Qase TestOps Cypress Reporter

Qase Cypress Reporter enables seamless integration between your Cypress tests and Qase TestOps, providing automatic test result reporting, test case management, and comprehensive test analytics.

Features

• Link automated tests to Qase test cases by ID
• Auto-create test cases from your test code
• Report test results with rich metadata (fields, attachments, steps)
• Support for parameterized tests
• Multi-project reporting support
• Flexible configuration (file, environment variables, Cypress config)
• Cucumber/Gherkin integration support
• Automatic screenshot and video attachments
• Network Profiler for automatic HTTP request capture

Installation

npm install --save-dev cypress-qase-reporter

Quick Start

1. Create qase.config.json in your project root:

{
  "mode": "testops",
  "testops": {
    "project": "YOUR_PROJECT_CODE",
    "api": {
      "token": "YOUR_API_TOKEN"
    }
  }
}

2. Configure Cypress to use the reporter in cypress.config.js:

const { defineConfig } = require('cypress');

module.exports = defineConfig({
  reporter: 'cypress-qase-reporter',
  reporterOptions: {
    mode: 'testops',
  },
  e2e: {
    setupNodeEvents(on, config) {
      require('cypress-qase-reporter/plugin')(on, config);
      require('cypress-qase-reporter/metadata')(on);
    },
  },
});

3. Add Qase ID to your test:

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

describe('Login Suite', () => {
  it(qase(1, 'User can login with valid credentials'), () => {
    cy.visit('https://example.com/login');
    cy.get('#email').type('[email protected]');
    cy.get('#password').type('password123');
    cy.get('button[type="submit"]').click();
    cy.url().should('include', '/dashboard');
  });
});

4. Run your tests:

npx cypress run

Configuration

The reporter is configured via (in order of priority):

1. cypress.config.js (Cypress-specific, highest priority)
2. Environment variables (QASE_*)
3. Config file (qase.config.json)

Minimal Configuration

| Option | Environment Variable | Description | |--------|---------------------|-------------| | mode | QASE_MODE | Set to testops to enable reporting | | testops.project | QASE_TESTOPS_PROJECT | Your Qase project code | | testops.api.token | QASE_TESTOPS_API_TOKEN | Your Qase API token |

Example cypress.config.js

const { defineConfig } = require('cypress');

module.exports = defineConfig({
  reporter: 'cypress-qase-reporter',
  reporterOptions: {
    mode: 'testops',
    debug: false,
    testops: {
      api: {
        token: process.env.QASE_API_TOKEN,
      },
      project: 'DEMO',
      uploadAttachments: true,
      run: {
        title: 'Cypress Automated Run',
        complete: true,
      },
      batch: {
        size: 100,
      },
    },
    framework: {
      cypress: {
        screenshotsFolder: 'cypress/screenshots',
        videosFolder: 'cypress/videos',
      },
    },
  },
  e2e: {
    setupNodeEvents(on, config) {
      require('cypress-qase-reporter/plugin')(on, config);
      require('cypress-qase-reporter/metadata')(on);
    },
  },
});

Example qase.config.json

{
  "mode": "testops",
  "fallback": "report",
  "testops": {
    "project": "YOUR_PROJECT_CODE",
    "api": {
      "token": "YOUR_API_TOKEN"
    },
    "run": {
      "title": "Cypress Automated Run"
    },
    "batch": {
      "size": 100
    }
  },
  "report": {
    "driver": "local",
    "connection": {
      "local": {
        "path": "./build/qase-report",
        "format": "json"
      }
    }
  },
  "framework": {
    "cypress": {
      "screenshotsFolder": "cypress/screenshots",
      "videosFolder": "cypress/videos"
    }
  }
}

Full configuration reference: See qase-javascript-commons for all available options including logging, status mapping, execution plans, and more.

Usage

Link Tests with Test Cases

Associate your tests with Qase test cases using test case IDs:

Single ID:

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

describe('Authentication', () => {
  it(qase(1, 'Login with valid credentials'), () => {
    cy.visit('/login');
    cy.get('#email').type('[email protected]');
    cy.get('button').click();
  });
});

Multiple IDs:

describe('Authentication', () => {
  it(qase([1, 2, 3], 'Login works across multiple browsers'), () => {
    cy.visit('/login');
    cy.get('#email').type('[email protected]');
    cy.get('button').click();
  });
});

Add Metadata

Enhance your tests with additional information:

it('User can login', () => {
  qase.title('User successfully logs in with valid credentials');
  qase.fields({
    severity: 'critical',
    priority: 'high',
    layer: 'e2e',
    description: 'Tests the core login flow',
  });
  qase.suite('Authentication / Login');

  cy.visit('/login');
  cy.get('#email').type('[email protected]');
  cy.get('#password').type('password123');
  cy.get('button').click();
});

Ignore Tests

Exclude specific tests from Qase reporting (test still runs, but results are not sent):

it('Test under development', () => {
  qase.ignore();
  cy.visit('/new-feature');
  cy.get('.coming-soon').should('be.visible');
});

Test Result Statuses

| Cypress Result | Qase Status | |----------------|-------------| | Passed | Passed | | Failed | Failed | | Pending | Skipped | | Skipped | Skipped |

For more usage examples, see the Usage Guide.

Running Tests

Run Cypress tests with Qase reporting:

# Run all tests
npx cypress run

# Run specific spec file
npx cypress run --spec "cypress/e2e/login.cy.js"

# Run in headed mode
npx cypress open

# Run with environment variables
QASE_MODE=testops QASE_TESTOPS_PROJECT=DEMO npx cypress run

Network Profiler

The Network Profiler automatically captures browser-originated HTTP requests made during test execution and reports them as REQUEST-type steps in Qase TestOps.

Additional setup: Import the support file in your cypress/support/e2e.ts (or e2e.js):

// cypress/support/e2e.ts
import 'cypress-qase-reporter/support';

The support file registers a beforeEach hook that installs cy.intercept('**') to capture all application HTTP requests. No changes to spec files are needed.

Enable in qase.config.json:

{
  "profilers": ["network"],
  "networkProfiler": {
    "skip_domains": ["analytics.example.com"],
    "track_on_fail": true
  }
}

| Option | Description | Default | |--------|-------------|---------| | profilers | Array of profilers to enable. Use ["network"] for HTTP capture | [] | | networkProfiler.skip_domains | Domains to exclude from profiling | [] | | networkProfiler.track_on_fail | Capture response body for failed requests (status >= 400) | true |

Requests to qase.io and Cypress internal requests (/__cypress/) are always excluded automatically.

Requirements

• Node.js >= 14
• Cypress >= 10.0.0

Documentation

| Guide | Description | |-------|-------------| | Usage Guide | Complete usage reference with all methods and options | | Cucumber Integration | Gherkin/Cucumber support with preprocessors | | Attachments | Adding screenshots, logs, and files to test results | | Steps | Defining test steps for detailed reporting | | Multi-Project Support | Reporting to multiple Qase projects | | Upgrade Guide | Migration guide for breaking changes |

Examples

See the examples directory for complete working examples:

• Single project example
• Cucumber (badeball) example
• Cucumber (legacy) example

License

Apache License 2.0. See LICENSE for details.