Merge branch 'main' into lcartey/m16-1-1

Author: lcartey

.vscode/tasks.json

@@ -140,6 +140,28 @@
             },
             "problemMatcher": []
         },
+        {
+            "label": "🧪 Standards Automation: Build Case Test DB from test file",
+            "type": "shell",
+            "windows": {
+                "command": ".${pathSeparator}scripts${pathSeparator}.venv${pathSeparator}Scripts${pathSeparator}python.exe scripts${pathSeparator}build_test_database.py ${file}"
+            },
+            "linux": {
+                "command": ".${pathSeparator}scripts${pathSeparator}.venv${pathSeparator}bin${pathSeparator}python3 scripts${pathSeparator}build_test_database.py ${file}"
+            },
+            "osx": {
+                "command": ".${pathSeparator}scripts${pathSeparator}.venv${pathSeparator}bin${pathSeparator}python3 scripts${pathSeparator}build_test_database.py ${file}"
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new",
+                "focus": true
+            },
+            "runOptions": {
+                "reevaluateOnRerun": false
+            },
+            "problemMatcher": []
+        },
         {
             "label": "📝 Standards Automation: Format CodeQL",
             "type": "shell",

change_notes/2023-11-24-a2-7-3-remove-function-scope.md

@@ -0,0 +1,3 @@
+ * `A2-7-3` - `UndocumentedUserDefinedType.ql`:
+   - Excluding declarations in function scope. The rationale is that these declarations are not exposed outside the scope of the function.
+   

change_notes/2024-01-14-m5-3-3-exclude-binary.md

@@ -0,0 +1,2 @@
+`M5-3-3` - `UnaryOperatorOverloaded.ql`:
+  - Exclude binary user defined `operator&` from this rule.

change_notes/2024-02-12-exclusion-A2-10-4.md

@@ -0,0 +1,2 @@
+- `A2-10-4` - `IdentifierNameOfStaticNonMemberObjectReusedInNamespace.ql`:
+    - Fix FP reported in #385. Addresses incorrect detection of partially specialized template variables as conflicting reuses.

cpp/autosar/src/rules/A2-10-4/IdentifierNameOfStaticNonMemberObjectReusedInNamespace.ql

@@ -20,7 +20,9 @@ class CandidateVariable extends Variable {
   CandidateVariable() {
     hasDefinition() and
     isStatic() and
-    not this instanceof MemberVariable
+    not this instanceof MemberVariable and
+    //exclude partially specialized template variables
+    not exists(TemplateVariable v | this = v.getAnInstantiation())
   }
 }
 

cpp/autosar/src/rules/A2-7-3/UndocumentedUserDefinedType.ql

@@ -17,6 +17,14 @@
 import cpp
 import codingstandards.cpp.autosar
 
+private predicate isInFunctionScope(Declaration d) {
+  // Type declared in function
+  exists(d.(UserType).getEnclosingFunction())
+  or
+  // Member declared in type which is in function scope
+  isInFunctionScope(d.getDeclaringType())
+}
+
 /**
  * A declaration which is required to be preceded by documentation by AUTOSAR A2-7-3.
  */
@@ -42,10 +50,8 @@ class DocumentableDeclaration extends Declaration {
     declarationType = "member variable" and
     // Exclude memeber variables in instantiated templates, which cannot reasonably be documented.
     not this.(MemberVariable).isFromTemplateInstantiation(_) and
-    // Exclude anonymous lambda functions.
-    // TODO: replace with the following when support is added.
-    // not this.(MemberVariable).isCompilerGenerated()
-    not exists(LambdaExpression lc | lc.getACapture().getField() = this)
+    // Exclude compiler generated variables, such as those for anonymous lambda functions
+    not this.(MemberVariable).isCompilerGenerated()
   }
 
   /** Gets a `DeclarationEntry` for this declaration that should be documented. */
@@ -96,6 +102,7 @@ from DocumentableDeclaration d, DeclarationEntry de
 where
   not isExcluded(de, CommentsPackage::undocumentedUserDefinedTypeQuery()) and
   not isExcluded(d, CommentsPackage::undocumentedUserDefinedTypeQuery()) and
+  not isInFunctionScope(d) and
   d.getAnUndocumentedDeclarationEntry() = de
 select de,
   "Declaration entry for " + d.getDeclarationType() + " " + d.getName() +

cpp/autosar/src/rules/M3-9-1/TypesNotIdenticalInReturnDeclarations.ql

@@ -15,8 +15,6 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import cpp
-import codingstandards.cpp.autosar
 
 from FunctionDeclarationEntry f1, FunctionDeclarationEntry f2
 where

cpp/autosar/src/rules/M5-3-3/UnaryOperatorOverloaded.ql

@@ -13,7 +13,8 @@
 
 import cpp
 import codingstandards.cpp.autosar
+import codingstandards.cpp.Operator
 
-from Operator o
-where not isExcluded(o, OperatorsPackage::unaryOperatorOverloadedQuery()) and o.hasName("operator&")
+from UnaryAddressOfOperator o
+where not isExcluded(o, OperatorsPackage::unaryOperatorOverloadedQuery())
 select o, "The unary & operator overloaded."

cpp/autosar/test/rules/A2-10-4/test1a.cpp

@@ -13,4 +13,10 @@ namespace ns3 {
 static void f1() {}
 
 void f2() {}
+
+// Variable templates can cause false positives
+template <int x> static int number_one = 0; // COMPLIANT
+
+template <> static int number_one<1> = 1; // COMPLIANT
+template <> static int number_one<2> = 2; // COMPLIANT
 } // namespace ns3

cpp/autosar/test/rules/A2-7-3/test.cpp

@@ -160,4 +160,19 @@ template <typename T> class A2_7_3 final {
   const std::string kBar{"bar"}; // NON_COMPLIANT
 };
 /// @brief This is the instantiateA2_7_3 documentation
-void instantiateA2_7_3() { A2_7_3<int> instance; }
+void instantiateA2_7_3() { A2_7_3<int> instance; }
+
+/// Test documentation
+void testFunctionScope() {
+  using my_float = float;
+  class ClassF { // COMPLIANT - in function scope
+  public:
+    int m_x;      // COMPLIANT - in function scope
+    void fTest(); // COMPLIANT - in function scope
+    class ClassFNested {
+    public:
+      int m_nested_x;     // COMPLIANT - in function scope
+      void fNestedTest(); // COMPLIANT - in function scope
+    };
+  };
+}

cpp/autosar/test/rules/M5-3-3/UnaryOperatorOverloaded.expected

@@ -1 +1,2 @@
-| test.cpp:6:5:6:13 | operator& | The unary & operator overloaded. |
+| test.cpp:2:5:2:13 | operator& | The unary & operator overloaded. |
+| test.cpp:8:3:8:11 | operator& | The unary & operator overloaded. |

cpp/autosar/test/rules/M5-3-3/test.cpp

@@ -1,7 +1,9 @@
-/* The unary & operator shall not be overloaded */
-// do not defined it at all
-class A
-
-{
-  A operator&(); // NON_COMPLIANT
+class A {
+  A operator&();                      // NON_COMPLIANT - unary
+  constexpr A operator&(const A rhs); // COMPLIANT - binary
 };
+
+class B {};
+
+B operator&(B b);                                // NON_COMPLIANT - unary
+constexpr B operator&(const B lhs, const B rhs); // COMPLIANT - binary

cpp/common/src/codingstandards/cpp/Operator.qll

@@ -265,6 +265,22 @@ class UserOverloadedOperator extends Function {
   }
 }
 
+/** A user defined operator address of operator (`&`). */
+class UnaryAddressOfOperator extends Operator {
+  UnaryAddressOfOperator() {
+    hasName("operator&") and
+    (
+      // If this is a member function, it needs to have zero arguments to be the unary addressof
+      // operator
+      if this instanceof MemberFunction
+      then getNumberOfParameters() = 0
+      else
+        // Otherwise it needs one argument to be unary
+        getNumberOfParameters() = 1
+    )
+  }
+}
+
 private newtype TOperatorUse =
   TBuiltinOperatorUse(Operation op) or
   TOverloadedOperatorUse(FunctionCall call, Operator op) { op.getACallToThisFunction() = call }

rule_packages/cpp/Comments.json

@@ -70,7 +70,10 @@
           "tags": [
             "maintainability",
             "readability"
-          ]
+          ],
+          "implementation_scope": {
+            "description": "Function scope declarations are excluded from this rule as they are restricted in scope to only a single function."
+          }
         }
       ],
       "title": "All declarations of 'user-defined' types, static and non-static data members, functions and methods shall be preceded by documentation."

