https://github.com/testpointcorp/katalon-vansah
This tutorial guides you through the process of integrating Katalon WebUI tests with Vansah Test Management for Jira to automatically send test case results.
https://github.com/testpointcorp/katalon-vansah
automation automation-framework katalon-studio webuitest
Last synced: 4 months ago
JSON representation
This tutorial guides you through the process of integrating Katalon WebUI tests with Vansah Test Management for Jira to automatically send test case results.
- Host: GitHub
- URL: https://github.com/testpointcorp/katalon-vansah
- Owner: testpointcorp
- Created: 2024-04-05T09:11:04.000Z (about 1 year ago)
- Default Branch: prod
- Last Pushed: 2024-04-16T20:37:36.000Z (about 1 year ago)
- Last Synced: 2025-01-01T16:22:27.683Z (6 months ago)
- Topics: automation, automation-framework, katalon-studio, webuitest
- Language: Groovy
- Homepage: https://vansah.com/connect-integrations/
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Katalon Integration with Vansah Test Management for Jira
This tutorial guides you through the process of integrating Katalon WebUI tests with Vansah Test Management for Jira. Integrating Katalon with Vansah will allow you to send Test Case results from Katalon to your Jira workspace.
By following this setup, you can streamline your testing workflow, ensuring that test outcomes are recorded directly in your Jira workspace.
## Prerequisites
- **Katalon** WebUI test project is already setup.
- Make sure that [`Vansah`](https://marketplace.atlassian.com/apps/1224250/vansah-test-management-for-jira?tab=overview&hosting=cloud) is installed in your Jira workspace
- You need to Generate **Vansah** [`connect`](https://docs.vansah.com/docs-base/generate-a-vansah-api-token-from-jira-cloud/) token to authenticate with Vansah APIs.
## Configuration
**Setting Environment Variables** - Store your Vansah API token as an environment variable for security.
For Windows (use cmd)
```cmd
setx VANSAH_TOKEN "your_vansah_api_token_here"
```
For macOS
```bash
echo export VANSAH_TOKEN="your_vansah_api_token_here" >> ~/.bash_profile
source ~/.bash_profile
```
For Linux (Ubuntu, Debian, etc.)
```bash
echo export VANSAH_TOKEN="your_vansah_api_token_here" >> ~/.bashrc
source ~/.bashrc
```
## Implementation
To enable Vansah integration in any WebUI Katalon project, follow these steps:
1. **Place the VansahBinding.java File**: Ensure that [`VansahBinding.java`](/Include/scripts/groovy/VansahBinding.java) is located in the `Include/scripts/groovy` directory of your project.
2. **Add the Vansah Test Listener**: Add or Create **@AfterTestCase** listener so that after running each Test Case we can send the test results of the same test Case to Vansah.
Ex: [`VansahListeners.groovy`](Test%20Listeners/VansahListeners.groovy)
```groovy
import com.kms.katalon.core.annotation.AfterTestCase
import com.kms.katalon.core.context.TestCaseContext
import VansahBinding;
class VansahListeners {
/**
* Executes after every test case ends to send results to Vansah.
* @param testCaseContext Context of the executed test case.
*/
@AfterTestCase
def AfterTestCase(TestCaseContext testCaseContext) {
// Retrieve Test Case and Asset details
def vansahData = testCaseContext.getTestCaseVariables()
def testCaseKey = vansahData.get("TestCaseKey")
def assetKey = vansahData.get("Asset")
VansahBinding vb = new VansahBinding();
vb.sendResultstoVansah(testCaseKey, assetKey, testCaseContext.getTestCaseStatus());
}
}
}
}
```
4. **Configure Test Run Properties**: Modify `Profiles/default.glbl` with your specific Vansah URL and test run properties to ensure proper configuration and communication with Vansah.
OR
Copy and Paste below script to your default profile, include inside ``
```xml
Required : Obtain your Vansah Connect URL from Vansah Settings > Vansah API Tokens
'https://prod.vansahnode.app'
Vansah_URL
Optional : Provide your Sprint Name
'SM Sprint 1'
SprintName
Optional : Provide your Release Name
'Release 24'
ReleaseName
Optional : Provide your Environment Name
'UAT'
EnvironmentName
```
5. **Prepare Test Cases**: Incorporate test case and asset details directly within your Katalon test case files. This step ensures that all necessary information for Vansah reporting is readily available.
## Conclusion
By following the above steps, your Katalon project will be equipped to send test run results directly to Vansah, streamlining your testing and reporting process.
Ensure that all files are placed and configured as described to facilitate successful integration.
For more details on Katalon, visit the [Test Fixtures and Test Listeners in Katalon Studio](https://docs.katalon.com/katalon-studio/create-test-cases/test-fixtures-and-test-listeners-test-hooks-in-katalon-studio).
For Vansah specific configurations and API details, please refer to the [Vansah API documentation](https://apidoc.vansah.com/).