ci(sonarcloud): upload artifact (#1614)

* ci(sonarcloud): upload artifact * Update ci-test-go.yml * Apply suggestions from code review * Update ci-test-go.yml * Update ci-test-go.yml * Update ci.yml
testcontainers · Sep 13, 2023 · eb91328 · eb91328
1 parent 4c6a989
commit eb91328
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 28 deletions.
diff --git a/.github/workflows/ci-test-go.yml b/.github/workflows/ci-test-go.yml
@@ -79,7 +79,7 @@ jobs:
           # Optional: working directory, useful for monorepos
           working-directory: ${{ inputs.project-directory }}
           # Optional: golangci-lint command line arguments.
-          args: --verbose --out-format=checkstyle:golangci-lint.report.xml
+          args: --verbose
           # Optional: if set to true then the all caching functionality will be complete disabled,
           #           takes precedence over all other caching options.
           skip-cache: true
@@ -107,15 +107,16 @@ jobs:
         run: |
             go install gotest.tools/gotestsum@latest
             make test-unit
-            
-      - name: Analyze with SonarCloud
-        if: ${{ github.ref_name == 'main' && github.repository_owner == 'testcontainers' && inputs.run-tests && !inputs.rootless-docker && inputs.project-directory == '.' }}
-        uses: sonarsource/sonarcloud-github-action@master
+
+      - name: Upload SonarCloud files
+        if: ${{ github.ref_name == 'main' && github.repository_owner == 'testcontainers' && inputs.run-tests && !inputs.rootless-docker }}
+        uses: actions/upload-artifact@v3
         with:
-          projectBaseDir: ${{ inputs.project-directory }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          name: sonarcloud
+          path: |
+            ./sonar-project.properties
+            ${{ inputs.project-directory }}/TEST-unit.xml
+            ${{ inputs.project-directory }}/coverage.out
 
       - name: Run checker
         run: |

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,7 +31,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest, macos-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
@@ -52,7 +51,6 @@ jobs:
       matrix:
         go-version: [1.20.x, 1.x]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
@@ -74,7 +72,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
@@ -92,7 +89,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
@@ -112,7 +108,6 @@ jobs:
         platform: [ubuntu-latest, macos-latest]
         module: [artemis, clickhouse, compose, couchbase, elasticsearch, k3s, localstack, mariadb, mongodb, mysql, nats, neo4j, postgres, pulsar, redis, redpanda, vault]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: false
@@ -130,7 +125,6 @@ jobs:
       matrix:
         module: [bigtable, cockroachdb, consul, datastore, firestore, nginx, pubsub, spanner, toxiproxy]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: "1.20.x"
       fail-fast: true
@@ -139,3 +133,25 @@ jobs:
       rootless-docker: false
       run-tests: true
       ryuk-disabled: false
+
+  sonarcloud:
+    if: ${{ always() && github.ref_name == 'main' && github.repository_owner == 'testcontainers' }}
+    needs: test-examples
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+        with:
+          # Disabling shallow clone is recommended for improving relevancy of reporting
+          fetch-depth: 0
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: sonarcloud
+
+      - name: Analyze with SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
diff --git a/commons-test.mk b/commons-test.mk
@@ -16,7 +16,7 @@ test-%:
 		--format short-verbose \
 		--rerun-fails=5 \
 		--packages="./..." \
-		--junitfile TEST-$*.xml \
+		--junitfile TEST-unit.xml \
 		-- \
                 -coverprofile=coverage.out \
 		-timeout=30m

diff --git a/modulegen/_template/ci.yml.tmpl b/modulegen/_template/ci.yml.tmpl
@@ -31,7 +31,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest, macos-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: {{ "${{ matrix.go-version }}" }}
       fail-fast: true
@@ -52,7 +51,6 @@ jobs:
       matrix:
         go-version: [1.20.x, 1.x]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: {{ "${{ matrix.go-version }}" }}
       fail-fast: true
@@ -74,7 +72,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: {{ "${{ matrix.go-version }}" }}
       fail-fast: true
@@ -92,7 +89,6 @@ jobs:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: {{ "${{ matrix.go-version }}" }}
       fail-fast: true
@@ -112,7 +108,6 @@ jobs:
         platform: [ubuntu-latest, macos-latest]
         module: [{{ .Modules }}]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: {{ "${{ matrix.go-version }}" }}
       fail-fast: false
@@ -130,7 +125,6 @@ jobs:
       matrix:
         module: [{{ .Examples }}]
     uses: ./.github/workflows/ci-test-go.yml
-    secrets: inherit
     with:
       go-version: "1.20.x"
       fail-fast: true
@@ -139,3 +133,24 @@ jobs:
       rootless-docker: false
       run-tests: true
       ryuk-disabled: false
+
+  sonarcloud:
+    if: {{ "${{ github.ref_name == 'main' && github.repository_owner == 'testcontainers' }}" }}
+    needs: test-examples
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+        with:
+          # Disabling shallow clone is recommended for improving relevancy of reporting
+          fetch-depth: 0
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: sonarcloud
+
+      - name: Analyze with SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: {{ "${{ secrets.GITHUB_TOKEN }}" }}
+          SONAR_TOKEN: {{ "${{ secrets.SONAR_TOKEN }}" }}
diff --git a/modulegen/main_test.go b/modulegen/main_test.go
@@ -481,11 +481,11 @@ func assertModuleGithubWorkflowContent(t *testing.T, module context.Testcontaine
 
 	modulesList, err := ctx.GetModules()
 	assert.Nil(t, err)
-	assert.Equal(t, "        module: ["+strings.Join(modulesList, ", ")+"]", data[112])
+	assert.Equal(t, "        module: ["+strings.Join(modulesList, ", ")+"]", data[108])
 
 	examplesList, err := ctx.GetExamples()
 	assert.Nil(t, err)
-	assert.Equal(t, "        module: ["+strings.Join(examplesList, ", ")+"]", data[130])
+	assert.Equal(t, "        module: ["+strings.Join(examplesList, ", ")+"]", data[125])
 }
 
 // assert content go.mod

diff --git a/sonar-project.properties b/sonar-project.properties
@@ -10,12 +10,11 @@ sonar.projectVersion=v0.23.0
 
 sonar.sources=.
 
-sonar.exclusions=**/*_test.go,**/vendor/**,**/testdata/*
+sonar.exclusions=**/*_test.go,**/vendor/**,**/testdata/**
 
 sonar.tests=.
 sonar.test.inclusions=**/*_test.go
 sonar.test.exclusions=**/vendor/**
 
-sonar.go.coverage.reportPaths=coverage.out
-sonar.go.golangci-lint.reportPaths=golangci-lint.report.xml
-sonar.go.tests.reportPaths=TEST-unit.xml
+sonar.go.coverage.reportPaths=**/coverage.out
+sonar.go.tests.reportPaths=**/TEST-unit.xml