WDIO-Cucumber-TestRail

Class: TestRail

TestRail~ TestRail

TestRail basic API wrapper

new TestRail(options)

Parameters:
Name Type Description
options Object

wdio TestRail specifc configurations

Properties
Name Type Argument Description
domain string

Domain for TestRail
projectId number

Project identifier
suiteId Array.<number>

List of suites identifiers
assignedToId number <optional>

User identifier
username string

User email
password string

User API key
includeAll Boolean

Flag to inlcude all tests from a suite in a run
updateRun number <optional>

Test run identifier for test run to update
updatePlan number <optional>

Test plan identifier for a test plan to update
Source:

Methods

addCasesToRun(runId, cases)

Adds test cases to a test run

Parameters:
Name Type Description
runId number

Run identifier
cases Array.<Object>

Test case data
Source:
Returns:

API response

Type
*

addPlan(name, desc, testRuns)

Creates a new test plan

Parameters:
Name Type Description
name string

Plan name
desc string

Plane description
testRuns Array.<Object>

Test runs
Source:
Returns:

API response

Type
*

addResultsForCases(runId, results)

Adds test results for a test cases

Parameters:
Name Type Description
runId number

Run identifier
results Array.<Object>

Test case results
Source:
Returns:

API response

Type
*

addRun(name, description, suiteId)

Adds a test run

Parameters:
Name Type Description
name string

Test run name
description string

Test run description
suiteId number

Suite id for test cases in this run
Source:
Returns:

API response

Type
*

addTestPlanEntry(planId, suiteId, name, desc, runs, caseIds)

Adds a test plan entry to the current project

Parameters:
Name Type Description
planId number

Plan identifier
suiteId number

Suite identifier
name string

Plan name
desc string

Plan name
runs Array.<Object>

Test runs
caseIds Array.<number>

Test case identifiers
Source:
Returns:

API response

Type
*

getPlan(planId)

Retrieves a test plan

Parameters:
Name Type Description
planId number

Plan identifier
Source:
Returns:

API response

Type
*

getSuite(suiteId)

Gets a suite

Parameters:
Name Type Description
suiteId number

Suite identifier
Source:
Returns:

API response

Type
*

getTestsForRun(runId)

Gets all the tests in a run

Parameters:
Name Type Description
runId number

Run identifier
Source:
Returns:

API response

Type
*

getTestsForSuite(projectId, suiteId)

Get test cases that belong to a suite

Parameters:
Name Type Description
projectId *

Project identifier
suiteId *

Suite identifier
Source:
Returns:

API response

Type
*

publish(name, description, results, callback)

Publishes results of execution of an automated test run

Parameters:
Name Type Description
name string

Test run/plan name
description string
results Array.<Object>
callback callback
Source:

updateTestPlanEntry(planId, entryId, caseIds)

Adds missing case ids to a test plan entry

Parameters:
Name Type Description
planId number

Plan identifier
entryId number

Entry identifier
caseIds Array.<number>

Test case identifiers
Source:
Returns:

API response

Type
*