Mocha test reporting

Install the mocha-tesults-reporter

npm install mocha-tesults-reporter --save

Now that the mocha-tesults-reporter is installed you have to have Mocha use it. This is done using Mocha's --reporter arg. In your package.json file add this snippet:

"scripts": {
  "test": "mocha * --reporter mocha-tesults-reporter -- tesults-target=token"
}

Then run Mocha as usual with the npm test command. Use npm run script-name if you named the script something other than test in the package.json. If running mocha from the commandline run:

mocha * --reporter mocha-tesults-reporter -- tesults-target=token

The 'token' above should be replaced with your Tesults target token, which you received when creating a project or target, and can be regenerated from the configuration menu. The * after mocha is telling Mocha to run all tests it finds, you may want to narrow this down, see Mocha docs for more details.

To supply multiple args to the reporter use this format:

mocha * --reporter mocha-tesults-reporter -- arg1=val1 arg2=val2 arg3=val3

for example:

mocha * --reporter mocha-tesults-reporter
 -- tesults-target=token tesults-files=path tesults-config=configpath

The reporter treats the describe as a test suite and each it as a test case.

const assert = require('assert');

describe('SuiteA', function() {
  it("Test1", function () {
     assert.equal(2, 2);
  });

  it("Test2", function () {
     assert.equal(1, 2);
  });
});

describe('SuiteB', function() {
  it("Test3", function () {
     assert.equal(3, 3);
  });
});

Using Protractor? The configuration instructions above do not apply. Follow the Protractor configuration instructions instead and then return here to continue.

tesults-targetRequired

Required arg to upload to Tesults, if this arg is not provided the reporter does not attempt upload, effectively disabling it. Get your target token from the configuration menu in the Tesults web interface.

Inline method

tesults-target=eyJ0eXAiOiJ...

In this case, the target token is supplied directly or inline in the commandline args. This is the simplest approach.

Key method

tesults-target=target1

In this case, the reporter will automatically look up the value of the token from a config.json file. See below for more details.

tesults-configOptional

You can optionally provide a path to a config.json file. Configuration json files make it possible to store many targets and have one selected with the tesults-target arg (see above). All args other than tesults-target and tesults-config can be supplied in a config.json file instead of the mocha command, including the file and build related args detailed below.

Example contents of a config.json:

{
  "target1": "eyJ0eXAiOiJKV1QiLCJhb1",
  "target2": "eyJ0eXAiOiJKV1QiLCJhb2",
  "target3": "eyJ0eXAiOiJKV1QiLCJhb3",
  "target4": "eyJ0eXAiOiJKV1QiLCJhb4",
}

Or something more descriptive about the targets:

{
  "web-qa-env": "eyJ0eXAiOiJKV1QiLCJhb1",
  "web-staging-env": "..."
  "web-prod-env": "..."
  "ios-qa-env": "eyJ0eXAiOiJKV1QiLCJhb2",
  "ios-staging-env": "..."
  "web-prod-env": "..."
  "android-qa-env": "eyJ0eXAiOiJKV1QiLCJhb3",
  "android-staging-env": "..."
  "android-prod-env": "..."
}

Use the Tesults reporter to report additional properties for each test case. To begin doing this, require the reporter in your test file:

const tesultsReporter = require("mocha-tesults-reporter")

Report custom fields, test steps and attach files to test cases using the Tesult reporter functions: description, custom, step, and file. Call reporter functions from within your tests (test block). The first parameter is always the test state to provide the reporter with context about the test:

description

Add a description of the test case for reporting purposes.

tesultsReporter.description(this.test, "some description here")

custom

Add a custom field and value to the test case for reporting purposes.

tesultsReporter.custom(this.test, "Some custom field", "Some custom value")

file

Associate a file to the test case in order to upload it for reporting.

tesultsReporter.file(this.test, "/full/path/to/file/screenshot.png")

Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

step

Add test steps to the test case for reporting. Each step is an object with a name and result (one of [pass, fail, unknown]). You can also add the optional fields description and reason (failure reason in case of step fail).

tesultsReporter.step(this.test, {
  name: "First step",
  result: "pass"
})
tesultsReporter.step(this.test, {
  name: "Second step",
  description: "Second step description",
  result: "fail"
  reason: "Error line 203 of test.js"
})

const tesultsReporter = require("mocha-tesults-reporter")

describe ('Suite A', () => {
  test('Test 1', () => {
    tesultsReporter.custom(this.test, "custom field 1", "custom value 1")
    tesultsReporter.description(this.test, "description here")
    tesultsReporter.step(this.test,
    {name: "step 1", description: "step 1 description", result: "pass"})
    tesultsReporter.step(this.test,
    {name: "step 2", description: "step 2 description", result: "pass"})
    tesultsReporter.file(this.test, "/full/path/logs/log1.txt")
  });
});

This method of uploading files is no longer recommended starting from mocha-tesults-reporter 1.3.0+. If using mocha-tesults-reporter 1.3.0 or newer, utilize the file method described above to simplify uploading files from tests.

tesults-filesOptional

Provide this arg to save files generated during a test run. The value for this arg is the top-level directory where files generated during testing are saved for the running test run. Files, including logs, screen captures and other artifacts will be automatically uploaded.

tesults-files=/Users/admin/Desktop/temporary

This is one area where the mocha-tesults-reporter is opinionated and requires that files generated during a test run be saved locally temporarily within a specific directory structure.

Store all files in a temporary directory as your tests run. After Tesults upload is complete, delete the temporary directory or just have it overwritten on the next test run.

Within this temporary directory create subdirectories matching the test suite (describe) and test case (it) name.

Be aware that if providing build files, the build suite is always set to [build] and files are expected to be located in temporary/[build]/buildname

Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

• temporary folder
• Test Suite A
• Test 1
• test.log
• screenshot.png
• Test 2
• test.log
• screenshot.png
• Test Suite B
• Test 3
• metrics.csv
• error.log
• Test 4
• test.log

tesults-build-nameOptional

Use this to report a build version or name for reporting purposes.

tesults-build-name=1.0.0

tesults-build-resultOptional

Use this to report the build result, must be one of [pass, fail, unknown].

tesults-build-result=pass

tesults-build-descriptionOptional

Use this to report a build description for reporting purposes.

tesults-build-description='added new feature'

tesults-build-reasonOptional

Use this to report a build failure reason.

tesults-build-reason='build error line 201 somefile.js'

Result interpretation is supported by Mocha. Install version 1.2.0 or newer. If you use result interpretation we recommend you add these minimum mapping values: