In addition to the the Configuring Test Coverage help doc, these topics provide additional troubleshooting context:
Self help from technical documentation
Command Line Interface (CLI)
Specific error messages from the reporter
Common GitHub scenarios
Need more help?
- Do you have coverage reporting configured for one of our supported languages?
- Are you using the correct CC_TEST_REPORTER_ID?
- Are you using single or multiple test coverage setups? Setup varies for each.
- Are you running your tests outside of your root directory? You may need to use the
- Are you working with a Docker container? Check out this doc.
- Coverage data is based on the data that you send us via your coverage payloads, which is created client-side.
- Try removing Code Climate from the equation:
(1) Look at coverage results locally. Are they what you expect?
(2) Are your results what you expect, regardless of Code Climate?
(3) How are they different while looking at Code Climate?
- Output debug messages to your CI using the
--debugflag with your cc-test-reporter.
- View uploaded reports (with potential errors) in the Code Climate UI. These can be found under the Recent Reports section at the following URL:
- Search the test reporter GitHub project for specific error messages.
- Read the test reporter's README for detailed instructions and low level usage commands.
- Check out the sample/working test config files on the test reporter GitHub project here.
- Ask a question and open an issue on the test reporter repo itself.
Opening an Issue or contacting Support?
- Repo name
- CI name
- If you use single, parallel or multi-suite builds
- A copy of your CI configuration file
- Output from your CI when using the
--debugflag in your CI configuration
- Any relevant screenshots of your setup
|Common Problems and FAQs||Reason and Action|
I see a "successfully sent" message in my CI, but no results show in Code Climate's UI.
1. In order to coverage info in the Code Climate UI, you'll need to send a test report for your default branch. If you've only setup the test reporter on a feature branch, then reports won't be uploaded for the default branch. If you're successfully uploaded reports, but still not seeing coverage info in the UI, it's most likely because you haven't yet sent a test report for the default branch. Coverage info for non-default branches is visible in GitHub using the browser extension.
2. Possibly due to malformed payloads. Head to
(note: the Test Coverage Settings page is only available to users that have Owner/Admin permissions for the repo on GitHub.)
3. Make sure that you're sending ENV (not Git) values. See this doc
4. Check to see if you're pinning to a specific test coverage reporter version.
Where should I put the
1. If you're running your tests in single builds, use
2. For tests run in parallel, please use both
What CI-specific environmental variables and calls should I use?
1. Although the same basic variables are needed, we've found that each CI's naming of variables and calls can be quite different.
2. Check our CI sample config files in our help docs here as well as in the test reporter project.
3. See this doc.
Coverage results from one repo are showing on a different repo.
1. You might be using the incorrect
2. Check the test reporter id used in your test coverage config file or CI configurations.
When Code Climate is down, it causes my builds to fail because I can't upload my coverage reports. How can I fix this?
1. We're looking to update our reporter to account for this. In the meantime, we recommend the following workaround:
You can also use:
1. See this doc.
|The reporter is unable to find your repo's test reporter ID. This value either needs to configured within the environment or passed directly as a CLI argument.|
The reporter is unable to find a file referenced with the test report. Does that file exist within your git repository? Was your test suite run within a different filesystem (such as in a docker container)?
You may need to specify a prefix value.
For example, if you're running the tests within a docker container and your app code is located at
Most often, this is related to:
1. The reporter not able to find your test coverage results to upload them to Code Climate.
2. The reporter encountering a file that it can't process
For #1, adding the
For #2, try excluding the mentioned file from your test coverage payloads. If you need the coverage results of that file, contact us and we'll help.
The reporter is unable to find a formatter.
This is often seen with Java projects, when the the path to source code can't be inferred.
|When using the ||Change the endpoint from |
|This error happens when using SimpleCov newer versions (||Ensure that the |
- this comment in the SimpleCov README
- this comment in an issue on CodeClimate
Updated 7 months ago