csdiff: implement --filter-file option

lzaoral · lzaoral · commit 036108f11df6 · 2021-07-30T13:33:50.000+02:00
diff --git a/src/csdiff.cc b/src/csdiff.cc
@@ -50,7 +50,9 @@ int main(int argc, char *argv[])
             ("json-output,j", "write the result in JSON format")
             ("html-output", "write the result in HTML format")
             ("file-rename,s", po::value<TStringList>(),
-             "account the file base-name change, [OLD,NEW] (*testing*)");
+             "account the file base-name change, [OLD,NEW] (*testing*)")
+            ("filter-file,f", po::value<TStringList>(),
+             "read custom filtering rules from a file in JSON format");
 
         addColorOptions(&desc);
 
@@ -151,6 +153,13 @@ int main(int argc, char *argv[])
     const bool showInternal = vm.count("show-internal");
     const bool silent       = vm.count("quiet");
 
+    if (vm.count("filter-file")) {
+        const TStringList &filterFiles = vm["filter-file"].as<TStringList>();
+        if (!MsgFilter::inst()->setFilterFiles(filterFiles, silent))
+            // an error message already printed out
+            return 1;
+    }
+
     try {
         // open streams
         InStream strOld(fnOld, silent);
diff --git a/tests/csdiff/CMakeLists.txt b/tests/csdiff/CMakeLists.txt
@@ -1,4 +1,4 @@
-# Copyright (C) 2011 - 2020 Red Hat, Inc.
+# Copyright (C) 2011 - 2021 Red Hat, Inc.
 #
 # This file is part of csdiff.
 #
@@ -77,3 +77,5 @@ test_csdiff(diff-misc 09-shellcheck-raw)
 test_csdiff(diff-misc 10-pylint-copr)
 test_csdiff(diff-misc 11-pylint-copr-json)
 test_csdiff(diff-misc 12-shellcheck-sc222x)
+
+add_subdirectory(filter-file)
diff --git a/tests/csdiff/filter-file/01-basic-add-z.err b/tests/csdiff/filter-file/01-basic-add-z.err
diff --git a/tests/csdiff/filter-file/01-basic-add.err b/tests/csdiff/filter-file/01-basic-add.err
diff --git a/tests/csdiff/filter-file/01-basic-filter.json b/tests/csdiff/filter-file/01-basic-filter.json
@@ -0,0 +1,13 @@
+{
+    "msg-filter" : [
+        {
+            "checker" : "DIVINE|SYMBIOTIC",
+            "regexp" : "memory"
+        },
+        {
+            "checker" : "COMPILER_WARNING",
+            "regexp" : "called on unallocated object",
+            "replace" : "called correctly, no UB here"
+        }
+    ]
+}
diff --git a/tests/csdiff/filter-file/01-basic-fix-z.err b/tests/csdiff/filter-file/01-basic-fix-z.err
@@ -0,0 +1,5 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c:5:5: warning[-Wunused-result]: ignoring return value of 'calloc' declared with attribute 'warn_unused_result'
+#    5 |     calloc(1, sizeof(char)); /* leak */
+#      |     ^~~~~~~~~~~~~~~~~~~~~~~
diff --git a/tests/csdiff/filter-file/01-basic-fix.err b/tests/csdiff/filter-file/01-basic-fix.err
@@ -0,0 +1,5 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c:5:5: warning[-Wunused-result]: ignoring return value of 'calloc' declared with attribute 'warn_unused_result'
+#    5 |     calloc(1, sizeof(char)); /* leak */
+#      |     ^~~~~~~~~~~~~~~~~~~~~~~
diff --git a/tests/csdiff/filter-file/01-basic-new.err b/tests/csdiff/filter-file/01-basic-new.err
@@ -0,0 +1,20 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:6:5: warning[-Wfree-nonheap-object]: 'free' called correctly, no UB here 'a'
+#    6 |     free(&a); /* invalid free */
+#      |     ^~~~~~~~
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:5:9: note: declared here
+#    5 |     int a;
+#      |         ^
+
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/01-basic-old.err b/tests/csdiff/filter-file/01-basic-old.err
@@ -0,0 +1,26 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:6:5: warning[-Wfree-nonheap-object]: 'free' called on unallocated object 'a'
+#    6 |     free(&a); /* invalid free */
+#      |     ^~~~~~~~
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:5:9: note: declared here
+#    5 |     int a;
+#      |         ^
+
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-calloc/0004-calloc-plain-leak/0004-test.c:5:5: warning[-Wunused-result]: ignoring return value of 'calloc' declared with attribute 'warn_unused_result'
+#    5 |     calloc(1, sizeof(char)); /* leak */
+#      |     ^~~~~~~~~~~~~~~~~~~~~~~
+
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/02-checker-regex-add-z.err b/tests/csdiff/filter-file/02-checker-regex-add-z.err
@@ -0,0 +1,8 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:6:5: warning[-Wfree-nonheap-object]: 'free' called correctly, no UB here 'a'
+#    6 |     free(&a); /* invalid free */
+#      |     ^~~~~~~~
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:5:9: note: declared here
+#    5 |     int a;
+#      |         ^
diff --git a/tests/csdiff/filter-file/02-checker-regex-add.err b/tests/csdiff/filter-file/02-checker-regex-add.err
@@ -0,0 +1,8 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:6:5: warning[-Wfree-nonheap-object]: 'free' called correctly, no UB here 'a'
+#    6 |     free(&a); /* invalid free */
+#      |     ^~~~~~~~
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:5:9: note: declared here
+#    5 |     int a;
+#      |         ^
diff --git a/tests/csdiff/filter-file/02-checker-regex-filter.json b/tests/csdiff/filter-file/02-checker-regex-filter.json
@@ -0,0 +1,9 @@
+{
+    "msg-filter" : [
+        {
+            "checker" : "DIVINE|SYMBIOTIC",
+            "regexp" : "memory",
+            "replace" : "heap"
+        }
+    ]
+}
diff --git a/tests/csdiff/filter-file/02-checker-regex-fix-z.err b/tests/csdiff/filter-file/02-checker-regex-fix-z.err
@@ -0,0 +1,11 @@
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/02-checker-regex-fix.err b/tests/csdiff/filter-file/02-checker-regex-fix.err
@@ -0,0 +1,11 @@
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/02-checker-regex-new.err b/tests/csdiff/filter-file/02-checker-regex-new.err
@@ -0,0 +1,20 @@
+Error: COMPILER_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c: scope_hint: In function 'main'
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:6:5: warning[-Wfree-nonheap-object]: 'free' called correctly, no UB here 'a'
+#    6 |     free(&a); /* invalid free */
+#      |     ^~~~~~~~
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-free/0006-free-stack/0006-test.c:5:9: note: declared here
+#    5 |     int a;
+#      |         ^
+
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/02-checker-regex-old.err b/tests/csdiff/filter-file/02-checker-regex-old.err
@@ -0,0 +1,23 @@
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: heap error: heap not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: SYMBIOTIC_WARNING:
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: error: memory error: memory not cleaned up
+/home/lukas/aufover-benchmark/tests/single-c/mem-basic-malloc/0009-malloc-zerosize-leak/0009-test.c:10: note: call stack: main ()
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: heap error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
+
+Error: DIVINE_WARNING:
+/home/lukas/tmp/assert-bounds.c: scope_hint: In function 'main':
+/home/lukas/tmp/assert-bounds.c:8: error: access of size 1 at [alloca*] is 1 bytes out of bounds
+/home/lukas/tmp/assert-bounds.c:8: note: memory error in userspace
+/opt/divine/include/dios/sys/fault.hpp:119: note: void __dios::FaultBase::handler<__dios::Context>(_VM_Fault, _VM_Frame*, void (*)())
+/home/lukas/tmp/assert-bounds.c:8: note: main
+/opt/divine/include/dios/libc/sys/start.cpp:91: note: __dios_start
diff --git a/tests/csdiff/filter-file/CMakeLists.txt b/tests/csdiff/filter-file/CMakeLists.txt
@@ -0,0 +1,52 @@
+# Copyright (C) 2021 Red Hat, Inc.
+#
+# This file is part of csdiff.
+#
+# csdiff is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# any later version.
+#
+# csdiff is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with csdiff.  If not, see <http://www.gnu.org/licenses/>.
+
+# a generic template for a csdiff test-case
+macro(test_csdiff num)
+    set(tst "${CMAKE_CURRENT_SOURCE_DIR}/${num}")
+
+    set(cmd "${csdiff} -cf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-add.err -")
+    add_test_wrap("filter-file-${num}-added" "${cmd}")
+
+    set(cmd "${csdiff} -xf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${csjson} | ${csgrep}")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-fix.err -")
+    add_test_wrap("filter-file-${num}-fixed" "${cmd}")
+
+    set(cmd "${csdiff} -zf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${csjson} | ${csgrep}")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-add-z.err -")
+    add_test_wrap("filter-file-${num}-added-with-z" "${cmd}")
+
+    set(cmd "${csdiff} -xzf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${csjson} | ${csgrep}")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-fix-z.err -")
+    add_test_wrap("filter-file-${num}-fixed-with-z" "${cmd}")
+
+    set(cmd "${csdiff} -cf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-add.err -")
+    add_test_wrap("filter-file-${num}-added-with-c" "${cmd}")
+
+    set(cmd "${csdiff} -jxf ${tst}-filter.json ${tst}-old.err ${tst}-new.err")
+    set(cmd "${cmd} | ${csgrep}")
+    set(cmd "${cmd} | ${diffcmd} ${tst}-fix.err -")
+    add_test_wrap("filter-file-${num}-fixed-with-j" "${cmd}")
+endmacro()
+
+test_csdiff(01-basic)
+test_csdiff(02-checker-regex)
diff --git a/tests/csdiff/sync-diff.sh b/tests/csdiff/sync-diff.sh
@@ -15,3 +15,18 @@ for i in diff*/; do (
     done
     echo
 ) done
+
+(
+    cd filter-file || exit $?
+    basename "$PWD"
+    for j in [0-9][0-9]*-old.err; do
+        set -x
+        tst=${j%-old.err}
+        "$CSDIFF" -cf   ${tst}-filter.json ${tst}-old.err ${tst}-new.err > ${tst}-add.err
+        "$CSDIFF" -czf  ${tst}-filter.json ${tst}-old.err ${tst}-new.err > ${tst}-add-z.err
+        "$CSDIFF" -cxf  ${tst}-filter.json ${tst}-old.err ${tst}-new.err > ${tst}-fix.err
+        "$CSDIFF" -cxzf ${tst}-filter.json ${tst}-old.err ${tst}-new.err > ${tst}-fix-z.err
+        set +x
+    done
+    echo
+)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright (C) 2011 - 2020 Red Hat, Inc.`
	`1`	`+# Copyright (C) 2011 - 2021 Red Hat, Inc.`
`2`	`2`	`#`
`3`	`3`	`# This file is part of csdiff.`
`4`	`4`	`#`
`@@ -77,3 +77,5 @@ test_csdiff(diff-misc 09-shellcheck-raw)`
`77`	`77`	`test_csdiff(diff-misc 10-pylint-copr)`
`78`	`78`	`test_csdiff(diff-misc 11-pylint-copr-json)`
`79`	`79`	`test_csdiff(diff-misc 12-shellcheck-sc222x)`
	`80`	`+`
	`81`	`+add_subdirectory(filter-file)`