Merge pull request #28 from blackducksoftware/gsnyder/license-info

Gsnyder/license info

Author: Glenn Snyder

blackduck/HubRestApi.py

@@ -544,6 +544,41 @@ def download_report(self, report_id):
  url = self.get_urlbase() + "/api/reports/{}".format(report_id)
  return self.execute_get(url, {'Content-Type': 'application/zip', 'Accept':'application/zip'})
 
+ ##
+ #
+ # License stuff
+ #
+ ##
+ def _get_license_info(self, license_obj):
+ if 'license' in license_obj:
+ license_info = {}
+ text_json = {}
+ logging.debug("license: {}".format(license_obj))
+ response = self.execute_get(license_obj['license'])
+ if response.status_code == 200:
+ license_info = response.json()
+ text_url = self.get_link(license_info, 'text')
+ response = self.execute_get(text_url)
+ if response.status_code == 200:
+ text_json = response.text
+ yield {"license_info": license_info,
+ "license_text_info": text_json}
+ elif 'licenses' in license_obj and isinstance(license_obj['licenses'], list):
+ for license in license_obj['licenses']:
+ self._get_license_info(license)
+
+ def get_license_info_for_bom_component(self, bom_component, limit=1000):
+ self._check_version_compatibility()
+ all_licenses = {}
+ logging.debug("gathering license info for bom component {}, version {}".format(
+ bom_component['componentName'], bom_component['componentVersionName']))
+ for license in bom_component.get('licenses', []):
+ for license_info_obj in self._get_license_info(license):
+ all_licenses.update({
+ license['licenseDisplay']: license_info_obj
+ })
+ return all_licenses
+
  ##
  #
  # Files and Snippet matching
@@ -564,11 +599,10 @@ def get_file_bom_entries(self, hub_release_id, limit=100):
  jsondata = response.json()
  return jsondata
 
- def get_file_matches_for_component_with_version(self, project_id, version_id, component_id, component_version_id, limit=1000):
+ def get_file_matches_for_bom_component(self, bom_component, limit=1000):
  self._check_version_compatibility()
+ url = self.get_link(bom_component, "matched-files")
  paramstring = self.get_limit_paramstring(limit)
- url = "{}/projects/{}/versions/{}/components/{}/versions/{}/matched-files".format(
- self.get_apibase(), project_id, version_id, component_id, component_version_id)
  logging.debug("GET {}".format(url))
  response = self.execute_get(url)
  jsondata = response.json()

blackduck/__version__.py

@@ -1,4 +1,4 @@
 
-VERSION = (0, 0, 12)
+VERSION = (0, 0, 14)
 
 __version__ = '.'.join(map(str, VERSION))

examples/create_policy.py

@@ -16,7 +16,6 @@
 "operation":"EQ",
 "parameters":{"values":["0"]}}]},"wait":True}
 
-import pdb; pdb.set_trace()
 result = hub.create_policy(policy_data)
 
 print(result)

examples/get_bom_component_files.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+
+import argparse
+import json
+
+from blackduck.HubRestApi import HubInstance
+
+
+parser = argparse.ArgumentParser("Retreive BOM component file matches 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)
+
+project_id = project['_meta']['href'].split("/")[-1]
+version_id = version['_meta']['href'].split("/")[-1]
+
+all_matches = dict()
+
+for bom_component in bom_components['items']:
+# Retrieve the file matches for this bom component and insert those matches along with the bom component info
+# into the all_matches dictionary
+component_file_matches = hub.get_file_matches_for_bom_component(bom_component)
+all_matches.update({"{}, {}".format(bom_component['componentName'], bom_component['componentVersionName']): {
+"component_info": bom_component,
+"component_file_matches": component_file_matches
+}
+})
+
+print(json.dumps(all_matches))

examples/get_bom_component_license_info.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+
+import argparse
+import json
+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)
+
+project_id = project['_meta']['href'].split("/")[-1]
+version_id = version['_meta']['href'].split("/")[-1]
+
+all_licenses = 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)
+
+for bom_component in bom_components['items']:
+# Retrieve the licenses and license text for this bom component and insert the license info along with the bom component info
+# into the all_licenses dictionary
+component_licenses = hub.get_license_info_for_bom_component(bom_component)
+all_licenses.update({"{}, {}".format(bom_component['componentName'], bom_component['componentVersionName']): {
+"component_info": bom_component,
+"component_licenses": component_licenses
+}
+})
+
+print(json.dumps(all_licenses))