Skip to main content

Zephyr Scale

  • Please note that the integration will work for most users but has not been tested for every use case.

This document will cover a step by step guide on integration of Zephyr Scale Cloud in JIRA with Katalon Automation Platform.

Setup Zephyr Scale in Jira

  • Katalon Studio

  • Zephyr Scale app in Jira Cloud

  1. Generate API Access Tokens
    You need to generate an access token to use the API for Zephyr Scale. Each user interacting with the API will need a token for that instance of Jira.
    1. Click your Jira profile icon and select Zephyr Scale API Access Tokens.Zephyr Scale API access tokens
    2. Select Create access token. Zephyr - create access token
    3. The pop-up Access token successfully created appears. Select Copy to copy the access token.
  2. Now you can get started using the REST API.
    The URL for API requests is:{endpoint}
    The authorization we use is based on JWT, so you have to use a bearer token. Add the Authorization header with the value Bearer {token}.

    You can refer to the API documentation for details on available endpoints and data models.

  3. Create sample Test Case, Test Cycle, Test Plan and link them as per requirements

Setup Katalon project

  1. Global Variables setup

    Create the following global variable in your package which will be used in API calls for pushing execution results to Zephyr cloud in Jira from Katalon after execution of test cases.Zephyr Katalon global variables setup

  2. Create Test Case and tag
    Script the test case and give name to test case with prefix as Test Case Key from Zephyr Scale then an underscore followed by Test case name, for example: <<TestCase Key>>_<<Test case name as per your choice>>

    Also, you need to tag the test case with linked Test Cycle Keys from Zephyr scale as below.Zephyr test case tag

  3. Create Web Service Request

    Under the Object repository add a new web service request for API Create test execution -This API will be used to push test results by creating a new execution record for each Test case after execution in Katalon.

    In API you need to provide an end point, set authorization with bearer token generated in the step Generating API Access Tokens above, update that to HTTP Header and the HTTP Body with parameterized global variables which will be replaced with actual value in runtime.
    Zephyr - update to HTTP headerZephyr update to body
  4. Create TestListener
    Create a new test listener with following methods and code given below. This will call the Execution API after each Test case gets executed and push results to Zephyr Scale.
    << default import statements will be here>> 
    class NewTestListener {
    * Executes after every test case ends.
    * @param testCaseContext related information of the executed test case.
    def sampleAfterTestCase(TestCaseContext testCaseContext) {
    //Get Test Case Key from test case name
    TestCase testCase = findTestCase(testCaseContext.getTestCaseId())
    //Set Zephyr Status
    if (testCaseContext.getTestCaseStatus()=="PASSED")
    else if (testCaseContext.getTestCaseStatus()=="FAILED")
    GlobalVariable.g_ZS_StatusName="Not Executed"
    //Call API to Push Result to Zephyr by creating Test case execution
    WS.sendRequest(findTestObject('Create Execution'))
  5. Install Basic Search for Dynamic Test Suite Plugin.

    You can install Basic Search For Dynamic Test Suite by login into the Katalon Store and reload the plugin in Katalon Studio.Katalon Studio reload plugins

  6. Create Dynamic Test Suite and Generate Command for Console Mode
    1. In Test Explorer panel, right-click at the Test Suites folder > New > Dynamic Test Suite to create a Dynamic Test Suite.Katalon Studio - Dynamic Test Suite
    2. Select Generate Command icon near Run icon and select Test Suite and other details.KS - generate command
  7. Execute Dynamic Test Suite using Console mode command.
    This command can be configured in Katalon TestOps or in CI tool for triggering execution or can be run on cmd using Katalon Runtime Engine.
    ./katalonc -noSplash -runMode=console
    -projectPath="/Users/rupeshsawant/Katalon Studio/Katalon and
    Zephyr Integration/Katalon and Zephyr Integration.prj"
    -retry=0 -testSuitePath="Test Suites/Zephyr TestCycle Dynamic
    Test Suite" -browserType="Chrome" -executionProfile="default"
    -apiKey="<<Your APi Key>>" -orgID=<<Your Org Id>> --config
    -proxy.auth.option=NO_PROXY -proxy.system.option=NO_PROXY
    You need to append two arguments with the Test Cycle Key value which you want to execute:
    • -testSuiteQuery="tag=(<<Your Test Cycle Key)>>)": this argument will be used for filtering test cases linked to test cycle for execution in dynamic test suite.

    • -g_ZS_TestCycleKey="<<Your Test Cycle Key)>>": this argument will be used for setting global variable value to selected test cycle which will be required in API calls.

    The command will be updated as follows:
    ./katalonc -noSplash -runMode=console
    -projectPath="/Users/rupeshsawant/Katalon Studio/Katalon and
    Zephyr Integration/Katalon and Zephyr Integration.prj"
    -retry=0 -testSuitePath="Test Suites/Zephyr TestCycle Dynamic
    Test Suite" -browserType="Chrome" -executionProfile="default"
    -apiKey="<<Your APi Key>>" -orgID=<<Your Org Id>> --config
    -proxy.auth.option=NO_PROXY -proxy.system.option=NO_PROXY
    -webui.autoUpdateDrivers=true -testSuiteQuery="tag=(<<Your
    Test Cycle Key)>>)" -g_ZS_TestCycleKey="<<Your Test Cycle
  8. Check test results in Jira Zephyr Scale
    Results will be updated in Jira Zephyr scale in respective test cycle and test case with new execution record.Zephyr test result