Fix SonarQube test coverage issue #1557
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For some reason, SonarQube (formerly SonarCloud) no longer correctly recognises test coverage. This PR is to investigate and fix the issue.
StuAA78
added
bug
StuAA78
force-pushed
the
fix-sonarqube-test-coverage-issue
branch
from
f687dfe to
f8f0388
Compare
This was referenced Dec 13, 2024
StuAA78
added a commit
to DEFRA/hapi-pg-rest-api
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-helpers
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-permit-repository
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-returns
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-tactical-crm
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-tactical-idm
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-import
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-service
that referenced
this pull request
Dec 13, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. While amending this, we found an unused sonarcloud config file `src/sonar-project.properties`, which we delete. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
StuAA78
added a commit
to DEFRA/water-abstraction-ui
that referenced
this pull request
Dec 16, 2024
Our CI pipeline uses SonarCloud for static code analysis using the `sonarsource/sonarcloud-github-action` action. This has recently been deprecated in favour of `sonarsource/sonarqube-scan-action` following the rebranding of SonarCloud to SonarQube Cloud. This PR therefore makes the required change to `ci.yml`. We also resolve a code coverage issue by removing a previously-required fix; see DEFRA/water-abstraction-system#1557 for info.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SonarQube (formerly SonarCloud) recently stopped correctly recognising test coverage. This PR fixes the issue.
Summary
On investigating, we realised that this was due to a fix we'd put in place to work around a SonarQube issue that had now been resolved, and our fix was now causing problems. We therefore remove the fix to ensure SonarQube recognises code coverage again.
Detail
Previously, SonarQube expected the code it analyses to be under the path
/github/workspace. However, thelcov.infocode coverage report had the code under a different path/home/runner/work/water-abstraction-system/water-abstraction-system. We therefore usedsedto replace the original paths inlcov.infowith ones under/github/workspace, ensuring that SonarQube correctly picked up code coverage.Somewhere between 02/12/2024 and 05/12/204, SonarQube started expecting the code to be under the
/home/runner/work/water-abstraction-system/water-abstraction-systempath. This can be seen by comparing the logs of a previous run to a recent run:Run dated 02/12/2024
Run dated 05/12/2024
Because our fix changed the file paths to be under
/github/workspace, SonarQube no longer recognised the files under/home/runner/work/water-abstraction-system/water-abstraction-systemas having code coverage, hence the issue. Removing the fix therefore resolves this.