Output to SARIF from scan-build

[aaron.ballman]

Summary

This updates the scan-build perl script to allow outputting to sarif in a more natural fashion by specifying -sarif as a command line argument, similar to how -plist is already supported.

There appear to be no tests for scan-build, which is why you only see implementation files here. I tested locally by running test/Analysis/diagnostics/sarif-diagnostics-taint-test.c through scan-build and ensuring the results are expected for the generated temp directory.

[NoQ]

Thanks, looks perfectly sane to me!

When i previously wanted to add tests for scan-build, it seemed fairly straightforward:

diff --git a/test/Analysis/scan-build/lit.local.cfg b/test/Analysis/scan-build/lit.local.cfg
new file mode 100644
index 0000000000..84749a790e
--- /dev/null
+++ b/test/Analysis/scan-build/lit.local.cfg
@@ -0,0 +1,7 @@
+# -*- Python -*- vim: set ft=python ts=4 sw=4 expandtab tw=79:
+
+import lit.util
+
+config.substitutions.append(('%scan_build',
+                             lit.util.which('scan-build',
+                                            config.environment['PATH'])))
diff --git a/test/Analysis/scan-build/simple-test.test b/test/Analysis/scan-build/simple-test.test
new file mode 100644
index 0000000000..61053dedce
--- /dev/null
+++ b/test/Analysis/scan-build/simple-test.test
@@ -0,0 +1,3 @@
+// RUN: %scan_build --help 2>&1 | FileCheck %s
+
+// CHECK: USAGE: scan-build

But i never committed it, so i'm not sure if it works anywhere except my machine, and i didn't write any actual tests after that. If you like this, you can add this to your patch or make me commit it separately, in any order.

[aaron.ballman]

Committed in r349082.

I left the test file off; it looks like it might work, but given that scan-build puts its output into a temp directory, I wasn't able to see a good way to handle checking the output. Given the simplicity of the change here, I didn't want to spend a lot of time working on spinning up testing infrastructure.

tools/scan-build/bin/scan-build

 
    Specify the title used on generated HTML pages. If not specified, a default
    title will be used.
 
  --show-description
 
    Display the description of defects in the list
 
+ -sarif
+
+  By default the output of scan-build is a set of HTML files. This option
+  outputs the results in SARIF format.
+ 
  -plist
 
    By default the output of scan-build is a set of HTML files. This option
    outputs the results as a set of .plist files.
 
  -plist-html
 
    By default the output of scan-build is a set of HTML files. This option

     }
 
     if ($arg eq "-internal-stats") {
       shift @$Args;
       $Options{InternalStats} = 1;
       next;
     }
 
+    if ($arg eq "-sarif") {
+      shift @$Args;
+      $Options{OutputFormat} = "sarif";
+      next;
+    }
+
     if ($arg eq "-plist") {
       shift @$Args;
       $Options{OutputFormat} = "plist";
       next;
     }
 
     if ($arg eq "-plist-html") {
       shift @$Args;

   'CCC_ANALYZER_FORCE_ANALYZE_DEBUG_CODE' => $Options{ForceAnalyzeDebugCode}
 );
 
 # Run the build.
 my $ExitStatus = RunBuildCommand(\@ARGV, $Options{IgnoreErrors}, $Options{KeepCC},
                           $Cmd, $CmdCXX, \%EnvVars);
 
 if (defined $Options{OutputFormat}) {
-  if ($Options{OutputFormat} =~ /plist/) {
+  if ($Options{OutputFormat} =~ /plist/ ||
+      $Options{OutputFormat} =~ /sarif/) {
     Diag "Analysis run complete.\n";
-    Diag "Analysis results (plist files) deposited in '$Options{OutputDir}'\n";
+    Diag "Analysis results (" .
+      ($Options{OutputFormat} =~ /plist/ ? "plist" : "sarif") .
+      " files) deposited in '$Options{OutputDir}'\n";
   }
   if ($Options{OutputFormat} =~ /html/) {
     # Postprocess the HTML directory.
     my $NumBugs = Postprocess($Options{OutputDir}, $BaseDir,
                               $Options{AnalyzerStats}, $Options{KeepEmpty});
 
     if ($Options{ViewResults} and -r "$Options{OutputDir}/index.html") {
       Diag "Analysis run complete.\n";

tools/scan-build/libexec/ccc-analyzer

     }
 
     if (defined $Plugins) {
       push @AnalyzeArgs, split '\s+', $Plugins;
     }
 
     if (defined $OutputFormat) {
       push @AnalyzeArgs, "-analyzer-output=" . $OutputFormat;
-      if ($OutputFormat =~ /plist/) {
+      if ($OutputFormat =~ /plist/ || $OutputFormat =~ /sarif/) {
         # Change "Output" to be a file.
-        my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => ".plist",
+        my $Suffix = $OutputFormat =~ /plist/ ? ".plist" : ".sarif";
+        my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => $Suffix,
                                DIR => $HtmlDir);
         $ResultFile = $f;
         # If the HtmlDir is not set, we should clean up the plist files.
         if (!defined $HtmlDir || -z $HtmlDir) {
           $CleanupFile = $f;
         }
       }
     }