Merge branch 'main' into jsinglet/rule-fix-dir-1-2

jsinglet · web-flow · commit 9cf82afec52b · 2022-11-04T12:22:15.000-04:00
diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
@@ -10,7 +10,7 @@ on:
 jobs:
 
   apply-version-bump:
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-22.04
     name: Apply Version Bump
     steps:
         - name: Checkout 
diff --git a/.github/workflows/code-scanning-pack-gen.yml b/.github/workflows/code-scanning-pack-gen.yml
@@ -19,7 +19,7 @@ env:
 jobs:
   prepare-code-scanning-pack-matrix:
     name: Prepare CodeQL Code Scanning pack matrix
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     outputs:
       matrix: ${{ steps.export-code-scanning-pack-matrix.outputs.matrix }}
     steps:
diff --git a/.github/workflows/codeql_unit_tests.yml b/.github/workflows/codeql_unit_tests.yml
@@ -14,7 +14,7 @@ on:
 jobs:
   prepare-unit-test-matrix:
     name: Prepare CodeQL unit test matrix
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     outputs:
       matrix: ${{ steps.export-unit-test-matrix.outputs.matrix }}
     steps:
@@ -157,7 +157,7 @@ jobs:
   validate-test-results:
     name: Validate test results
     needs: [run-test-suites]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Collect test results
         uses: actions/download-artifact@v2
diff --git a/.github/workflows/create-draft-release.yml b/.github/workflows/create-draft-release.yml
@@ -21,7 +21,7 @@ on:
 jobs:
   create-draft-release:
     name: Create draft release
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:      
       # AWS CONFIGURATION
       AWS_EC2_INSTANCE_TYPE: ${{ github.event.inputs.aws_ec2_instance_type }}
diff --git a/.github/workflows/generate-html-docs.yml b/.github/workflows/generate-html-docs.yml
@@ -15,7 +15,7 @@ on:
 jobs:
   generate-html-doc:
     name: Generate HTML documentation
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
diff --git a/.github/workflows/standard_library_upgrade_tests.yml b/.github/workflows/standard_library_upgrade_tests.yml
@@ -14,7 +14,7 @@ on:
 jobs:
   prepare-unit-test-matrix:
     name: Prepare CodeQL unit test matrix
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     outputs:
       matrix: ${{ steps.export-unit-test-matrix.outputs.matrix }}
     steps:
@@ -154,7 +154,7 @@ jobs:
   validate-test-results:
     name: Validate test results
     needs: [run-test-suites]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Install Python
         uses: actions/setup-python@v4
