LEGO

Open source backend for abakus.no, frontend located at webkom/lego-webapp

LEGO Er Ganske Oppdelt

Getting started

LEGO requires python3.9, python3.9-venv, docker and docker-compose. Services like Postgres, Redis, Thumbor and Minio run inside docker.

# Initial setup (only need to once)
$ git clone [email protected]:webkom/lego.git && cd lego/
$ python3 -m venv venv
$ echo "from .development import *" > lego/settings/local.py
$ source venv/bin/activate
$ pip install -r requirements/dev.txt
$ docker-compose up -d
$ python manage.py initialize_development

# Activate and run (do every time)
$ docker-compose up -d
$ source venv/bin/activate
$ python manage.py runserver

# Note 1: Whenever you switch branches you might need to make minor changes
$ pip install -r requirements/dev.txt # If the branch has changes in the dependencies
$ python manage.py migrate # If the branch has a database in another state then yours

# Note 2: When you make changes to models, or constants used by models, you need to create new migrations
$ python manage.py makemigrations # Creates one or more new files that must be commited
# Remember to format generated migrations! (using f.ex: make fixme)

If you get problems it can be a solution to delete the venv, and do a fresh setup

Code Style

This codebase uses the PEP 8 code style. We enforce this with isort, black & flake8. In addition to the standards outlined in PEP 8, we have a few guidelines (see setup.cfg for more info):

Format the code with black & isort

$ make fixme

To check if it is formatted properly, run:

$ tox -e isort -e flake8 -e black

To check if code is typed properly, run:

$ tox -e mypy

Tests

If you want to run a specific test class you can run

$ ./manage.py test lego.apps.[APP]

You can add flags to speed up the tests

By adding the --keepdb the next time it will go a lot faster to run the tests multiple times.

By adding the --parallel will run multiple tests in parallel using multiple cores.

If you want to check your test coverage, you can do the following

# Install the packages needed
$ pip install -r requirements/coverage.txt

# Run a full test run with coverage. This will run all tests in LEGO.
$ coverage run --source=lego ./manage.py test

# Then you can output the full coverage report
$ coverage report
# or a small one that only contains the things you are interested in
$ coverage report | grep [some string]

Deployment

Lego runs in Docker Swarm and deploys are managed by Drone and Ansible.

How to deploy:

1. Make sure the changes is pushed to master and the test passes.
2. Have you added some new settings in settings/? If so make sure the Ansible variables reflects these changes.
3. We run migrations automatically, make sure they work!
4. Push to the build branch. From master: git push origin master:prod
5. Wait for the build build to complete. The last step will be docker build
6. Go to ci.webkom.dev and use the promote feature to deploy the staging/production build.

Ansible will automatically run the playbook for deploying the new build to staging or production based on the target selected in step 6.

$ apt-get install libpq-dev python3-dev

$ sysctl -w vm.max_map_count=262144

export LDFLAGS="-L/usr/local/opt/openssl/lib"

./manage.py load_fixtures --generate