Skip to content

Commit

Permalink
Merge branch 'master' into PP-456
Browse files Browse the repository at this point in the history
  • Loading branch information
iiojib authored Nov 1, 2023
2 parents b461c31 + 6dd0b2c commit 7be6f05
Show file tree
Hide file tree
Showing 18 changed files with 427 additions and 108 deletions.
28 changes: 14 additions & 14 deletions qase-core-reporter/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions qase-core-reporter/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "qase-core-reporter",
"version": "v1.0.0",
"version": "v1.0.1",
"description": "Qase TMS Core JS Reporter",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down Expand Up @@ -57,7 +57,7 @@
"dependencies": {
"chalk": "^4.1.0",
"form-data": "^4.0.0",
"qaseio": "^2.0.1",
"qaseio": "^2.0.2",
"strip-ansi": "^6.0.1",
"uuid": "^8.3.2"
}
Expand Down
18 changes: 9 additions & 9 deletions qase-cucumberjs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions qase-cucumberjs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cucumberjs-qase-reporter",
"version": "v0.2.8-alpha.2",
"version": "v0.2.10",
"description": "Qase TMS CucumberJS Reporter",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down Expand Up @@ -57,7 +57,7 @@
"file-type": "^17.1.1",
"mime-types": "^2.1.35",
"moment": "^2.29.1",
"qaseio": "^2.0.1",
"qaseio": "^2.0.2",
"read-chunk": "^4.0.2"
}
}
55 changes: 32 additions & 23 deletions qase-cypress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,42 @@ npm install cypress-qase-reporter

## Example of usage

If you want to decorate come test with Qase Case ID you could use qase function:
In order to connect Qase tests with your automated JavaScript tests you need to pass your `testId` and the test itself to the `qase` function.
You can see example usage with [CypressJS](https://docs.qase.io/documentation/general/get-started-with-the-qase-platform/create-a-test-run#quick-test-case) tests:

```typescript
import { qase } from 'cypress-qase-reporter/dist/mocha';
const testId = 1

describe('My First Test', () => {
qase([1,2],
it('Several ids', () => {
expect(true).to.equal(true);
})
);
qase(3,
qase(testId,
it('Correct test', () => {
expect(true).to.equal(true);
})
);
qase(4,
it.skip('Skipped test', () => {
});

```
You can also pass testId to a list if the automated test corresponds to multiple of you test cases in Qase:
```typescript
import { qase } from 'cypress-qase-reporter/dist/mocha';

describe('My First Test', () => {
qase([1,4,9],
it('Correct test', () => {
expect(true).to.equal(true);
})
);
qase(5,
it('Failed test', () => {
expect(true).to.equal(false);
})
);
});

```
If you are going to use several specifications for execution and you have in config

If you are going to use several specifications for execution and you have in config

```bash
"runComplete": true
```
then it is necessary to additionally set in the project settings
then it is necessary to additionally set in the [project settings](https://docs.qase.io/documentation/general/get-started-with-the-qase-platform/create-a-project/project-settings) the following option:

```
Allow to add results for cases in closed runs.
```
Expand All @@ -68,11 +70,11 @@ https://app.qase.io/run/QASE_PROJECT_CODE

## Configuration

Reporter options (* - required):
Reporter options (__*__ - required):

- *`apiToken` - Token for API access, you can find more information
- `apiToken` __*__ - Token for API access, you can find more information
[here](https://developers.qase.io/#authentication)
- *`projectCode` - Code of your project (can be extracted from main
- `projectCode` __*__ - Code of your project (can be extracted from main
page of your project: `https://app.qase.io/project/DEMOTR` -
`DEMOTR` is project code here)
- `runId` - Run ID from Qase TMS (also can be got from run URL)
Expand All @@ -83,12 +85,19 @@ Reporter options (* - required):
- `sendScreenshot` [true/false] - Permission to send screenshots to Qase TMS
- `runComplete` [true/false] - Permission for automatic completion of the test run

#### You can check example configuration with multiple reporters in [demo project (cypress v10)](examples_cypress_v10/cypress.config.js) and [demo project (cypress v6)](examples_cypress_v6/cypress.json).
#### Example

Configuration with multiple reporters:
[demo project (cypress v10)](examples_cypress_v10/cypress.config.js)
and
[demo project (cypress v6)](examples_cypress_v6/cypress.json).

## Environment

Supported ENV variables:

- `QASE_REPORT` - You **should** pass this ENV if you want to use
qase reporter
- `QASE_REPORT` __*__ - You **should** pass 1 to this ENV if you want to use
qase reporter.
- `QASE_RUN_ID` - Pass Run ID from ENV and override reporter options
- `QASE_RUN_NAME` - Set custom Run name, when new run is created
- `QASE_RUN_DESCRIPTION` - Set custom Run description, when new run is created
Expand Down
18 changes: 9 additions & 9 deletions qase-cypress/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions qase-cypress/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cypress-qase-reporter",
"version": "v1.4.2-alpha.3",
"version": "v1.4.3",
"description": "Qase TMS Cypress Reporter",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down Expand Up @@ -30,7 +30,7 @@
"license": "Apache-2.0",
"dependencies": {
"form-data": "^4.0.0",
"qaseio": "^2.0.1"
"qaseio": "^2.0.2"
},
"devDependencies": {
"@hutson/npm-deploy-git-tag": "^6.0.0",
Expand Down
18 changes: 9 additions & 9 deletions qase-jest/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions qase-jest/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jest-qase-reporter",
"version": "v1.3.0-alpha.4",
"version": "v1.3.1",
"description": "Qase TMS Jest Reporter",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down Expand Up @@ -30,7 +30,7 @@
},
"license": "Apache-2.0",
"dependencies": {
"qaseio": "^2.0.0-alpha.5"
"qaseio": "^2.0.2"
},
"devDependencies": {
"@hutson/npm-deploy-git-tag": "^6.0.0",
Expand Down
Loading

0 comments on commit 7be6f05

Please sign in to comment.