diff --git a/.github/workflows/upgrade_codeql_dependencies.yml b/.github/workflows/upgrade_codeql_dependencies.yml
@@ -20,7 +20,7 @@ jobs:
     env:
       CODEQL_CLI_VERSION: ${{ github.event.inputs.codeql_cli_version }}
       CODEQL_LIB_COMMIT: ${{ github.event.inputs.codeql_standard_library_commit }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
diff --git a/.github/workflows/validate-coding-standards.yml b/.github/workflows/validate-coding-standards.yml
@@ -18,7 +18,7 @@ env:
 jobs:
   validate-package-files:
     name: Validate Package Files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -63,7 +63,7 @@ jobs:
 
   validate-codeql-format:
     name: "Validate CodeQL Format"
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -94,7 +94,7 @@ jobs:
 
   validate-query-help-files:
     name: Validate Query Help Files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -129,7 +129,7 @@ jobs:
 
   validate-cpp-test-files:
     name: Validate C++ Test Files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -152,7 +152,7 @@ jobs:
 
   validate-c-test-files:
     name: Validate C Test Files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
diff --git a/c/cert/src/qlpack.yml b/c/cert/src/qlpack.yml
@@ -1,4 +1,4 @@
 name: cert-c-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-c-coding-standards
diff --git a/c/cert/test/qlpack.yml b/c/cert/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: cert-c-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: cert-c-coding-standards
 extractor: cpp
diff --git a/c/common/src/qlpack.yml b/c/common/src/qlpack.yml
@@ -1,3 +1,3 @@
 name: common-c-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: common-cpp-coding-standards
diff --git a/c/common/test/qlpack.yml b/c/common/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: common-c-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: common-c-coding-standards
 extractor: cpp
diff --git a/c/misra/src/qlpack.yml b/c/misra/src/qlpack.yml
@@ -1,4 +1,4 @@
 name: misra-c-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-c-coding-standards
diff --git a/c/misra/test/qlpack.yml b/c/misra/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: misra-c-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: misra-c-coding-standards
 extractor: cpp
diff --git a/change_notes/2022-11-02-c-style-casts-library-macros.md b/change_notes/2022-11-02-c-style-casts-library-macros.md
@@ -0,0 +1,4 @@
+ - `A5-2-2` - `TraditionalCStyleCastsUsed.ql`
+   - Reduced false positives by excluding casts generated by library macros (i.e. macros defined outside the source location)
+   - Improved the message to cite the macro which generated the c-style cast, if any.
+   - Improved the message to cite the type being casted to, to aid with identification and remediation.
diff --git a/change_notes/2022-11-02-m0-1-4-single-use-with-templates.md b/change_notes/2022-11-02-m0-1-4-single-use-with-templates.md
@@ -0,0 +1,2 @@
+ - `M0-1-4` - `SingleUseMemberPODVariable.ql`
+   - Reduce false positives by excluding any constexpr variable whose constant value is used as an argument to a template.
diff --git a/cpp/autosar/src/qlpack.yml b/cpp/autosar/src/qlpack.yml
@@ -1,4 +1,4 @@
 name: autosar-cpp-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-cpp-coding-standards
diff --git a/cpp/autosar/src/rules/A5-2-2/TraditionalCStyleCastsUsed.ql b/cpp/autosar/src/rules/A5-2-2/TraditionalCStyleCastsUsed.ql
@@ -16,9 +16,55 @@
 import cpp
 import codingstandards.cpp.autosar
 
-from CStyleCast c
+/**
+ * Gets the macro (if any) that generated the given `CStyleCast`.
+ *
+ * If there are nested macro invocations, we identify the most specific macro that generated the
+ * cast.
+ */
+Macro getGeneratedFrom(CStyleCast c) {
+  exists(MacroInvocation mi |
+    mi = result.getAnInvocation() and
+    mi.getAGeneratedElement() = c and
+    mi.getLocation().getStartColumn() = c.getLocation().getStartColumn() and
+    not exists(MacroInvocation child |
+      child.getParentInvocation() = mi and
+      child.getAGeneratedElement() = c
+    )
+  )
+}
+
+/** A macro within the source location of this project. */
+class UserProvidedMacro extends Macro {
+  UserProvidedMacro() { exists(this.getFile().getRelativePath()) }
+}
+
+/** A macro defined within a library used by this project. */
+class LibraryMacro extends Macro {
+  LibraryMacro() { not this instanceof UserProvidedMacro }
+}
+
+from CStyleCast c, string extraMessage, Locatable l, string supplementary
 where
   not isExcluded(c, BannedSyntaxPackage::traditionalCStyleCastsUsedQuery()) and
   not c.isImplicit() and
-  not c.getType() instanceof UnknownType
-select c, "Use of explicit C-style Cast"
+  not c.getType() instanceof UnknownType and
+  // Exclude casts created from macro invocations of macros defined by third parties
+  not getGeneratedFrom(c) instanceof LibraryMacro and
+  // If the cast was generated from a user-provided macro, then report the macro that generated the
+  // cast, as the macro itself may have generated the cast
+  if getGeneratedFrom(c) instanceof UserProvidedMacro
+  then
+    extraMessage = " generated from macro $@" and
+    // Add macro as explanatory link
+    l = getGeneratedFrom(c) and
+    supplementary = getGeneratedFrom(c).getName()
+  else (
+    // No extra message required
+    extraMessage = "" and
+    // No explanatory link required, but we still need to set these to valid values
+    l = c and
+    supplementary = ""
+  )
+select c, "Use of explicit c-style cast to " + c.getType().getName() + extraMessage + ".", l,
+  supplementary
diff --git a/cpp/autosar/src/rules/M0-1-4/SingleUsePODVariable.qll b/cpp/autosar/src/rules/M0-1-4/SingleUsePODVariable.qll
@@ -4,6 +4,12 @@ import cpp
 import codingstandards.cpp.TrivialType
 import codingstandards.cpp.deadcode.UnusedVariables
 
+/** Gets the constant value of a constexpr variable. */
+private string getConstExprValue(Variable v) {
+  result = v.getInitializer().getExpr().getValue() and
+  v.isConstexpr()
+}
+
 /** Gets a "use" count according to rule M0-1-4. */
 int getUseCount(Variable v) {
   exists(int initializers |
@@ -12,7 +18,14 @@ int getUseCount(Variable v) {
     result =
       initializers +
         count(VariableAccess access | access = v.getAnAccess() and not access.isCompilerGenerated())
-        + count(UserProvidedConstructorFieldInit cfi | cfi.getTarget() = v)
+        + count(UserProvidedConstructorFieldInit cfi | cfi.getTarget() = v) +
+        // For constexpr variables used as template arguments, we don't see accesses (just the
+        // appropriate literals). We therefore take a conservative approach and count the number of
+        // template instantiations that use the given constant, and consider each one to be a use
+        // of the variable
+        count(ClassTemplateInstantiation cti |
+          cti.getTemplateArgument(_).(Expr).getValue() = getConstExprValue(v)
+        )
   )
 }
 
diff --git a/cpp/autosar/test/qlpack.yml b/cpp/autosar/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: autosar-cpp-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: autosar-cpp-coding-standards
 extractor: cpp
diff --git a/cpp/autosar/test/rules/A5-2-2/TraditionalCStyleCastsUsed.expected b/cpp/autosar/test/rules/A5-2-2/TraditionalCStyleCastsUsed.expected
@@ -1,3 +1,7 @@
-| test.cpp:8:22:8:37 | (uint32_t)... | Use of explicit C-style Cast |
-| test.cpp:9:22:9:32 | (unsigned int)... | Use of explicit C-style Cast |
-| test.cpp:15:3:15:13 | (void)... | Use of explicit C-style Cast |
+| test.cpp:8:22:8:37 | (uint32_t)... | Use of explicit c-style cast to uint32_t. | test.cpp:8:22:8:37 | (uint32_t)... |  |
+| test.cpp:9:22:9:32 | (unsigned int)... | Use of explicit c-style cast to unsigned int. | test.cpp:9:22:9:32 | (unsigned int)... |  |
+| test.cpp:15:3:15:13 | (void)... | Use of explicit c-style cast to void. | test.cpp:15:3:15:13 | (void)... |  |
+| test.cpp:77:3:77:11 | (int)... | Use of explicit c-style cast to int generated from macro $@. | test.cpp:70:1:70:31 | #define ADD_ONE(x) ((int)x) + 1 | ADD_ONE |
+| test.cpp:79:3:79:18 | (int)... | Use of explicit c-style cast to int generated from macro $@. | test.cpp:71:1:71:36 | #define NESTED_ADD_ONE(x) ADD_ONE(x) | NESTED_ADD_ONE |
+| test.cpp:85:19:85:26 | (int)... | Use of explicit c-style cast to int. | test.cpp:85:19:85:26 | (int)... |  |
+| test.cpp:86:27:86:34 | (int)... | Use of explicit c-style cast to int. | test.cpp:86:27:86:34 | (int)... |  |
diff --git a/cpp/autosar/test/rules/A5-2-2/test.cpp b/cpp/autosar/test/rules/A5-2-2/test.cpp
@@ -65,4 +65,25 @@ class A5_2_2 final {
 void a5_2_2_test() {
   A5_2_2 a;
   a.f("");
+}
+
+#define ADD_ONE(x) ((int)x) + 1
+#define NESTED_ADD_ONE(x) ADD_ONE(x)
+#define NO_CAST_ADD_ONE(x) x + 1
+
+#include "macro_c_style_casts.h"
+
+void test_macro_cast() {
+  ADD_ONE(1);         // NON_COMPLIANT - expansion of user-defined macro creates
+                      // c-style cast
+  NESTED_ADD_ONE(1);  // NON_COMPLIANT - expansion of user-defined macro creates
+                      // c-style cast
+  LIBRARY_ADD_TWO(1); // COMPLIANT - macro generating the cast is defined in a
+                      // library, and is not modifiable by the user
+  LIBRARY_NESTED_ADD_TWO(1); // COMPLIANT - macro generating the cast is defined
+                             // in a library, and is not modifiable by the user
+  NO_CAST_ADD_ONE((int)1.0); // NON_COMPLIANT - cast in argument to macro
+  LIBRARY_NO_CAST_ADD_TWO((int)1.0); // NON_COMPLIANT - library macro with
+                                     // c-style cast in argument, written by
+                                     // user so should be reported
 }
diff --git a/cpp/autosar/test/rules/M0-1-4/SingleUseMemberPODVariable.expected b/cpp/autosar/test/rules/M0-1-4/SingleUseMemberPODVariable.expected
@@ -1,3 +1,4 @@
+| test.cpp:36:24:36:29 | unused | Member POD variable unused in C1 is only $@. | test.cpp:36:31:36:31 | initializer for unused | used once |
 | test_global_or_namespace.cpp:16:7:16:7 | x | Member POD variable x in GA is only $@. | test_global_or_namespace.cpp:38:6:38:6 | x | used once |
 | test_global_or_namespace.cpp:54:7:54:7 | x | Member POD variable x in N1A is only $@. | test_global_or_namespace.cpp:76:6:76:6 | x | used once |
 | test_member.cpp:5:7:5:8 | m2 | Member POD variable m2 in A is only $@. | test_member.cpp:9:21:9:25 | constructor init of field m2 | used once |
diff --git a/cpp/autosar/test/rules/M0-1-4/test.cpp b/cpp/autosar/test/rules/M0-1-4/test.cpp
@@ -1,5 +1,5 @@
 /** Test cases for `SingleUseLocalPODVariable.ql` */
-
+#include <array>
 class A {};
 
 class B {
@@ -30,4 +30,12 @@ void test_templates() {
   f1<B>(); // Triggers a NON_COMPLIANT case in f1(), because B is a POD type
   f1<C>(); // Does not trigger a NON_COMPLIANT case in f1(), because C is not a
            // POD type
-}
+}
+
+class C1 {
+  static constexpr int unused{1}; // NON_COMPLIANT
+  static constexpr int used{2};   // COMPLIANT
+  int test_use() { return used; }
+  static constexpr int size{3};               // COMPLIANT
+  std::array<bool, size> array{false, false}; // size is used here
+};
diff --git a/cpp/cert/src/qlpack.yml b/cpp/cert/src/qlpack.yml
@@ -1,4 +1,4 @@
 name: cert-cpp-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 suites: codeql-suites
 libraryPathDependencies: common-cpp-coding-standards
diff --git a/cpp/cert/test/qlpack.yml b/cpp/cert/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: cert-cpp-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: cert-cpp-coding-standards
 extractor: cpp
diff --git a/cpp/common/src/qlpack.yml b/cpp/common/src/qlpack.yml
@@ -1,3 +1,3 @@
 name: common-cpp-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: codeql-cpp
diff --git a/cpp/common/test/includes/custom-library/macro_c_style_casts.h b/cpp/common/test/includes/custom-library/macro_c_style_casts.h
@@ -0,0 +1,4 @@
+// Macros used in test for A5-2-2
+#define LIBRARY_ADD_TWO(x) ((int)x) + 2
+#define LIBRARY_NESTED_ADD_TWO(x) LIBRARY_ADD_TWO(x)
+#define LIBRARY_NO_CAST_ADD_TWO(x) x + 1
diff --git a/cpp/common/test/qlpack.yml b/cpp/common/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: common-cpp-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: common-cpp-coding-standards
 extractor: cpp
diff --git a/cpp/misra/src/qlpack.yml b/cpp/misra/src/qlpack.yml
@@ -1,3 +1,3 @@
 name: misra-cpp-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: common-cpp-coding-standards
diff --git a/cpp/misra/test/qlpack.yml b/cpp/misra/test/qlpack.yml
@@ -1,4 +1,4 @@
 name: misra-cpp-coding-standards-tests
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: misra-cpp-coding-standards
 extractor: cpp
diff --git a/cpp/options b/cpp/options
@@ -1 +1 @@
-semmle-extractor-options:--clang -std=c++14 -nostdinc++ -I../../../../common/test/includes/standard-library
+semmle-extractor-options:--clang -std=c++14 -nostdinc++ -I../../../../common/test/includes/standard-library -I../../../../common/test/includes/custom-library
diff --git a/cpp/report/src/qlpack.yml b/cpp/report/src/qlpack.yml
@@ -1,3 +1,3 @@
 name: report-cpp-coding-standards
-version: 2.9.0
+version: 2.11.0-dev
 libraryPathDependencies: codeql-cpp
