Fix code coverage #17
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
PR #16 switched this project from CodeClimate to SonarCloud. When on CodeClimate our code coverage was 100% 🥳. After switching to SonarCloud its 0% 😱 After running it locally and checking what SimpleCov is reporting, it starts to make sense. SonarCloud we have learnt does not just take the final figure SimpleCov spits out. Instead it compares the details in `coverage/.resultset.json` with the code files to confirm what has been covered. If you look at the detail of the SimpleCov report, its listing only the files in `spec/`! It shows there is no coverage for the actual code in `lib/`, but still reports 100%. Hence when SonarCloud analyses the results it comes back with a big fat 0. This PR is about fixing the test coverage so we can report accurately what test coverage we have.
We still get 100% reported, but if you look at the simplecov detail now it no longer lists the spec files.
The one difference I spotted between this project and our others is the way the files are required. In this project it seems they are done in the gemspec. Everything works and the tests run so shouldn't be an issue. In all our other gems though we don't have this line in the gemspec, and its not what gets added if you use bundler to generate your initial gem project. So as the first discrepancy we saw, this change updates the project to follow the convention of the others and instead require the `lib/` files in a support file which gets called when the tests run. And voila! We now have accurate test coverage being reported 97.92% and our lib files are listed in the Simplecov report.
cintamani
approved these changes
Mar 12, 2020
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.
PR #16 switched this project from CodeClimate to SonarCloud. When on CodeClimate our code coverage was 100% 🥳 After switching to SonarCloud its 0% 😱
After running it locally and checking what SimpleCov is reporting, it starts to make sense. SonarCloud we have learnt does not just take the final figure SimpleCov spits out. Instead, it compares the details in
coverage/.resultset.jsonwith the code files to confirm what has been covered.If you look at the detail of the SimpleCov report, it's listing only the files in
spec/! It shows there is no coverage for the actual code inlib/, but still reports 100%. Hence when SonarCloud analyses the results it comes back with a big fat 0.This PR is about fixing the test coverage so we can report accurately what test coverage we have.
SimpleCov before
SimpleCov after