scripts/build_test_database.py

@@ -3,14 +3,42 @@
 import os 
 import subprocess
 import json 
+from pathlib import Path
 
-if len(sys.argv) < 4:
-    print ("Usage: build_test_database.py LANGUAGE STANDARD RULE", file=sys.stderr)
+if len(sys.argv) != 4 and len(sys.argv) != 2:
+    print ("Usage: build_test_database.py TEST_FILE | LANGUAGE STANDARD RULE", file=sys.stderr)
     exit(1)
 
-LANGUAGE=sys.argv[1]
-STANDARD=sys.argv[2]
-RULE=sys.argv[3]
+if len(sys.argv) == 4:
+    LANGUAGE=sys.argv[1]
+    STANDARD=sys.argv[2]
+    RULE=sys.argv[3]
+
+if len(sys.argv) == 2:
+    TEST_FILE_PATH=Path(sys.argv[1])
+    if not TEST_FILE_PATH.exists():
+        print(f"The test file {TEST_FILE_PATH} does not exist!", file=sys.stderr)
+        exit(1)
+    RULE_PATH=TEST_FILE_PATH.parent
+    while True:
+        if len(list(RULE_PATH.glob("*.expected"))) > 0:
+            break
+        if RULE_PATH.parent != RULE_PATH:
+            RULE_PATH = RULE_PATH.parent
+        else:
+            print(f"The test file {TEST_FILE_PATH} is not a test because we couldn't find an expected file!", file=sys.stderr)
+            exit(1)
+    RULE=RULE_PATH.name
+    TESTS_PATH=RULE_PATH.parent.parent
+    if TESTS_PATH.name != "test":
+        print(f"The test file {TEST_FILE_PATH} is not in the expected test layout, cannot determine standard or language!", file=sys.stderr)
+        exit(1)
+
+    STANDARD_PATH=TESTS_PATH.parent
+    STANDARD=STANDARD_PATH.name
+
+    LANGUAGE_PATH=STANDARD_PATH.parent
+    LANGUAGE=LANGUAGE_PATH.name
 
 if shutil.which("codeql") is None:
     print ("Please install codeql.", file=sys.stderr)