testrail-api-client

testrail-api-client

TypeScript (JavaScript) client for TestRail API v2

Installing

Using npm:

$ npm install testrail-api-client

Using yarn:

$ yarn add testrail-api-client

Example

note: CommonJS usage

Using Environment Variables:

const client = require('testrail-api-client');

Using Custom Options:

const client = require('testrail-api-client').default;

const options = {
    domain: "example.testrail.com",
    username: "[e-mail]",
    password: "ABC",
    projectId: 1
};

const client_options = new client(options);

addRun

client.addRun("Example Run", "Example Description", 123, [1,2,3])
  .then(function (runId) {
      console.log(`Created run with id: ${runId}`)
  })
  .catch(error => console.error(error));

getCasesFromRun

client.getCasesFromRun(123)
  .then(function (cases) {
      console.log(`Number of cases from run #${runId}: ${cases.length}`)
  })
  .catch(error => console.error(error));

closeRun

client.closeRun(123)
  .then(console.log(`Closed run with id: ${runId}`))
  .catch(error => console.error(error));

closeRun

client.getCases(suiteId)
  .then(function (cases) {
      console.log(`Number of cases in suiteid=${suiteId}: ${cases.length}`);
  })
  .catch(error => console.error(error));

Environment variables

Variable	Description
TESTRAIL_DOMAIN	This is a required variable to point the client to your TestRail instance. Required Example: example.testrail.com
TESTRAIL_USERNAME	This is a required variable to authenticate HTTP communication. Required Example: [e-mail]
TESTRAIL_APIKEY	This is a required variable to authenticate HTTP communication. Can be obtained in TestRail settings, see [http://docs.gurock.com/testrail-api2/accessing]. Required Example: ABC
TESTRAIL_PROJECTID	This is a required variable to point client to the right project. Required Example: 1