Package Exports
- tesults
- tesults/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tesults) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Tesults
Tesults is a test automation results reporting service. https://www.tesults.com
Tesults API library for uploading test results to Tesults in your node application.
Installation
npm install tesults --save
Configuration
var tesults = require('tesults');Documentation
Documentation is available at https://www.tesults.com/docs.
API Overview
Upload test results using the results method:
tesults.results(data, function (err, response) {
// err is undefined unless there is a library error
// response.success is a bool, true if results successfully uploaded, false otherwise
// response.message is a string, if success is false, check message to see why upload failed
// response.warnings is an array, empty if no warnings
// response.errors is an array, empty if no errors
});The data param in results is an object containing your test results in the form:
var data = {
target: 'token',
results: {
cases: [
{
name: 'Test 1',
desc: 'Test 1 description.',
suite: 'Suite A',
result: 'pass'
},
{
name: 'Test 2',
desc: 'Test 2 description.',
suite: 'Suite A',
result: 'fail',
reason: 'Assert fail in line 203, example.js'
},
{
name: 'Test 3',
desc: 'Test 3 description.',
suite: 'Suite B',
result: 'pass',
params: {
param1: 'value1',
param2: 'value2'
},
files: ['/path/to/file/log.txt', '/path/to/file/screencapture.png']
}
]
}
}The target value, 'token' above should be replaced with your Tesults target token. If you have lost your token you can regenerate one at https://www.tesults.com/config. The cases array should contain your test cases.