Skip to main content

Codecov

Scorecards

Codecov is a code coverage reporting platform that that monitors how much of your code has been tested and validated. Codecov analytics can be used to drive visibility into your microservice architecture and understand coverage trends over time.

In this guide, you'll learn how to set up and use the Codecov integration to drive insights into code coverage.

Setup and configuration

Getting started

In order to connect Cortex to your Codecov instance, you’ll need to create a Codecov access token.

Configuration

Once you've created an access token, add it on the Codecov Settings page in the API token field.

caution

If you do not see the Settings page you're looking for, you likely don't have the proper permissions and need to contact your admin.

You can also add an optional Host at this step if you're using a custom Codecov instance. Make sure to enter the URL without the API path (e.g. https://codecov.getcortexapp.com).

Once you save your configuration, you'll see the last four characters of the token you entered. If you’ve set everything up correctly, you’ll see the option to Remove Integration in settings.

You can also use the Test configuration button to confirm that the configuration was successful. If your configuration is valid, you’ll see a banner that says “Configuration is valid. If you see issues, please see documentation or reach out to Cortex support.”

Registration

Discovery

Cortex will use the GitHub, GitLab, Bitbucket, or Azure DevOps repository as the "best guess" for the corresponding Codecov project, since Codecov projects are connected to repositories. For example, if the GitHub repo associated with your Codecov instance is my-org/repo, then the entities in Cortex should also be associated with my-org/repo.

You can find the repository for a given entity in its YAML, defined in a block like the one below:

x-cortex-git:
github:
repository: cortexapps/sample-repo

If the Codecov project you want to associate isn't the same as the repository, you can override this in the Cortex entity descriptor.

Warning

While Cortex will use the entity tag for discovery with many integrations, the repository is used for Codecov projects.

Entity descriptor

If you need to override automatic discovery, you can define the following block in your Cortex entity descriptor.

x-cortex-static-analysis:
codecov:
owner: org-name # git org
repo: my-project # git repo name without the org
provider: AZURE_DEVOPS | BITBUCKET | BITBUCKET_SERVER | GITHUB | GITHUB_ENTERPRISE | GITLAB | GITLAB_ENTERPRISE # select one of the options
flag: flag # (optional) pulls from isolated & categorized coverage reports

The value for repo should be the full repository because Codecov maps projects by repo.

Expected results

Entity pages

With the Codecov integration, you can find code coverage details on an entity's details page as long as that entity is associated with a repo linked to your Codecov instance.

From the Integrations tab in the sidebar, you can open the Codecov page to find the code coverage for that entity.

Scorecards and CQL

Once the Codecov integration is established, you can create Scorecard rules and write CQL queries based on code coverage metrics:

  • Code coverage for an entity's Git repository (out of 100)

Flags

Codecov's flags are used to categorize coverage reports for various features and tests in a given project. Flags allow you to set different statistics for different areas of your code base.

For example, if you have a monorepo with a bunch of unique projects, you can use Codecov flags to evaluate each project with different test coverage metrics.

You can pull flags into Cortex by defining the flag line in the entity descriptor block above.

caution

If you choose to configure with flags, discovery will be disabled, so you'll also have to define the owner, repo, and provider lines.

Real-world examples

For a Scorecard focused on development maturity, you can set a rule to make sure code coverage for a given entity is at least 95%:

codecov.codeCoverage() >= 95

Set a threshold that is both challenging and realistic so there's an incentive for developers to improve.

tip

Setting up a rule based on code coverage can serve as a secondary check to confirm an entity is synced with Codecov and reporting frequently.

Still need help?

The following are all the ways to get assistance from our customer engineering team. Please use the option that is best for your users:

  • Email: help@cortex.io, or open a support ticket in the in app Resource Center
  • Chat: Available in the Resource Center
  • Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your customer success manager.