chore(ci): enable code coverage on Sonarcloud #1518

mmorel-35 · 2023-08-23T19:03:21Z

Hi @mdelapenya,
It seems like sonar requires a SONAR_TOKEN secret, I tried to compare with testcontainers-donet and testcontainers-node that reports code coverage on their sonarcloud reports but I couldn’t find anything comparable as they are not using the sonarcloud action to upload their test results.
I tried to provide my own SONAR_TOKEN but it seems it not possible to use it in a fork repository.
Any idea ? Or you prefer to keep things as it is now ?

netlify · 2023-08-23T19:03:32Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`bcb9795`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/64ff35c3003cf200089e751b
😎 Deploy Preview	https://deploy-preview-1518--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mmorel-35 · 2023-08-24T07:02:27Z

.github/workflows/ci-test-go.yml

@@ -101,6 +101,15 @@ jobs:
        run: |
            go install gotest.tools/gotestsum@latest
            make test-unit
+
+      - name: Analyze with SonarCloud
+        if: ${{ always() && inputs.run-tests && inputs.project-directory == '.' }}


Once this is working for the parent go module we can do the same for each submodule.

mmorel-35 · 2023-08-24T07:08:14Z

sonar-project.properties

+sonar.projectKey=testcontainers_testcontainers-go
+
+sonar.projectName=testcontainers-go


I imagine that for modulegen, it could be :

sonar.projectKey=testcontainers_testcontainers-go_modulegen sonar.projectName=testcontainers-go/modulegen

For examples/bigtable it could be :

sonar.projectKey=testcontainers_testcontainers-go_examples_bigtable sonar.projectName=testcontainers-go/examples/bigtable

mdelapenya · 2023-08-24T10:48:06Z

Let me check internally with other maintainers how it's done in their language projects. Will ping you back here once I have it clear how to proceed with Sonarqube, as it'd be a great improvement seeing the code coverage alongside the "defects" it finds (although I dislike a bit how the Go rules are processed).

mdelapenya · 2023-09-11T11:56:04Z

I tried to provide my own SONAR_TOKEN but it seems it not possible to use it in a fork repository.
Any idea ?

I'm going to create the secret in the project to make this work.

mdelapenya

Added a comment about the used flags. I also added the SONAR_TOKEN secret to the repo, probably won't work until this is PR merged because of forks 🤷

commons-test.mk

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>

.github/workflows/ci.yml

mmorel-35 · 2023-09-11T13:18:26Z

There seems to be an option to share secrets with pull request from forks. Have you read this ?

mdelapenya · 2023-09-11T13:38:11Z

There seems to be an option to share secrets with pull request from forks. Have you read this ?

I'm not sure if that will work for PRs from forks not from the organisation: https://community.sonarsource.com/t/sonar-token-permissions-in-pull-request-github-actions/90614/9

I'll double check with other maintainers now

mdelapenya · 2023-09-11T13:48:40Z

@mmorel-35 it seems that .NET uses it but only for merges to develop or main branches: https://github.com/testcontainers/testcontainers-dotnet/blob/develop/.github/workflows/cicd.yml#L74

I think we should go with the same approach for the moment

sonarcloud · 2023-09-11T15:44:24Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

mmorel-35 · 2023-09-11T15:55:26Z

Hi @mdelapenya ,
It’s now only executed when the owner of the repo is testcontainers and the branch is main.

mdelapenya

LGTM, thanks again for your work here!

mdelapenya · 2023-09-11T16:02:27Z

Merging it now

mmorel-35 · 2023-09-11T16:31:31Z

Hi @mdelapenya ,
The error message says there cannot be an automatic configuration and the sonar action at the same time.
After reading this , it seems better to desactivate automatic analysis and use the github-action.
To my understanding, the desactivation is done on the sonarcloud administration panel.

mdelapenya · 2023-09-11T16:48:03Z

I've just disabled the automatic analysis from the service. It's unfortunate that they do not provide a graceful alternative, like not failing that hard 🤷‍♂️

sonar-project.properties

