github/workflows: test improvements (#436)

Author: wikkyk

.github/workflows/comment.yml

@@ -0,0 +1,30 @@
+name: Comment
+
+on:
+  pull_request_target:
+    types: ["opened"]
+    branches: ["main"]
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - uses: thollander/actions-comment-pull-request@v3
+        with:
+          message: |
+            ### Tests
+            Please note that running unit and e2e tests requires manual approval from a team member.
+            
+            ### e2e tests
+            We use labels to control which e2e tests contexts are run:
+            
+            | Label | Behaviour |
+            |--|--|
+            | none | Run `Generic` tests only |
+            | https://github.com/ionos-cloud/cluster-api-provider-proxmox/labels/e2e%2Fnone | Do not run any e2e tests |
+            | https://github.com/ionos-cloud/cluster-api-provider-proxmox/labels/e2e%2Fflatcar | Add `Flatcar` tests |
+            
+            ℹ️ Ask a team member to add the requested labels if you don't have enough permissions.
+          comment_tag: comment
+          mode: "recreate"

.github/workflows/e2e-comment.yml

@@ -6,47 +6,60 @@ on:
     branches: ["main"]
 
 jobs:
-  go_test:
-    if: ${{ github.event_name == 'push' }}
+  confirm:
+    # check if confirmation is necessary
+    if: github.event_name == 'pull_request_target'
+    # request confirmation
+    environment: e2e
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/[email protected]
+      - run: ":"
+
+  test:
+    # check the result of confirmation if necessary
+    # https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#example-not-requiring-successful-dependent-jobs
+    # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#always
+    if: ${{ !cancelled() }}
+    needs: [confirm]
+
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: checkout PR ${{ github.event.pull_request.number }}
+        if: github.event_name == 'pull_request_target'
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0 # for SonarQube
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: checkout
+        if: github.event_name == 'push'
+        uses: actions/[email protected]
         with:
-          fetch-depth: 0 # for sonarcloud
+          fetch-depth: 0 # for SonarQube
+
       - uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
+
       - run: "make verify"
       - run: "make test"
-      - uses: SonarSource/[email protected]
-        if: ${{ github.event_name == 'push' }}
+
+      - name: SonarQube for PR ${{ github.event.pull_request.number }}
+        if: github.event_name == 'pull_request_target'
+        uses: SonarSource/[email protected]
+        with:
+         args: >
+           -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
+           -Dsonar.scm.revision=${{ github.event.pull_request.head.sha }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
-  ext_pr:
-    if: ${{ github.event_name == 'pull_request_target' }}
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-    steps:
-      - uses: actions/[email protected]
-        with:
-          fetch-depth: 2 # for diff
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          ref: ${{ github.event.pull_request.head.ref }}
-
-      - name: generate comment message
-        run: |
-          printf '%s\n%s\n\n' '### External PR' 'Test runs on external PRs require manual approval.' >"${{ runner.temp }}/msg"
-          git diff --name-only -z HEAD^1 HEAD | grep -Evz '\.go$|^docs/' | tr '\0' '\n' >"${{ runner.temp }}/diff"
-          if [ -s '${{ runner.temp }}'/diff ]; then
-            echo '**Note:** This PR changes the following non-go, non-docs files:' >>"${{ runner.temp }}/msg"
-            cat "${{ runner.temp }}/diff" >>"${{ runner.temp }}/msg"
-          fi
-
-      - uses: thollander/actions-comment-pull-request@v3
-        with:
-          comment_tag: test
-          mode: recreate
-          file-path: ${{ runner.temp }}/msg
+      - name: SonarQube
+        if: github.event_name == 'push'
+        uses: SonarSource/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}