Merge branch 'master' of https://github.com/blackducksoftware/hub-rest-api-python

Author: Glenn Snyder

blackduck/HubRestApi.py

@@ -140,7 +140,12 @@ def get_auth_token(self):
                 verify=not self.config['insecure']
             )
             csrf_token = response.headers['X-CSRF-TOKEN']
-            bearer_token = json.loads(response.content.decode('utf-8'))['bearerToken']
+            try:
+              bearer_token = json.loads(response.content.decode('utf-8'))['bearerToken']
+            except json.decoder.JSONDecodeError as e:
+              import traceback
+              traceback.print_exc()
+              raise Exception("Failed to obtain bearer token, check for valid authentucation token")
             return (bearer_token, csrf_token, None)
         else:
             authendpoint="/j_spring_security_check"
@@ -1677,4 +1682,9 @@ def execute_post(self, url, data, custom_headers={}):
         response = requests.post(url, headers=headers, data=json_data, verify = not self.config['insecure'])
         return response
 
-
+	def get_matched_components(self, version_obj, limit=9999):
+		url = "{}/matched-files".format(version_obj['_meta']['href'])
+		param_string = self._get_parameter_string({'limit': limit})
+		url = "{}{}".format(url, param_string)
+		response = self.execute_get(url)
+		return response.json()

examples/custom_signatures_import.py

@@ -60,15 +60,21 @@ def read_metadata_file(metadata_path):
 def create_projects(hub, metadata):
     for project_name in metadata['content']:
         for version_name in metadata['content'][project_name]:
-            version = hub.get_or_create_project_version(project_name, version_name)
-        project = hub.get_project_by_name(project_name)
-        if not project['customSignatureEnabled']:
-            print ("Enabling custom signature for {}".format(project['name']))
-            project['customSignatureEnabled'] = True
-            response = hub.update_project_settings(project, new_settings=project)
-            print (response)
-        else:
-            print ("Custom signature for {} already enabled".format(project_name))
+            try:
+                version = hub.get_or_create_project_version(project_name, version_name)
+            except:
+                print ("Failed to create project {} version {}".format(project_name, version_name))
+        try:
+            project = hub.get_project_by_name(project_name)
+            if not project['customSignatureEnabled']:
+                print ("Enabling custom signature for {}".format(project['name']))
+                project['customSignatureEnabled'] = True
+                response = hub.update_project_settings(project, new_settings=project)
+                print (response)
+            else:
+                print ("Custom signature for {} already enabled".format(project_name))
+        except:
+            print ("Failed to set custom signature flag for {}".format(project_name))
 
 def upload_scan_data(hub, workdir):
     with (os.scandir(workdir)) as entries:
@@ -131,7 +137,7 @@ def main(argv=None): # IGNORE:C0111
         return 0
     except Exception as e:
         import traceback
-        traceback.print_exc()
+        traceback.print_stack()
         if DEBUG or TESTRUN:
             raise(e)
         indent = len(program_name) * " "

examples/generate_confidence_score.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+
+import argparse
+import json
+import logging
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("Generate Confidence Score Report")
+parser.add_argument("project_name")
+parser.add_argument("version")
+
+args = parser.parse_args()
+
+
+hub = HubInstance()
+
+project = hub.get_project_by_name(args.project_name)
+version = hub.get_version_by_name(project, args.version)
+
+result = hub.get_matched_components(version)
+print(json.dumps(result))
+
+

examples/get_bom_component_origin_info_Updated.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+
+import argparse
+import json
+import csv
+import logging
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+
+parser = argparse.ArgumentParser("Retreive BOM component license information for the given project and version")
+parser.add_argument("project_name")
+parser.add_argument("version")
+
+args = parser.parse_args()
+
+
+hub = HubInstance()
+
+project = hub.get_project_by_name(args.project_name)
+version = hub.get_version_by_name(project, args.version)
+
+bom_components = hub.get_version_components(version)
+
+all_origins = dict()
+
+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)
+
+all_origin_info = {}
+components_info = [["Component Name", "Component Version" ,"Homepage", "Approval Status", "Component ID", "Component Version ID", "License"]]
+
+for bom_component in bom_components['items']:
+	component_url = bom_component['component']
+	response = hub.execute_get(component_url)
+
+	# Component details include the home page url and additional home pages
+	logging.debug("Retrieving component home page info for {}:{}".format(
+		bom_component.get("componentName"), bom_component.get("componentVersionName")))
+	component_details = None
+	if response.status_code == 200:
+		component_details = response.json()
+
+	for origin in bom_component.get('origins', []):
+		logging.debug("Retrieving origin details for origin {}".format(origin['name']))
+		origin_url = hub.get_link(origin, 'origin')
+		response = hub.execute_get(origin_url)
+		origin_details = None
+		if response.status_code == 200:
+			origin_details = response.json()
+
+		all_origin_info.update({
+				"{}:{}".format(bom_component['componentName'], bom_component['componentVersionName']): {
+					"component_details": component_details,
+					"component_home_page": component_details.get("url"),
+					"additional_home_pages": component_details.get("additionalHomepages"),
+					"origin_details": origin_details,
+				}
+			})
+		#component_info = [bom_component['componentName'], bom_component['componentVersionName'], component_details.get("url"), component_details['approvalStatus'], bom_component['component'], bom_component['componentVersion'], origin_details['license']['licenseDisplay']]
+		component_info = [bom_component.get("componentName"), bom_component.get("componentVersionName"), component_details.get("url"), bom_component.get("approvalStatus"), bom_component.get("component"), bom_component.get("componentVersion"), origin_details.get('license').get("licenseDisplay")]
+		components_info.append(component_info)
+
+mycsv = csv.writer(open(r'Report.csv', 'w'), lineterminator='\n')
+for row in components_info:
+    if any(row):
+        mycsv.writerow(row)
+print("Report.csv is successfully generated")
+#print(json.dumps(all_origin_info))
+