cypress-qase-reporter 2.2.0-beta.3 → 2.2.0

package/README.md

@@ -4,21 +4,12 @@ Publish results simple and easy.
 
 ## Installation
 
-To install the latest release version (2.1.x), run:
+To install the latest release version (2.2.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter
 ```
 
-<!-- if there's no current beta, comment the next block
--->
-
-To install the latest beta version (2.2.x), run:
-
-```sh
-npm install -D cypress-qase-reporter@beta
-```
-
 ## Updating from v1 to v2.1
 
 To update an existing test project using Qase reporter from version 1 to version 2.1,

package/changelog.md

@@ -1,3 +1,9 @@
+# cypress-qase-reporter@2.2.0
+
+## What's new
+
+Minor release of the Cypress reporter package
+
 # cypress-qase-reporter@2.2.0-beta.3
 
 ## What's new

package/docs/usage.md

@@ -0,0 +1,196 @@
+# Qase Integration in Cypress
+
+This guide demonstrates how to integrate Qase with Cypress, providing instructions on how to add Qase IDs, titles,
+fields, suites, comments, and file attachments to your test cases.
+
+---
+
+## Adding QaseID to a Test
+
+To associate a QaseID with a test in Cypress, use the `qase` function. This function accepts a single integer
+representing the test's ID in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+qase(1, it('simple test', () => {
+  cy.visit('https://example.com');
+}));
+```
+
+---
+
+## Adding a Title to a Test
+
+You can provide a title for your test using the `qase.title` function. The function accepts a string, which will be
+used as the test's title in Qase. If no title is provided, the test method name will be used by default.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.title('Title');
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding Fields to a Test
+
+The `qase.fields` function allows you to add additional metadata to a test case. You can specify multiple fields to
+enhance test case information in Qase.
+
+### System Fields:
+
+- `description` — Description of the test case.
+- `preconditions` — Preconditions for the test case.
+- `postconditions` — Postconditions for the test case.
+- `severity` — Severity of the test case (e.g., `critical`, `major`).
+- `priority` — Priority of the test case (e.g., `high`, `low`).
+- `layer` — Test layer (e.g., `UI`, `API`).
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.fields({ description: "Description", preconditions: "Preconditions" });
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding a Suite to a Test
+
+To assign a suite or sub-suite to a test, use the `qase.suite` function. It can receive a suite name, and optionally a
+sub-suite, both as strings.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.suite("Suite 01");
+  cy.visit('https://example.com');
+});
+
+it('test', () => {
+  qase.suite("Suite 01\tSuite 02");
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Ignoring a Test in Qase
+
+To exclude a test from being reported to Qase (while still executing the test in Cypress), use the `qase.ignore`
+function. The test will run, but its result will not be sent to Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.ignore();
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Adding a Comment to a Test
+
+You can attach comments to the test results in Qase using the `qase.comment` function. The comment will be displayed
+alongside the test execution details in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.comment("Some comment");
+  cy.visit('https://example.com');
+});
+```
+
+---
+
+## Attaching Files to a Test
+
+To attach files to a test result, use the `qase.attach` function. This method supports attaching one or multiple files,
+along with optional file names, comments, and file types.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+  qase.attach({ paths: '/path/to/file' });
+  qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Parameters to a Test
+
+You can add parameters to a test case using the `qase.parameters` function. This function accepts an object with
+parameter names and values.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Group Parameters to a Test
+
+To add group parameters to a test case, use the `qase.groupParameters` function. This function accepts an list with
+group parameter names.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  qase.groupParameters(['param1']);
+  cy.visit('https://example.com');
+});
+```
+
+## Adding Steps to a Test
+
+You can add steps to a test case using the `qase.step` function. This function accepts a string, which will be used as
+the step description in Qase.
+
+### Example:
+
+```javascript
+import { qase } from 'cypress-qase-reporter/mocha';
+
+it('test', () => {
+  qase.step('Some step', () => {
+    // some actions
+  });
+  cy.visit('https://example.com');
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.2.0-beta.3",
+  "version": "2.2.0",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,