Added RULE-15-6

s-samadi · s-samadi · commit 4599a7354a9e · 2023-03-07T07:55:38.000+11:00
diff --git a/c/misra/src/rules/RULE-15-6/LoopCompoundCondition.ql b/c/misra/src/rules/RULE-15-6/LoopCompoundCondition.ql
@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/loop-compound-condition
+ * @name RULE-15-6: the statement forming the body of a loop shall be a compound statement
+ * @description if the body of a loop is not enclosed in braces, then this can lead to incorrect
+ *              execution, and is hard for developers to maintain.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/misra/id/rule-15-6
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+
+from Loop loop
+where
+  not isExcluded(loop, Statements3Package::loopCompoundConditionQuery()) and
+  not loop.getStmt() instanceof BlockStmt
+select loop, "Loop body not enclosed within braces."
diff --git a/c/misra/src/rules/RULE-15-6/SelectionCompoundCondition.ql b/c/misra/src/rules/RULE-15-6/SelectionCompoundCondition.ql
@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/selection-compound-condition
+ * @name RULE-15-6: the statement forming the body of a loop shall be a compound statement
+ * @description if the body of a selection statement is not enclosed in braces, then this can lead
+ *              to incorrect execution, and is hard for developers to maintain.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/misra/id/rule-15-6
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+
+from IfStmt ifStmt
+where
+  not isExcluded(ifStmt, Statements3Package::selectionCompoundConditionQuery()) and
+  not ifStmt.getChildStmt() instanceof BlockStmt
+select ifStmt, "If statement not enclosed within braces."
diff --git a/c/misra/src/rules/RULE-15-6/SwitchCompoundCondition.ql b/c/misra/src/rules/RULE-15-6/SwitchCompoundCondition.ql
@@ -0,0 +1,26 @@
+/**
+ * @id c/misra/switch-compound-condition
+ * @name RULE-15-6: The statement forming the body of a switch shall be a compound statement
+ * @description If the body of a switch is not enclosed in braces, then this can lead to incorrect
+ *              execution, and is hard for developers to maintain.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/misra/id/rule-15-6
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.SwitchStatement
+
+from SwitchStmt switch
+where
+  not isExcluded(switch, Statements3Package::switchCompoundConditionQuery()) and
+  (
+    switch.getStmt() instanceof ArtificialBlock or
+    not switch.getStmt() instanceof BlockStmt
+  )
+select switch, "Switch body not enclosed within braces."
diff --git a/c/misra/test/rules/RULE-15-6/LoopCompoundCondition.expected b/c/misra/test/rules/RULE-15-6/LoopCompoundCondition.expected
@@ -0,0 +1,4 @@
+| test.c:4:3:5:9 | while (...) ... | Loop body not enclosed within braces. |
+| test.c:7:3:8:5 | while (...) ... | Loop body not enclosed within braces. |
+| test.c:11:3:12:9 | for(...;...;...) ... | Loop body not enclosed within braces. |
+| test.c:14:3:15:5 | while (...) ... | Loop body not enclosed within braces. |
diff --git a/c/misra/test/rules/RULE-15-6/LoopCompoundCondition.qlref b/c/misra/test/rules/RULE-15-6/LoopCompoundCondition.qlref
@@ -0,0 +1 @@
+rules/RULE-15-6/LoopCompoundCondition.ql
diff --git a/c/misra/test/rules/RULE-15-6/SelectionCompoundCondition.expected b/c/misra/test/rules/RULE-15-6/SelectionCompoundCondition.expected
@@ -0,0 +1,4 @@
+| test.c:29:3:32:5 | if (...) ...  | If statement not enclosed within braces. |
+| test.c:34:3:41:7 | if (...) ...  | If statement not enclosed within braces. |
+| test.c:36:8:41:7 | if (...) ...  | If statement not enclosed within braces. |
+| test.c:37:5:41:7 | if (...) ...  | If statement not enclosed within braces. |
diff --git a/c/misra/test/rules/RULE-15-6/SelectionCompoundCondition.qlref b/c/misra/test/rules/RULE-15-6/SelectionCompoundCondition.qlref
@@ -0,0 +1 @@
+rules/RULE-15-6/SelectionCompoundCondition.ql
diff --git a/c/misra/test/rules/RULE-15-6/SwitchCompoundCondition.expected b/c/misra/test/rules/RULE-15-6/SwitchCompoundCondition.expected
@@ -0,0 +1 @@
+| test.c:75:3:79:5 | switch (...) ...  | Switch body not enclosed within braces. |
diff --git a/c/misra/test/rules/RULE-15-6/SwitchCompoundCondition.qlref b/c/misra/test/rules/RULE-15-6/SwitchCompoundCondition.qlref
@@ -0,0 +1 @@
+rules/RULE-15-6/SwitchCompoundCondition.ql
diff --git a/c/misra/test/rules/RULE-15-6/test.c b/c/misra/test/rules/RULE-15-6/test.c
@@ -0,0 +1,80 @@
+void f1();
+
+void f2(int p1) {
+  while (p1) // NON_COMPLIANT
+    f1();
+
+  while (p1) // NON_COMPLIANT
+    ;
+  f1();
+
+  for (int i = 0; i < p1; i++) // NON_COMPLIANT
+    f1();
+
+  while (p1)
+    ;
+  { // NON_COMPLIANT
+    ;
+  }
+
+  while (p1) { // COMPLIANT
+    ;
+  }
+  for (int i = 0; i < p1; i++) { // COMPLIANT
+    ;
+  }
+}
+
+void f3(int p1) {
+  if (p1) // NON_COMPLIANT
+    ;
+  else
+    ;
+
+  if (p1) // NON_COMPLIANT
+    ;
+  else if (p1) // NON_COMPLIANT
+    if (p1)    // NON_COMPLIANT
+
+      if (p1) { // COMPLIANT
+        ;
+      }
+
+  if (p1) { // COMPLIANT
+    ;
+  } else { // COMPLIANT
+    ;
+  }
+
+  if (p1) { // COMPLIANT
+    ;
+  } else if (p1) { // COMPLIANT
+    ;
+  } else { // COMPLIANT
+    ;
+  }
+}
+
+void f4(int p1) {
+
+  switch (p1) { // COMPLIANT
+  case 0:
+    while (p1) {
+      ;
+    }
+    break;
+  case 1:
+    if (p1) {
+      ;
+    }
+    break;
+  default:
+    break;
+  }
+
+  switch (p1) // NON_COMPLIANT
+  case 0:
+    while (p1) {
+      ;
+    }
+}
diff --git a/cpp/common/src/codingstandards/cpp/SwitchStatement.qll b/cpp/common/src/codingstandards/cpp/SwitchStatement.qll
@@ -4,6 +4,30 @@
 
 import cpp
 
+/**
+ * Class to differentiate between extractor generated blockstmt and actual blockstmt. The extractor
+ * will generate an artificial blockstmt when there is a single case and statement, e.g.
+ * ```
+ * switch(x)
+ *   case 1:
+ *     f();
+ * ```
+ * This is because our AST model considers the `case` to be a statement in its own right, so the
+ * extractor needs an aritifical block to hold both the case and the statement.
+ */
+class ArtificialBlock extends BlockStmt {
+  ArtificialBlock() {
+    exists(Location block, Location firstStatement |
+      block = getLocation() and firstStatement = getStmt(0).getLocation()
+    |
+      // We can identify artificial blocks as those where the start of the statement is at the same
+      // location as the start of the first statement in the block i.e. there was no opening brace.
+      block.getStartLine() = firstStatement.getStartLine() and
+      block.getStartColumn() = firstStatement.getStartColumn()
+    )
+  }
+}
+
 /* A `SwitchCase` that contains a 'SwitchCase' inside its body  */
 class NestedSwitchCase extends SwitchCase {
   NestedSwitchCase() {
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll
@@ -44,6 +44,7 @@ import SideEffects1
 import SideEffects2
 import Statements1
 import Statements2
+import Statements3
 import Strings1
 import Strings2
 import Strings3
@@ -93,6 +94,7 @@ newtype TCQuery =
   TSideEffects2PackageQuery(SideEffects2Query q) or
   TStatements1PackageQuery(Statements1Query q) or
   TStatements2PackageQuery(Statements2Query q) or
+  TStatements3PackageQuery(Statements3Query q) or
   TStrings1PackageQuery(Strings1Query q) or
   TStrings2PackageQuery(Strings2Query q) or
   TStrings3PackageQuery(Strings3Query q) or
@@ -142,6 +144,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId, string cat
   isSideEffects2QueryMetadata(query, queryId, ruleId, category) or
   isStatements1QueryMetadata(query, queryId, ruleId, category) or
   isStatements2QueryMetadata(query, queryId, ruleId, category) or
+  isStatements3QueryMetadata(query, queryId, ruleId, category) or
   isStrings1QueryMetadata(query, queryId, ruleId, category) or
   isStrings2QueryMetadata(query, queryId, ruleId, category) or
   isStrings3QueryMetadata(query, queryId, ruleId, category) or
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Statements3.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Statements3.qll
@@ -0,0 +1,129 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Statements3Query =
+  TSwitchCompoundConditionQuery() or
+  TLoopCompoundConditionQuery() or
+  TSelectionCompoundConditionQuery() or
+  TIfElseEndConditionQuery() or
+  TSwitchCaseStartConditionQuery() or
+  TSwitchStmtNotWellFormedQuery() or
+  TRecursiveFunctionConditionQuery()
+
+predicate isStatements3QueryMetadata(Query query, string queryId, string ruleId, string category) {
+  query =
+    // `Query` instance for the `switchCompoundCondition` query
+    Statements3Package::switchCompoundConditionQuery() and
+  queryId =
+    // `@id` for the `switchCompoundCondition` query
+    "c/misra/switch-compound-condition" and
+  ruleId = "RULE-15-6" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `loopCompoundCondition` query
+    Statements3Package::loopCompoundConditionQuery() and
+  queryId =
+    // `@id` for the `loopCompoundCondition` query
+    "c/misra/loop-compound-condition" and
+  ruleId = "RULE-15-6" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `selectionCompoundCondition` query
+    Statements3Package::selectionCompoundConditionQuery() and
+  queryId =
+    // `@id` for the `selectionCompoundCondition` query
+    "c/misra/selection-compound-condition" and
+  ruleId = "RULE-15-6" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `ifElseEndCondition` query
+    Statements3Package::ifElseEndConditionQuery() and
+  queryId =
+    // `@id` for the `ifElseEndCondition` query
+    "c/misra/if-else-end-condition" and
+  ruleId = "RULE-15-7" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `switchCaseStartCondition` query
+    Statements3Package::switchCaseStartConditionQuery() and
+  queryId =
+    // `@id` for the `switchCaseStartCondition` query
+    "c/misra/switch-case-start-condition" and
+  ruleId = "RULE-16-1" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `switchStmtNotWellFormed` query
+    Statements3Package::switchStmtNotWellFormedQuery() and
+  queryId =
+    // `@id` for the `switchStmtNotWellFormed` query
+    "c/misra/switch-stmt-not-well-formed" and
+  ruleId = "RULE-16-1" and
+  category = "required"
+  or
+  query =
+    // `Query` instance for the `recursiveFunctionCondition` query
+    Statements3Package::recursiveFunctionConditionQuery() and
+  queryId =
+    // `@id` for the `recursiveFunctionCondition` query
+    "c/misra/recursive-function-condition" and
+  ruleId = "RULE-17-2" and
+  category = "required"
+}
+
+module Statements3Package {
+  Query switchCompoundConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `switchCompoundCondition` query
+      TQueryC(TStatements3PackageQuery(TSwitchCompoundConditionQuery()))
+  }
+
+  Query loopCompoundConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `loopCompoundCondition` query
+      TQueryC(TStatements3PackageQuery(TLoopCompoundConditionQuery()))
+  }
+
+  Query selectionCompoundConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `selectionCompoundCondition` query
+      TQueryC(TStatements3PackageQuery(TSelectionCompoundConditionQuery()))
+  }
+
+  Query ifElseEndConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `ifElseEndCondition` query
+      TQueryC(TStatements3PackageQuery(TIfElseEndConditionQuery()))
+  }
+
+  Query switchCaseStartConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `switchCaseStartCondition` query
+      TQueryC(TStatements3PackageQuery(TSwitchCaseStartConditionQuery()))
+  }
+
+  Query switchStmtNotWellFormedQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `switchStmtNotWellFormed` query
+      TQueryC(TStatements3PackageQuery(TSwitchStmtNotWellFormedQuery()))
+  }
+
+  Query recursiveFunctionConditionQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `recursiveFunctionCondition` query
+      TQueryC(TStatements3PackageQuery(TRecursiveFunctionConditionQuery()))
+  }
+}
diff --git a/rule_packages/c/Statements3.json b/rule_packages/c/Statements3.json
diff --git a/rules.csv b/rules.csv

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-15-6/LoopCompoundCondition.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-15-6/SelectionCompoundCondition.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+\| test.c:75:3:79:5 \| switch (...) ... \| Switch body not enclosed within braces. \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-15-6/SwitchCompoundCondition.ql`