Update golanci-lint-action to scan all affected directories and corre…

…ctly upload reports

Update golangci-lint action to go through all dirs if no working directory set

Update paths to linter reports

Restore producing test coverage report for each unit test run

Remove test files fail_test.go and polished the workflows

Get list of affected files

Map affected files to modules

Update lint working directory for uploading step

Update lint working directory for uploading step

Removed duplicated runs of golangci-lint

Move running tests for core/scripts module to ci-core.yaml workflow

Remove test files

Move validation of golangci results to a non-matrix job

Add filter for affected files in core/scripts. Move related tests to a separate job

Update SonarQube to pick up coverage reports for core/scripts test runs

.github/actions/golangci-lint/action.yml

@@ -27,50 +27,80 @@ runs:
       if: github.event_name == 'merge_group'
       with:
         fetch-depth: 0
+
     - name: Checkout repo
       uses: actions/[email protected]
       if: github.event_name != 'merge_group'
       with:
         fetch-depth: 1
+
     - name: Setup Go
       uses: ./.github/actions/setup-go
       with:
         only-modules: ${{ inputs.only-modules }}
         cache-version: ${{ inputs.cache-version }}
         go-version-file: ${{ inputs.go-version-file }}
         go-module-file: ${{ inputs.go-module-file }}
+
     - name: Touching core/web/assets/index.html
       shell: bash
       run: mkdir -p core/web/assets && touch core/web/assets/index.html
-    - name: Build binary
-      working-directory: ${{ inputs.go-directory }}
-      shell: bash
-      run: go build ./...
-    - name: Set golangci-lint working directory
+
+    - name: Set Golangci-lint working directory
       shell: bash
       id: set-working-directory
       # XXX: Don't use `.` default working directory here due to issues with the golangci-lint-action.
       run: |
         if [ "${{ inputs.go-directory }}" == "." ]; then
-          echo "golangci-lint-working-directory=" | tee -a $GITHUB_OUTPUT
+          echo "golangci-lint-working-directory=" >> $GITHUB_OUTPUT
         else
-          echo "golangci-lint-working-directory=${{ inputs.go-directory }}" | tee -a $GITHUB_OUTPUT
+          echo "golangci-lint-working-directory=${{ inputs.go-directory }}/" >> $GITHUB_OUTPUT
         fi
-    - name: golangci-lint
+
+    - name: Golangci-lint
       uses: golangci/golangci-lint-action@38e1018663fa5173f3968ea0777460d3de38f256 # v5.3.0
       with:
-        version: v1.61.0
+        version: v1.62.2
         only-new-issues: true
         args: --out-format colored-line-number,checkstyle:golangci-lint-report.xml
         working-directory: ${{ steps.set-working-directory.outputs.golangci-lint-working-directory }}
-    - name: Print lint report artifact
+
+    - name: Print Golangci-lint report results
       if: failure()
       shell: bash
-      run: cat ${{ inputs.go-directory }}/golangci-lint-report.xml
-    - name: Store lint report artifact
+      run: cat ./${{ steps.set-working-directory.outputs.golangci-lint-working-directory }}golangci-lint-report.xml
+
+      # Get a valid name for the upload-artifact step.
+      # Avoid error: `The artifact name is not valid: <path>/<to>/<artifact>/` caused by `/`.
+      # Remove trailing `/` from the directory name: `core/scripts/` -> `core/scripts`.
+      # Replace remaining `/` with `-`: `core/scripts` -> `core-scripts`.
+      # Assign `root` if the directory name is empty (ref: step.id: set-working-directory).
+    - name: Get valid suffix for artifact name
+      if: always()
+      id: suffix
+      shell: bash
+      run: |
+        go_directory=${{ steps.set-working-directory.outputs.golangci-lint-working-directory }}
+        echo "Validating if directory name '$go_directory' is empty or has slashes"
+        
+        if [[ $go_directory == *\/* ]]; then
+            suffix=$(echo "$go_directory" | sed 's:\/$::' | tr '/' '-')
+            echo "Directory name with slashes '$go_directory' updated to a valid artifact suffix '$suffix'"
+        elif [[ $go_directory == "" ]]; then
+          suffix="root"
+          echo "Root directory (empty string) updated to a valid artifact suffix '$suffix'"
+        else
+          suffix="$go_directory"
+          echo "Directory name is valid for the artifact suffix: '$suffix'"
+        fi
+
+        echo "suffix=${suffix}" >> $GITHUB_OUTPUT
+
+    - name: Store Golangci-lint report artifact
       if: always()
       uses: actions/[email protected]
       with:
-        name: golangci-lint-report
-        path: ${{ inputs.go-directory }}/golangci-lint-report.xml
-        retention-days: 7
+        # Use a unique suffix for each lint report artifact to avoid duplication errors
+        name: golangci-lint-report-${{ steps.suffix.outputs.suffix }}
+        # N/B: value may be empty (no slash) OR `<path>/<to>/<module>/` (with slash tat the end)
+        path: ./${{ steps.set-working-directory.outputs.golangci-lint-working-directory }}golangci-lint-report.xml

.github/scripts/map-affected-files-to-modules.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+set -e
+
+# This script:
+# 1. Finds all modules.
+# 2. Maps changed files (passed as a param) to found modules.
+# 3. Prints out the affected modules.
+# 4. Output the result (as JSON) to a GitHub Actions environment variable.
+
+# Get the list of changed files as parameter (from JSON array)
+changed_files=$(echo "$1" | jq -r '.[]')
+echo "Changed files: $changed_files"
+
+# 1. Find all modules in the repository, 
+# - Strip the leading './' from the path 
+# (necessary for comparison, affected files do not have leading './')
+modules=$(find . -name 'go.mod' -exec dirname {} \; | sed 's|^./||' | uniq)
+echo "Found modules: $modules"
+
+# Use a Bash associative array to track unique modules
+declare -A unique_modules
+
+for path_to_file in $changed_files; do
+	echo "Resolving a module affected by a file: '$path_to_file'"
+  for module in $modules; do
+    echo "Validating against module: '$module'"
+
+    # if no slash in the path, it is the root 
+    # (i.e. `main.go`, `.gitignore` vs `core/main.go`)
+    if [[ ! $path_to_file =~ \/ ]]; then
+      echo "File '$path_to_file' mapped to the "root" module."
+      unique_modules["."]="."
+      break
+    # if a module's name matches with a file path 
+    # add it, to the affected modules array, skipping the root (`.`) 
+    elif [[ $module != "." && $path_to_file =~ ^$module* ]]; then
+      echo "File '$path_to_file' mapped the module '$module'"
+      unique_modules["$module"]="$module"
+      break
+    fi
+	done
+done
+
+# Convert keys (module names) of the associative array to an indexed array
+affected_modules=("${!unique_modules[@]}")
+echo "Affected modules: ${affected_modules[@]}"
+
+# Convert bash array to a JSON array for GitHub Actions
+json_array=$(printf '%s\n' "${affected_modules[@]}" | jq -R . | jq -s . | jq -c)
+echo "module_names=$json_array" >> "$GITHUB_OUTPUT"