Merge branch 'main' into lcartey/rule-11-4-improvements

Author: lcartey

.github/actions/check-permissions/action.yml

@@ -16,11 +16,17 @@ runs:
   steps:
   - uses: actions/github-script@v7
     id: check-permission
+    env:
+      INPUT_MINIMUM-PERMISSION: ${{ inputs.minimum-permission }}
     with:
       script: |
         // Valid permissions are none, read, write, admin (legacy base permissions)
         const permissionsRanking = ["none", "read", "write", "admin"];
 
+        // Note: core.getInput doesn't work by default in a composite action - in this case
+        //       it would try to fetch the input to the github-script instead of the action
+        //       itself. Instead, we set the appropriate magic env var with the actions input.
+        //       See: https://github.com/actions/runner/issues/665
         const minimumPermission = core.getInput('minimum-permission');
         if (!permissionsRanking.includes(minimumPermission)) {
           core.setFailed(`Invalid minimum permission: ${minimumPermission}`);
@@ -30,14 +36,14 @@ runs:
         const { data : { permission : actorPermission } } = await github.rest.repos.getCollaboratorPermissionLevel({
           owner: context.repo.owner,
           repo: context.repo.repo,
-          username: tools.context.actor
+          username: context.actor
         });
 
         // Confirm whether the actor permission is at least the selected permission
         const hasPermission = permissionsRanking.indexOf(minimumPermission) <= permissionsRanking.indexOf(actorPermission) ? "1" : "";
         core.setOutput('has-permission', hasPermission);
         if (!hasPermission) {
-          core.info(`Current actor (${tools.context.actor}) does not have the minimum required permission '${minimumPermission}' (has '${actorPermission}')`);
+          core.info(`Current actor (${context.actor}) does not have the minimum required permission '${minimumPermission}' (has '${actorPermission}')`);
         } else {
-          core.info(`Current actor (${tools.context.actor}) has the minimum required permission '${minimumPermission}' (has '${actorPermission}')`);
-        }
+          core.info(`Current actor (${context.actor}) has the minimum required permission '${minimumPermission}' (has '${actorPermission}')`);
+        }

.github/workflows/dispatch-matrix-check.yml

@@ -11,6 +11,9 @@ jobs:
   dispatch-matrix-check:
     runs-on: ubuntu-22.04
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Check permission
         id: check-write-permission
         uses: ./.github/actions/check-permissions

.github/workflows/dispatch-matrix-test-on-comment.yml

@@ -8,6 +8,9 @@ jobs:
   dispatch-matrix-check:
     runs-on: ubuntu-22.04
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Check permission
         id: check-write-permission
         uses: ./.github/actions/check-permissions

.github/workflows/dispatch-release-performance-check.yml

@@ -8,6 +8,9 @@ jobs:
   dispatch-matrix-check:
     runs-on: ubuntu-22.04
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Check permission
         id: check-write-permission
         uses: ./.github/actions/check-permissions

change_notes/2024-07-16-fix-fp-606-A2-7-3.md

@@ -0,0 +1,2 @@
+- `A2-7-3` - `UndocumentedUserDefinedType.ql`:
+  - Fixes #606. Fix false positive relating to friend functions in template classes.

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

@@ -77,7 +77,11 @@ class DocumentableDeclaration extends Declaration {
     // Exclude instantiated template functions, which cannot reasonably be documented.
     not this.(Function).isFromTemplateInstantiation(_) and
     // Exclude anonymous lambda functions.
-    not exists(LambdaExpression lc | lc.getLambdaFunction() = this)
+    not exists(LambdaExpression lc | lc.getLambdaFunction() = this) and
+    //Exclude friend functions (because they have 2 entries in the database), and only one shows documented truly
+    not exists(FriendDecl d |
+      d.getFriend().(Function).getDefinition() = this.getADeclarationEntry()
+    )
     or
     this instanceof MemberVariable and
     declarationType = "member variable" and

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

@@ -9,3 +9,4 @@
 | test.cpp:101:6:101:6 | definition of e | Declaration entry for function e is missing documentation. |
 | test.cpp:108:1:108:30 | definition of message_to_string_undocumented | Declaration entry for function message_to_string_undocumented is missing documentation. |
 | test.cpp:180:21:180:24 | definition of kBar | Declaration entry for member variable kBar is missing documentation. |
+| test.cpp:227:14:227:17 | definition of foo3 | Declaration entry for function foo3 is missing documentation. |

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

@@ -195,4 +195,34 @@ void testFunctionScope() {
       void fNestedTest(); // COMPLIANT - in function scope
     };
   };
-}
+}
+
+/// Test documentation
+template <typename T> class ClassG { // COMPLIANT
+private:
+  /// Test documentation
+  int x; // COMPLIANT
+
+public:
+  /// Test documentation
+  friend int foo(ClassG<T> g) { return g.x; } // COMPLIANT
+};
+
+/// Test documentation
+void test() { // COMPLIANT
+  ClassG<int> g;
+  foo(g);
+}
+
+/// Test documentation
+class ClassG2 { // COMPLIANT
+public:
+  /// Test documentation
+  friend int foo2() { return 1; } // COMPLIANT
+};
+
+/// Test documentation
+class ClassG3 { // COMPLIANT
+public:
+  friend int foo3() { return 1; } // NON_COMPLIANT
+};