fixed some stuff

Author: sacca97

prospector/Makefile

@@ -31,13 +31,13 @@ docker-clean:
 	@docker-compose down --rmi all -v 2>/dev/null
 	@echo "$(DONE) Stopped and removed all container and images"
 
-	@echo "$(PROGRESS) Cleaning volumes"
-	@docker volume prune -f
-	@echo "$(DONE) Cleaned volumes"
+# @echo "$(PROGRESS) Cleaning volumes"
+# @docker volume prune -f
+# @echo "$(DONE) Cleaned volumes"
 
-	@echo "$(PROGRESS) Cleaning residue"
-	@docker system prune -a -f
-	@echo "$(DONE) Cleaned residue"
+# @echo "$(PROGRESS) Cleaning residue"
+# @docker system prune -a -f
+# @echo "$(DONE) Cleaned residue"
 
 
 clean:

prospector/client/cli/main.py

@@ -92,21 +92,21 @@ def main(argv):  # noqa: C901
     with ConsoleWriter("Generating report\n") as console:
         match config.report:
             case "console":
-                report.console(results, advisory_record, get_level() < logging.INFO)
+                report.console_(results, advisory_record, get_level() < logging.INFO)
             case "json":
-                report.json(results, advisory_record, config.report_filename)
+                report.json_(results, advisory_record, config.report_filename)
             case "html":
-                report.html(results, advisory_record, config.report_filename)
+                report.html_(results, advisory_record, config.report_filename)
             case "all":
-                report.json(results, advisory_record, config.report_filename)
-                report.html(results, advisory_record, config.report_filename)
+                report.json_(results, advisory_record, config.report_filename)
+                report.html_(results, advisory_record, config.report_filename)
             case _:
                 logger.warning("Invalid report type specified, using 'console'")
                 console.set_status(MessageStatus.WARNING)
                 console.print(
                     f"{config.report} is not a valid report type, 'console' will be used instead",
                 )
-                report.console(results, advisory_record, get_level() < logging.INFO)
+                report.console_(results, advisory_record, get_level() < logging.INFO)
 
         logger.info("\n" + execution_statistics.generate_console_tree())
         execution_time = execution_statistics["core"]["execution time"][0]

prospector/client/cli/report.py

@@ -19,7 +19,7 @@ def default(self, obj):
         return json.JSONEncoder.default(self, obj)
 
 
-def json(
+def json_(
     results: List[Commit],
     advisory_record: AdvisoryRecord,
     filename: str = "prospector-report.json",
@@ -38,7 +38,7 @@ def json(
     return fn
 
 
-def html(
+def html_(
     results: List[Commit],
     advisory_record: AdvisoryRecord,
     filename: str = "prospector-report.html",
@@ -74,7 +74,7 @@ def html(
     return fn
 
 
-def console(results: List[Commit], advisory_record: AdvisoryRecord, verbose=False):
+def console_(results: List[Commit], advisory_record: AdvisoryRecord, verbose=False):
     def format_annotations(commit: Commit) -> str:
         out = ""
         if verbose:

prospector/client/cli/report_test.py

@@ -2,7 +2,7 @@
 import os.path
 from random import randint
 
-from client.cli.report import as_html, as_json
+import client.cli.report as report
 from datamodel.advisory import build_advisory_record
 from datamodel.commit import Commit
 from util.sample_data_generation import (  # random_list_of_url,
@@ -45,10 +45,10 @@ def test_report_generation():
         os.remove("test_report.html")
     if os.path.isfile("test_report.json"):
         os.remove("test_report.json")
-    html = as_html(
+    html = report.html_(
         candidates, advisory, "test_report.html", statistics=sample_statistics()
     )
-    json = as_json(candidates, advisory, "test_report.json")
+    json = report.json_(candidates, advisory, "test_report.json")
 
     assert os.path.isfile(html)
     assert os.path.isfile(json)

prospector/docker/api/Dockerfile

@@ -3,7 +3,7 @@ FROM python:3.10-slim
 WORKDIR /app
 ADD . .
 COPY docker/api/start.sh /app/start.sh
-COPY /app/config-example.yaml /app/config.yaml
+COPY ./config-sample.yaml /app/config.yaml
 RUN chmod +x /app/start.sh
 COPY ./api /app
 RUN pip install --upgrade pip