Merge pull request #105 from blackducksoftware/gsnyder/versions-with-unconfirmed-snippets

Adding example to show how to retrieve project-versions with unconfirmed snippets

Author: Glenn Snyder

examples/get_project_versions_with_unconfirmed_snippet_matches.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python
+
+import argparse
+import csv
+import json
+import logging
+import math
+import sys
+from pprint import pprint
+
+from blackduck.HubRestApi import HubInstance, object_id
+
+parser = argparse.ArgumentParser("Get a list of project-versions with un-confirmed snippet matches")
+parser.add_argument("csv_file", help="Provide the name of the CSV file to dump the list of project-versions into")
+parser.add_argument("-l", "--limit", type=int, default=100, help="Set the limit on the number of projects to retrieve at a time")
+parser.add_argument("-a", "--all", action='store_true', help="Output all the project-versions regardless of whether they have snippet matches, or un-confirmed snippet matches")
+args = parser.parse_args()
+
+logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.WARNING)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+hub = HubInstance()
+
+columns = [
+    'Project Name', 
+    'Version Name', 
+    'Version URL', 
+    'Has Snippets', 
+    'Un-confirmed', 
+    'Confirmed', 
+    'Ignored',
+    'Total'
+]
+
+with open(args.csv_file, 'w') as csv_file:
+    writer = csv.DictWriter(csv_file, fieldnames=columns)
+    writer.writeheader()
+
+    num_projects = math.inf
+    projects_offset = 0
+    first = True
+
+    while projects_offset < num_projects:
+        parameters = {'offset': projects_offset}
+        projects_json = hub.get_projects(limit=args.limit, parameters=parameters)
+        if first:
+            num_projects = projects_json.get('totalCount', 0)
+            first = False
+
+        logging.debug(f"Retreived {len(projects_json.get('items', []))} from offset {projects_offset} of {num_projects} projects.")
+        for project in projects_json.get('items', []):
+            versions_json = hub.get_project_versions(project)
+            versions_total = versions_json['totalCount']
+            logging.debug(f"Retrieved {len(versions_json.get('items', []))} of {versions_total} versions for project {project['name']}.")
+            for version in versions_json.get('items', []):
+                snippet_counts_url = version['_meta']['href'] + "/snippet-counts"
+                #
+                # As of v2020.6.0 the Content-Type returned is application/vnd.blackducksoftware.internal-1+json;charset=UTF-8
+                # so I'm accepting any content type to allow the GET to work flexibly
+                #
+                custom_headers = {'Accept': '*/*'}
+                snippet_counts = hub.execute_get(snippet_counts_url, custom_headers=custom_headers).json()
+
+                snippets_present = snippet_counts.get('snippetScanPresent', False)
+                unconfirmed_snippets = snippets_present and snippet_counts.get('unreviewedCount', 0) > 0
+                number_unconfirmed = snippet_counts.get('unreviewedCount', 0)
+                number_confirmed = snippet_counts.get('reviewedCount', 0)
+                number_ignored = snippet_counts.get('ignoredCount', 0)
+                total = snippet_counts.get('totalCount', 0)
+                assert (number_unconfirmed + number_confirmed + number_ignored) == total
+
+                if snippets_present or args.all:
+                    # url_html = f"<a href={version['_meta']['href']}>{version['versionName']}</a>"
+                    url_html = f"=hyperlink(\"{version['_meta']['href']}/components\")"
+                    row = {
+                        'Project Name': project['name'],
+                        'Version Name': version['versionName'],
+                        'Version URL': url_html,
+                        'Has Snippets': snippets_present,
+                        'Un-confirmed': number_unconfirmed,
+                        'Confirmed': number_confirmed,
+                        'Ignored': number_ignored,
+                        'Total': total
+                    }
+                    logging.debug(f"Version {version['versionName']} in project {project['name']} has snippets or the --all flag was used, writing row to {args.csv_file}")
+                    writer.writerow(row)
+        
+        projects_offset += args.limit
+
+

examples/get_snippet_match_counts.py

@@ -24,7 +24,12 @@
 
 snippet_counts_url = version['_meta']['href'] + "/snippet-counts"
 
-snippet_counts = hub.execute_get(snippet_counts_url).json()
+#
+# As of v2020.6.0 the Content-Type returned is application/vnd.blackducksoftware.internal-1+json;charset=UTF-8
+# so I'm accepting any content type to allow the GET to work flexibly
+#
+custom_headers = {'Accept': '*/*'}
+snippet_counts = hub.execute_get(snippet_counts_url, custom_headers=custom_headers).json()
 
 del snippet_counts['_meta']
 

out.csv

@@ -0,0 +1,4 @@
+Project Name,Version Name,Version URL,Has Snippets,Un-confirmed,Confirmed,Ignored,Total
+protex,snippets,"=hyperlink(""https://ec2-18-217-189-8.us-east-2.compute.amazonaws.com/api/projects/2871cddb-01b9-4bad-a5e5-38884ab3b6da/versions/ce2832c0-371b-4689-94d8-1c88faeed038/components"")",True,25,22,0,47
+protex,snippets-diff-path,"=hyperlink(""https://ec2-18-217-189-8.us-east-2.compute.amazonaws.com/api/projects/2871cddb-01b9-4bad-a5e5-38884ab3b6da/versions/6c5a2d92-d6bd-4d88-8697-a68d29284fae/components"")",True,47,0,0,47
+protex,snippets2,"=hyperlink(""https://ec2-18-217-189-8.us-east-2.compute.amazonaws.com/api/projects/2871cddb-01b9-4bad-a5e5-38884ab3b6da/versions/d940b4f7-7e24-43a1-88c2-5f4d89d7bf7e/components"")",True,25,22,0,47