zenoss / testrail-jira-gadgets Goto Github PK

View Code? Open in Web Editor NEW

13.0 21.0 6.0 340 KB

Gadgets used to display current TestRail data for projects, milestones, test plans, and test runs on JIRA dashboards.

License: Apache License 2.0

JavaScript 79.38% Perl 20.62%

testrail-jira-gadgets's Introduction

TestRail JIRA Dashboard Gadgets

Introduction
Gadgets

Introduction

The following JIRA gadget files can be used to display current TestRail data for projects, milestones, test plans, and test runs on JIRA dashboards.

NOTES

TestRail 3.0 or later is required for all of the gadgets except TestRail: Daily Activity Summary, TestRail: Milestone Status, and TestRail: User Activity Summary. Those gadgets require TestRail 4.0 or later.
The gadgets were tested on JIRA 6 and 7. No other versions were tested.
All of the charts (pie charts, stacked bar charts, etc.) use the Google charts API.
All active statuses (including custom ones) and their respective colors are pulled from the TestRail server to be used by the gadgets.
Since the gadgets are standalone rather than a plugin, installation and configuration are manual. (See INSTALL.md for installation instructions.)
The standalone gadgets don't do dynamic dropdowns, so Perl scripts were created to periodically update the XML files with the current active projects, test plans, etc.
The gadgets do not automatically refresh; refresh occurs any time the browser page is refreshed. Also, if the browser is resized or the dashboard layout changed then the browser must be refreshed to resize the gadget.
JIRA caches gadget data so updates in TestRail are not immediately displayed in the gadget. (The delay is 1-2 hours, unless the browser cache is cleared.)

Gadgets

The following gadgets are available. Each gadget displays summary data for each of the statuses in your TestRail instance, using the labels and colors you have defined in TestRail.

TestRail: Daily Activity Summary

Displays the number of test results for each status added per day for the past seven days on a specific test plan.

Settings

(Project) Test Plan - TestRail project and test plan

Screenshot

TestRail: Milestone Status

Displays the current test results for all tests on a milestone.

Settings

(Project) Milestone - TestRail project and milestone

Screenshot

TestRail: Project Status

Displays the current test results for all active test plans on a specific project.

Settings

Project - TestRail project

Screenshot

TestRail: Release Status

Displays the current test results for all test plans and/or test runs that make up a specific release. The test plans/runs can be in different projects.

Settings

Release Name - name of the release that will be displayed in the chart
Test Plans/Runs - one or more test plans or runs that make up the release. Enter the ID of the plan/run pre-pended with P for a test plan or R for a test run. Click Add to add the plan or run to the list. Click the (X) next to the test plan/run to delete that test plan/run from the list.

Screenshot

TestRail: Test Plan Status

Displays the current test results for a specific test plan.

Settings

(Project) Test Plan - TestRail project and test plan

Screenshot

TestRail: Test Run Status

Displays the current test results for a specific test run.

Settings

(Project) Test Run - TestRail project and test run

Screenshot

TestRail: Testing Status

Displays the current test results for all active test plans across all projects.

Settings

None

Screenshot

TestRail: User Activity Summary

Displays the number of test results for each status added per user for a specified number of days on a specific test plan.

Settings

(Project) Test Plan - TestRail project and test plan
Number of Days - Number of days of activity to display (Unlimited will display all activity)

Screenshot

testrail-jira-gadgets's People

Contributors

Stargazers

Watchers

Forkers

gryzl oxagileci calebjenkins dyoung-ib notteflondon psamuel47

testrail-jira-gadgets's Issues

Unable to get data in the gadgets on jira dashboard

Mixed Content: The page at '' was loaded over HTTPS, but requested an insecure script ''. This request has been blocked; the content must be served over HTTPS.

Mixed Content: The page at 'https://jira.qualifacts.org/secure/Dashboard.jspa?selectPageId=14208' was loaded over HTTPS, but requested an insecure script 'http://testrailgadget.qualifacts.org/gadgets/testrail-project-summary.js'. This request has been blocked; the content must be served over HTTPS.

Unable to retrieve the list of statuses on Jira server

