TestRail API wrapper using promises
npm install testrail-promise
var TestRail = require("testrail-promise");
var tr = new TestRail("", "", "");
`
Simple Use Cases
`
//Getting all Projects
tr.getProjects()
.then(function(projects) { ... })
.catch(function(err) { ... });
//Getting a specific project
tr.getProject({"project_id":6})
.then(function(project) { ... })
.catch(function(err) { ... });
//Getting test cases
tr.getCases({"project_id":"6", "suite_id":"6", "section_id":"173"})
.then(function(case) { ... })
.catch(function(err) { ... });
`
Automation Use Case
If automated test (Protractor/Karma/...) results are wanted in TestRail use this function.
`
var obj = {
"project_name":"",
"plan_name":"",
"section_name":"",
"title":"",
<br /> "status_name":"<passed/failed/retest/blocked>"
<br />};
<br />tr.ifNeededCreateThenAddResultForCase(obj)
<br /> .then(function (result) { ... })
<br /> .catch(function (err) { ... });
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />This will create a test case under the specific section if one does not exist, then update the result to the most recent run of a test plan.
<br />It will query using the API to get IDs hence names can be used as long as they are <strong>unique</strong>. The only required information is: project (</code>project_id<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">/</code>project_name<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">), plan(</code>plan_id<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">/</code>plan_name<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">),section(</code>section_id<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">/</code>section_name<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">), </code>title<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">(can use </code>case_id<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> if case already exists) and status(</code>status_id<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">/</code>status_name<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">).
<br />
<br />Jasmine considers showing results within a tests a leak, so we have to use a <a href="http://jasmine.github.io/2.1/custom_reporter.html" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">custom reporter</a> to get results. Usually, we would send the results in a </code>specDone<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> function, but it is not asynchronous therefore I suggest adding an object onto the </code>jasmine<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> var. Here is an example of how to report tests in Protractor:
<br />
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />resultLeaker = {
<br /> suiteStarted: function(result){ jasmine.results = {suite:result}; },
<br /> specStarted: function(result){ jasmine.results.spec = result; }
<br />};
<br />jasmine.getEnv().addReporter(resultLeaker);
<br />
<br />describe('TestRail Reporter', function(){
<br /> it('Passing', function(){
<br /> expect(true).toBeTruthy();
<br /> });
<br /> it('Failing', function(){
<br /> expect(false).toBeTruthy();
<br /> });
<br />
<br /> var TestRail = require("testrail-promise");
<br /> var tr = new TestRail("<url>", "<user email>", "<password/apikey>");
<br />
<br /> afterEach(function(done){
<br /> var obj = {
<br /> "project_name":"<project name>",
<br /> "plan_name":"<test plan>",
<br /> "section_name":"<section/test case folder>",
<br /> "title":jasmine.results.spec.fullName,
<br /> "status_name":(jasmine.results.spec.failedExpectations.length === 0 ? "passed" : "failed")
<br /> };
<br /> tr.ifNeededCreateThenAddResultForCase(obj).finally(function(){
<br /> done();
<br /> });
<br /> });
<br />});
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">Additional Information</h2>
<br />
<br />All functions that need input take just one object. It uses what is needed for the API URI then sends the object to the API. This means you should be able to use any field available in the API documentation.
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />var object = {
<br /> "section_id":173,
<br /> "title":"testrail-promise",
<br /> "type_id":3,
<br /> "project_id":6,
<br /> "estimate":1,
<br /> "milestone_id":3,
<br /> "refs":""
<br />};
<br />tr.addCase(object);
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />If for some reason the cert on TestRail is not trusted, this function can be called to ignore that error.
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />tr.allowUntrustedCertificate();
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />If you want to get errors on non-200 responses change to simple requests.
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />tr.simpleRequests();
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />The functions that allow filters (
<br /><a href="http://docs.gurock.com/testrail-api2/reference-cases#get_cases" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_cases</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-milestones#get_milestones" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_milestones</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-plans#get_plans" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_plans</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-projects#get_projects" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_projects</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-results#get_results" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_results</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-results#get_results_for_case" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_results_for_case</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-results#get_results_for_run" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_results_for_run</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-runs#get_runs" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_runs</a>
<br />, <a href="http://docs.gurock.com/testrail-api2/reference-tests#get_tests" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">get_tests</a>
<br />)
<br />can have as part of their parameter object a </code>filters<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> object.
<br />
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />tr.getPlans({
<br /> project_id : 1,
<br /> filters: {
<br /> is_completed : 0
<br /> }
<br />})
<br /></code>``
<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:3"></template><template id="P:4"></template></div></div></div><script>self.__next_f.push([1,"26:[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-wrench h-4 w-4\",\"children\":[[\"$\",\"path\",\"cbrjhi\",{\"d\":\"M14.7 6.3a1 1 0 0 0 0 1.4l1.6 1.6a1 1 0 0 0 1.4 0l3.77-3.77a6 6 0 0 1-7.94 7.94l-6.91 6.91a2.12 2.12 0 0 1-3-3l6.91-6.91a6 6 0 0 1 7.94-7.94l-3.76 3.76z\"}],\"$undefined\"]}]\n27:[\"$\",\"span\",null,{\"data-slot\":\"badge\",\"className\":\"inline-flex items-center justify-center rounded-md border px-2 py-0.5 font-medium w-fit whitespace-nowrap shrink-0 [\u0026\u003esvg]:size-3 gap-1 [\u0026\u003esvg]:pointer-events-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive transition-[color,box-shadow] overflow-hidden border-transparent bg-secondary text-secondary-foreground [a\u0026]:hover:bg-secondary/90 ml-auto text-xs\",\"children\":1}]\n28:[\"$\",\"div\",null,{\"data-slot\":\"card-content\",\"className\":\"px-6\",\"children\":[\"$\",\"div\",null,{\"className\":\"grid gap-1 sm:grid-cols-2 lg:grid-cols-3\",\"children\":[[\"$\",\"$L5\",\"jasmine\",{\"href\":\"/package/jasmine\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"jasmine\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"2.x\"}]]}]]}]}]\n"])</script><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><script>$RC("B:1","S:1")</script></body></html>