testrail-api


> An API wrapper for TestRail with error handling and unit testing.

The TestRail API is described here.

Usage

First, you will have to initialize the API wrapper :

``javascript
var Testrail = require('testrail-api');

var testrail = new Testrail({
host: 'https://rundef.testrail.com',
user: 'username',
password: 'password or api key'
});
`

Callback

Working with callbacks gives you three parameters: error, response and body in this order
`javascript
function (err, response, body)
`
error is null when nothing unexpected happened.

response contains data like the status code.

body contains the response body the server sent back.

Promises

Working with Promises gives you response and body like this
`javascript
.then(function (result) {
console.log(result.response);
console.log(result.body);
})
.catch(function (error) {
console.log(error.response);
console.log(error.message);
});
`

$3

> List cases

`javascript
testrail.getCases(/PROJECT_ID=/1, /FILTERS=/{ suite_id: 3, section_id: 4 }, function (err, response, cases) {
console.log(cases);
});
`

You can also use Promises with all the functions:

`javascript
testrail.getCases(1)
.then(function (result) {
console.log(result.body);
}).catch(function (error) {
console.log('error', error.message);
});
`

> Get a case

`javascript
testrail.getCase(/CASE_ID=/1, function (err, response, testcase) {
console.log(testcase);
});
`

> Add a case

`javascript
testrail.addCase(/SECTION_ID=/1, /CONTENT=/{}, function (err, response, testcase) {
console.log(testcase);
});
`

> Update a case

`javascript
testrail.updateCase(/CASE_ID=/1, /CONTENT=/{}, function (err, response, testcase) {
console.log(testcase);
});
`

> Delete a case

`javascript
testrail.deleteCase(/CASE_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

> List case fields

`javascript
testrail.getCaseFields(function (err, response, caseFields) {
console.log(caseFields);
});
`

$3

> List case types

`javascript
testrail.getCaseTypes(function (err, response, caseTypes) {
console.log(caseTypes);
});
`

$3

> List configurations

`javascript
testrail.getConfigs(/PROJECT_ID=/1, function (err, response, configs) {
console.log(configs);
});
`

> Add a configuration group

`javascript
testrail.addConfigGroup(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, config_group) {
console.log(config_group);
});
`

> Add a configuration

`javascript
testrail.addConfig(/CONFIGURATION_GROUP_ID=/1, /CONTENT=/{}, function (err, response, config) {
console.log(config);
});
`

> Update a configuration group

`javascript
testrail.updateConfigGroup(/CONFIGURATION_GROUP_ID=/1, /CONTENT=/{}, function (err, response, config_group) {
console.log(config_group);
});
`

> Update a configuration

`javascript
testrail.updateConfig(/CONFIGURATION_ID=/1, /CONTENT=/{}, function (err, response, config) {
console.log(config);
});
`

> Delete a configuration group

`javascript
testrail.deleteConfigurationGroup(/CONFIGURATION_GROUP_ID=/1, function (err, response, body) {
console.log(body);
});
`

> Delete a configuration

`javascript
testrail.deleteConfig(/CONFIGURATION_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

> List milestones

`javascript
testrail.getMilestones(/PROJECT_ID=/1, /FILTERS=/{}, function (err, response, milestones) {
console.log(milestones);
});
`

> Get a milestone

`javascript
testrail.getMilestone(/MILESTONE_ID=/1, function (err, response, milestone) {
console.log(milestone);
});
`

> Add a milestone

`javascript
testrail.addMilestone(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, milestone) {
console.log(milestone);
});
`

> Update a milestone

`javascript
testrail.updateMilestone(/MILESTONE_ID=/1, /CONTENT=/{}, function (err, response, milestone) {
console.log(milestone);
});
`

> Delete a milestone

`javascript
testrail.deleteMilestone(/MILESTONE_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

> List plans

`javascript
testrail.getPlans(/PROJECT_ID=/1, /FILTERS=/{}, function (err, response, plans) {
console.log(plans);
});
`

> Get a plan

`javascript
testrail.getPlan(/PLAN_ID=/1, function (err, response, plan) {
console.log(plan);
});
`

> Add a plan

`javascript
testrail.addPlan(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, plan) {
console.log(plan);
});
`

> Add a plan entry

`javascript
testrail.addPlanEntry(/PLAN_ID=/1, /CONTENT=/{}, function (err, response, plan_entry) {
console.log(plan_entry);
});
`

> Update a plan

`javascript
testrail.updatePlan(/PLAN_ID=/1, /CONTENT=/{}, function (err, response, plan) {
console.log(plan);
});
`

> Update a plan entry

`javascript
testrail.updatePlanEntry(/PLAN_ID=/1, /PLAN_ENTRY_ID=/2, /CONTENT=/{}, function (err, response, plan_entry) {
console.log(plan_entry);
});
`

> Close a plan

`javascript
testrail.closePlan(/PLAN_ID=/1, function (err, response, plan) {
console.log(plan);
});
`

> Delete a plan

`javascript
testrail.deletePlan(/PLAN_ID=/1, function (err, response, body) {
console.log(body);
});
`

> Delete a plan entry

`javascript
testrail.deletePlanEntry(/PLAN_ID=/1, /PLAN_ENTRY_ID=/2, function (err, response, body) {
console.log(body);
});
`

$3

`javascript
testrail.getPriorities(function (err, response, priorities) {
console.log(priorities);
});
`

$3

> List projects

`javascript
testrail.getProjects(/FILTERS=/{}, function (err, response, projects) {
console.log(projects);
});
`

> Get a project

`javascript
testrail.getProject(/PROJECT_ID=/1, function (err, response, project) {
console.log(project);
});
`

> Add a project

`javascript
testrail.addProject(/CONTENT=/{}, function (err, response, project) {
console.log(project);
});
`

> Update a project

`javascript
testrail.updateProject(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, project) {
console.log(project);
});
`

> Delete a project

`javascript
testrail.deleteProject(/PROJECT_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

> Get results

`javascript
testrail.getResults(/TEST_ID=/1, /FILTERS=/{}, function (err, response, results) {
console.log(results);
});
`

> Get results for case

`javascript
testrail.getResultsForCase(/RUN_ID=/1, /CASE_ID=/2, /FILTERS=/{}, function (err, response, results) {
console.log(results);
});
`

> Get results for run

`javascript
testrail.getResultsForRun(/RUN_ID=/1, /FILTERS=/{}, function (err, response, results) {
console.log(results);
});
`

> Add a result

`javascript
testrail.addResult(/TEST_ID=/1, /CONTENT=/{}, function (err, response, result) {
console.log(result);
});
`

> Add a result for case

`javascript
testrail.addResultForCase(/RUN_ID=/1, /CASE_ID=/2, /CONTENT=/{}, function (err, response, result) {
console.log(result);
});
`

> Add results

`javascript
testrail.addResults(/RUN_ID=/1, /CONTENT=/{}, function (err, response, results) {
console.log(results);
});
`

> Add results for cases

`javascript
testrail.addResultsForCases(/RUN_ID=/1, /CONTENT=/{}, function (err, response, results) {
console.log(results);
});
`

$3

`javascript
testrail.getResultFields(function (err, response, resultFields) {
console.log(resultFields);
});
`

$3

> List runs

`javascript
testrail.getRuns(/PROJECT_ID=/1, /FILTERS=/{}, function (err, response, runs) {
console.log(runs);
});
`

> Get a run

`javascript
testrail.getRun(/RUN_ID=/1, function (err, response, run) {
console.log(run);
});
`

> Add a run

`javascript
testrail.addRun(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, run) {
console.log(run);
});
`

> Update a run

`javascript
testrail.updateRun(/RUN_ID=/1, /CONTENT=/{}, function (err, response, run) {
console.log(run);
});
`

> Close a run

`javascript
testrail.closeRun(/RUN_ID=/1, function (err, response, run) {
console.log(run);
});
`

> Delete a run

`javascript
testrail.deleteRun(/RUN_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

> List sections

`javascript
testrail.getSections(/PROJECT_ID=/1, /FILTERS=/{}, function (err, response, sections) {
console.log(sections);
});
`

> Get a section

`javascript
testrail.getSection(/SECTION_ID=/1, function (err, response, section) {
console.log(section);
});
`

> Add a section

`javascript
testrail.addSection(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, section) {
console.log(section);
});
`

> Update a section

`javascript
testrail.updateSection(/SECTION_ID=/1, /CONTENT=/{}, function (err, response, section) {
console.log(section);
});
`

> Delete a section

`javascript
testrail.deleteSection(/SECTION_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

`javascript
testrail.getStatuses(function (err, response, statuses) {
console.log(statuses);
});
`

$3

> List suites

`javascript
testrail.getSuites(/PROJECT_ID=/1, function (err, response, suites) {
console.log(suites);
});
`

> Get a suite

`javascript
testrail.getSuite(/SUITE_ID=/1, function (err, response, suite) {
console.log(suite);
});
`

> Add a suite

`javascript
testrail.addSuite(/PROJECT_ID=/1, /CONTENT=/{}, function (err, response, suite) {
console.log(suite);
});
`

> Update a suite

`javascript
testrail.updateSuite(/SUITE_ID=/1, /CONTENT=/{}, function (err, response, suite) {
console.log(suite);
});
`

> Delete a suite

`javascript
testrail.deleteSuite(/SUITE_ID=/1, function (err, response, body) {
console.log(body);
});
`

$3

`javascript
testrail.getTemplates(/PROJECT_ID=/1, function (err, response, template) {
console.log(template);
});
`

$3

> List tests

`javascript
testrail.getTests(/RUN_ID=/1, /FILTERS=/{}, function (err, response, tests) {
console.log(tests);
});
`

> Get a test

`javascript
testrail.getTest(/TEST_ID=/1, function (err, response, test) {
console.log(test);
});
`

$3

> List users

`javascript
testrail.getUsers(/FILTERS=/{}, function (err, response, users) {
console.log(users);
});
`

> Get a user

`javascript
testrail.getUser(/USER_ID=/1, function (err, response, user) {
console.log(user);
});
`

> Get a user by email

`javascript
testrail.getUserByEmail(/EMAIL=/'test@gmail.com', function (err, response, user) {
console.log(user);
});
``