Followed all the instructions on https://github.com/zenoss/testrail-jira-gadgets/blob/master/INSTALL.md
All .pl files are running and .xml files are created with my Testrail data
All XML path's are added as gadgates to Jira, and can be added.
Once Added, I get the following:
"Unable to retrieve the list of statuses"
See below a screenshot of the gadget inside Jira and the Gadgets directory containing the testrail gadgets:
https://cdn-business.discourse.org/uploads/gurock/original/2X/1/164ea6f71d41d5dce7b9f8dd27374ad9ffc12672.png

My configuration is:

Jira Server v6 configured as HTTP
local Gadget server - RedHat7 running httpd - HTTP
Testrail cloud - HTTPS

Jira server can access both TestRail cloud and Gadget server
Gadget server can access both TestRail cloud and Jira server

To Don Young request, I have ran the below curl from both the gadget server and Jira server - both returned with the same result.
real user and domain name were replaced with xxxxx (no typoes there as everything was replaced from default configuration using sed):

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0* About to connect() to XXXX.testrail.com port 443 (#0)
*   Trying 52.1.103.218...
* Connected to XXXX.testrail.com (52.1.103.218) port 443 (#0)
* Initializing NSS with certpath: sql:/etc/pki/nssdb
*   CAfile: /etc/pki/tls/certs/ca-bundle.crt
  CApath: none
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0* SSL connection using TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
* Server certificate:
* 	subject: CN=*.testrail.com,OU=IT,O=Gurock Software GmbH,L=Berlin,C=DE
* 	start date: Aug 17 00:00:00 2014 GMT
* 	expire date: Nov 03 12:00:00 2017 GMT
* 	common name: *.testrail.com
* 	issuer: CN=DigiCert SHA2 Secure Server CA,O=DigiCert Inc,C=US
* Server auth using Basic with user 'XXXXXX'
> GET /index.php?/api/v2/get_statuses HTTP/1.1
> Authorization: Basic bW9zaGVAcmVkdXhpby5jb206Z3Vlc3Q=
> User-Agent: curl/7.29.0
> Host: XXXXX.testrail.com
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Mon, 09 Jan 2017 18:47:06 GMT
< Server: Apache
< Content-Length: 830
< Connection: keep-alive
< 
{ [data not shown]
100   830  100   830    0     0    620      0  0:00:01  0:00:01 --:--:--   620
* Connection #0 to host XXXXX.testrail.com left intact
[
    {
        "color_bright": 12709313,
        "color_dark": 6667107,
        "color_medium": 9820525,
        "id": 1,
        "is_final": true,
        "is_system": true,
        "is_untested": false,
        "label": "Passed",
        "name": "passed"
    },
    {
        "color_bright": 14737632,
        "color_dark": 9474192,
        "color_medium": 13684944,
        "id": 2,
        "is_final": true,
        "is_system": true,
        "is_untested": false,
        "label": "Blocked",
        "name": "blocked"
    },
    {
        "color_bright": 15790320,
        "color_dark": 11579568,
        "color_medium": 15395562,
        "id": 3,
        "is_final": false,
        "is_system": true,
        "is_untested": true,
        "label": "Untested",
        "name": "untested"
    },
    {
        "color_bright": 16448182,
        "color_dark": 13026868,
        "color_medium": 15593088,
        "id": 4,
        "is_final": false,
        "is_system": true,
        "is_untested": false,
        "label": "Retest",
        "name": "retest"
    },
    {
        "color_bright": 16631751,
        "color_dark": 14250867,
        "color_medium": 15829135,
        "id": 5,
        "is_final": true,
        "is_system": true,
        "is_untested": false,
        "label": "Failed",
        "name": "failed"
    }
]

Example Gadget XML:

<ModulePrefs title="TestRail: Milestone Status" description="Testing status from TestRail for a specific milestone" author="Don Young" author_email="[email protected]" thumbnail="__UP_gadgetURL__/images/testrail-milestone-gadget-thumbnail.png" height="330">
<Require feature="dynamic-height"/>
<Require feature="settitle"/>
<Require feature="minimessage"/>
<Optional feature="gadget-directory">
<Param name="categories">Other</Param>
</Optional>
</ModulePrefs>
<UserPref name="projectMilestoneIDList" display_name="(Project) Milestone" datatype="enum" default_value="1|10">
<EnumValue value="1|10" display_value="(XXXX) V3.0 Integration"/>
<EnumValue value="1|12" display_value="(XXXX) V3.0GA"/>
<EnumValue value="1|13" display_value="(XXXX) V3.0GA\V3-Cycle1"/>
<EnumValue value="1|14" display_value="(XXXX) V3.0GA\V3-Cycle2"/>
<EnumValue value="1|15" display_value="(XXXX) V3.0GA\V3-Cycle3"/>
</UserPref>
<UserPref name="testRailURL" display_name="TestRail URL" datatype="hidden" default_value="https://XXXX.testrail.com/"/>
<UserPref name="gadgetURL" display_name="Gadget Web Server URL" datatype="hidden" default_value="http://vm-qa-nfs/"/>
<Content type="html" view="default">
<![CDATA[
<div id="milestoneChart"></div> <div id="milestoneCaption" style="text-align: center; font-weight: bold"></div> <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script> <script type="text/javascript" src="__UP_gadgetURL__/gadgets/testrail-milestone-summary.js"></script> <p id="disclaimer" style='text-align: center; font-size: 11px; font-style:italic'></p>
]]>
</Content>
</Module>

Gadgets does not support Jira Wallboard

First, Thank you for your beautiful gadgets !

I have configured a Dashboard with multiple gadgets and would like to present them in WallBoard presentation (Can show multiple dashboards on TV as a slideshow)

The Gadgets are not shown in WallBoard presentation mode.

Please see if you have a solution for that.

Thanks !

project permissions

On the JIRA gadgets for TestRail forum , another user comment from March2018 states:

Has anyone solved the permissions and project visibility issues with the gadgets e.g. I only want a person seeing plans/projects which they have permission to see. Only the admin can see all projects, individual access is added when they are working on the project and removed asap. But the gadget gives everyone visibility of all projects

Can you please verify whether this has been fixed? Does every JIRA user see information about all TestRail projects, even TestRail projects that they do not have permissions in TestRail to see?

Can't locate Config/Properties.pm in @INC

i've tried to run this files in perl getting below error.

"Can't locate Config/Properties.pm in @inc (you may need to install the Config::Properties module) (@inc contains: C:/Perl64/site/lib C:/Perl64/lib) at generate-activity-gadget-xml.pl line 8.
BEGIN failed--compilation aborted at generate-activity-gadget-xml.pl line 8."

Gadget work with JIRA Cloud??

The Testrail-jira-gadget code looks promising and will be very useful for our firm if this can work with JIRA Cloud. Please advise if the available code can be configured for JIRA cloud and if we can set up the respective gadget for reporting from Testrail to JIRA Cloud.

Thank you,
Ballard Team

Unable to retrieve the list of statuses on Jira server

Am seeing this issue even after whitelisting the testrail URL. Does integration need to be enabled between testrail and JIRA for this gadget to work?
Debugging according to steps provided in previous ticket shows the following:
obj = {text: "", rc: 500, headers: {…}, oauthApprovalUrl: undefined, oauthError: undefined}

zenoss / testrail-jira-gadgets Goto Github PK

testrail-jira-gadgets's Introduction

TestRail JIRA Dashboard Gadgets

Table of Contents

Introduction

Gadgets

TestRail: Daily Activity Summary

Settings

Screenshot

TestRail: Milestone Status

Settings

Screenshot

TestRail: Project Status

Settings

Screenshot

TestRail: Release Status

Settings

Screenshot

TestRail: Test Plan Status

Settings

Screenshot

TestRail: Test Run Status

Settings

Screenshot

TestRail: Testing Status

Settings

Screenshot

TestRail: User Activity Summary

Settings

Screenshot

testrail-jira-gadgets's People

Contributors

Stargazers

Watchers

Forkers

testrail-jira-gadgets's Issues

Recommend Projects

Recommend Topics

Recommend Org