csparser: black-list 'remediation' for a key event

But do not treat it as a trace event either.

Author: kdudka

csparser.cc

@@ -214,7 +214,7 @@ struct KeyEventDigger::Private {
     typedef std::set<std::string>                   TSet;
     typedef std::map<std::string, TSet>             TMap;
     TMap hMap;
-    TSet blackList;
+    TSet blackList, traceEvts;
 };
 
 KeyEventDigger::KeyEventDigger():
@@ -258,26 +258,29 @@ KeyEventDigger::KeyEventDigger():
     // do not match the lowered checker name of the following checkers
     d->hMap["LOCK"];
 
-    // events that should never be used as key events
-    d->blackList.insert("break");
-    d->blackList.insert("caretline");
-    d->blackList.insert("cond_false");
-    d->blackList.insert("cond_true");
-    d->blackList.insert("continue");
-    d->blackList.insert("else_branch");
-    d->blackList.insert("end_of_path");
-    d->blackList.insert("goto");
-    d->blackList.insert("if_end");
-    d->blackList.insert("if_fallthrough");
-    d->blackList.insert("label");
-    d->blackList.insert("loop");
-    d->blackList.insert("loop_begin");
-    d->blackList.insert("loop_end");
-    d->blackList.insert("switch");
-    d->blackList.insert("switch_case");
-    d->blackList.insert("switch_default");
-    d->blackList.insert("switch_end");
-    d->blackList.insert("return");
+    // events that should never be used as key events (excluding trace events)
+    d->blackList.insert("remediation");
+
+    // trace events
+    d->traceEvts.insert("break");
+    d->traceEvts.insert("caretline");
+    d->traceEvts.insert("cond_false");
+    d->traceEvts.insert("cond_true");
+    d->traceEvts.insert("continue");
+    d->traceEvts.insert("else_branch");
+    d->traceEvts.insert("end_of_path");
+    d->traceEvts.insert("goto");
+    d->traceEvts.insert("if_end");
+    d->traceEvts.insert("if_fallthrough");
+    d->traceEvts.insert("label");
+    d->traceEvts.insert("loop");
+    d->traceEvts.insert("loop_begin");
+    d->traceEvts.insert("loop_end");
+    d->traceEvts.insert("switch");
+    d->traceEvts.insert("switch_case");
+    d->traceEvts.insert("switch_default");
+    d->traceEvts.insert("switch_end");
+    d->traceEvts.insert("return");
 }
 
 KeyEventDigger::~KeyEventDigger() {
@@ -322,7 +325,9 @@ bool KeyEventDigger::guessKeyEvent(Defect *def) {
             // never use comment as the key event
             continue;
 
-        if (!d->blackList.count(evt.event))
+        const std::string &evtName = evt.event;
+        if (!d->traceEvts.count(evtName) && !d->blackList.count(evtName))
+            // never use trace or black-listed event as the key event
             break;
     }
 
@@ -336,7 +341,7 @@ void KeyEventDigger::initVerbosity(Defect *def) {
         DefEvent &evt = evtList[idx];
         evt.verbosityLevel = (idx == def->keyEventIdx)
             ? /* key event */ 0
-            : 1 + /* trace event */ !!d->blackList.count(evt.event);
+            : 1 + /* trace event */ !!d->traceEvts.count(evt.event);
     }
 }
 

tests/CMakeLists.txt

@@ -144,6 +144,8 @@ test_csgrep(csgrep      "34-csgrep-color"             )
 test_csgrep(csgrep      "35-cov-format-errors"        )
 test_csgrep(csgrep      "36-csgrep-json"              )
 test_csgrep(csgrep      "37-csgrep-json"              )
+test_csgrep(csgrep      "38-csparser-remediation"     )
+test_csgrep(csgrep      "39-csparser-remediation"     )
 test_csparser(csparser-5.8                          00)
 test_csparser(csparser-5.8                          01)
 test_csparser(csparser-5.8                          02)

tests/csgrep/38-csparser-remediation-args.txt

@@ -0,0 +1 @@
+--prune-events=0

tests/csgrep/38-csparser-remediation-stdin.txt

@@ -0,0 +1,10 @@
+Error: NO_EFFECT:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+bad_memset: Calling "memset" with size 0: "memset(buf, 4096, 0UL)" does nothing.
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+remediation: Did you reverse the second and third arguments?  The second argument should be the value to fill the memory with and the third argument should be the number of bytes to set.
+Error: memset_noop:
+path:/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:6:
+cond_true: Condition "f < 100", taking true branch.
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+memset_noop: "memset(buf, 4096, 0UL)" does nothing because the "size" argument of memset() evaluates to zero. Did you swap its arguments?

tests/csgrep/38-csparser-remediation-stdout.txt

@@ -0,0 +1,5 @@
+Error: NO_EFFECT:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7: bad_memset: Calling "memset" with size 0: "memset(buf, 4096, 0UL)" does nothing.
+
+Error: memset_noop:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7: memset_noop: "memset(buf, 4096, 0UL)" does nothing because the "size" argument of memset() evaluates to zero. Did you swap its arguments?

tests/csgrep/39-csparser-remediation-args.txt

@@ -0,0 +1 @@
+--prune-events=1

tests/csgrep/39-csparser-remediation-stdin.txt

@@ -0,0 +1,10 @@
+Error: NO_EFFECT:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+bad_memset: Calling "memset" with size 0: "memset(buf, 4096, 0UL)" does nothing.
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+remediation: Did you reverse the second and third arguments?  The second argument should be the value to fill the memory with and the third argument should be the number of bytes to set.
+Error: memset_noop:
+path:/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:6:
+cond_true: Condition "f < 100", taking true branch.
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7:
+memset_noop: "memset(buf, 4096, 0UL)" does nothing because the "size" argument of memset() evaluates to zero. Did you swap its arguments?

tests/csgrep/39-csparser-remediation-stdout.txt

@@ -0,0 +1,6 @@
+Error: NO_EFFECT:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7: bad_memset: Calling "memset" with size 0: "memset(buf, 4096, 0UL)" does nothing.
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7: remediation: Did you reverse the second and third arguments?  The second argument should be the value to fill the memory with and the third argument should be the number of bytes to set.
+
+Error: memset_noop:
+/home/kdudka/git/csa-sdk/memset_noop/tests/memset_noop-tests.c:7: memset_noop: "memset(buf, 4096, 0UL)" does nothing because the "size" argument of memset() evaluates to zero. Did you swap its arguments?