From b36ebb3972d84aa112e3e5e42a6f37fb23ef6804 Mon Sep 17 00:00:00 2001 From: Hubert Tong Date: Wed, 19 Jun 2019 15:27:35 +0000 Subject: [PATCH] [analyzer] SARIF: Add EOF newline; replace diff_sarif Summary: This patch applies a change similar to rC363069, but for SARIF files. The `%diff_sarif` lit substitution invokes `diff` with a non-portable `-I` option. The intended effect can be achieved by normalizing the inputs to `diff` beforehand. Such normalization can be done with `grep -Ev`, which is also used by other tests. Additionally, this patch updates the SARIF output to have a newline at the end of the file. This makes it so that the SARIF file qualifies as a POSIX text file, which increases the consumability of the generated file in relation to various tools. Reviewers: NoQ, sfertile, xingxue, jasonliu, daltenty, aaron.ballman Reviewed By: aaron.ballman Subscribers: xazax.hun, baloghadamsoftware, szepet, a.sidorin, mikhail.ramalho, Szelethus, donat.nagy, dkrupp, Charusso, jsji, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D62952 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@363822 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/StaticAnalyzer/Core/SarifDiagnostics.cpp | 2 +- .../expected-sarif/sarif-diagnostics-taint-test.c.sarif | 2 +- .../expected-sarif/sarif-multi-diagnostic-test.c.sarif | 2 +- test/Analysis/diagnostics/sarif-diagnostics-taint-test.c | 2 +- test/Analysis/diagnostics/sarif-multi-diagnostic-test.c | 2 +- test/Analysis/lit.local.cfg | 9 ++++++--- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/lib/StaticAnalyzer/Core/SarifDiagnostics.cpp b/lib/StaticAnalyzer/Core/SarifDiagnostics.cpp index 4233f25edb..d1faf3f4de 100644 --- a/lib/StaticAnalyzer/Core/SarifDiagnostics.cpp +++ b/lib/StaticAnalyzer/Core/SarifDiagnostics.cpp @@ -345,5 +345,5 @@ void SarifDiagnostics::FlushDiagnosticsImpl( "http://json.schemastore.org/sarif-2.0.0-csd.2.beta.2018-11-28"}, {"version", "2.0.0-csd.2.beta.2018-11-28"}, {"runs", json::Array{createRun(Diags)}}}; - OS << llvm::formatv("{0:2}", json::Value(std::move(Sarif))); + OS << llvm::formatv("{0:2}\n", json::Value(std::move(Sarif))); } diff --git a/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif b/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif index af482a40c9..cebc817dec 100644 --- a/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif +++ b/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif @@ -6,7 +6,7 @@ { "fileLocation": { }, - "length": 415, + "length": 434, "mimeType": "text/plain", "roles": [ "resultFile" diff --git a/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif b/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif index 4ce20e0843..f1527d4105 100644 --- a/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif +++ b/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif @@ -6,7 +6,7 @@ { "fileLocation": { }, - "length": 667, + "length": 686, "mimeType": "text/plain", "roles": [ "resultFile" diff --git a/test/Analysis/diagnostics/sarif-diagnostics-taint-test.c b/test/Analysis/diagnostics/sarif-diagnostics-taint-test.c index 37ddc9df6a..b1042f9034 100644 --- a/test/Analysis/diagnostics/sarif-diagnostics-taint-test.c +++ b/test/Analysis/diagnostics/sarif-diagnostics-taint-test.c @@ -1,4 +1,4 @@ -// RUN: %clang_analyze_cc1 -analyzer-checker=alpha.security.taint,debug.TaintTest %s -verify -analyzer-output=sarif -o - | %diff_sarif %S/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif - +// RUN: %clang_analyze_cc1 -analyzer-checker=alpha.security.taint,debug.TaintTest %s -verify -analyzer-output=sarif -o - | %normalize_sarif | diff -U1 -b %S/Inputs/expected-sarif/sarif-diagnostics-taint-test.c.sarif - #include "../Inputs/system-header-simulator.h" int atoi(const char *nptr); diff --git a/test/Analysis/diagnostics/sarif-multi-diagnostic-test.c b/test/Analysis/diagnostics/sarif-multi-diagnostic-test.c index 459128a05f..3402714a30 100644 --- a/test/Analysis/diagnostics/sarif-multi-diagnostic-test.c +++ b/test/Analysis/diagnostics/sarif-multi-diagnostic-test.c @@ -1,4 +1,4 @@ -// RUN: %clang_analyze_cc1 -analyzer-checker=core,alpha.security.taint,debug.TaintTest %s -verify -analyzer-output=sarif -o - | %diff_sarif %S/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif - +// RUN: %clang_analyze_cc1 -analyzer-checker=core,alpha.security.taint,debug.TaintTest %s -verify -analyzer-output=sarif -o - | %normalize_sarif | diff -U1 -b %S/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif - #include "../Inputs/system-header-simulator.h" int atoi(const char *nptr); diff --git a/test/Analysis/lit.local.cfg b/test/Analysis/lit.local.cfg index bfe4589438..d6c0a370c7 100644 --- a/test/Analysis/lit.local.cfg +++ b/test/Analysis/lit.local.cfg @@ -17,9 +17,12 @@ config.substitutions.append(('%normalize_plist', '^[[:space:]]*/.*[[:space:]]*$', '^[[:space:]]*.:.*[[:space:]]*$'))) -# Diff command for testing SARIF output to reference output. -config.substitutions.append(('%diff_sarif', - '''diff -U1 -w -I ".*file:.*%basename_t" -I '"version":' -I "2\.0\.0\-csd\.[0-9]*\.beta\."''')) +# Filtering command for testing SARIF output against reference output. +config.substitutions.append(('%normalize_sarif', + "grep -Ev '^[[:space:]]*(%s|%s|%s)[[:space:]]*$'" % + ('"uri": "file:.*%basename_t"', + '"version": ".* version .*"', + '"version": "2\.0\.0-csd\.[0-9]*\.beta\.[0-9-]{10}"'))) if not config.root.clang_staticanalyzer: config.unsupported = True -- 2.50.1