Nightwatch test reporting

Tesults supplies a reporter specifically designed for Nightwatch to make integration quick and easy.

Install nightwatch-tesults:

npm install nightwatch-tesults --save

In your nightwatch.conf.js file, under test_settings and any environment for which you are testing add a property called tesults (in this example the default environment is being used):

module.exports = {
  ...
  test_settings: {
    default: {
      ...
      globals: {
        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.

Then run your tests as usual and use the reporter parameter to use nightwatch-tesults:

npx nightwatch tests --reporter nightwatch-tesults

Files generated by tests

Any files attached during a test using the built-in Nightwatch screenshot mechanism (enabled in nightwatch.conf.js) will be automatically uploaded to Tesults for reporting.

module.exports = {
  ...
  test_settings: {
    default: {
      ...
      screenshots: {
        enabled: true
        path: 'screens'
        on_failure: true
      }
      ...
    }
  }
  ...
}

To upload other files, make use of the files property in the tesults object in the nightwatch.conf.js file. The value for this property is an absolute path to a directory where you store all of your test generated files during at test run. This directory can be temporary, after the test run has completed and files uploaded it can be deleted or overwritten.

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.

Handling multiple test jobs with targets

For supporting multiple test jobs Tesults suggests creating multiple targets, as outlined in the project structuring advice you can specify different target tokens for different environments within your nightwatch.conf.js file or even have multiple configuration files.

Full parameter list

module.exports = {
  ...
  test_settings: {
    default: {
      ...
      globals: {
        tesults: {
          target: token,
          build_name: "1.0.0",
          build_result: "pass",
          build_desc: "Build description",
          build_reason: "Build failure reason",
          files: "/full/path/to/temp/files/directory"
        }
      }
      ...
    }
  }
  ...
}

Target

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.

build_nameOptional

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

build_resultOptional

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

build_descOptional

Use this to report a build description for reporting purposes.

build_reasonOptional

Use this to report a build failure reason.

filesOptional

Absolute path to the folder containing additional files to upload. The directory structure must match the described layout in the 'Other files' section above.

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