https://github.com/katalon-studio/testops-report-js
Katalon TestOps JavaScript Reporters
https://github.com/katalon-studio/testops-report-js
critical katalon-testops
Last synced: 7 months ago
JSON representation
Katalon TestOps JavaScript Reporters
- Host: GitHub
- URL: https://github.com/katalon-studio/testops-report-js
- Owner: katalon-studio
- Created: 2020-12-22T10:21:17.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-28T07:17:20.000Z (almost 2 years ago)
- Last Synced: 2025-03-11T17:17:45.506Z (7 months ago)
- Topics: critical, katalon-testops
- Language: TypeScript
- Homepage:
- Size: 1010 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Katalon TestOps JavaScript Reporters
## Usage
### Configuration
#### Environment variables
Configurations will be read from environment variables, and properties file in this order.
* `TESTOPS_SERVER_URL`
Katalon TestOps endpoint (default: `https://testops.katalon.io`).
* `TESTOPS_API_KEY`
Your Katalon TestOps API Key.
* `TESTOPS_PROJECT_ID`
The Katalon TestOps project that will receive the test results.
* `TESTOPS_REPORT_FOLDER`
The local directory where test results will be written to (default: `testops-report`).
* `TESTOPS_PROXY_SERVER_TYPE`
* `TESTOPS_PROXY_HOST`
* `TESTOPS_PROXY_PORT`
* `TESTOPS_PROXY_USERNAME`
* `TESTOPS_PROXY_PASSWORD`
#### Configuration file
Create a `testops-config.json` file in the top-level directory.
```
{
// Default value: https://testops.katalon.io
"basePath": "",
"apiKey": "",
"projectId": "",
// Default value: testops-report
"reportFolder": "",
"proxy": {
"protocol": "", // Value: http, https
"host": "",
"port": "",
"auth": {
"username": "",
"password": ""
}
}
}
```
#### Mocha
- Sample: https://github.com/katalon-studio-samples/testops-report-sample-js
- Install dependency
```
npm i @katalon/testops-mocha
```
- Add reporter
```
mocha dist --recursive --reporter @katalon/testops-mocha './tests/*.js'
```
#### Cypress
- Sample: https://github.com/katalon-studio-samples/testops-report-sample-js
- Install dependency
```
npm i @katalon/testops-cypress
```
- Add reporter
```
const cypress = require('cypress')
const CypressTestOpsReporter = require('@katalon/testops-cypress');
cypress.run({
})
.then((results) => {
const reporter = new CypressTestOpsReporter();
reporter.parseAndUploadTestResults(results);
})
.catch((err) => {
console.error(err)
})
```
#### Jasmine
- Sample: https://github.com/katalon-studio-samples/testops-report-sample-js
- Install dependency
```
npm i @katalon/testops-jasmine
```
- Add reporter
```
import TestOpsJasmineReporter from "@katalon/testops-jasmine";
const reporter = new TestOpsJasmineReporter()
jasmine.getEnv().addReporter(reporter)
```
#### Jest
- Sample: https://github.com/katalon-studio-samples/testops-report-sample-js
- Install dependency
```
npm i @katalon/testops-jest
```
- Setup reporter in `jest.config.js` file
```
module.exports = {
"reporters": ["default", "@katalon/testops-jest"]
};
```
## Samples
https://github.com/katalon-studio-samples/testops-report-sample-js