Merge pull request #34 from mozilla-mobile/irios-add-jira

Adding Jira to collect data

Author: isabelrios

.github/workflows/staging-push.yml

@@ -42,14 +42,16 @@ jobs:
             echo "TESTRAIL_HOST=${{ secrets.TESTRAIL_HOST_TEST }}" >> $GITHUB_ENV
             echo "TESTRAIL_USERNAME=${{ secrets.TESTRAIL_USERNAME }}" >> $GITHUB_ENV
             echo "TESTRAIL_PASSWORD=${{ secrets.TESTRAIL_PASSWORD }}" >> $GITHUB_ENV
+            echo "JIRA_HOST=${{ secrets.JIRA_HOST }}" >> $GITHUB_ENV
+            echo "JIRA_USER=${{ secrets.JIRA_USER }}" >> $GITHUB_ENV
+            echo "JIRA_PASSWORD=${{ secrets.JIRA_PASSWORD }}" >> $GITHUB_ENV
             echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
 
       #- name: Update DB - test runs 
       #  run: python ./__main__.py --report-type test-run-counts --project fenix --start-date 2021-08-15 --end-date 2021-10-01 
 
-      - name: Update DB - test coverage
-        #run: python ./__main__.py --report-type test-case-coverage --project ALL
-        run: python ./__main__.py --report-type test-case-coverage --project fenix
+      - name: Jira query
+        run: python ./__main__.py --report-type jira-qa-requests
       - name: Set job log URL
         if: always()
         run: echo "JOB_LOG_URL=https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" >> $GITHUB_ENV

__main__.py

@@ -2,6 +2,7 @@
 import sys
 
 from github import GithubClient
+from jira import Jira
 from testrail import TestRailClient
 from utils.constants import PROJECTS_ABBREV, REPORT_TYPES
 
@@ -14,7 +15,7 @@ def parse_args(cmdln_args):
     parser.add_argument(
         "--project",
         help="Indicate project",
-        required=True,
+        required=False,
         choices=PROJECTS_ABBREV
     )
 
@@ -52,6 +53,9 @@ def main():
         h = GithubClient()
         h.github_issue_regression(args.project)
         h = GithubClient()
+    if args.report_type == 'jira-qa-requests':
+        h = Jira()
+        h.filters()
 
 
 if __name__ == '__main__':

jira.py

@@ -0,0 +1,37 @@
+import os
+import sys
+
+from lib.jira_conn import JiraAPIClient
+
+
+# JQL query All QA Requests since 2022 filter_id: 13856
+FILTER_ID_ALL_REQUESTS_2022 = "13856"
+# Fields needed
+STORY_POINTS = "customfield_10037"
+FIREFOX_RELEASE_TRAIN = "customfield_10155"
+ENGINEERING_TEAM = "customfield_10134"
+DEFAULT_COLUMNS = "id,key,status,created,summary,labels,assignee,"
+MAX_RESULT = "maxResults=100"
+
+JQL_QUERY = 'jql=filter='
+
+
+class Jira:
+
+    def __init__(self):
+        try:
+            JIRA_HOST = os.environ['JIRA_HOST']
+            self.client = JiraAPIClient(JIRA_HOST)
+            self.client.user = os.environ['JIRA_USER']
+            self.client.password = os.environ['JIRA_PASSWORD']
+
+        except KeyError:
+            print("ERROR: Missing jira env var")
+            sys.exit(1)
+
+    # API: Filters
+    def filters(self):
+        query = JQL_QUERY + FILTER_ID_ALL_REQUESTS_2022 + '&fields=' \
+                + DEFAULT_COLUMNS + STORY_POINTS + FIREFOX_RELEASE_TRAIN \
+                + ENGINEERING_TEAM + '&' + MAX_RESULT
+        return self.client.get_search(query)

lib/jira_conn.py

@@ -0,0 +1,68 @@
+
+"""Jira API binding for Python 3.x
+
+Learn more:
+
+https://docs.atlassian.com/software/jira/docs/api/REST/9.16.0/
+
+Copyright Atlassian developer. See license.md for details.
+"""
+import requests
+
+from requests.auth import HTTPBasicAuth
+
+
+class JiraAPIClient:
+    def __init__(self, base_url):
+        self.user = ''
+        self.password = ''
+        if not base_url.endswith('/'):
+            base_url += '/'
+        self.__url = base_url
+
+    def get_search(self, query):
+        """Issue a GET request (read) against the API.
+
+        Args:
+            filter{id}: The API method to call including parameters,
+            e.g. GET /rest/api/2/filter/{id}.
+
+        Returns:
+            JSON representation of the search results.
+        """
+        return self.__send_request('GET', query)
+
+    def __send_request(self, method, query):
+        url = self.__url + '?' + query
+
+        # Store all results
+        all_results = []
+
+        headers = {"Content-Type": "application/json"}
+
+        # Pagination variables
+        start_at = 0
+        max_results = 100
+        total = 1  # Initial value greater than start_at to enter the loop
+
+        while start_at < total:
+            # Send GET request
+            response = requests.get(
+                        url,
+                        headers=headers,
+                        auth=HTTPBasicAuth(self.user, self.password))
+
+            if response.status_code == 200:
+                data = response.json()
+                all_results.extend(data['issues'])
+                total = data['total']  # Update total based on the response
+                start_at += max_results  # Move to the next page
+            else:
+                print(f"Failed to fetch data: {response.status_code}")
+                print(response.text)
+                break
+
+        # Print the total number of issues retrieved
+        print(f"Total issues retrieved: {len(all_results)}")
+        print(data)
+        return data

utils/constants.py

@@ -11,4 +11,5 @@
     'test-case-coverage',
     'test-run-counts',
     'issue-regression',
+    'jira-qa-requests'
 ]