Node.js test reporting

Test case properties

This is a complete list of test case properties for reporting results. The required fields must have values otherwise upload will fail with an error message about missing fields.

Build properties

To report build information simply add another case added to the cases array with suite set to [build]. This is a complete list of build properties for reporting results. The required fields must have values otherwise upload will fail with an error message about missing fields.

Files generated by tests

The example above demonstrates how to upload files for each test case. In practice you would generate the array of file paths for each test case programatically.

To make this process simpler we suggest you write a helper function to extract files for each test case and this can be easily achieved by following a couple of simple conventions when testing.

1. Store all files in a temporary directory as your tests run. After Tesults upload is complete you can delete the temporary directory or overwrite it on the next test run.

2. Within this temporary directory create subdirectories for each test case so that files for each test case are easily mapped to a particular test case.

Then all your helper function needs to do is take the test name and/or suite as parameters and return an array of files for that particular test case.

const tesults = require('tesults');
const fs = require('fs');
const temp = '/files-temp-dir';

function filesForTestSync (suite, testCase) {
  let filePaths = [];
  let dir =  temp + "/" + suite + "/" + testCase;
  let files = [];
  try {
    files = fs.readdirSync(dir);
  } catch (error) {
     // dir may not exist
  }
  files.forEach(function (file) {
    if (file !== ".DS_Store") { // Exclude os files
      filePaths.push(dir + "/" + file);
    }
  });
  return filePaths;
}

//testCase.files = filesForTestSync(testCase.suite, testCase.name);

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.

Consolidating parallel test runs

If you execute multiple test runs in parallel or serially for the same build or release and results are submitted to Tesults within each run, separately, you will find that multiple test runs are generated on Tesults. This is because the default behavior on Tesults is to treat each results submission as a separate test run. This behavior can be changed from the configuration menu. Click 'Results Consolidation By Build' from the Configure Project menu to enable and disable consolidation by target. Enabling consolidation will mean that multiple test runs submitted with the same build name will be consolidated into a single test run.

Dynamically created test cases

If you dynamically create test cases, such as test cases with variable values, we recommend that the test suite and test case names themselves be static. Provide the variable data information in the test case description or other custom fields but try to keep the test suite and test name static. If you change your test suite or test name on every test run you will not benefit from a range of features Tesults has to offer including test case failure assignment and historical results analysis. You need not make your tests any less dynamic, variable values can still be reported within test case details.

Proxy servers

Does your corporate/office network run behind a proxy server? Contact us and we will supply you with a custom API Library for this case. Without this results will fail to upload to Tesults.