Merge lp:~powersj/jenkins-launchpad-plugin/add-pipeline-report into lp:jenkins-launchpad-plugin

[Joshua Powers]

Add Pipeline reporting

This will go through the stages of a pipeline and report the outcomes of
each stage. It will stop if a failure is found because Jenkins
incorrectly will report all stages after a failure as a success.

[Francis Ginther (fginther)]

I'm not able to immediately test this out, but I think this code will generate exceptions with the workflow plugins are not installed.

A few unit tests would also be appreciated.

review: Needs Fixing

[lp:~powersj/jenkins-launchpad-plugin/add-pipeline-report]

135. By Joshua Powers on 2018-01-25

Catch 404 and add tests to check for matrix, pipeline, and freestyle jobs.

[Joshua Powers (powersj)]

Can you give this one another look?

[Francis Ginther (fginther)]

I think it's better to catch the exception only where the code is expected to raise it. Otherwise this looks good. Thanks for the tests too.

review: Needs Fixing

[lp:~powersj/jenkins-launchpad-plugin/add-pipeline-report]

136. By Joshua Powers on 2018-01-26

Restrict try/except to only the is_pipeline_job

[Joshua Powers (powersj)]

I wasn't sure on the urllib2 import (wasn't sure of the ordering), otherwise restricted the try/catch as requested. Thanks!

[Francis Ginther (fginther)]

This looks good now, approve.

review: Approve

=== modified file 'jlp/jenkinsutils.py'
--- jlp/jenkinsutils.py	2017-06-23 19:03:15 +0000
+++ jlp/jenkinsutils.py	2018-01-26 18:56:00 +0000
@@ -3,6 +3,7 @@
 from xml.dom.minidom import parseString
 import jenkins
 import urlparse
+import urllib2
 import launchpadutils
 from textwrap import dedent
 from . import get_json_jenkins
@@ -408,6 +409,33 @@
     return 'activeConfigurations' in data
 
 
+def get_pipeline_builds(jenkins, job_url):
+    """Get a list of stages for pipeline jobs."""
+    job = jenkins.get_json_data(job_url + 'wfapi', append_api=False)
+    data = []
+    for stage in job['stages']:
+        data.append({'result': stage['status'],
+                     'output': stage['name']})
+        if stage['status'] == 'FAILED':
+            break
+
+    return data
+
+
+def is_pipeline_job(jenkins, job_url):
+    """ Check if a job is a pipeline job."""
+    try:
+        data = jenkins.get_json_data(job_url + 'wfapi',
+                                     append_api=False)
+    except urllib2.HTTPError:
+        data = None
+
+    if data:
+        return 'stages' in data
+    else:
+        return False
+
+
 def parse_jenkins_url(url):
     """ Return a touple of jenkins_url, job_name and build_number given
        a jenkins url """
@@ -437,6 +465,8 @@
     builds = []
     if is_matrix_job(jenkins, jenkins_url + job_name):
         builds = builds + get_multiconfig_builds(jenkins, url)
+    elif is_pipeline_job(jenkins, url):
+        builds = builds + get_pipeline_builds(jenkins, url)
     else:
         downstream_builds = get_downstream_builds(jenkins,
                                                   jenkins_url,

=== modified file 'tests/__init__.py'
--- tests/__init__.py	2016-01-27 15:09:31 +0000
+++ tests/__init__.py	2018-01-26 18:56:00 +0000
@@ -50,6 +50,55 @@
         'artifacts': [{'relativePath': 'results/coverity/CID_10895.html'},
                       {'relativePath': 'results/coverity/CID_10896.html'}]}
 
+    job_pipeline_data = {
+        "_links": {
+            "self": {
+            "href": "/job/job-pipeline/223/wfapi/describe"
+            },
+            "changesets": {
+            "href": "/job/job-pipeline/223/wfapi/changesets"
+            }
+        },
+        "id": "223",
+        "name": "#223",
+        "status": "SUCCESS",
+        "startTimeMillis": 1516836240699,
+        "endTimeMillis": 0,
+        "durationMillis": 0,
+        "queueDurationMillis": 251,
+        "pauseDurationMillis": 0,
+        "stages": [
+            {
+            "_links": {
+                "self": {
+                "href": "/job/job-pipeline/223/execution/node/6/wfapi/describe"
+                }
+            },
+            "id": "6",
+            "name": "Checkout",
+            "execNode": "",
+            "status": "SUCCESS",
+            "startTimeMillis": 1516836240950,
+            "durationMillis": 10949,
+            "pauseDurationMillis": 0
+            },
+            {
+            "_links": {
+                "self": {
+                "href": "/job/job-pipeline/223/execution/node/12/wfapi/describe"
+                }
+            },
+            "id": "12",
+            "name": "Unit & Style Tests",
+            "execNode": "",
+            "status": "SUCCESS",
+            "startTimeMillis": 1516836251932,
+            "durationMillis": 221722,
+            "pauseDurationMillis": 0
+            }
+        ]
+    }
+
     job_freestyle_build_data = {
         u'builds': [{u'actions': [{u'causes':
                                   [{u'upstreamBuild': 3,
@@ -120,6 +169,8 @@
             return self.job_multiconfig_data
         elif url == 'http://10.0.0.1:8080/job/job-multiconfig/3':
             return self.job_multiconfig_build3_data
+        elif url == 'http://10.0.0.1:8080/job/job-pipeline/wfapi':
+            return self.job_pipeline_data
         elif url == 'http://10.0.0.1:8080/job/job-freestyle':
             return self.job_freestyle_data
         elif url == 'http://10.0.0.1:8080/job/freestyle-downstream':
@@ -175,3 +226,5 @@
                     'number,url,result,actions[causes[upstreamBuild,' +\
                     'upstreamProject]]]]':
             return self.job_freestyle_triggered_build_data
+        elif url == 'http://10.0.0.1:8080/404':
+            return None

=== modified file 'tests/test_jenkinsutils.py'
--- tests/test_jenkinsutils.py	2017-02-18 13:28:31 +0000
+++ tests/test_jenkinsutils.py	2018-01-26 18:56:00 +0000
@@ -625,6 +625,42 @@
         self.assertEqual(ret, False)
 
 
+class JenkinsUtilsIsPipelineJob(unittest.TestCase):
+
+    def setUp(self):
+        self.jenkins = JenkinsJSONData()
+
+    def test_matrix_job(self):
+        ret = jenkinsutils.is_pipeline_job(
+            self.jenkins,
+            'http://10.0.0.1:8080/job/job-multiconfig/')
+        self.assertEqual(ret, False)
+
+    def test_matrix_job_with_build_number(self):
+        ret = jenkinsutils.is_pipeline_job(
+            self.jenkins,
+            'http://10.0.0.1:8080/job/job-multiconfig/32')
+        self.assertEqual(ret, False)
+
+    def test_non_matrix_job(self):
+        ret = jenkinsutils.is_pipeline_job(
+            self.jenkins,
+            'http://10.0.0.1:8080/job/job-freestyle/')
+        self.assertEqual(ret, False)
+
+    def test_pipeline_job(self):
+        ret = jenkinsutils.is_pipeline_job(
+            self.jenkins,
+            'http://10.0.0.1:8080/job/job-pipeline/')
+        self.assertEqual(ret, True)
+
+    def test_404_job(self):
+        ret = jenkinsutils.is_pipeline_job(
+            self.jenkins,
+            'http://10.0.0.1:8080/404')
+        self.assertEqual(ret, False)
+
+
 class JenkinsUtilsGetExecutedBuilds(unittest.TestCase):
     def setUp(self):
         self.jenkins = JenkinsJSONData()