Skip to content
This repository has been archived by the owner on Dec 26, 2019. It is now read-only.

Latest commit

 

History

History
92 lines (66 loc) · 2.31 KB

Development.md

File metadata and controls

92 lines (66 loc) · 2.31 KB
Raw

Quick Setup for Development

No manual settings, plug and play:

# get code
git clone https://github.com/cgtuebingen/infomark-backend.git
go build infomark.go

# copy pre-defined config (just for demo purposes)
cp .informark.example.yml .informark.yml
cp docker-compose.example.yml docker-compose.yml
# the backend will search for .infomark.yml in the directory $INFOMARK_CONFIG_DIR
# or use the file in the current directory

# start dependencies (postgres, rabbitmq, redis)
sudo docker-compose up -d

# initialize database
cd database
export POSTGRES_HOST=localhost
./reset_db.sql
./mock_db.sql
cd ..

# start some background worker (feel free to start more instances)
# as it uses docker, sudo permissions are required to talk to the docker context
sudo ./infomark worker &
sudo ./infomark worker &
sudo ./infomark worker &

# start server
./infomark serve

# generate swagger
go generate

The backend will be served at http://localhost:3000 and some credentials are:

user: test@uni-tuebingen.de
pass: test

Generating the Docs (Swagger)

This implementation features an automatic Swagger-v3 definition generation of all available endpoints from the REST-endpoints which includes code-checks to ensure that:

  • all routes are documented and have the correct method (GET, POST, PATCH, PUT)
  • responses or request bodies have documentations and examples

Just run

go generate

and use the Swagger-UI to serve the file api.yaml.

Development + Unit-Tests

Some tools have been proven useful during development. We suggest pgweb to debug the database queries

pgweb --host=127.0.0.1 --port 5433 --user=user --pass=pass --db=db

To run the unit-tests you will need to mock the database content (we need some data to test again) in python:

# do it once to create schema and mock
cd database
./reset_db.sh
./mock_db.sql
cd ..

cd api/app
# this is run by our CI tests
go test -cover

If during development (and using docker-compose) you want to reset everything just do

sudo docker-compose down -v
sudo docker-compose rm
sudo docker-compose up --force-recreate

If you are working on the mock-generator please add new lines to the end of the file as the random seed is fixed and some unit tests depend on the actual random seed.