added RULE-14-4 and moved A5-0-2 to shared folder

s-samadi · s-samadi · commit 9748585e5560 · 2023-03-07T16:22:55.000+11:00
diff --git a/c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.expected b/c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.expected
@@ -0,0 +1,3 @@
+| test.c:7:7:7:8 | l1 | If condition has non boolean type int. |
+| test.c:9:7:9:8 | call to f1 | If condition has non boolean type int. |
+| test.c:12:7:12:8 | l2 | If condition has non boolean type void *. |
diff --git a/c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql b/c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.nonbooleanifstmt.NonBooleanIfStmt
diff --git a/c/common/test/rules/nonbooleanifstmt/test.c b/c/common/test/rules/nonbooleanifstmt/test.c
@@ -0,0 +1,24 @@
+#include "stdbool.h"
+int f1();
+void *f2();
+
+void f3() {
+  int l1 = 1;
+  if (l1) { // NON_COMPLIANT
+  }
+  if (f1()) { // NON_COMPLIANT
+  }
+  void *l2 = f2();
+  if (l2) { // NON_COMPLIANT
+  }
+}
+
+void f4() {
+  int l1 = 1;
+  if ((bool)l1) { // COMPLIANT
+  }
+
+  int l2 = 1;
+  if ((const bool)l2) { // COMPLIANT
+  }
+}
diff --git a/c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.expected b/c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.expected
@@ -0,0 +1,3 @@
+| test.c:5:3:6:3 | for(...;...;...) ... | Iteration condition has non boolean type int. |
+| test.c:7:3:8:3 | while (...) ... | Iteration condition has non boolean type int. |
+| test.c:13:3:14:3 | for(...;...;...) ... | Iteration condition has non boolean type int. |
diff --git a/c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql b/c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.nonbooleaniterationstmt.NonBooleanIterationStmt
diff --git a/c/common/test/rules/nonbooleaniterationstmt/test.c b/c/common/test/rules/nonbooleaniterationstmt/test.c
@@ -0,0 +1,15 @@
+
+
+void f1() {
+  int l1;
+  for (int i = 10; i; i++) { // NON_COMPLIANT
+  }
+  while (l1) { // NON_COMPLIANT
+  }
+}
+
+void f2() {
+  int j = 0;
+  for (int i = 0; i < 10; i++) { // COMPLIANT
+  }
+}
diff --git a/c/misra/src/rules/RULE-14-4/NonBooleanIfCondition.ql b/c/misra/src/rules/RULE-14-4/NonBooleanIfCondition.ql
@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/non-boolean-if-condition
+ * @name RULE-14-4: The condition of an if-statement shall have type bool
+ * @description Non boolean conditions can be confusing for developers.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/misra/id/rule-14-4
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.nonbooleanifstmt.NonBooleanIfStmt
+
+class NonBooleanIfConditionQuery extends NonBooleanIfStmtSharedQuery {
+  NonBooleanIfConditionQuery() {
+    this = Statements4Package::nonBooleanIfConditionQuery()
+  }
+}
diff --git a/c/misra/src/rules/RULE-14-4/NonBooleanIterationCondition.ql b/c/misra/src/rules/RULE-14-4/NonBooleanIterationCondition.ql
@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/non-boolean-iteration-condition
+ * @name RULE-14-4: The condition of an iteration statement shall have type bool
+ * @description Non boolean conditions can be confusing for developers.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/misra/id/rule-14-4
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.nonbooleaniterationstmt.NonBooleanIterationStmt
+
+class NonBooleanIterationConditionQuery extends NonBooleanIterationStmtSharedQuery {
+  NonBooleanIterationConditionQuery() {
+    this = Statements4Package::nonBooleanIterationConditionQuery()
+  }
+}
diff --git a/c/misra/test/rules/RULE-14-4/NonBooleanIfCondition.testref b/c/misra/test/rules/RULE-14-4/NonBooleanIfCondition.testref
@@ -0,0 +1 @@
+c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql
diff --git a/c/misra/test/rules/RULE-14-4/NonBooleanIterationCondition.testref b/c/misra/test/rules/RULE-14-4/NonBooleanIterationCondition.testref
@@ -0,0 +1 @@
+c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql
diff --git a/cpp/autosar/src/rules/A5-0-2/NonBooleanIfCondition.ql b/cpp/autosar/src/rules/A5-0-2/NonBooleanIfCondition.ql
@@ -15,12 +15,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
+import codingstandards.cpp.rules.nonbooleanifstmt.NonBooleanIfStmt
 
