Update notices report generation to check for 412 unfinished report c…

examples/generate_notices_report_for_project_version.py

@@ -18,9 +18,6 @@
 parser = argparse.ArgumentParser("A program to generate the notices file for a given project-version")
 parser.add_argument("project_name")
 parser.add_argument("version_name")
-
-# TODO: Add the copyright checkbox option
-
 parser.add_argument('-f', "--file_name_base", default="notices_report", help="Base file name to write the report data into. If the report format is TEXT a .zip file will be created, otherwise a .json file")
 parser.add_argument('-r', '--report_format', default='TEXT', choices=["JSON", "TEXT"], help="Report format - choices are TEXT or HTML")
 parser.add_argument('-c', '--include_copyright_info', action='store_true', help="Set this option to have additional copyright information from the Black Duck KB included in the notices file report.")
@@ -32,58 +29,67 @@
 logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
 
 class FailedReportDownload(Exception):
-pass
+ pass
+
+DOWNLOAD_ERROR_CODES = ['{report.main.read.unfinished.report}', '{report.main.download.unfinished.report}']
 
 def download_report(location, file_name_base, retries=10):
-report_id = location.split("/")[-1]
-
-if retries:
-logging.debug("Retrieving generated report from {}".format(location))
-# response = hub.download_report(report_id)
-response, report_format = hub.download_notification_report(location)
-if response.status_code == 200:
-if report_format == "TEXT":
-filename = file_name_base + ".zip"
-with open(filename, "wb") as f:
-f.write(response.content)
-else:
-# JSON format
-filename = file_name_base + ".json"
-with open(filename, "w") as f:
-json.dump(response.json(), f, indent=3)
-logging.info("Successfully downloaded json file to {} for report {}".format(
-filename, report_id))
-else:
-logging.warning("Failed to retrieve report {}".format(report_id))
-logging.warning("Probably not ready yet, waiting 5 seconds then retrying (remaining retries={}".format(retries))
-time.sleep(5)
-retries -= 1
-download_report(location, file_name_base, retries)
-else:
-raise FailedReportDownload("Failed to retrieve report {} after multiple retries".format(report_id))
+ report_id = location.split("/")[-1]
+
+ if retries:
+ logging.debug("Retrieving generated report from {}".format(location))
+ # response = hub.download_report(report_id)
+ response, report_format = hub.download_notification_report(location)
+
+ if response.status_code == 200:
+ if report_format == "TEXT":
+ filename = file_name_base + ".zip"
+ with open(filename, "wb") as f:
+ f.write(response.content)
+ else:
+ # JSON format
+ filename = file_name_base + ".json"
+ with open(filename, "w") as f:
+ json.dump(response.json(), f, indent=3)
+ logging.info("Successfully downloaded json file to {} for report {}".format(
+ filename, report_id))
+ elif response.status_code == 412 and response.json()['errorCode'] in DOWNLOAD_ERROR_CODES:
+ # failed to download, and report generation still in progress, wait and try again infinitely
+ # TODO: is it possible for things to get stuck in this forever?
+ logging.warning(f"Failed to retrieve report {report_id} for reason {response.json()['errorCode']}. Waiting 5 seconds then trying infinitely")
+ time.sleep(5)
+ download_report(location, file_name_base, retries)
+ else:
+ logging.warning(f"Failed to retrieve report, status code {response.status_code}")
+ logging.warning("Probably not ready yet, waiting 5 seconds then retrying (remaining retries={}".format(retries))
+ time.sleep(5)
+ retries -= 1
+ download_report(location, file_name_base, retries)
+ else:
+ raise FailedReportDownload("Failed to retrieve report {} after multiple retries".format(report_id))
 
 project = hub.get_project_by_name(args.project_name)
 
 if project:
-version = hub.get_version_by_name(project, args.version_name)
+ version = hub.get_version_by_name(project, args.version_name)
 
-response = hub.create_version_notices_report(version, args.report_format, include_copyright_info=args.include_copyright_info)
+ response = hub.create_version_notices_report(version, args.report_format, include_copyright_info=args.include_copyright_info)
 
-if response.status_code == 201:
-logging.info("Successfully created notices report in {} format for project {} and version {}".format(
-args.report_format, args.project_name, args.version_name))
-location = response.headers['Location']
-download_report(location, args.file_name_base)
+ if response.status_code == 201:
+ logging.info("Successfully created notices report in {} format for project {} and version {}".format(
+ args.report_format, args.project_name, args.version_name))
+ location = response.headers['Location']
+ download_report(location, args.file_name_base)
 
 
-# Showing how you can interact with the downloaded zip and where to find the
-# output content. Uncomment the lines below to see how it works.
+ # Showing how you can interact with the downloaded zip and where to find the
+ # output content. Uncomment the lines below to see how it works.
 
-# with zipfile.ZipFile(zip_file_name_base, 'r') as zipf:
-# with zipf.open("{}/{}/version-license.txt".format(args.project_name, args.version_name), "r") as license_file:
-# print(license_file.read())
-else:
-logging.error("Failed to create reports for project {} version {}, status code returned {}".format(
-args.project_name, args.version_name, response.status_code))
+ # with zipfile.ZipFile(zip_file_name_base, 'r') as zipf:
+ # with zipf.open("{}/{}/version-license.txt".format(args.project_name, args.version_name), "r") as license_file:
+ # print(license_file.read())
+ else:
+ logging.error("Failed to create reports for project {} version {}, status code returned {}".format(
+ args.project_name, args.version_name, response.status_code))
 else:
-logging.warning("Did not find project with name {}".format(args.project_name))
+ logging.warning("Did not find project with name {}".format(args.project_name))