Skip to content

Latest commit

 

History

History
118 lines (71 loc) · 5.36 KB

README.md

File metadata and controls

118 lines (71 loc) · 5.36 KB
Raw

worker

Actions worker

We believe that everyone should have access to quality software (like Sentry), that’s why we have always offered Codecov for free to open source maintainers.

By making our code public, we’re not only joining the community that’s supported us from the start — but also want to make sure that every developer can contribute to and build on the Codecov experience.

Code for Background Workers of Codecov. This is built on top of the celery async framework

Quickstart

Setting Virtual Env

Before starting, we suggest using a virtual environment for this project. It eases testing in general at least.

If you already know how to do it (and how you like it), just do what you already do. If you dont know how to do it, we suggest the following steps:

  • python3 -m venv workerenv
  • cd workerenv
  • source bin/activate

Then you should clone this project when inside workerenv folder.

Installing dependencies

Make sure to:

To install the dependencies, run

pip install -r requirements.txt

Environment variables

In order to successfully run make push, you'll need to define the CODECOV_WORKER_GCR_REPO_BASE variable. See its use in Makefile to understand what it's used for. An example is gcr.io/your-project-here/codecov. Codecov internal users, see the env setup documentation for our canonical defaults.

Running Tests

Then, try to run tests to see if the code is working. First get some postgres database running. Anything is fine. I like to spin a postgres docker (docker run -d -p 5432:5432 postgres:9.6.16). Then do

make test

Linting and Import Sorts

Install/run black and isort using

make lint

Getting into docker

To build this into a docker image:

make build.base
make build

To run this as part of the whole infrasctructure, you will be better served by getting the main codebase and running docker-compose up from there

Getting into enterprise mode

To generate an enterprise build, do

make build.enterprise

Versioning

The source of truth on which version we use is in the file VERSION. Every script that tags things with versions will consult that file to see what version it is.

That file is manually updated. We use semantic versioning.

If you are unsure whether you need to change that version at a given moment, the answer is that you probaby don't then. We have multiple deploys on the same version, and only change it when we want to cut a version to enterprise.

Upgrading Dependencies

This repository uses pip-tools to manage dependencies, so make sure you've installed it with pip install pip-tools. To add or update dependencies, change requirements.in, Then run

make update-requirements

Do not change requirements.txt directly

After deploying

If you are deploying or helping with a deploy, make sure to:

  1. Watch logs (on datadog and sentry)
  2. Monitor error rates and timing graphs on the dashboards we have set up

As the deployer, it is your responsability to make sure the system is working as expected post-deploy. If not, you might need to do a rollback.

Code Structure

Before getting into changing the code, try to use the following structure (feel free to suggest changes.Some bits of it are based on our experience)

  • helpers - Those are the "low" level pieces of code, that don't depend on database models or any other heavy business logic. Those shouldn't depend on anything else on the codebase, preferrably
  • database - Those contain database models. They can use logic from helpers and other models, but nothing else. Try to avoid any heavy logic in this code.
  • services - Those are heavier pieces of logic, that don't talk to the external world. They can use helpers and database logic, and among themselves. But make sure that if a service bravo depends on service alpha, then alpha should not depend on any part of bravo
  • tasks - Those are the parts of the code that talk to the external world: it has the tasks that are triggered by external containers. They can depend on helpers, models and services, but NEVER depend on another task (except to schedule them). If some code is common to two tasks, try to put it in a service or somewhere else.

You will also notice some usage of the package https://github.com/codecov/shared for various things. The logic that is there is used by both here and codecov/api codebase. So feel free to make changes there, but dont do anything that will break compatibility too hard.

Contributing

This repository, like all of Codecov's repositories, strives to follow our general Contributing guidlines. If you're considering making a contribution to this repository, we encourage review of our Contributing guidelines first.