Added Docker Containerization with Run Script for CLI Tool Execution

prospector/Makefile

@@ -24,6 +24,7 @@ dev-setup: setup requirements-dev.txt
 	@echo "$(DONE) Installed development requirements"
 
 docker-setup:
+	docker build -t prospector-base:1.0 -f ./docker/Dockerfile .
 	docker-compose up -d --build
 
 docker-clean:

prospector/cli/main.py

@@ -30,10 +30,7 @@
 
 def main(argv):  # noqa: C901
     with ConsoleWriter("Initialization") as console:
-        print("before config: ", argv)
         config = get_configuration(argv)
-        print("after config: ", config.cve_id)
-
         if not config:
             logger.error("No configuration file found. Cannot proceed.")
 
@@ -46,7 +43,7 @@ def main(argv):  # noqa: C901
         logger.setLevel(config.log_level)
         logger.info(f"Global log level set to {get_level(string=True)}")
 
-        if config.cve_id is None:
+        if config.vuln_id is None:
             logger.error("No vulnerability id was specified. Cannot proceed.")
             console.print(
                 "No configuration file found.",
@@ -64,10 +61,10 @@ def main(argv):  # noqa: C901
         logger.debug("Using the following configuration:")
         pretty_log(logger, config.__dict__)
 
-        logger.debug("Vulnerability ID: " + config.cve_id)
+        logger.debug("Vulnerability ID: " + config.vuln_id)
 
     results, advisory_record = prospector(
-        vulnerability_id=config.cve_id,
+        vulnerability_id=config.vuln_id,
         repository_url=config.repository,
         publication_date=config.pub_date,
         vuln_descr=config.description,

prospector/config-sample.yaml

@@ -18,8 +18,8 @@ nvd_token: Null
 use_backend: optional
 
 # Optional backend info to save/use already preprocessed data
-backend: http://backend:8000
-#backend: http://localhost:8000
+#backend: http://backend:8000
+backend: http://localhost:8000
 
 database:
   user: postgres

prospector/core/prospector.py

@@ -61,7 +61,7 @@ def prospector(  # noqa: C901
     git_cache: str = "/tmp/git_cache",
     limit_candidates: int = MAX_CANDIDATES,
     rules: List[str] = ["ALL"],
-    tag_commits: bool = False,
+    tag_commits: bool = True,
     silent: bool = False,
 ) -> Tuple[List[Commit], AdvisoryRecord] | Tuple[int, int]:
     if silent:
@@ -143,7 +143,7 @@ def prospector(  # noqa: C901
     with ExecutionTimer(
         core_statistics.sub_collection("commit preprocessing")
     ) as timer:
-        with ConsoleWriter("\nPreprocessing commits") as writer:
+        with ConsoleWriter("\nProcessing commits") as writer:
             try:
                 if use_backend != "never":
                     missing, preprocessed_commits = retrieve_preprocessed_commits(
@@ -158,7 +158,7 @@ def prospector(  # noqa: C901
                 )
                 if use_backend == "always":
                     print("Backend not reachable: aborting")
-                    sys.exit(0)
+                    sys.exit(1)
                 print("Backend not reachable: continuing")
 
             if "missing" not in locals():
@@ -169,7 +169,7 @@ def prospector(  # noqa: C901
                 # preprocessed_commits += preprocess_commits(missing, timer)
 
                 pbar = tqdm(
-                    missing, desc="Preprocessing commits", unit="commit", disable=silent
+                    missing, desc="Processing commits", unit="commit", disable=silent
                 )
                 start_time = time.time()
                 with Counter(
@@ -215,7 +215,7 @@ def preprocess_commits(commits: List[RawCommit], timer: ExecutionTimer) -> List[
         counter.initialize("preprocessed commits", unit="commit")
         for raw_commit in tqdm(
             commits,
-            desc="Preprocessing commits",
+            desc="Processing commits",
             unit=" commit",
         ):
             counter.increment("preprocessed commits")
@@ -321,8 +321,8 @@ def retrieve_preprocessed_commits(
 
 def save_preprocessed_commits(backend_address, payload):
     with ExecutionTimer(core_statistics.sub_collection(name="save commits to backend")):
-        with ConsoleWriter("Saving preprocessed commits to backend") as writer:
-            logger.debug("Sending preprocessing commits to backend...")
+        with ConsoleWriter("Saving processed commits to backend") as writer:
+            logger.debug("Sending processing commits to backend...")
             try:
                 r = requests.post(
                     backend_address + "/commits/",