[jenkins] Add blacklist option for builds

Add blacklist functionality for builds in Jenkins integration.
To ignore a build, you must define the job name and the build
id with the following format: `--blacklist-builds job-id:1234`

Signed-off-by: Jose Javier Merchante <jjmerchante@bitergia.com>

Author: jjmerchante

perceval/backends/core/jenkins.py

@@ -73,7 +73,8 @@ class Jenkins(Backend):
     ORIGIN_UNIQUE_FIELD = OriginUniqueField(name='url', type=str)
 
     def __init__(self, url, user=None, api_token=None, tag=None, archive=None,
-                 detail_depth=DETAIL_DEPTH, sleep_time=SLEEP_TIME, blacklist_ids=None, ssl_verify=True):
+                 detail_depth=DETAIL_DEPTH, blacklist_builds=None, sleep_time=SLEEP_TIME,
+                 blacklist_ids=None, ssl_verify=True):
 
         if (user and not api_token) or (not user and api_token):
             msg = "Authentication method requires user and api_token"
@@ -87,6 +88,7 @@ def __init__(self, url, user=None, api_token=None, tag=None, archive=None,
         self.api_token = api_token
         self.sleep_time = sleep_time
         self.blacklist_ids = blacklist_ids
+        self.blacklist_builds = blacklist_builds or []
         self.detail_depth = detail_depth
 
         self.client = None
@@ -133,6 +135,9 @@ def fetch_items(self, category, **kwargs):
                         njobs += 1
 
                     for build in builds:
+                        if f"{job['name']}:{build['id']}" in self.blacklist_builds:
+                            logger.warning(f"Skipping blacklisted build: {job['name']}:{build['id']}")
+                            continue
                         nbuilds += 1
                         yield build
 
@@ -144,6 +149,9 @@ def fetch_items(self, category, **kwargs):
                     njobs += 1
 
                 for build in builds:
+                    if f"{job['name']}:{build['id']}" in self.blacklist_builds:
+                        logger.warning(f"Skipping blacklisted build: {job['name']}:{build['id']}")
+                        continue
                     nbuilds += 1
                     yield build
 
@@ -342,6 +350,10 @@ def setup_cmd_parser(cls):
         group.add_argument('--sleep-time', dest='sleep_time',
                            type=int, default=SLEEP_TIME,
                            help="Minimun time to wait after a Timeout connection error.")
+        group.add_argument('--blacklist-builds', dest='blacklist_builds',
+                           nargs='*', default=[],
+                           help="List of builds to be blacklisted. "
+                                "Format: 'job_name:build_id'.")
 
         # Required arguments
         parser.parser.add_argument('url',

releases/unreleased/blacklist-option-for-builds-in-jenkins.yml

@@ -0,0 +1,9 @@
+---
+title: Blacklist option for builds in Jenkins
+category: added
+author: Jose Javier Merchante <jjmerchante@bitergia.com>
+issue: null
+notes: >
+  Add blacklist functionality for builds in Jenkins integration.
+  To ignore a build, you must define the job name and the build
+  id with the following format: `--blacklist-builds job-id:1234`.

tests/test_jenkins.py

@@ -571,6 +571,27 @@ def test_fetch_blacklist(self):
         # Builds just from JOB_BUILDS_2
         self.assertEqual(len(builds), 37)
 
+    @httpretty.activate
+    def test_fetch_blacklist_build(self):
+        """Test whether builds in blacklist are not retrieved"""
+
+        blacklist = ["apex-build-brahmaputra:106",
+                     "apex-build-brahmaputra:107"]
+
+        configure_http_server()
+
+        jenkins = Jenkins(SERVER_URL, blacklist_builds=blacklist)
+
+        with self.assertLogs(logger, level='WARNING') as cm:
+            builds = [build for build in jenkins.fetch()]
+            self.assertIn('WARNING:perceval.backends.core.jenkins:'
+                          'Skipping blacklisted build: apex-build-brahmaputra:107', cm.output)
+            self.assertIn('WARNING:perceval.backends.core.jenkins:'
+                          'Skipping blacklisted build: apex-build-brahmaputra:106', cm.output)
+
+        # Builds from JOB_BUILDS_1 + JOB_BUILDS_2 except those 2 in blacklist
+        self.assertEqual(len(builds), 67)
+
 
 class TestJenkinsBackendArchive(TestCaseBackendArchive):
     """Jenkins backend tests using an archive"""
@@ -834,6 +855,7 @@ def test_setup_cmd_parser(self):
 
         args = ['--tag', 'test', '-u', USER, '-t', TOKEN,
                 '--no-archive', '--sleep-time', '60', '--detail-depth', '2',
+                '--blacklist-builds', 'job_1:123',
                 '--blacklist-ids', '1', '2', '3', '4', '--',
                 SERVER_URL]
 
@@ -846,6 +868,7 @@ def test_setup_cmd_parser(self):
         self.assertEqual(parsed_args.sleep_time, 60)
         self.assertTrue(parsed_args.no_archive)
         self.assertListEqual(parsed_args.blacklist_ids, ['1', '2', '3', '4'])
+        self.assertListEqual(parsed_args.blacklist_builds, ['job_1:123'])
 
 
 if __name__ == "__main__":