Narrating Prophetic Monks

    testcafe-reporter-qatouch

    1.1.0 • Public • Published

    QA Touch

    Test Together

    Collaborative Test Case Management tool For Modern QA Teams

    QA Touch Reporter for TestCafe

    Pushes test results into QA Touch system.

    Installation

    You can install plugins from npm in two ways:

    ####Locally - If you are going to use plugins within TestCafe installed locally.

    Navigate to your project directory and run the following command.

    npm install --save-dev testcafe-reporter-qatouch

    ####Globally - If the TestCafe module is installed globally or you are going to use plugins within other projects as well.

    Run the npm install command with a -g flag.

    npm install -g testcafe-reporter-qatouch

    Usage

    Ensure that your QA Touch API is enabled and generate your API keys. See https://doc.qatouch.com/#qa-touch-api

    Add .env file to testcafe project root folder with the following keys:

    QATOUCH_DOMAIN=your-domain
    QATOUCH_API_TOKEN=your-api-token
    QATOUCH_PROJECT_KEY=Project-Key
    QATOUCH_TESTRUN_ID=Test-Run-Id

    In order to use reporter, you should add meta information to your tests. Meta key should be TRXXX ID (TestRun Code in qatouch), e.g.:

    test
        .meta({ 'TRID': ['TR001'] })
        ('My first test', async t => {
            await t
                .typeText('#developer-name', 'John Smith')
                .click('#submit-button')
                .expect(Selector('#article-header').innerText).eql('Thank you, John Smith!');
        });

    Note: TRID key in meta information must be in array format .meta({ 'TRID': ['TR001'] })

    Only passed, untested and failed tests will be published in QA Touch Test Run.

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

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

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

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

    Options

    domain: string domain name of your QA Touch instance (e.g. dckap)

    apiToken: string API token for user which will be created in the edit profile menu in your domain login

    projectKey: number project key with which the tests are associated

    testRunId: number test run Id with which the tests are associated

    References

    Install

    npm i testcafe-reporter-qatouch

    DownloadsWeekly Downloads

    3

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    11.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • qatouch