Codecov - per test coverage #21
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Codecov - per test coverage | |
# This workflow generates pytest coverage with the flag --cov-context=test | |
# This coverage is used as input for Codecov Automated Test Selection (see .github/workflows/codecov_ats.yml) | |
# However there's a performance toll in running tests with this flag. | |
# So we will not be running the test suite on every commit | |
on: [workflow_dispatch, workflow_call] | |
jobs: | |
# Same as 'backend' in .github/workflows/backed.yml | |
# Except for run_backend_tests step (which includes the extra --cov-context=test flag) | |
# And the coverage generation and handling | |
backend-test-with-cov-context: | |
if: github.ref == 'refs/heads/master' | |
name: backend test | |
runs-on: ubuntu-20.04 | |
timeout-minutes: 120 | |
strategy: | |
# This helps not having to run multiple jobs because one fails, thus, reducing resource usage | |
# and reducing the risk that one of many runs would turn red again (read: intermittent tests) | |
fail-fast: false | |
matrix: | |
# XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL. | |
instance: [0, 1, 2, 3, 4, 5, 6, 7, 8] | |
pg-version: ['14'] | |
env: | |
# XXX: `MATRIX_INSTANCE_TOTAL` must be hardcoded to the length of `strategy.matrix.instance`. | |
# If this increases, make sure to also increase `flags.backend.after_n_builds` in `codecov.yml`. | |
MATRIX_INSTANCE_TOTAL: 9 | |
steps: | |
- uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0 | |
with: | |
# Avoid codecov error message related to SHA resolution: | |
# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891 | |
fetch-depth: '2' | |
- name: Setup sentry env | |
uses: ./.github/actions/setup-sentry | |
id: setup | |
with: | |
kafka: true | |
snuba: true | |
symbolicator: true | |
# Right now, we run so few bigtable related tests that the | |
# overhead of running bigtable in all backend tests | |
# is way smaller than the time it would take to run in its own job. | |
bigtable: true | |
pg-version: ${{ matrix.pg-version }} | |
# TODO: Change this for the pip installation | |
# I resorted to the binary because via pip it's not installing and I don't know how to fix it | |
# See https://github.com/giovanni-guidini/sentry/actions/runs/7224632563/job/19686421329 for example | |
- name: Install Codecov CLI (binary) | |
run: | | |
# https://docs.codecov.com/docs/codecov-uploader | |
# https://docs.codecov.com/docs/codecov-uploader#integrity-checking-the-uploader | |
mkdir codecovcli_install_tmp | |
cd codecovcli_install_tmp | |
curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --import # Import Codecov gpg key | |
# Download all binaries | |
curl -O https://cli.codecov.io/v0.4.2/linux/codecov | |
curl -O https://cli.codecov.io/v0.4.2/linux/codecov.SHA256SUM | |
curl -O https://cli.codecov.io/v0.4.2/linux/codecov.SHA256SUM.sig | |
# Verify binaries | |
gpg --verify codecov.SHA256SUM.sig codecov.SHA256SUM | |
shasum -a 256 -c codecov.SHA256SUM | |
cd .. | |
mv codecovcli_install_tmp/codecov codecovcli | |
chmod +x codecovcli | |
rm -r codecovcli_install_tmp | |
./codecovcli --version | |
- name: Run backend test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }}) with --cov-context=test | |
id: run_backend_tests | |
run: | | |
make test-python-ci COV_ARGS=--cov-context=test | |
# Separate from the testing step above so that we always create the report | |
# Even if some tests fail | |
- name: Create coverage report in JSON format | |
if: ${{ always() }} | |
run: | | |
coverage json --show-contexts -o .artifacts/python.coverage.json | |
# Upload coverage data even if running the tests step fails since | |
# it reduces large coverage fluctuations | |
- name: Upload coverage - special case to test Codecov ATS | |
if: ${{ always() }} | |
run: | | |
./codecovcli do-upload --plugin compress-pycoverage --file .artifacts/python.coverage.codecov.json --disable-search --flag smart-tests | |
env: | |
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
continue-on-error: true | |
# Upload coverage data even if running the tests step fails since | |
# it reduces large coverage fluctuations | |
- name: Upload coverage - special case to test Codecov ATS (staging) | |
if: ${{ always() }} | |
run: | | |
./codecovcli --url=${{ secrets.CODECOV_STAGING_URL }} do-upload --plugin compress-pycoverage --file .artifacts/python.coverage.codecov.json --disable-search --flag smart-tests | |
env: | |
CODECOV_TOKEN: ${{ secrets.CODECOV_STAGING_TOKEN }} | |
continue-on-error: true |