[analyzer][tests] Add normalize_plist to replace diff_plist

[hubert.reinterpretcast]

Summary

The %diff_plist 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.

This patch applies the change (adjusted for review comments) described in http://lists.llvm.org/pipermail/cfe-dev/2019-April/061904.html to the specific case shown in the list message. Mechanical changes to the other affected files will follow in later patches.

[NoQ]

Thanks!

I think we should:

• Pre-normalize our expected outputs so that we didn't have to normalize them in every run-line.
• Treat the lack of newline in plist output as a bug and try to fix it.

[hubert.reinterpretcast]

In D62949#1533574, @NoQ wrote:

I think we should:

• Pre-normalize our expected outputs so that we didn't have to normalize them in every run-line.

Okay; I think this might be possible to do in a separate patch that does not depend on this set.

• Treat the lack of newline in plist output as a bug and try to fix it.

A quick look at this seems to point at clang/lib/ARCMigrate/PlistReporter.cpp and clang/lib/StaticAnalyzer/Core/PlistDiagnostics.cpp.

[NoQ]

Ok! I'll be happy to have this addressed incrementally.

[hubert.reinterpretcast]

In D62949#1533605, @NoQ wrote:

Ok! I'll be happy to have this addressed incrementally.

I think it should be safe to at least commit the pre-normalization directly first. I'll take a look, and update the patch if the pre-normalization lands.

[hubert.reinterpretcast]

I've tested the pre-normalization and it looks like I can commit it tomorrow. I noticed that the following three files appear to be unreferenced:

clang/test/Analysis/Inputs/expected-plists/cstring-plist.c.plist
clang/test/Analysis/Inputs/expected-plists/plist-stats-output.c.plist
clang/test/Analysis/Inputs/expected-plists/yaccignore.c.plist

I'll commit the deletion of these tomorrow as well.

Modifying the tools to produce a newline at the end of the output also seems to work okay with the tests. I've posted the change for that in D63041.

[hubert.reinterpretcast]

Update based on review comments, building from rL362877 and D63041

[hubert.reinterpretcast]

@NoQ, I've updated the patches based on the changes you suggested. This patch, D62950, and D62951 now looks much cleaner. These are now dependent on the approval of D63041.

cfe/trunk/test/Analysis/lit.local.cfg

 # -*- Python -*- vim: set ft=python ts=4 sw=4 expandtab tw=79:
 
 import site
 
 # Load the custom analyzer test format, which runs the test again with Z3 if it
 # is available.
 site.addsitedir(os.path.dirname(__file__))
 import analyzer_test
 config.test_format = analyzer_test.AnalyzerTest(
         config.test_format.execute_external, config.use_z3_solver)
 
 # Diff command used by Clang Analyzer tests (when comparing .plist files
 # with reference output)
 config.substitutions.append(('%diff_plist',
     'diff -u -w -I "<string>/" -I "<string>.:" -I "version"'))
 
+# Filtering command used by Clang Analyzer tests (when comparing .plist files
+# with reference output)
+config.substitutions.append(('%normalize_plist',
+    "grep -Ev '%s|%s|%s'" %
+        ('^[[:space:]]*<string>.* version .*</string>$',
+         '^[[:space:]]*<string>/.*</string>$',
+         '^[[:space:]]*<string>.:.*</string>$')))
+
 # 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\."'''))
 
 if not config.root.clang_staticanalyzer:
     config.unsupported = True

cfe/trunk/test/Analysis/unix-fns.c

 // RUN: %clang_analyze_cc1 -triple x86_64-apple-darwin10 -analyzer-checker=core,unix.API,osx.API,optin.portability %s -analyzer-store=region -analyzer-output=plist -analyzer-config faux-bodies=true  -fblocks -verify -o %t.plist
-// RUN: cat %t.plist | %diff_plist %S/Inputs/expected-plists/unix-fns.c.plist -
+// RUN: %normalize_plist <%t.plist | diff -u %S/Inputs/expected-plists/unix-fns.c.plist -
 // RUN: mkdir -p %t.dir
 // RUN: %clang_analyze_cc1 -analyzer-checker=core,unix.API,osx.API,optin.portability -analyzer-output=html -analyzer-config faux-bodies=true -fblocks -o %t.dir %s
 // RUN: rm -fR %t.dir
 
 
 struct _opaque_pthread_once_t {
   long __sig;
   char __opaque[8];