GlaceJS

Module: reporter/testrail

TestRail reporter publishs test results to remote testrail server via its API.

Source:

Methods

processErrors(errors)

Entry point to process test errors before testrail publication. Can be overridden with custom function.

Parameters:
Name Type Description
errors Array.<string>

List of test errors.
Source:
Returns:
  • Test errors info, attaching to test comment.
Type
string
Example

Overriding with custom function

// should be after configuration but before tests run
const testrail = require("glace-core/lib/reporter/testrail");
testrail.processErrors = myFuncToProcessErrors;

processExtras(extras)

Entry point to process test extra details before testrail publication. Can be overridden with custom function.

Parameters:
Name Type Description
extras Array.<string>

List of extra details.
Source:
Returns:
  • Test extra details, attaching to test comment.
Type
string
Example

Overriding with custom function

// should be after configuration but before tests run
const testrail = require("glace-core/lib/reporter/testrail");
testrail.processExtras = myFuncToProcessExtras;

processScreens(screens)

Entry point to process test screenshot paths before testrail publication. Can be overridden with custom function.

Parameters:
Name Type Description
screens Array.<string>

List of screenshot paths.
Source:
Returns:
  • Test screenshots info, attaching to test comment.
Type
string
Example

Overriding with custom function

// should be after configuration but before tests run
const testrail = require("glace-core/lib/reporter/testrail");
testrail.processScreens = myFuncToProcessScreens;

processVideos(videos)

Entry point to process test video paths before testrail publication. Can be overridden with custom function.

Parameters:
Name Type Description
videos Array.<string>

List of video paths.
Source:
Returns:
  • Test videos info, attaching to test comment.
Type
string
Example

Overriding with custom function

// should be after configuration but before tests run
const testrail = require("glace-core/lib/reporter/testrail");
testrail.processVideos = myFuncToProcessVideos;

setComment()

Entry point to set comment of test before testrail publication. Can be overridden with custom function.

Source:
Returns:
  • Test comment.
Type
string
Example

Overriding with custom function

// should be after configuration but before tests run
const testrail = require("glace-core/lib/reporter/testrail");
testrail.setComment = myFuncToSetComment;