@skills17/test-result

skills17/test-result

This package commonly generates and converts test results. It can be used to abstract logic for the different testing library helper packages.

Table of contents

• Installation
• Usage
  • Specific test overrides
  • Converting to JSON
• License

Installation

npm install @skills17/test-result

Usage

First, create a new instance for every test run:

import { TestRun, Group, Strategy, Override } from '@skills17/test-result';

const run = new TestRun();

After that, you have to define and add all test groups:

/**
 * Group constructor:
 *
 * @param {string}    match           Tests that match this regular expression
 *                                    get added to the group
 * @param {number}    defaultPoints   Points a test within this group will award
 *                                    by default
 * @param {Strategy}  strategy        Either Strategy.Add or Strategy.Deduct
 * @param {string}    [displayName]   Group name that should be used in outputs
 * @param {number}    [maxPoints]     Only for the deduct strategy, a point maximum
 *                                    can be set
 */

run.addGroup(new Group('CountriesIndex.+', 1, Strategy.Add));

Once all groups have been added, you can start recording tests:

/**
 * recordTest method:
 *
 * @param {string}    fullName    Full test name including all groups
 * @param {string}    testName    Test name only that is used for display
 * @param {boolean}   extra       Whether it is an extra test or not
 * @param {boolean}   successful  Whether the test was successful or not
 * @returns {Group}               Group that matched or false if no matching group was found
 */

run.recordTest('Countries > IndexAll', 'IndexAll', false, true);

The difference between fullName and testName is that fullName should include all groups (the name of the describe() or context() calls) as well as the actual test name (it() or test() calls) while the testName is only the actual test name (it() or test()). fullName will then be used to match against a group and testName will be used for displaying the result.

After that, points and everything else will get calculated automatically. To get an overview of available getters and other functions, take a look at the class implementations.

Specific test overrides

If specific tests should award more points or have to pass in order that the whole group passes, overrides can be defined on a group.

/**
 * Override constructor:
 *
 * @param {string}  match             The override applies to all tests
 *                                    that match this regular expression
 * @param {boolean} [required=false]  If the test is required for the whole
 *                                    group to pass
 * @param {boolean} [points]          Points this test awards
 */

group.addOverride(new Override('CountriesIndexJson', true, 0));

Converting to JSON

The whole test run can simply be converted to JSON by passing the object to the JSON.stringify function:

JSON.stringify(run);

License

MIT