Merge branch 'main' into knewbury01/Preprocessor6

Author: knewbury01

.github/touch

@@ -0,0 +1,28 @@
+name: ⚙️ Validate Rules CSV
+
+on:
+  push:
+    branches:
+      - main
+      - "rc/**"
+      - next
+  pull_request:
+    branches:
+      - main
+      - "rc/**"
+      - next
+
+
+jobs:
+  validate-rules-csv:
+    name: Validate Rules CSV 
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Check Rules 
+        shell: pwsh
+        run: scripts/util/Get-DuplicateRules.ps1 -Language 'all' -CIMode
+
+      

.github/workflows/validate-rules-csv.yml

@@ -185,6 +185,7 @@
             "type": "pickString",
             "options": [
                 "Allocations",
+                "Banned",
                 "BannedFunctions",
                 "BannedLibraries",
                 "BannedSyntax",

.vscode/tasks.json

@@ -1,4 +1,4 @@
 name: cert-c-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-c-coding-standards

c/cert/src/qlpack.yml

@@ -1,4 +1,4 @@
 name: cert-c-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: cert-c-coding-standards
 extractor: cpp

c/cert/test/qlpack.yml

@@ -1,3 +1,3 @@
 name: common-c-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: common-cpp-coding-standards

c/common/src/qlpack.yml

@@ -1,4 +1,4 @@
 name: common-c-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: common-c-coding-standards
 extractor: cpp

c/common/test/qlpack.yml

@@ -1,7 +1,7 @@
 problems
-| test.c:8:8:8:12 | c_str | The object returned by the function getenv should not be modified. | test.c:15:16:15:21 | call to getenv | call to getenv | test.c:8:8:8:12 | c_str | c_str |
-| test.c:64:5:64:9 | conv4 | The object returned by the function localeconv should not be modified. | test.c:61:11:61:20 | call to localeconv | call to localeconv | test.c:64:5:64:9 | conv4 | conv4 |
-| test.c:73:5:73:8 | conv | The object returned by the function localeconv should not be modified. | test.c:69:25:69:34 | call to localeconv | call to localeconv | test.c:73:5:73:8 | conv | conv |
+| test.c:8:8:8:12 | c_str | test.c:15:16:15:21 | call to getenv | test.c:8:8:8:12 | c_str | The object returned by the function getenv should not be modified. |
+| test.c:64:5:64:9 | conv4 | test.c:61:11:61:20 | call to localeconv | test.c:64:5:64:9 | conv4 | The object returned by the function localeconv should not be modified. |
+| test.c:73:5:73:8 | conv | test.c:69:25:69:34 | call to localeconv | test.c:73:5:73:8 | conv | The object returned by the function localeconv should not be modified. |
 edges
 | test.c:5:18:5:22 | c_str | test.c:8:8:8:12 | c_str |
 | test.c:15:16:15:21 | call to getenv | test.c:21:9:21:12 | env1 |

c/common/test/rules/constlikereturnvalue/ConstLikeReturnValue.expected

@@ -1,4 +1,4 @@
 name: misra-c-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-c-coding-standards

c/misra/src/qlpack.yml

@@ -1,12 +1,12 @@
 /**
  * @id c/misra/precaution-include-guards-not-provided
- * @name RULE-4-10: Precautions shall be taken in order to prevent the contents of a header file being included more than once
+ * @name DIR-4-10: Precautions shall be taken in order to prevent the contents of a header file being included more than once
  * @description Using anything other than a standard include guard form can make code confusing and
  *              can lead to multiple or conflicting definitions.
  * @kind problem
  * @precision very-high
  * @problem.severity warning
- * @tags external/misra/id/rule-4-10
+ * @tags external/misra/id/dir-4-10
  *       correctness
  *       maintainability
  *       readability

c/misra/src/rules/RULE-4-10/PrecautionIncludeGuardsNotProvided.ql renamed to c/misra/src/rules/DIR-4-10/PrecautionIncludeGuardsNotProvided.ql

@@ -1,13 +1,13 @@
 /**
  * @id c/misra/std-lib-dynamic-memory-allocation-used
- * @name RULE-4-12: Dynamic memory allocation shall not be used
+ * @name DIR-4-12: Dynamic memory allocation shall not be used
  * @description Using dynamic memory allocation and deallocation can result to undefined behavior.
  *              This query is for the Standard Library Implementation. Any implementation outside it
  *              will require a separate query under the same directive.
  * @kind problem
  * @precision very-high
  * @problem.severity error
- * @tags external/misra/id/rule-4-12
+ * @tags external/misra/id/dir-4-12
  *       security
  *       correctness
  *       maintainability

c/misra/src/rules/RULE-4-12/StdLibDynamicMemoryAllocationUsed.ql renamed to c/misra/src/rules/DIR-4-12/StdLibDynamicMemoryAllocationUsed.ql

@@ -1,11 +1,11 @@
 /**
  * @id c/misra/sections-of-code-shall-not-be-commented-out
- * @name RULE-4-4: Sections of code should not be commented out
+ * @name DIR-4-4: Sections of code should not be commented out
  * @description Commented out code may become out of date leading to developer confusion.
  * @kind problem
  * @precision high
  * @problem.severity warning
- * @tags external/misra/id/rule-4-4
+ * @tags external/misra/id/dir-4-4
  *       maintainability
  *       readability
  *       correctness

c/misra/src/rules/RULE-4-4/SectionsOfCodeShallNotBeCommentedOut.ql renamed to c/misra/src/rules/DIR-4-4/SectionsOfCodeShallNotBeCommentedOut.ql

@@ -1,13 +1,13 @@
 /**
  * @id c/misra/object-with-no-pointer-dereference-should-be-opaque
- * @name RULE-4-8: The implementation of an object shall be hidden if a pointer to its structure or union is never dereferenced within a translation unit
+ * @name DIR-4-8: The implementation of an object shall be hidden if a pointer to its structure or union is never dereferenced within a translation unit
  * @description If a pointer to a structure or union is never dereferenced within a translation
  *              unit, then the implementation of the object should be hidden to prevent
  *              unintentional changes.
  * @kind problem
  * @precision very-high
  * @problem.severity error
- * @tags external/misra/id/rule-4-8
+ * @tags external/misra/id/dir-4-8
  *       readability
  *       maintainability
  *       external/misra/obligation/advisory

c/misra/src/rules/RULE-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql renamed to c/misra/src/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql

@@ -1,4 +1,4 @@
 name: misra-c-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: misra-c-coding-standards
 extractor: cpp

c/misra/test/qlpack.yml

@@ -0,0 +1 @@
+rules/DIR-4-12/StdLibDynamicMemoryAllocationUsed.ql

c/misra/test/rules/RULE-4-10/PrecautionIncludeGuardsNotProvided.testref renamed to c/misra/test/rules/DIR-4-10/PrecautionIncludeGuardsNotProvided.testref

@@ -0,0 +1 @@
+rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql

c/misra/test/rules/RULE-4-12/StdLibDynamicMemoryAllocationUsed.expected renamed to c/misra/test/rules/DIR-4-12/StdLibDynamicMemoryAllocationUsed.expected

@@ -1,4 +1,4 @@
 name: autosar-cpp-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-cpp-coding-standards

c/misra/test/rules/DIR-4-12/StdLibDynamicMemoryAllocationUsed.qlref

@@ -1,4 +1,4 @@
 name: autosar-cpp-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: autosar-cpp-coding-standards
 extractor: cpp

c/misra/test/rules/RULE-4-12/test.c renamed to c/misra/test/rules/DIR-4-12/test.c

@@ -1,4 +1,4 @@
 name: cert-cpp-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-cpp-coding-standards

c/misra/test/rules/RULE-4-4/SectionsOfCodeShallNotBeCommentedOut.testref renamed to c/misra/test/rules/DIR-4-4/SectionsOfCodeShallNotBeCommentedOut.testref

@@ -1,4 +1,4 @@
 name: cert-cpp-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: cert-cpp-coding-standards
 extractor: cpp

c/misra/test/rules/RULE-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.expected renamed to c/misra/test/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.expected

@@ -159,7 +159,7 @@ predicate isBannedQueryMetadata(Query query, string queryId, string ruleId) {
   queryId =
     // `@id` for the `stdLibDynamicMemoryAllocationUsed` query
     "c/misra/std-lib-dynamic-memory-allocation-used" and
-  ruleId = "RULE-4-12"
+  ruleId = "DIR-4-12"
   or
   query =
     // `Query` instance for the `octalConstantsUsed` query

c/misra/test/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.qlref

@@ -149,7 +149,7 @@ predicate isPointers1QueryMetadata(Query query, string queryId, string ruleId) {
   queryId =
     // `@id` for the `objectWithNoPointerDereferenceShouldBeOpaque` query
     "c/misra/object-with-no-pointer-dereference-should-be-opaque" and
-  ruleId = "RULE-4-8"
+  ruleId = "DIR-4-8"
   or
   query =
     // `Query` instance for the `pointerShouldPointToConstTypeWhenPossible` query

c/misra/test/rules/RULE-4-8/test.c renamed to c/misra/test/rules/DIR-4-8/test.c

@@ -40,7 +40,7 @@ predicate isPreprocessor2QueryMetadata(Query query, string queryId, string ruleI
   queryId =
     // `@id` for the `precautionIncludeGuardsNotProvided` query
     "c/misra/precaution-include-guards-not-provided" and
-  ruleId = "RULE-4-10"
+  ruleId = "DIR-4-10"
 }
 
 module Preprocessor2Package {

c/misra/test/rules/RULE-4-8/test.h renamed to c/misra/test/rules/DIR-4-8/test.h

@@ -43,7 +43,7 @@ predicate isSyntaxQueryMetadata(Query query, string queryId, string ruleId) {
   queryId =
     // `@id` for the `sectionsOfCodeShallNotBeCommentedOut` query
     "c/misra/sections-of-code-shall-not-be-commented-out" and
-  ruleId = "RULE-4-4"
+  ruleId = "DIR-4-4"
   or
   query =
     // `Query` instance for the `identifiersInTheSameNameSpaceUnambiguous` query

c/misra/test/rules/RULE-4-8/test_2.c renamed to c/misra/test/rules/DIR-4-8/test_2.c

@@ -52,16 +52,13 @@ class DFConf extends DataFlow::Configuration {
 }
 
 query predicate problems(
-  Element e, string message, DataFlow::PathNode source, string sourcetext, DataFlow::PathNode sink,
-  string sinktext
+  Element e, DataFlow::PathNode source, DataFlow::PathNode sink, string message
 ) {
   not isExcluded(e, getQuery()) and
   // the modified object comes from a call to one of the ENV functions
   any(DFConf d).hasFlowPath(source, sink) and
   e = sink.getNode().asExpr() and
   message =
     "The object returned by the function " +
-      source.getNode().asExpr().(FunctionCall).getTarget().getName() + " should not be modified." and
-  sourcetext = source.toString() and
-  sinktext = sink.toString()
+      source.getNode().asExpr().(FunctionCall).getTarget().getName() + " should not be modified."
 }

c/misra/test/rules/RULE-4-8/test_shared.h renamed to c/misra/test/rules/DIR-4-8/test_shared.h

@@ -1,3 +1,3 @@
 name: common-cpp-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: codeql-cpp

c/misra/test/rules/RULE-4-10/NonUniqueIncludeGuards.testref

@@ -1,4 +1,4 @@
 name: common-cpp-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: common-cpp-coding-standards
 extractor: cpp

c/misra/test/rules/RULE-4-12/StdLibDynamicMemoryAllocationUsed.qlref

@@ -1,3 +1,3 @@
 name: misra-cpp-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: common-cpp-coding-standards

c/misra/test/rules/RULE-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.qlref

@@ -1,4 +1,4 @@
 name: misra-cpp-coding-standards-tests
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: misra-cpp-coding-standards
 extractor: cpp

change_notes/2022-11-04-refactor-dir-rules.md

@@ -1,3 +1,3 @@
 name: report-cpp-coding-standards
-version: 2.11.0-dev
+version: 2.12.0-dev
 libraryPathDependencies: codeql-cpp