testrailmetrics

testrailmetrics package display the test metrics from the TestRail application.

Pre-Requisite

• NodeJS
• Visual Studio Code.

Installation

Create a node project

Create a package.json file using npm init -y command

Install the package using below command.

npm i testrailmetrics

Usage

getPassFail

This functions extracts the pass and fail count of the test runs/test plans present in a respective testrail project.

Pass the below arguments to the function to get the count

• Baseurl --> The URL of the testrail instance eg(https://pocmodule.testrail.io)
• TestRailuser--> TestRail User email id
• APIkey---> API Key for the respective Testrail User generated inside TestRail application
• projectId-->The ID of the project
• runId--->The ID of the test run.
• limit-->The number of test cases the response should return (The response size is 250 by default)
• Offset-->Where to start counting the tests cases from (the offset)

getautomationmanualcount

This functions extracts the manual and automation test cases count for a given project in the testrail application

Pass the below arguments to the function to get the count

• Baseurl --> The URL of the testrail instance eg(https://pocmodule.testrail.io)
• TestRailuser--> TestRail User email id
• APIkey---> API Key for the respective Testrail User generated inside TestRail application
• projectId-->The ID of the project
• suiteId--->The ID of the test suite.
• limit-->The number of test cases the response should return (The response size is 250 by default)
• Offset-->Where to start counting the tests cases from (the offset)

Example

import {passfail} from 'testrailmetrics';

passfail.getpassfail("https://www.example.testrail.in","[email protected]","password or apikey",/*projectid=*/ 1, /*runid=*/ 1,limit,offset).then(function(result) {
    console.log(result);
 }))

import {manualautomated} from 'testrailmetrics';

manualautomated.getautomationmanualcount("https://www.example.testrail.in","[email protected]","password or apikey",/*projectid=*/ 1, /*suiteid=*/ 1,limit,offset).then(function(result) {
   console.log(result);
}))

getJiraopenbugs

This function returns the open bugs present in the given jira project

Pass the below arguments to the function to get the count

• Baseurl --> The URL of the Jira instance eg(https://testing.atlassian.net)
• Jirauser--> Jira User email id
• Jirauser API Key---> API Key for the respective JIRA instance User generated inside Jira application
• Jiraprojectcode-> The jira project code for the respective project.
• Isbearertoken ---> User can authenticate bearertoken using true flag. If flag is false then basicauth takes place, the condition is handled internally in our code.

Example

import { jirametrics} from "testrailmetrics";


jirametrics.getJiraopenbugs("https://testingcompany.testco.net","[email protected]","<Jira API Key>",<"your jiraproject code">,true)
.then(function(result) {
    console.log(result) 
 })

getJiraticketsperlatestrelease

This function returns the tickets present in the latest release.

Pass the below arguments to the function to get the count

• Baseurl --> The URL of the Jira instance eg(https://testing.atlassian.net)
• Jirauser--> Jira User email id
• Jirauser API Key---> API Key for the respective JIRA instance User generated inside Jira application
• Jiraprojectcode-> The jira project code for the respective project.
• Isbearertoken ---> User can authenticate bearertoken using true flag. If flag is false then basicauth takes place, the condition is handled internally in our code.

Example

import { ticketperlatestrelease} from "testrailmetrics";


ticketperlatestrelease.getJiraticketsperlatestrelease("https://testingcompany.testco.net","[email protected]","<Jira API Key>",<"your jiraproject code">,true)
.then(function(result) {
    console.log(result) 
 })

getJirabugsperlatestrelease

This function returns the bugs present in the latest release.

Pass the below arguments to the function to get the count

• Baseurl --> The URL of the Jira instance eg(https://testing.atlassian.net)
• Jirauser--> Jira User email id
• Jirauser API Key---> API Key for the respective JIRA instance User generated inside Jira application
• Jiraprojectcode-> The jira project code for the respective project.
• Isbearertoken ---> User can authenticate bearertoken using true flag. If flag is false then basicauth takes place, the condition is handled internally in our code.

Example

import { bugsperlatestrelease} from "testrailmetrics";


bugsperlatestrelease.getJirabugsperlatestrelease("https://testingcompany.testco.net","[email protected]","<Jira API Key>",<"your jiraproject code">,true)
.then(function(result) {
    console.log(result) 
 })