def scan(db, pkg_list, report_file):
"""
Method to search packages in our vulnerability database
:param pkg_list: List of packages
"""
results = utils.search_pkgs(db, pkg_list)
jsonl_report(results, report_file)
print_results(results)
summary = analyse(results)
return summary
def summarise(
project_type,
results,
pkg_aliases,
sug_version_dict,
scoped_pkgs={},
report_file=None,
console_print=True,
):
"""
Method to summarise the results
:param project_type: Project type
:param results: Scan or audit results
:param pkg_aliases: Package aliases used
:param sug_version_dict: Dictionary containing version suggestions
:param scoped_pkgs: Dict containing package scopes
:param report_file: Output report file
:param print: Boolean to indicate if the results should get printed to the console
:return: Summary of the results
"""
if not results:
LOG.info(f"No oss vulnerabilities detected for type {project_type} ✅")
return None
if report_file:
jsonl_report(
project_type,
results,
pkg_aliases,
sug_version_dict,
scoped_pkgs,
report_file,
)
if console_print:
print_results(project_type, results, pkg_aliases, sug_version_dict,
scoped_pkgs)
summary = analyse(project_type, results)
return summary
def summarise(
project_type,
results,
pkg_aliases,
sug_version_dict,
report_file=None,
console_print=True,
):
"""
Method to summarise the results
:param project_type: Project type
:param results: Scan or audit results
:param pkg_aliases: Package aliases used
:param sug_version_dict: Dictionary containing version suggestions
:param report_file: Output report file
:param print: Boolean to indicate if the results should get printed to the console
:return: Summary of the results
"""
if report_file and len(results):
jsonl_report(project_type, results, pkg_aliases, sug_version_dict, report_file)
if console_print:
print_results(project_type, results, pkg_aliases, sug_version_dict)
summary = analyse(project_type, results)
return summary