Merge pull request diffblue#276 from diffblue/marek/test_driver_copy-paste-able_command

Copy-paste-able dump of executed/failed command of security-scanner pipeline.

Author: smowton

regression/end_to_end/driver.py

@@ -78,7 +78,7 @@ def run_security_analyser_pipeline(
                "-R", results_dir,
                "-T", temporary_dir,
                "--name", relative_binary_path,
-               "--verbosity", "9"]
+               "--verbosity", "9"]  # TODO: we should rather pass the verbosity to this function.
     cmdline.extend(extra_args)
     if "SECURITY_ANALYSER_END_TO_END_TESTS_EXTRA_ARGS" in os.environ:
         cmdline.extend(os.environ["SECURITY_ANALYSER_END_TO_END_TESTS_EXTRA_ARGS"].split(","))
@@ -87,12 +87,24 @@ def run_security_analyser_pipeline(
          temp_dir_deleter(results_dir), \
          temp_dir_deleter(temporary_dir):
 
+        def quote_pathnames_in_command_line(cmdline):
+            assert isinstance(cmdline, list) and len(cmdline) > 0
+            result = cmdline[:1]
+            for idx in range(1, len(cmdline)):
+                if cmdline[idx - 1] in ["-C", "-I", "-R", "-T"] or \
+                   (cmdline[idx - 1] == "--name" and " " in cmdline[idx]):
+                    result.append("'" + cmdline[idx] + "'")
+                else:
+                    result.append(cmdline[idx])
+            return result
+
         executable_runner = ExecutableRunner(cmdline)
         (stdout, stderr, ret) = executable_runner.run()
         if ret != 0:
             raise Exception(
-                "Failed running %s:\nstdout:\n\n%s\nstderr\n\n%s" % \
-                (cmdline, stdout, stderr))
+                "Failed running \"%s\":\nstdout:\n\n%s\nstderr\n\n%s" % \
+                (" ".join(quote_pathnames_in_command_line(cmdline)),
+                 stdout, stderr))
 
         trace_list = \
             os.path.join(
@@ -112,6 +124,8 @@ def run_security_analyser_pipeline(
                         inline_traces.append(trace_json)
 
         if "SECURITY_ANALYSER_END_TO_END_TESTS_KEEP_RESULTS" in os.environ:
-            print("Test %s kept results (%s) and temporary directory (%s)" % (cmdline, results_dir, temporary_dir))
+            print("Test \"%s\" kept results (%s) and temporary directory (%s)" %
+                  (" ".join(quote_pathnames_in_command_line(cmdline)),
+                   results_dir, temporary_dir))
 
         return ErrorTraces(traces)