Installation

To integrate Qase Reporter in your Jest setup, follow these steps:

activate the jest app

To activate the app, go to the Apps section in your workspace, and click on ‘Activate’

Switch to the ‘Access tokens’ tab, and create a new API token from here. Save the API token as we’ll need it for the next steps.

Add jest-qase-reporter to your project

To install and add the reporter as a development dependency, run the following in node project -

npm install -D jest-qase-reporter

Add the reporter to your Jest configuration file

At the very least, the reporter will need two variables defined - your Jest App’s Token, and the Qase Project you want to publish the results to -

// jest.config.js

export default {
  reporters: [
    'default',
    [
      'jest-qase-reporter',
      {
        testops: {
          api: {
            token: 'api_key', // Replace with your actual API token
          },
          project: 'project_code', // Replace with your project code
          run: {
            complete: true,
          },
        },
        debug: true,
      },
    ],
  ],
   Other configurations...
};

*The above example is using *ES Module format, for a CommonJS version, copy the code from this toggle.

const defaultConfig = {
  reporters: [
    'default',
    [
      'jest-qase-reporter',
      {
        testops: {
          api: {
            token: 'api_key', // Replace with your actual API token
          },
          project: 'project_code', // Replace with your project code
          run: {
            complete: true,
          },
        },
        debug: true,
      },
    ],
  ],
  // Other configurations...
};

module.exports = defaultConfig;

Please refer to this article for guidance on how to find your Project code in Qase.

If you do not want to configure the reporter’s options in your Jest configuration file, you have the option to use a qase.config.json to have all your reporter options defined.

Create a new qase.config.json file at the root of your repository, and add the project code and App token.

{
  "testops": {
    "api": {
      "token": "<token>"
    },
    "project": "<project_code>"
  }
}

Let’s verify the integration

We’ll use a simple test to check if the results are being published to your Qase project.

Add the following sum function to the src/

// sum.js

function sum(a, b) {
  return a + b;
}

module.exports = sum;

Now, add the following test in the tests/ directory

const sum = require('../src/sum');

test('[Example] adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Now, let’s run the test, by executing the following command -

QASE_MODE=testops npx jest sum

In the above command, we’re setting the reporter’s mode to ‘testops’ using the Environment variable QASE_MODE.

Click on the link printed at the end of the run to go to the test run in Qase.