stop2.0

Backend server for stop 2.0 mobile application.

https://ohtuprojekti.jamo.fi/topic_descriptions/147

For front-end developers

To run the latest release version of this project locally using Docker execute this command in terminal:

docker run -p 5000:5000 stoptwo/backend

This will open the application on port 5000 of your localhost. Use a flag -d to run the container in detached mode.

To kill all docker images running on background:

docker stop $(docker ps -q)

For developers

Setting up a Development Environment for Linux

Python version: 3.5.2

Recommended IDE: PyCharm Professional. Students can apply for a free student license here.

To avoid any conflicting dependencies with your other projects, install virtualenv with one of these three installation commands:

sudo easy_install virtualenv

or

sudo pip install virtualenv

or

sudo apt-get install python-virtualenv

in your project folder (../stop2.0-backend)

virtualenv venv
. venv/bin/activate

Now you are in the virtualenv environment. To go back to the normal environment:

deactivate

To install all requirements needed for this project:

pip install -r requirements.txt

(if installing psycopg2 fails, you may need to install following dependencies to your system in normal environment: sudo apt-get install libpq-dev python3-dev )

or you can use Makefile with these commands:

make
make run

To prevent import problems for modules, in your project’s root folder:

export PYTHONPATH=$(pwd)/src/

Running project locally on a Docker container

For instructions installing Docker Engine on Linux please see: https://docs.docker.com/engine/installation/linux/

Build a dockerfile and run it locally:

docker build -t stop .
docker run -p 5000:5000 stop

You can add flag -dto your docker run command to run the container in detached mode.

Stop the container by executing docker ps to find the container id and then executing docker stop {container id}.

Run project’s database locally using Docker:

docker build -f DB-Dockerfile -t db .
docker run -p 5432:5432 db

Database

There are currently no automatic database migrations so whenever you make changes to database schema you have to update the production databases manually.

Testing

To run tests locally (requires Docker):

make test

This will open three docker containers that will automatically stop only if all the tests pass (sorry). If the tests fail you have to stop the containers manually.

Some tests require a mock HSL api, so if you want to run tests without using make test you will have to run the mock api in a docker container:

docker build -t mock-hsl . && docker run -p 11111:11111 mock-hsl