Skip to content

Latest commit

 

History

History
 
 

qase-testcafe

README.md

Qase TMS TestCafe reporter

Publish results simple and easy.

How to integrate

npm install testcafe testcafe-reporter-qase

Example of usage

The TestCafe reporter has the ability to auto-generate test cases and suites from your test data.

But if necessary, you can independently register the ID of already existing test cases from TMS before the executing tests. Meta key should be CID. You should assign list of case IDs to it, e.g.:

test
    .meta('CID', [1])
    ('Text typing basics', async (t) => {
        await t
    });

test
    .meta({ CID: [2, 3] })
    ('Click check boxes and then verify their state', async (t) => {
        await t
    });

You should also have an active item in the project settings at

https://app.qase.io/project/QASE_PROJECT_CODE/settings/options

options in the Test Runs block:

Auto create test cases

and

Allow submitting results in bulk

To run tests and create a test run, execute the command (for example from folder examples):

npx testcafe chrome test.js -r spec,qase

or

npm test

A test run will be performed and available at:

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

Configuration

Qase reporter supports passing parameters using two ways: using .qaserc file and using ENV variables.

.qaserc parameters:

  • enabled - Enable reporter
  • apiToken - Token for API access, you can find more information here
  • basePath - Qase.io URL
  • 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 - Pass Run ID
  • environmentId - Environment ID from Qase TMS
  • runName - Set custom Run name, when new run is created. Supports two parameters:
    • %DATE%
    • %AGENTS%
  • runDescription - Set custom Run description, when new run is created
  • uploadAttachments - Uploading attachment to Qase TMS
  • runComplete - Complete run after all tests are finished
  • logging - Enabled debug logging from reporter or not
  • rootSuiteTitle - A parent suite for your autocreated tests

Example configuration file:

{
    "enabled": true,
    "logging": true,
    "apiToken": "api_key",
    "projectCode": "project_code",
    "runName": "TestCafe run %DATE% %AGENTS%"
}

Supported ENV variables:

  • QASE_ENABLED - Same as enabled
  • QASE_API_TOKEN - Same as apiToken
  • QASE_PROJECT - Same as projectCode
  • QASE_RUN_ID - Pass Run ID from ENV and override reporter options
  • QASE_RUN_NAME - Same as runName
  • QASE_RUN_DESCRIPTION - Same as runDescription
  • QASE_RUN_COMPLETE - Same as runComplete
  • QASE_LOGGING - Same as logging
  • QASE_UPLOAD_ATTACHMENTS - Same as uploadAttachments
  • QASE_ROOT_SUITE_TITLE - Same as rootSuiteTitle

Requirements

We maintain the reporter on LTS versions of Node. You can find the current versions by following the link