Improve fix for FP for issue 216

Author: knewbury01

cpp/autosar/src/rules/A5-1-1/LiteralValueUsedOutsideTypeInit.ql

@@ -18,25 +18,6 @@ import cpp
 import codingstandards.cpp.autosar
 import codingstandards.cpp.LoggingOperation
 import codingstandards.cpp.Literals
-import codingstandards.cpp.standardlibrary.FileStreams
-
-/**
- * In a wrapper `Function`, all accesses of all `Parameters`
- * are in located in logging or stream calls
- */
-class LoggerOrStreamWrapperFunction extends Function {
-  LoggerOrStreamWrapperFunction() {
-    forall(Parameter p | p.getFunction() = this |
-      forall(VariableAccess va | va = p.getAnAccess() |
-        (
-          any(FileStreamFunctionCall fc).getAnArgument().getAChild*() = va
-          or
-          any(LoggingOperation logOp).getALoggedExpr().getAChild*() = va
-        )
-      )
-    )
-  }
-}
 
 from Literal l
 where
@@ -45,11 +26,8 @@ where
   not exists(ConstructorCall cc | cc.getAnArgument() = l) and
   not exists(ConstructorFieldInit cf | cf.getExpr() = l) and
   not l = any(LoggingOperation logOp).getALoggedExpr().getAChild*() and
-  not l = any(FileStreamFunctionCall fsc).getAnArgument().getAChild*() and
-  // Exclude arguments to wrapper functions
-  not exists(FunctionCall fc, LoggerOrStreamWrapperFunction w |
-    fc.getAnArgument() = l and w.getACallToThisFunction() = fc
-  ) and
+  // Exclude Macros with names like *LOG
+  not exists(MacroInvocation m | m.getMacroName().matches("%LOG") and m.getAnAffectedElement() = l) and
   // Exclude literal 0
   not l.getValue() = "0" and
   // Exclude character literals

cpp/autosar/test/rules/A5-1-1/LiteralValueUsedOutsideTypeInit.expected

@@ -1,5 +1,3 @@
 | test.cpp:5:9:5:25 | constant string | Literal value "constant string" used outside of type initialization StringLiteral |
 | test.cpp:14:23:14:25 | 100 | Literal value 100 used outside of type initialization Literal |
 | test.cpp:54:7:54:7 | 1 | Literal value 1 used outside of type initialization Literal |
-| test.cpp:75:23:75:28 | test | Literal value "test" used outside of type initialization StringLiteral |
-| test.cpp:75:31:75:40 | not okay | Literal value "not okay" used outside of type initialization StringLiteral |

cpp/autosar/test/rules/A5-1-1/test.cpp

@@ -72,6 +72,21 @@ void test_stream_two(std::ostream &os, const char *str,
 }
 
 void test_not_wrapper_stream(std::ostream &os, const char *str) noexcept {
-  test_stream_two(os, "test", "not okay"); // NON_COMPLIANT - test_stream_two is
-                                           // not actually exclusively a wrapper
+  test_stream_two(
+      os, "test",
+      "not okay"); // NON_COMPLIANT[FALSE_NEGATIVE] - test_stream_two is
+                   // not actually exclusively a wrapper
 }
+
+#define MACRO_LOG(test_str) do \
+{\
+struct test_struct {\
+  static const char* get_str(){\
+    return static_cast<char *>(test_str);\
+  }\
+};\
+} while (false)
+
+void f(){
+  MACRO_LOG("test"); //COMPLIANT - exclusion
+}

cpp/common/src/codingstandards/cpp/LoggingOperation.qll

@@ -1,5 +1,6 @@
 import cpp
 import semmle.code.cpp.security.OutputWrite
+import codingstandards.cpp.standardlibrary.FileStreams
 
 /**
  * A operation which may perform logging.
@@ -16,9 +17,36 @@ class OutputWriteLogging extends LoggingOperation, OutputWrite {
   override Expr getALoggedExpr() { result = getASource() }
 }
 
+/**
+ * A `FileStreamFunctionCall` operation is considered a log operation for Coding Standards purposes.
+ */
+class FileStreamLogging extends LoggingOperation, FileStreamFunctionCall {
+  override Expr getALoggedExpr() { result = getAnArgument() }
+
+  override Expr getFStream() { result = this.getQualifier() }
+}
+
 /** A call which looks like `printf`. */
 class PrintfLikeCall extends LoggingOperation, Call {
   PrintfLikeCall() { getTarget().getName().toLowerCase().matches("%printf%") }
 
   override Expr getALoggedExpr() { result = getAnArgument() }
 }
+
+/**
+ * In a wrapper `Function`, all accesses of all `Parameters`
+ * are in located in logging or stream calls
+ */
+class LoggerOrStreamWrapperFunction extends Function {
+  LoggerOrStreamWrapperFunction() {
+    forall(Parameter p | p.getFunction() = this |
+      forall(VariableAccess va | va = p.getAnAccess() |
+        (
+          any(FileStreamFunctionCall fc).getAnArgument().getAChild*() = va
+          or
+          any(LoggingOperation logOp).getALoggedExpr().getAChild*() = va
+        )
+      )
+    )
+  }
+}