Search code examples
karateintuit-partner-platform

How to distribute Karate testing framework?


Problem statement: Every service has a separate repository. what is the best way to use a common framework across several service repositories?

We are trying to create an API test automation framework using "Karate". Here we want to create a framework(Which can be distributed(example:jar)) such that it can be used across all of the microservice project repositories.


Solution

  • As the creator of Karate, I strongly recommend you don't do this. In the long term this makes all your projects depend on one common framework - and you should try to reduce the creation of "home grown" frameworks. Especially for a testing framework, you should try not to force teams to depend on an additional library which you need to maintain and version-control. Re-use can cause more harm than good especially in the context of testing, see this article at the Google Testing Blog.

    That said, since Karate can read files from the classpath: you can "ship" a JAR file with common Java classes and even feature or JS files that all your projects can inherit from or "re use". In fact the karate-base.js has been designed to solve for common bootstrap logic or variables / parameters being supplied from a JAR file.

    Short Answer: use normal Java techniques (Maven / Gradle) to create a re-usable JAR file, e.g. put your feature files and JS files in src/main/* and not src/test/*. There are multiple ways to use resources (Java, *.feature, JS) from a JAR file. It is up to you how to structure your Maven (or Gradle) projects to make this happen.

    EDIT: for those looking for how to create a "runnable" JAR, please see https://stackoverflow.com/a/56553194/143475

    And even if using the standalone JAR, you can customize the classpath: https://karatelabs.github.io/karate/karate-netty/#custom-classpath