Add type hints to dummy instance creation methods

Issue: HIC-287
Change-Id: I1bd10c6aee50fc309d0d39d7b118a6dc76812aa9
2 files changed
tree: 209a94c2b96544c3ed1c0f404e146f17c157f79b
  1. .coveragerc
  2. .gitignore
  3. .pylintrc
  4. LICENSE
  5. README.md
  6. crashreport_stats/
  7. crashreports/
  8. documentation/
  9. hiccup/
  10. manage.py
  11. pyproject.toml
  12. requirements-dev-flake8.txt
  13. requirements-dev-pylint.txt
  14. requirements-dev.txt
  15. resources/
  16. setup.py
  17. tools/
  18. tox.ini
README.md

Hiccup Server

Hiccup is intended to help Fairphone to assess the stability of the Fairphones in the field. The Server side consists of two django projects: crashreports and crashreports_stats. The former implements the API endpoints for collecting crash reports, while the later implements the front-end and some endpoints to access statics.

Setup

Python 3.6 is the only supported python version for the server code. Use this version for development. It is the default version in Ubuntu 18.04, if you run another OS, it is still possible to get python 3.6 (see for example https://askubuntu.com/a/865569).

Make sure you have installed python3, virtualenv and libffi-dev.

$ sudo apt install python3 virtualenv libffi-dev

Clone Hiccup server and install it locally:

$ git clone ssh://$USER@review.fairphone.software:29418/tools/hiccup/hiccup-server
$ cd hiccup-server
$ virtualenv -p python3.6 .venv/hiccupenv
$ source .venv/hiccupenv/bin/activate
(hiccupenv) $ pip install -e .

When using a virtualenv with pyenv (e.g. to get python3.6 on Ubuntu 16.04), the python executable needs to be explicitly named to make tox work (see https://github.com/pyenv/pyenv-virtualenv/issues/202#issuecomment-284728205).

pyenv virtualenv -p python3.6 <installed-python-version> hiccupenv

i.e., because I have compiled python 3.6.6:

pyenv virtualenv -p python3.6 3.6.6 hiccupenv

Setting up PostgreSQL Server

The Hiccup server relies on a PostgreSQL database.

To set up a database server, you can install the following package:

(hiccupenv) $ sudo apt install postgresql

Then create a user and database:

(hiccupenv) $ sudo service postgresql start
(hiccupenv) $ sudo -u postgres createuser $USER --createdb
(hiccupenv) $ sudo -u postgres createdb -O $USER $USER

The settings for accessing the PostgreSQL server can be found in hiccup/settings.py (see the DATABASES setting). When both the postgresql server and the Hiccup server are running on the same machine and you are using the same user that you used for creating the database for running the server, the default settings should be fine. For all other cases a local_settings.py file can be created in the project root directory to overwrite the default settings.

Test that the configuration is correct:

(hiccupenv) $ python manage.py test

See the end of the next section to add a super-user.

Run Hiccup server

The first time you run the server, the database will be empty and the model migrations have yet to happen:

(hiccupenv) $ python manage.py migrate

Then, at any later point, start the local server:

(hiccupenv) $ python manage.py runserver
...
Starting development server at http://127.0.0.1:8000/
...

The API is available at localhost:8000/hiccup/ and the web-front-end at localhost:8000/hiccup_stats/.

The Django admin web-front-end is at localhost:8000/hiccup/admin.

If you plan to browse through the Django admin web-front-end (localhost:8000/hiccup/admin), you will need a super-user (admin) account:

(hiccupenv) $ python manage.py createsuperuser
...
Superuser created successfully.

To browse through the Hiccup front-end (localhost:8000/hiccup_stats/), the account you will identify with should belong to the group FairphoneSoftwareTeam.

Run the following command or perform the manual steps below:

python manage.py shell -c "
    from django.contrib.auth.models import Group, User
    admin = User.objects.get(username='admin')
    stats_group = Group.objects.get(name='FairphoneSoftwareTeam')
    stats_group.user_set.add(admin)
    "
  • You need a running server and a super-user account;
  • Go to the user list at http://localhost:8000/hiccup/admin/auth/user/ and add your super-user to the 'FairphoneSoftwareTeam' group.

API Documentation

The Hiccup REST API documentation is created automatically using drf_yasg and swagger2markup.

It can be generated using tox:

(hiccupenv) $ tox -e docs

The generated documentation file can be found under documentation/api-endpoints.md.

It is also possible to create an HTML version of the docs. Make sure you have asciidoctor installed:

(hiccupenv) $ sudo apt install asciidoctor

Then generate the html docs using tox:

(hiccupenv) $ tox -e docs-html

The generated documentation file can be found under documentation/api-endpoints.html.

Development

Coding Style

We follow the Google Python Style Guide.

Setup

We use tox to both test and validate the code quality:

(hiccupenv) $ pip install -r requirements-dev.txt

Testing

Simply run tox to test your changes in the supported environments:

(hiccupenv) $ tox

To get an overview of the test coverage run:

(hiccupenv) $ tox -e coverage

To generate HTML coverage reports (saved to htmlcov/):

 (hiccupenv) $ tox -e coverage-html

Linters and Formatters

To run the linters (flake8 and pylint) on all files:

(hiccupenv) $ tox -e linters

To run flake8 on only the diff with upstream:

(hiccupenv) $ git diff origin/master ./**/*py | flake8 --diff

We use the black formatter to check the format of the code. To format a single file in place run:

(hiccupenv) $ black file.py

To run the formatter over all python files run:

(hiccupenv) $ git ls-files '*.py' | xargs black

Before committing a patchset, you are kindly asked to run the linting tools (flake8 and pylint) and format the code. For both linters and formatter, git pre-commit hooks can be set up. To activate, copy the pre-commit script that calls all scripts in tools/hooks/pre-commit.d to the .git/hooks folder and make it executable:

(hiccupenv) $ cp tools/hooks/pre-commit .git/hooks/pre-commit
(hiccupenv) $ chmod +x .git/hooks/pre-commit

To prevent commits when the flake8 check fails the strict option can be set to true:

(hiccupenv) $ git config --bool flake8.strict true

Branching structure

New changes should be pushed for review to the master branch. Every version that is merged into the master branch has to be buildable.

The production server is fetching its code from the public mirror of the project.

To update the production server, new changes have to be pulled into the public project and the server should be redeployed using the corresponding ansible playbook.

License

Copyright 2018 Fairphone B.V.

The project is made available under the terms of the Apache 2.0 license. See LICENSE for details.