Skip to content

katalon-studio/katalon-gradle-plugin

Repository files navigation

Katalon Studio's Gradle Plugin

This Gradle plugin helps simplify/automate some tasks in Katalon Studio. It is published at https://plugins.gradle.org/plugin/com.katalon.gradle-plugin.

How to build and test

  • Build Run gradle build
  • Test
    Suggestion plugin: katalon-studio-zip-keywords-plugin
    Remove line 'com.katalon.gradle-plugin' version '<version>'
    Adding this script to the build.gradle file in the tested plugin.
buildscript{
    dependencies{
        classpath files('<path>/katalon-gradle-plugin-<version>.jar')
    }
}
.....
apply plugin: com.katalon.gradle.plugin.KatalonGradlePlugin

Gradle Tasks

  • katalonCopyDependencies
  • katalonListTestCases
  • katalonListTestSuites

Sample

Please see https://github.com/katalon-studio-samples/framework-integration.

Tutorial: Automatically download dependencies for Katalon Studio projects

Install Gradle

Please follow this guide to install Gradle on your machine.

Add build.gradle file

Add a build.gradle file inside Katalon Studio project contains the below code. Dependencies can be changed or modified based on your libraries prerferences.

plugins {
  id 'java-library'
  id "com.katalon.gradle-plugin" version "0.1.2"
}

repositories {
  mavenCentral()
}

dependencies {
  // sample dependencies
  // rest-assured
  implementation 'io.rest-assured:rest-assured:3.2.0'
  // JsonPath
  implementation 'io.rest-assured:json-path:3.2.0'
  // XmlPath
  implementation 'io.rest-assured:json-path:3.2.0'
  // JSON Schema Validation
  implementation 'io.rest-assured:json-schema-validator:3.2.0'
}

Download the dependencies

Due to the way Java loading libraries, please close all Katalon Studio applications before execute the following command, and re-open it after the command has been completed.

gradle katalonCopyDependencies

License

Copyright (c) Katalon LLC. All rights reserved.

Licensed under the LICENSE AGREEMENT FOR KATALON AUTOMATION FRAMEWORK.

Companion products

Katalon TestOps

Katalon TestOps is a web-based application that provides dynamic perspectives and an insightful look at your automation testing data. You can leverage your automation testing data by transforming and visualizing your data; analyzing test results; seamlessly integrating with such tools as Katalon Studio and Jira; maximizing the testing capacity with remote execution.

Katalon Studio

Katalon Studio is a free and complete automation testing solution for Web, Mobile, and API testing with modern methodologies (Data-Driven Testing, TDD/BDD, Page Object Model, etc.) as well as advanced integration (JIRA, qTest, Slack, CI, Katalon TestOps, etc.). Learn more about Katalon Studio features.