Skip to main content

Dependencies Management with Native Gradle Support (Poc) in Katalon Studio

Important:
  • This Proof of Concept (PoC) is not ready for production use. We recommend using this PoC for evaluation purposes only.

Previously, Katalon Studio provides a Gradle Plugin to simplify and automate some tasks in Katalon Studio. However, some users find it cumbersome, and dependencies management is pretty bare-bones.

Empowered by Buildship, an Eclipse plugin, the Gradle wrapper and native Gradle integration in Katalon Studio makes dependencies management with Maven or Gradle more streamlined and robust. You are no longer required to use any Command-line or third-party tools and free to decide which Gradle version to use in your test project instead of being limited to use only the fixed version that you have installed on your local machine earlier.

This feature is particularly beneficial to Katalon users who use external libraries in multiple test projects and prefer to use Gradle for managing their build process. You can now run Gradle tasks in a better editor without installing Gradle in Katalon Studio or using an external terminal/command prompt. It substantially reduces your manual effort when you can manage and download external libraries in fewer steps than before.

This manual introduces what built-in Gradle support looks like and how to use it in Katalon Studio.

Note:

Gradle Settings in Katalon Studio​

Katalon Studio turns on the built-in Gradle integration by default for all projects.

Note:
  • When you create/open a project for the first time, it takes 2 to 5 minutes to download Gradle.

You can access Gradle settings by going to Katalon Studio > Preferences > Gradle.



To change the Gradle settings of an opening project, go to Project > Properties > Gradle.





Gradle Tasks in Katalon Studio​

To use Gradle tasks in Katalon Studio, open the Gradle Tasks tab at the bottom dock:



  • To sync Gradle tasks when you change the build.gradle file, on the top right corner, click the Refresh Tasks for All Projects button.

  • To view and use Katalon Gradle tasks, on the top right corner, click on the three-dot button and select Show All Tasks.



    All Katalon Tasks are available under the other category of the Gradle task tree:



  • Click on any item on the Gradle task tree to run the dedicated Gradle tasks. For the katalonCopyDependencies task, you need to select Project > Refresh to refresh the project classpath after successfully running the task.

Usage Examples of katalonCopyDependencies task in Katalon Studio​

On Tests Explorer, open the build.gradle file, in its editor:

  1. You can use compile to add dependencies to a project:
    compile 'io.rest-assured:json-schema-validator:3.2.0'
  2. Use the following command to exclude dependencies:
    compile ('io.rest-assured:json-schema-validator:3.2.0') {
        exclude group: 'org.hamcrest', module: 'hamcrest-core' 
    }