Merge pull request lightspeed-core#1959 from tisnik/lcore-2631-vulnerability-report-script

LCORE-2631: Vulnerability report script

Author: tisnik

scripts/vulnerability_report.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+
+"""CLI tool to retrieve information about Dependabot issues and produces Vulnerability report.
+
+Rretrieves Dependabot issues, analyses issues, generates graphs, and generates
+HTML page with Vulnerability report. Is is also possible to compare two
+repositories.
+"""
+
+from argparse import ArgumentParser
+
+
+def create_argument_parser() -> ArgumentParser:
+    """Create and configure argument parser object.
+
+    The parser includes the following options:
+
+    Returns:
+        Configured ArgumentParser for parsing the command line options.
+    """
+    parser = ArgumentParser(description="Vulnerability report tool")
+
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        dest="verbose",
+        help="make it verbose",
+        action="store_true",
+        default=False,
+    )
+
+    parser.add_argument(
+        "--organization",
+        default="",
+        help="GitHub organization.",
+        required=True,
+    )
+
+    parser.add_argument(
+        "--repository",
+        default="",
+        help="GitHub repository.",
+        required=True,
+    )
+
+    parser.add_argument(
+        "-r",
+        "--retrieve-issues",
+        default=True,
+        help="Retrieve issues",
+    )
+
+    parser.add_argument(
+        "-g",
+        "--generate-graphs",
+        default=True,
+        help="Generate graphs with vulnerabilities info",
+    )
+
+    parser.add_argument(
+        "-p",
+        "--generate-page",
+        default=True,
+        help="Generate page with vulnerabilities info",
+    )
+
+    parser.add_argument(
+        "-c",
+        "--comparison",
+        default=False,
+        help="Compare two repositories and generate comparison report. "
+        "Need to be used with --data1 and --data2 options",
+    )
+
+    return parser
+
+
+def main() -> int:
+    """
+    CLI entry point that retrieves Dependabot issues and produces Vulnerability report.
+
+    Parses command-line arguments, retrieves Dependabot issues, analyses issues, generates
+    graphs, and generates HTML page with Vulnerability report. Is is also possible to
+    compare two repositories.
+
+    Error diagnostics are printed to stderr.
+
+    Usage:
+
+    Returns:
+        int: Exit code where
+            `0` indicates success,
+            `1` indicates any failure
+    """
+    parser = create_argument_parser()
+    args = parser.parse_args()
+
+    print(args)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())