cypress-qase-reporter

Qase TMS Cypress reporter

Publish results simple and easy.

How to install

To install the latest version, run:

npm install -D cypress-qase-reporter

Updating from v1

You can update a test project from using version 1 to version 2 in several steps:

1. Change import paths:

   - import { qase } from 'cypress-qase-reporter/dist/mocha'
   + import { qase } from 'cypress-qase-reporter/mocha'

2. Update reporter configuration in cypress.config.js and/or environment variables — see the configuration reference below.

Getting started

The Cypress reporter can auto-generate test cases and suites from your test data. Test results of subsequent test runs will match the same test cases as long as their names and file paths don't change.

You can also annotate the tests with the IDs of existing test cases from Qase.io before executing tests. It's a more reliable way to bind autotests to test cases, that persists when you rename, move, or parameterize your tests.

For example:

import { qase } from 'cypress-qase-reporter/mocha';

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

To execute Cypress tests and report them to Qase.io, run the command:

QASE_MODE=testops npx cypress run

or

npm test

You can try it with the example project at examples/cypress.

A test run will be performed and available at:

https://app.qase.io/run/QASE_PROJECT_CODE

Configuration

Qase Cypress reporter can be configured in multiple ways:

• by adding configuration block in cypress.config.js,
• using a separate config file qase.config.json,
• using environment variables (they override the values from the configuration files).

For a full list of configuration options, see the Configuration reference.

Example cypress.config.js config:

import cypress from 'cypress';

import plugins from './cypress/plugins/index.js';

module.exports = cypress.defineConfig({
  reporter: 'cypress-multi-reporters',
  reporterOptions: {
    reporterEnabled: 'cypress-mochawesome-reporter, cypress-qase-reporter',
    cypressMochawesomeReporterReporterOptions: {
      charts: true,
    },
    cypressQaseReporterReporterOptions: {
      debug: true,

      testops: {
        api: {
          token: 'api_key',
        },

        project: 'project_code',
        uploadAttachments: true,

        run: {
          complete: true,
        },
      },

      framework: {
        cypress: {
          screenshotsFolder: 'cypress/screenshots',
        }
      }
    },
  },
  video: false,
  e2e: {
    setupNodeEvents(on, config) {
      return plugins(on, config);
    },
  },
});

Check out the example of configuration for multiple reporters in the demo project.

Requirements

We maintain the reporter on LTS versions of Node.

cypress >= 8.0.0