update generate reports (#182)

Update to reflect new reports that can be included

Author: Glenn Snyder

blackduck/Reporting.py

@@ -8,7 +8,7 @@
 
 logger = logging.getLogger(__name__)
 
-valid_categories = ['VERSION','CODE_LOCATIONS','COMPONENTS','SECURITY','FILES', 'ATTACHMENTS', 'CRYPTO_ALGORITHMS', 'PROJECT_VERSION_CUSTOM_FIELDS', 'BOM_COMPONENT_CUSTOM_FIELDS', 'LICENSE_TERM_FULFILLMENT', 'UPGRADE_GUIDANCE']
+valid_categories = ['VERSION','CODE_LOCATIONS','COMPONENTS','SECURITY','FILES', 'ATTACHMENTS', 'CRYPTO_ALGORITHMS', 'PROJECT_VERSION_CUSTOM_FIELDS', 'BOM_COMPONENT_CUSTOM_FIELDS', 'LICENSE_TERM_FULFILLMENT', 'UPGRADE_GUIDANCE', 'VULNERABILITY_MATCH']
 valid_report_formats = ["CSV", "JSON"]
 def create_version_reports(self, version, report_list, format="CSV"):
     assert all(list(map(lambda k: k in valid_categories, report_list))), "One or more selected report categories in {} are not valid ({})".format(

blackduck/__version__.py

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

examples/generate_csv_reports_for_project_version.py

@@ -10,15 +10,36 @@
 
 import argparse
 import json
+import logging
 import time
 
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
+)
+
+version_name_map = {
+	'version': 'VERSION',
+	'scans': 'CODE_LOCATIONS',
+	'components': 'COMPONENTS',
+	'vulnerabilities': 'SECURITY',
+	'source':'FILES',
+	'cryptography': 'CRYPTO_ALGORITHMS',
+	'license_terms': 'LICENSE_TERM_FULFILLMENT',
+	'component_additional_fields': 'BOM_COMPONENT_CUSTOM_FIELDS',
+	'project_version_additional_fields': 'PROJECT_VERSION_CUSTOM_FIELDS',
+	'vulnerability_matches': 'VULNERABILITY_MATCH'
+}
+
+all_reports = list(version_name_map.keys())
+
 parser = argparse.ArgumentParser("A program to create reports for a given project-version")
 parser.add_argument("project_name")
 parser.add_argument("version_name")
 parser.add_argument("-z", "--zip_file_name", default="reports.zip")
 parser.add_argument("-r", "--reports",
-	default="version,scans,components,vulnerabilities,source", 
-	help="Comma separated list (no spaces) of the reports to generate - version, scans, components, vulnerabilities, source, and cryptography reports (default: all, except cryptography")
+	default=",".join(all_reports), 
+	help=f"Comma separated list (no spaces) of the reports to generate - {list(version_name_map.keys())}. Default is all reports.")
 parser.add_argument('--format', default='CSV', choices=["CSV"], help="Report format - only CSV available for now")
 parser.add_argument('-t', '--tries', default=4, type=int, help="How many times to retry downloading the report, i.e. wait for the report to be generated")
 parser.add_argument('-s', '--sleep_time', default=5, type=int, help="The amount of time to sleep in-between (re-)tries to download the report")
@@ -27,14 +48,6 @@
 
 hub = HubInstance()
 
-version_name_map = {
-	'version': 'VERSION',
-	'scans': 'CODE_LOCATIONS',
-	'components': 'COMPONENTS',
-	'vulnerabilities': 'SECURITY',
-	'source':'FILES'
-}
-
 class FailedReportDownload(Exception):
 	pass