Automatics - Zephyr Integration

Introduction

Zephyr Scale is a test management tool that integrates with Jira to help coordinate and track testing activities. It's designed for managing software quality in complex environments, and offers features like:

• Native integration with Jira
• 360-degree traceability
• Hierarchical folders
• Versioning
• Test data
• Structured test management
• Test libraries 

Zephyr Scale also supports REST API integration with test automation tools to submit test results. For example, you can use ScriptRunner to automate and customize your tests, making them more accurate and efficient. You can also add workflow conditions, post functions, scripted fields, and listeners to run an action when a Zephyr Scale event fires.

Zephyr API Documentation: https://support.smartbear.com/zephyr-scale-server/api-docs/v1/  

Automatics Zephyr Integration Architecture

Automatics Zephyr design workflow 

1. Automatics Zephyr Gateway server scheduler will fetch all the Automatics Test cases and create the test cases in to Zephyr. In return Zephyr will return the Zephyr ID which will be updated to Automatics by the Gateway server
       Zephyr REST API : /testcase
       HTTP Method : POST
2. Automatics Gateway server scheduler will check for Zephyr ID in Automatics and another column to check whether the any update in the testcase is done after the last update. If any changes in the test case is found then it will update the latest changes in Zephyr using the Update API    
       Zephyr REST API : /testcase/{testCaseKey}
       HTTP Method : PUT
      
3. Zephyr Test Plan key is fetched as an input from user when triggering Automatics Test execution, this is used to fetch the Test Run key using the Zephyr API "/testplan/{testPlanKey}". This Test Run Key is then used to fetch the Zephyr test cases id's using the API "/testrun/{testRunKey}" associated with these test runs and using these Zephyr Test case Ids Automatics test case execution will be triggered.
       Zephyr REST API : /testplan/{testPlanKey}
       HTTP Method : GET
       Zephyr REST API : /testrun/{testRunKey}
       HTTP Method : GET
4. Once execution is completed in Automatics the execution result needs to be updated to Zephyr. The existing REST API of zephyr can be used to update the execution result. Under "scriptResults" tag of the request body status of each steps needs to be updated without the "status" field of the main request.
       Zephyr REST API : /testresult
       HTTP Method : POST