-from IfStmt ifStmt, Expr condition, Type explicitConversionType
-where
-  not isExcluded(ifStmt, ConditionalsPackage::nonBooleanIfConditionQuery()) and
-  condition = ifStmt.getCondition() and
-  not ifStmt.isFromUninstantiatedTemplate(_) and
-  explicitConversionType = condition.getExplicitlyConverted().getType().getUnspecifiedType() and
-  not explicitConversionType instanceof BoolType
-select condition, "If condition has non boolean type " + explicitConversionType + "."
+class NonBooleanIfConditionQuery extends NonBooleanIfStmtSharedQuery {
+  NonBooleanIfConditionQuery() {
+    this = ConditionalsPackage::nonBooleanIfConditionQuery()
+  }
+}
diff --git a/cpp/autosar/src/rules/A5-0-2/NonBooleanIterationCondition.ql b/cpp/autosar/src/rules/A5-0-2/NonBooleanIterationCondition.ql
@@ -15,11 +15,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
+import codingstandards.cpp.rules.nonbooleaniterationstmt.NonBooleanIterationStmt
 
-from Loop loopStmt, Expr condition, Type explicitConversionType
-where
-  not isExcluded(loopStmt, ConditionalsPackage::nonBooleanIterationConditionQuery()) and
-  condition = loopStmt.getCondition() and
-  explicitConversionType = condition.getExplicitlyConverted().getType().getUnspecifiedType() and
-  not explicitConversionType instanceof BoolType
-select condition, "Iteration condition has non boolean type " + explicitConversionType + "."
+class NonBooleanIterationConditionQuery extends NonBooleanIterationStmtSharedQuery {
+  NonBooleanIterationConditionQuery() {
+    this = ConditionalsPackage::nonBooleanIterationConditionQuery()
+  }
+}
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.expected b/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.expected
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.qlref b/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.qlref
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.testref b/cpp/autosar/test/rules/A5-0-2/NonBooleanIfCondition.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.expected b/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.expected
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.qlref b/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.qlref
diff --git a/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.testref b/cpp/autosar/test/rules/A5-0-2/NonBooleanIterationCondition.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql
diff --git a/cpp/common/src/codingstandards/cpp/rules/nonbooleanifstmt/NonBooleanIfStmt.qll b/cpp/common/src/codingstandards/cpp/rules/nonbooleanifstmt/NonBooleanIfStmt.qll
@@ -0,0 +1,22 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+
+abstract class NonBooleanIfStmtSharedQuery extends Query { }
+
+Query getQuery() { result instanceof NonBooleanIfStmtSharedQuery }
+
+query predicate problems(Expr condition, string message) {
+  not isExcluded(condition, getQuery()) and
+  exists(IfStmt ifStmt, Type explicitConversionType |
+    condition = ifStmt.getCondition() and
+    not ifStmt.isFromUninstantiatedTemplate(_) and
+    explicitConversionType = condition.getExplicitlyConverted().getUnderlyingType() and
+    not explicitConversionType instanceof BoolType and
+    message = "If condition has non boolean type " + explicitConversionType + "."
+  )
+}
diff --git a/cpp/common/src/codingstandards/cpp/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.qll b/cpp/common/src/codingstandards/cpp/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.qll
@@ -0,0 +1,21 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+
+abstract class NonBooleanIterationStmtSharedQuery extends Query { }
+
+Query getQuery() { result instanceof NonBooleanIterationStmtSharedQuery }
+
+query predicate problems(Loop loopStmt, string message) {
+  not isExcluded(loopStmt, getQuery()) and
+  exists(Expr condition, Type explicitConversionType |
+    condition = loopStmt.getCondition() and
+    explicitConversionType = condition.getExplicitlyConverted().getType().getUnspecifiedType() and
+    not explicitConversionType instanceof BoolType and
+    message = "Iteration condition has non boolean type " + explicitConversionType + "."
+  )
+}
diff --git a/cpp/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.expected b/cpp/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.expected
@@ -0,0 +1,3 @@
+| test.cpp:9:7:9:7 | i | If condition has non boolean type int. |
+| test.cpp:11:7:11:7 | call to f | If condition has non boolean type int. |
+| test.cpp:14:7:14:7 | a | If condition has non boolean type void *. |
diff --git a/cpp/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql b/cpp/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.nonbooleanifstmt.NonBooleanIfStmt
diff --git a/cpp/common/test/rules/nonbooleanifstmt/test.cpp b/cpp/common/test/rules/nonbooleanifstmt/test.cpp
@@ -1,3 +1,4 @@
+
 #include <deque>
 
 int f();