…containerd-1.7.5 * main: chore: always generate the examples including a explicit image (#1611) chore: support linting all modules locally (#1609) ci(sonarcloud): run only when not root-less (#1608) remove extra equal in sonar.organization (#1607) chore(ci): enable code coverage on Sonarcloud (#1518) docs: use Go testable examples in modules (#1603)

* main: chore: always generate the examples including a explicit image (testcontainers#1611) chore: support linting all modules locally (testcontainers#1609) ci(sonarcloud): run only when not root-less (testcontainers#1608) remove extra equal in sonar.organization (testcontainers#1607) chore(ci): enable code coverage on Sonarcloud (testcontainers#1518) docs: use Go testable examples in modules (testcontainers#1603) ci(lint): enable errorlint linter (testcontainers#1604) ci(lint): enable gocritic linter (testcontainers#1605) chore(deps): bump github.com/hashicorp/vault-client-go in /modules/vault (testcontainers#1566) ci(security): setup codeql scan (testcontainers#1606) chore(deps): bump github.com/cyphar/filepath-securejoin (testcontainers#1601) chore: generate Go examples for new modules (testcontainers#1600) chore: generate Go examples for new modules (testcontainers#1600)

mmorel-35 commented Aug 24, 2023

View reviewed changes

mmorel-35 mentioned this pull request Aug 25, 2023

[Enhancement]: Some ideas for testcontainers-go #1536

Open

11 tasks

mdelapenya reviewed Sep 11, 2023

View reviewed changes

commons-test.mk Outdated Show resolved Hide resolved

mmorel-35 added 2 commits September 11, 2023 14:25

Setup Sonarcloud

ca94fae

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>

Update commons-test.mk

d895873

mmorel-35 marked this pull request as ready for review September 11, 2023 12:53

mmorel-35 requested a review from a team as a code owner September 11, 2023 12:53

mdelapenya self-assigned this Sep 11, 2023

mdelapenya added the chore Changes that do not impact the existing functionality label Sep 11, 2023

mdelapenya changed the title ~~Sonarcloud~~ chore: enable code coverage on Sonarcloud Sep 11, 2023

mdelapenya changed the title ~~chore: enable code coverage on Sonarcloud~~ chore(ci): enable code coverage on Sonarcloud Sep 11, 2023

mdelapenya reviewed Sep 11, 2023

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

mmorel-35 added 2 commits September 11, 2023 15:05

Update ci.yml.tmpl

02679e2

Update main_test.go

525a01b

Update ci-test-go.yml

904b51a

mmorel-35 requested a review from mdelapenya September 11, 2023 15:32

Update ci-test-go.yml

bcb9795

mdelapenya approved these changes Sep 11, 2023

View reviewed changes

mdelapenya merged commit 721aed7 into testcontainers:main Sep 11, 2023
90 of 92 checks passed

mmorel-35 deleted the sonarcloud branch September 11, 2023 16:03

mdelapenya reviewed Sep 11, 2023

View reviewed changes

sonar-project.properties Show resolved Hide resolved

mdelapenya mentioned this pull request Sep 13, 2023

chore: update sonarcloud properties when releasing the project #1615

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(ci): enable code coverage on Sonarcloud #1518

chore(ci): enable code coverage on Sonarcloud #1518

mmorel-35 commented Aug 23, 2023 •

edited

Loading

netlify bot commented Aug 23, 2023 •

edited

Loading

mmorel-35 Aug 24, 2023

mmorel-35 Aug 24, 2023 •

edited

Loading

mdelapenya commented Aug 24, 2023

mdelapenya commented Sep 11, 2023

mdelapenya left a comment

mmorel-35 commented Sep 11, 2023

mdelapenya commented Sep 11, 2023

mdelapenya commented Sep 11, 2023 •

edited

Loading

sonarcloud bot commented Sep 11, 2023

mmorel-35 commented Sep 11, 2023

mdelapenya left a comment

mdelapenya commented Sep 11, 2023

mmorel-35 commented Sep 11, 2023 •

edited

Loading

mdelapenya commented Sep 11, 2023

		sonar.projectKey=testcontainers_testcontainers-go

		sonar.projectName=testcontainers-go

chore(ci): enable code coverage on Sonarcloud #1518

chore(ci): enable code coverage on Sonarcloud #1518

Conversation

mmorel-35 commented Aug 23, 2023 • edited Loading

netlify bot commented Aug 23, 2023 • edited Loading

✅ Deploy Preview for testcontainers-go ready!

mmorel-35 Aug 24, 2023

Choose a reason for hiding this comment

mmorel-35 Aug 24, 2023 • edited Loading

Choose a reason for hiding this comment

mdelapenya commented Aug 24, 2023

mdelapenya commented Sep 11, 2023

mdelapenya left a comment

Choose a reason for hiding this comment

mmorel-35 commented Sep 11, 2023

mdelapenya commented Sep 11, 2023

mdelapenya commented Sep 11, 2023 • edited Loading

sonarcloud bot commented Sep 11, 2023

mmorel-35 commented Sep 11, 2023

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya commented Sep 11, 2023

mmorel-35 commented Sep 11, 2023 • edited Loading

mdelapenya commented Sep 11, 2023

mmorel-35 commented Aug 23, 2023 •

edited

Loading

netlify bot commented Aug 23, 2023 •

edited

Loading

mmorel-35 Aug 24, 2023 •

edited

Loading

mdelapenya commented Sep 11, 2023 •

edited

Loading

mmorel-35 commented Sep 11, 2023 •

edited

Loading