aft-jest-reporter

AFT-Jest-Reporter

a Jest Reporter integration for AFT providing support for AFT plugins, configuration and helpers

Installation

> npm i aft-jest-reporter

Jest Configuration

using this Reporter requires either calling the jest command with the following argument --reporters"default" --reporters="aft-jest-reporter" or from within your Jest config file using the following:

// jest.config.js
module.exports = {
    reporters: [
        'default',
        ["<rootDir>/node_modules/aft-jest-reporter/dist/src/aft-jest-reporter.js", { useReporter: true }]
    ]
};

AFT Configuration

while no configuration is required, the aft-jest-reporter supports all AFT configuration via an aftconfig.json file in the root directory.

AFT Helpers

this package comes with two helper classes that can be utilised from within your Jest specs to make use of AFT features.

AftJestTest

the AftJestTest class extends from the AftTest class providing the ability to parse the Spec name for any referenced Test. each Test ID must be surrounded with square brackets [ABC123]. additionally you can then call the AftJestTest.shouldRun() async function or use aftJestTest(expect, testFunction) which will determine if your test should be run based on any AFT PolicyPlugin instances referenced in your aftconfig.json file. using the AftJestTest class would look like the following:

describe('YourTestSuite', () => {
    test('can check if test [C1234] should be run', async () => {
        await aftJestTest(expect, async (v: AftJestTest) => { // passing 'expect' allows AftJestTest to get the current test full name
            await aft.reporter.step('we should never get here if C1234 should not be run');
            const result = await doStuff();
            await v.verify(result, equaling('stuff'));
        })
    });
});

which would output the following to your console and any AFT ReportingPlugin instances referenced in your aftconfig.json if the test ID should not be run:

17:52:45 - [YourTestSuite can check if test [C1234] should be run] - WARN - none of the supplied tests should be run: [C1234]
17:52:45 - [YourTestSuite can check if test [C1234] should be run] - WARN - test skipped

NOTES

• because Jest refuses to allow programmatic skipping of tests (see: 7245) you will either need to perform all test verification inside an AFTs AftTest or if using AftJestTest you may call if (await new AftJestTest(expect).shouldRun().result !== true) { return; } at the top of your test function to ensure AFT can skip tests that should not be run based on any PolicyPlugin responses. this means Jest will report the test as 'passing', but AFT will correctly report 'skipped'
• this Jest Reporter expects that there is only one instance of Jest running from a single location as it writes to a file to track the actual status of the test on completion