@@ -45,56 +46,3 @@ void test_boolean_conditions() {
   if (a) { // COMPLIANT - a has an explicit operator bool()
   }
 }
-
-void test_non_boolean_iterations() {
-  int j;
-  for (int i = 10; i; i++) { // NON_COMPLIANT
-    j = 3;
-  }
-
-  while (j) { // NON_COMPLIANT
-    int k = 3;
-  }
-}
-
-void test_boolean_iterations() {
-  int j = 0;
-  for (int i = 0; i < 10; i++) { // COMPLIANT
-    j = i + j;
-  }
-
-  int boolean = 0;
-  while (bool(boolean)) { // COMPLIANT
-    j = 5;
-  }
-
-  while (int i = 0) { // COMPLIANT - due to exception
-  }
-
-  ClassA a;
-  while (a) { // COMPLIANT - a has an explicit operator bool()
-  }
-}
-
-template <class T> class ClassB {
-public:
-  std::deque<T> d;
-  void f() {
-    if (d.empty()) { // COMPLIANT
-    }
-  }
-};
-
-void class_b_test() {
-  ClassB<int> b;
-
-  b.f();
-}
-
-class ClassC {
-  void run() {
-    std::deque<int> d;
-    if (!d.empty()) { // COMPLIANT
-    }
-  }
-};
diff --git a/cpp/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.expected b/cpp/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.expected
@@ -0,0 +1,2 @@
+| test.cpp:7:3:9:3 | for(...;...;...) ... | Iteration condition has non boolean type int. |
+| test.cpp:11:3:13:3 | while (...) ... | Iteration condition has non boolean type int. |
diff --git a/cpp/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql b/cpp/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.nonbooleaniterationstmt.NonBooleanIterationStmt
diff --git a/cpp/common/test/rules/nonbooleaniterationstmt/test.cpp b/cpp/common/test/rules/nonbooleaniterationstmt/test.cpp
@@ -0,0 +1,44 @@
+#include <deque>
+
+int f();
+void *g();
+void test_non_boolean_iterations() {
+  int j;
+  for (int i = 10; i; i++) { // NON_COMPLIANT
+    j = 3;
+  }
+
+  while (j) { // NON_COMPLIANT
+    int k = 3;
+  }
+}
+
+void test_boolean_iterations() {
+  int j = 0;
+  for (int i = 0; i < 10; i++) { // COMPLIANT
+    j = i + j;
+  }
+}
+
+template <class T> class ClassB {
+public:
+  std::deque<T> d;
+  void f() {
+    if (d.empty()) { // COMPLIANT
+    }
+  }
+};
+
+void class_b_test() {
+  ClassB<int> b;
+
+  b.f();
+}
+
+class ClassC {
+  void run() {
+    std::deque<int> d;
+    if (!d.empty()) { // COMPLIANT
+    }
+  }
+};
diff --git a/rule_packages/cpp/Conditionals.json b/rule_packages/cpp/Conditionals.json
@@ -16,6 +16,7 @@
           "precision": "very-high",
           "severity": "recommendation",
           "short_name": "NonBooleanIfCondition",
+          "shared_implementation_short_name": "NonBooleanIfStmt",
           "tags": [
             "maintainability",
             "readability"
@@ -28,6 +29,7 @@
           "precision": "very-high",
           "severity": "recommendation",
           "short_name": "NonBooleanIterationCondition",
+          "shared_implementation_short_name": "NonBooleanIterationStmt",
           "tags": [
             "maintainability",
             "readability"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| test.c:7:7:7:8 \| l1 \| If condition has non boolean type int. \|`
	`2`	`+\| test.c:9:7:9:8 \| call to f1 \| If condition has non boolean type int. \|`
	`3`	`+\| test.c:12:7:12:8 \| l2 \| If condition has non boolean type void *. \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// GENERATED FILE - DO NOT MODIFY`
	`2`	`+import codingstandards.cpp.rules.nonbooleanifstmt.NonBooleanIfStmt`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| test.c:5:3:6:3 \| for(...;...;...) ... \| Iteration condition has non boolean type int. \|`
	`2`	`+\| test.c:7:3:8:3 \| while (...) ... \| Iteration condition has non boolean type int. \|`
	`3`	`+\| test.c:13:3:14:3 \| for(...;...;...) ... \| Iteration condition has non boolean type int. \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+c/common/test/rules/nonbooleanifstmt/NonBooleanIfStmt.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+c/common/test/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.ql`