Merge pull request diffblue#599 from diffblue/jd/feature/more_verbose_logging

More verbose logging in Python

Author: JohnDumbell

driver/mkbench.py

@@ -1,7 +1,6 @@
 import os
 import re
 import sys
-
 import analyser
 import filecmp
 import shutil
@@ -250,11 +249,6 @@ def collect_java_binaries(cmdline):
     with utility.PushCwd(classes_temp_dir):
         utility.check_call(["jar", "cf", java_binaries.jar_file, "."], "jar", 0)
 
-    entry_points_file = configuration["detectedEntryPointsPath"]
-    if not os.path.exists(entry_points_file):
-        print("WARNING: Unable to find any detected entry points. No analysis will be run.")
-        return
-
     # Copy the current commandline and transpose into a dictionary.
     copied_command_line = {key.replace("_", "-"): val for key, val in vars(cmdline).items()}
 
@@ -276,8 +270,22 @@ def collect_java_binaries(cmdline):
     else:
         print("DI generation failed, continuing without synthetic entry points.", file=sys.stderr)
 
-    with open(entry_points_file) as ep_config_file:
-        ep_config = json.load(ep_config_file)
+    entry_points_file = configuration["detectedEntryPointsPath"]
+    if not os.path.exists(entry_points_file):
+        print("WARNING: Unable to find the detected entry points file at " + entry_points_file + ". No analysis will be run.")
+        return
+
+    try:
+        with open(entry_points_file) as ep_config_file:
+            ep_config = json.load(ep_config_file)
+    except json.JSONDecodeError as ex:
+        print("ERROR: Entry points file at " + entry_points_file + " is invalid json. " + ex.msg)
+        return
+
+    # Print out if we have the file, but it has nothing in it.
+    if not ep_config["entryPoints"]:
+        print("WARNING: No entry points have been detected. No analysis can be run.")
+        return
 
     previously_created_folders = set()
     for ep_data in ep_config["entryPoints"]:

driver/run.py

@@ -195,7 +195,8 @@ def create_parser():
     parser.add_argument("--prepare-scan", type=str, const='', nargs='?',
                         help="Path to the configuration file used to do the pre-analysis stage")
     parser.add_argument("--run-scan", type=str, const='', nargs="?",
-                        help="Flag for whether a security scan should be run. Target will be the results folder.")
+                        help="Flag for whether a security scan should be run. If left empty, will run on all folders in results-dir."
+                             "If passed a path to a command_line.json file, it will only run on that folder.")
     parser.add_argument("--skip-di-generation", action='store_true',
                         help="Turns off DI overlay generation. This overrides the automatic detection of DI usage.")
 
@@ -282,9 +283,13 @@ def load_config_and_run_scan(config_path):
 
     # We save the json with '-' as seperators to mimic the arguments coming in
     # but the parser replaces those with '_' and here we want to mimic that.
-    with open(config_path) as config_file:
-        json_output = { key.replace("-", "_"): val for key, val in json.load(config_file).items()}
-        cmdline = SimpleNamespace(**json_output)
+    try:
+        with open(config_path) as config_file:
+            json_output = { key.replace("-", "_"): val for key, val in json.load(config_file).items()}
+            cmdline = SimpleNamespace(**json_output)
+    except json.JSONDecodeError as ex:
+        print("ERROR: Command line configuration at " + config_path + " is invalid json. " + ex.msg)
+        return
 
     run_scan(cmdline)
 
@@ -512,6 +517,10 @@ def extract_wildcard_paths(path):
                   " and the default file can't be found at {0}.".format(default_config_path))
             return
 
+    if not os.path.isfile(cmdline.prepare_scan):
+        print("ERROR: The path passed in via cmdline.prepare_scan, " + cmdline.prepare_scan + ", dosen't exist.")
+        return
+
     if cmdline.name is None:
         cmdline.name = os.path.basename(cmdline.install_dir)