testcafe-reporter-allure-plus

An Allure reporter plugin for TestCafé, based on Isaac's modifications.

Important: Keep in mind that these modifications are an implementation that suit specifically my use case, required by my client. That's why you will probably see some non-general metatags.

TODO

• [x] Publish package to npm
• [x] Update config file allure.config.js to only have one base URL
• [x] Add specific metatags user_story and test_case
• [x] Generate links for epic and feature if they are present
• [x] Generate links for issue if present, otherwise use test_case
• [x] Generate links for story if present, otherwise use user_story
• [x] Generate links for bug if present
• [x] Verify is truthy and reliable
• [x] Research and possibly expand the displayment of errors inside the failed tests - Missing await errors are still ghosting the reporter
• [ ] Research the posibility of logs as attachments inside steps and tests in general

Documentation

A brief documentation to get up and running with this reporter

Installation

Install with npm:

npm install --save-dev testcafe-reporter-allure-plus

Configuration

TestCafé

When you run tests from the command-line, specify the reporter name by using the --reporter flag:

testcafe chrome 'path/to/test/file.js' --reporter allure-plus

When you use API, pass the reporter name to the reporter() method:

testCafe
    .createRunner()
    .src('path/to/test/file.js')
    .browsers('chrome')
    .reporter('allure-plus') // <-
    .run();

When using a general configuration file for TestCafe, use the reporter attribute:

{
    ...
    "reporter": {
        "name": "allure-plus"
    },
    ...
}

Allure

testcafe-reporter-allure-plus as its based on @Isaac's changes, provides a default configuration that can be overriden with the use of allure.config.js file, in the root of your directory. The defaults for this file (allure.config.js) are the following:

module.exports = {
  REPORTER_CONFIG_FILE: './allure.config.js',
  CATEGORIES_CONFIG_FILE: './allure-categories.config.js',

  RESULT_DIR: './allure/allure-results',
  REPORT_DIR: './allure/allure-report',
  SCREENSHOT_DIR: './allure/screenshots',

  CLEAN_RESULT_DIR: true,
  CLEAN_REPORT_DIR: true,
  CLEAN_SCREENSHOT_DIR: true,

  ENABLE_SCREENSHOTS: true,
  ENABLE_QUARANTINE: false,
  ENABLE_LOGGING: false,
  CONCURRENCY: 1,

  META: {
    SEVERITY: 'Normal',
    PRIORITY: 'Medium',
    JIRA_URL: 'https://jira.example.nl/browse/',
  },
  LABEL: {
    ISSUE: 'JIRA Test Case',
    EPIC: 'JIRA Epic',
    STORY: 'JIRA User Story',
    FLAKY: 'Flaky test',
    SCREENSHOT_MANUAL: 'Screenshot taken manually',
    SCREENSHOT_ON_FAIL: 'Screenshot taken on fail',
    DEFAULT_STEP_NAME: 'Test Step',
  },
};

And, the defaults for allure-categories.config.js are the following:

module.exports = [
  {
    name: 'Ignored tests',
    matchedStatuses: [Status.SKIPPED],
  },
  {
    name: 'Product defects',
    matchedStatuses: [Status.FAILED],
    messageRegex: '.*Assertion failed.*',
  },
  {
    name: 'Test defects',
    matchedStatuses: [Status.FAILED],
  },
  {
    name: 'Warnings',
    matchedStatuses: [Status.PASSED],
    messageRegex: '.*Warning.*',
  },
  {
    name: 'Flaky tests',
    matchedStatuses: [Status.PASSED, Status.FAILED],
    messageRegex: '.*Flaky.*',
  },
];

Metadata

Metadata can be added to a test using the meta() function. The metadata can be added to both test and fixture

Metadata added to the fixture will be inherited by all tests coupled in that fixture to avoid declaring metadata that is the same for all tests within the fixture multiple times.

This is a general example of the metadata added:

test.meta({
  severity: Severity.TRIVIAL,
  issue: 'TEST-ISSUE',
  description: 'An example discription',
  epic: 'Example Epic Ticket',
  feature: 'Example Feature Ticket',
  story: 'Example Story Ticket',
  suite: 'Main Example Group',
  // ... any other key: value property as custom metadata
})('Example test with metadata', async (t) => {
  // Test Code
});

Important: Know that issue, epic, feature and story can generate links ONLY if they have the Jira ID encased in square brackets, for example: epic: '[EX-00001] Example Epic Ticket', will generate a link to [JIRA_URL]/EX-00001

Steps

With this reporter, test-steps can be defined to split a test into multiple step. The step function expects three values: the step name, the TestController and the actions taken within the step as a TestControllerPromise.

import step from 'testcafe-reporter-allure-plus/dist/utils';

test("Example test with steps", async t => {
  await step("Add developer name to form", t, 
    t.typeText("#developer-name", "Jhon Smith")
  );
  await step("Submit form and check result", t,
    t.click("#submit-button")
      .expect(Selector("#article-header").innerText)
      .eql("Thank you, John Smith!")
  );
})

License

As we are basing our modifications on Isaac's work, our License as of yet would be MIT