Troubleshooting common issues¶

The sections below provide instructions or workarounds to overcome common issues while using Codacy Coverage Reporter.

Submitting coverage for unsupported languages¶

If your language is not in the list of supported languages, you can still send coverage to Codacy. You can do it by providing the correct language name with the flag -l, together with --force-language. For example:

bash <(curl -Ls https://coverage.codacy.com/get.sh) report
  -l Kotlin --force-language

See the list of languages that you can specify using the flag -l.

Submitting coverage from unsupported report formats¶

If you are generating a report format that Codacy does not yet support, try using community projects such as t-yuki/gocover-cobertura and danielpalme/ReportGenerator, or alternatively contribute to our codacy/coverage-parser project.

As a workaround, you can also send the coverage data directly by calling the Codacy API endpoint saveCoverage.

The following is an example of the JSON payload:

{
  "total": 23,
  "fileReports": [
    {
      "filename": "src/Codacy/Coverage/Parser/CloverParser.php",
      "total": 54,
      "coverage": {
        "3": 3,
        "5": 0,
        "7": 1
      }
    }
  ]
}

Note that all "coverable" lines should be present on the coverage node of the JSON payload. In the example you can see "5": 0, meaning that line 5 is not covered.

Can't guess any report due to no matching¶

Codacy Coverage Reporter automatically searches for coverage reports matching the file name conventions for supported formats.

However, if Codacy Coverage Reporter does not find your coverage report, you can explicitly define the report file name with the flag -r. For example:

bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
    -r <my report>

JsonParseException while uploading C# coverage data¶

If you are using dotCover to generate coverage reports for your C# projects, you should exclude xUnit files from the coverage analysis as follows:

dotCover.exe cover ... /Filters=-:xunit*

By default, dotCover includes xUnit files in the coverage analysis and this results in larger coverage reports. This filter helps ensure that the resulting coverage data does not exceed the size limit accepted by the Codacy API when uploading the results.

SubstrateSegfaultHandler caught signal 11¶

If you are experiencing segmentation faults when uploading the coverage results due to oracle/graal#624, execute the following command before running the reporter, as a workaround:

echo "$(dig +short api.codacy.com | tail -n1) api.codacy.com" >> /etc/hosts

coverage-xml/index.xml generated an empty result¶

If you are using PHPUnit version 5 or above to generate your coverage report, you must output the report using the Clover format. Codacy Coverage Reporter supports the PHPUnit XML format only for versions 4 and older.

To change the output format replace the flag --coverage-xml <dir> with --coverage-clover <file> when executing phpunit.

See PHPUnit command-line documentation for more information.

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

255 characters left

We're sorry to hear that. Please let us know what we can improve:

255 characters left

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified September 25, 2020