We use Codecov to track code coverage. Codecov leaves a comment PR's that indicate the a percentage change in code coverage compared to main. We encourage you to keep the code coverage percentage at 80% and above.
Rspec will generate code coverage at the end of the tests.
To get the code coverage of the entire Rails codebase, you must run the full
Ruby test suite. You can run the full test suite with the
bundle exec rspec
To get the code coverage of a single file, you can run:
bundle exec rspec spec/models/user_spec.rb
To get the code coverage of a particular spec in a single file, append the line-number for that spec:
bundle exec rspec spec/models/user_spec.rb:24
Once your tests have completed, the
coverage/index.html will be regenerated
with some stats concerning the overall health of our test suite including a code
A few things to note:
- "Coverage" indicates whether or not the test suite runs through the code in question. It does not equate to actually testing for functionality, and shouldn’t be thought of that way.
- Running Rspec in general will overwrite the existing
coverage/index.htmlso, if you want to reference the results of a particular run, save a copy of the file before re-running the test suite.
To turn off coverage report generation please set environment variable
COVERAGE value to
Preact tests will generate code coverage at the end of the tests.
To get the code coverage of the Preact codebase, you must run the full JS test
suite. You can run the full test suite with the npm task
npm run test
Once the tests have completed, the test coverage metric will be visible in the terminal window. Please note that jest will fail if test coverage thresholds are not met.