Dashboard Product

Dashboard Product contains Metrics from different tools like TestRail, Jira, X-Ray, etc.,

Pre-Requisite

• NodeJs
• Visual Studio code
• New Relic

Installation

• Create a project in Visual Studio Code.
• Create a package.json file inside that project using "npm init -y" command.
• Install the Dashboard package using command "npm i newdashboardpackage"

TestRail metrics

TestRail metrics package display the test metrics from TestRail application.

Usage

manualautomated

This functions extracts the Manual and Automation test cases count for a given project in the TestRail application.

Steps

Pass the below arguments to the function to get the count.

• baseURL --> The URL of the TestRail instance. e.g.(https://pocmodule.testrail.io)
• testrailUser--> Provide the respective TestRail account email id.
• apiKey,---> API Key for the respective TestRail User generated inside TestRail application.
• projectId-->Provide the ProjectId of respective project.
• suiteId--->The ID of the test suite.
• projectName-->Provide the ProjectName of respective project.
• automatedId-->The automation_type Id avaialable for automated Testcases in respective project. eg:[2,4]
• manualId-->The automation_type Id avaialable for manual Testcases in respective project. eg:[0,1,3]
• newRelicAPI--> Provides the respective New relic Url.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application

Example

const newRelicFunction = require("newdashboardpackage");
const metricData = [
  {
    baseURL: "https://pocmodule.testrail.io",
    testrailuser: "[email protected]",
    apiKey: "apiKey",
    projectId: "1",
    suiteId: "1",
    projectName: "projectName",
    automatedId: [2],
    manualId: [0, 1, 3],
    newRelicAPI: "https://dummy.newrelic.com",
    newRelicAPIKey: "newRelicApikey’",
  },
];
console.log(
  "AutomatedandManaulCount",
  newRelicFunction.manualautomated(metricData)
);

passfail

This functions extracts the Pass and Fail test cases count for a given project in the TestRail application.

Steps

Pass the below arguments to the function to get the count.

• baseURL --> The URL of the TestRail instance. e.g.(https://pocmodule.testrail.io)
• testrailUser--> Provide the respective TestRail account email id.
• apiKey,---> API Key for the respective TestRail User generated inside TestRail application.
• projectId-->Provide the ProjectId of respective project.
• projectName-->Provide the ProjectName of respective project.
• newRelicAPI--> Provides the respective New relic Api
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application

Example

 const newRelicFunction = require("newdashboardpackage");
 console.log("test",newRelicFunction.passfail('https://pocmodule.testrail.io',[email protected]',' ApiKey’, ‘/*projectId=*/ 1’,  ‘projectName’,'https://dummy.newrelic.com,'newRelicApikey’))

JIRA metrics

JIRA metrics package display the test metrics from JIRA application.

openbugs

This function returns the open bugs present in the given Jira project.

Steps

Pass the below arguments to the function to get the count.

• username --> Provide the username of the Jira account.
• baseUrl --> The URL of the Jira instance eg(https://testing.atlassian.net).
• apiToken --> Provide the Jira Api Token.
• jiraProjectCode--> The jira project code for the respective project.
• newRelicAPI--> Provides the respective New relic Api.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application.

Example

 const newRelicFunction = require("newdashboardpackage");
 const metricData = [
  {
    Username: "'[email protected]”,
    baseURL: " https://testingcompany.testco.net",
    apitoken: " Jira API Token ",
    jiraProjectCode: "<your jiraproject code>",
    newRelicAPI:
      "https://dummy.newrelic.com",
    newRelicAPIKey: "newRelicApikey’",

  },

];
 console.log("Openbugs",newRelicFunction.openbugs(metricData))

blockers

This function returns the Blockers present in the given Jira project.

Steps

Pass the below arguments to the function to get the count.

• username --> Provide the username of the Jira account.
• baseUrl --> The URL of the Jira instance eg(https://testing.atlassian.net).
• apitoken --> Provide the Jira Api Token.
• jiraProjectCode--> The jira project code for the respective project.
• Priority --> Provide the Priority of the Bug.
• newRelicAPI--> Provides the respective New relic Api.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application.

Example

 const newRelicFunction = require("newdashboardpackage");
 const metricData = [
  {
    username: "'[email protected]”,
    baseURL: " https://testingcompany.testco.net",
    apitoken: " Jira API Token ",
    jiraProjectCode: "<your jiraproject code>",
    Priority: " P0 - Critical",
    newRelicAPI:
      "https://dummy.newrelic.com",
    newRelicAPIKey: "newRelicApikey’",

  },

];
 console.log("blockers",newRelicFunction.blockers(metricData))

backlogtickets

This function returns the Backlog Tickets present in the given Jira project.

Steps

Pass the below arguments to the function to get the count.

• username --> Provide the username of the Jira account.
• baseUrl --> The URL of the Jira instance eg(https://testing.atlassian.net).
• apiToken --> Provide the Jira Api Token.
• jiraProjectCode--> The jira project code for the respective project.
• newRelicAPI--> Provides the respective New relic Api.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application.

Example

 const newRelicFunction = require("newdashboardpackage");
 const metricData = [
  {
    Username: "'[email protected]”,
    baseURL: " https://testingcompany.testco.net",
    apitoken: " Jira API Token ",
    jiraProjectCode: "<your jiraproject code>",
    newRelicAPI:
      "https://dummy.newrelic.com",
    newRelicAPIKey: "newRelicApikey’",

  },

];
 console.log("BacklogTickets",newRelicFunction.backlogtickets(metricData))

bugsperrelease

This function returns the BugsPerRelease present in the Latest Release of a respective project.

Steps

Pass the below arguments to the function to get the count.

• username --> Provide the username of the Jira account.
• baseUrl --> The URL of the Jira instance eg(https://testing.atlassian.net).
• apiToken --> Provide the Jira Api Token.
• jiraProjectCode--> The jira project code for the respective project.
• newRelicAPI--> Provides the respective New relic Api.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application.

Example

const newRelicFunction = require("newdashboardpackage");
 const metricData = [
  {
    Username: "'[email protected]”,
    baseURL: " https://testingcompany.testco.net",
    apitoken: " Jira API Token ",
    jiraProjectCode: "<your jiraproject code>",
    newRelicAPI:
      "https://dummy.newrelic.com",
    newRelicAPIKey: "newRelicApikey’",

  },

];
 console.log("BugsPerRelease",newRelicFunction.bugsperrelease(metricData))

ticketsperrelease

This function returns the TicketsPerRelease present in the Latest Release of a respective project.

Steps

Pass the below arguments to the function to get the count.

• username --> Provide the username of the Jira account.
• baseUrl --> The URL of the Jira instance eg(https://testing.atlassian.net).
• apiToken --> Provide the Jira Api Token.
• jiraProjectCode--> The jira project code for the respective project.
• newRelicAPI--> Provides the respective New relic Api.
• newRelicAPIKey--> API Key for the respective New relic user generated inside New relic application.

Example

const newRelicFunction = require("newdashboardpackage");
 const metricData = [
  {
    Username: "'[email protected]”,
    baseURL: " https://testingcompany.testco.net",
    apitoken: " Jira API Token ",
    jiraProjectCode: "<your jiraproject code>",
    newRelicAPI:
      "https://dummy.newrelic.com",
   newRelicAPIKey: "newRelicApikey’",

  },

];
 console.log("TicketsPerRelease",newRelicFunction.ticketsperrelease(metricData))