Test Reporter: Troubleshooting and Getting Help


Having trouble setting up test coverage for your repo?
In addition to the the Configuring Test Coverage help doc, these topics provide additional troubleshooting context:
Basic requirements
Client-side considerations
Self help from technical documentation
Contact Support
Command Line Interface (CLI)
Common Questions
Specific error messages from the reporter
Common GitHub scenarios
Diff-coverage and total-coverage statuses are hanging
Generating test coverage for branches, but not seeing coverage results in GitHub
Need more help?
Open an issue or contact Support! Include the information listed here. ⬅️
Basic requirements:
- 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
--prefix
option. - Are you working with a Docker container? Check out this doc.
Client-side considerations:
- 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?
Self help from technical documentation
- Output debug messages to your CI using the
--debug
flag 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:
codeclimate.com/repos/repo#/settings/test_reporter
- 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.
Contact Support
Opening an Issue or contacting Support?
Please include:
- 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
--debug
flag in your CI configuration- Any relevant screenshots of your setup
Common Questions - FAQs
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. |
|
Where should I put the |
|
What CI-specific environmental variables and calls should I use? |
|
Coverage results from one repo are showing on a different repo. |
|
When Code Climate is down, it causes my builds to fail because I can't upload my coverage reports. How can I fix this? |
|
My |
|
Specific error messages from the reporter
Error Message | Description | Resolution |
---|---|---|
| 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. |
OR
|
| 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)? |
|
| Most often, this is related to:
| 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. Instead of
AND
|
| When using the | Change the endpoint from
To
|
Updated about a year ago