race-service

The race service let you administrate the main domain objects race and race plan, startlist and results.

Based on the type of event (competition-format), list of race classes and a list of contestants, this service will support:

• generating a race plan, and
• generating races pr race classes with contestants and start times for each individual race,
• generating startlist,
• record individual result (time-events) on multiple timing points,
• create race results, and
• generate result lists pr ageclass.

The race service will support the following competition-formats:

• Interval Start competition,
• Mass start competition,
• Skiathlon competition,
• Pursuit,
• Individual sprint competition,
• Team sprint competition, and
• Relay competitions.

cf https://assets.fis-ski.com/image/upload/v1624284540/fis-prod/assets/ICR_CrossCountry_2022_clean.pdf

Example of usage

Scenario: generate raceplan and startlist for an event

% # Login to get a token:
% curl -H "Content-Type: application/json" \
  -X POST \
  --data '{"username":"admin","password":"passw123"}' \
  http://localhost:8083/login
% export ACCESS="" #token from response
% # Create a competition-format:
% curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS" \
  -X POST \
  --data @tests/files/competition_format_individual_sprint.json \
  http://localhost:8082/competition-formats
% # Create the event:
% curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS" \
  -X POST \
  --data @tests/files/event_individual_sprint.json \
  http://localhost:8081/events
% # Find the id of the event:
% curl http://localhost:8081/events
% # Add contestants to the event
% curl -H "Content-Type: multipart/form-data" \
  -H "Authorization: Bearer $ACCESS" \
  -X POST \
  -F "data=@tests/files/contestants_all.csv; type=text/csv" \
  http://localhost:8081/events/1234/contestants # use the id from the event in previous step
% # Generate raceclasses based on contestants
% curl -H "Authorization: Bearer $ACCESS" \
  -X POST \
  http://localhost:8081/events/1234/generate-raceclasses
% # Generate raceplan:
% curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS" \
  -X POST \
  --data '{"event_id": "1234"}' \
  http://localhost:8080/raceplans/generate-raceplan-for-event
% curl -H "Authorization: Bearer $ACCESS"  http://localhost:8080/raceplans?eventId=1234
% curl -H "Authorization: Bearer $ACCESS"  http://localhost:8080/races?eventId=1234
% # Assign bibs to contestants:
% curl -H "Authorization: Bearer $ACCESS" \
  -X POST \
  http://localhost:8081/events/1234/contestants/assign-bibs
% # Finally, generate the startlist:
% curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS" \
  -X POST \
  --data '{"event_id": "1234"}' \
  http://localhost:8080/startlists/generate-startlist-for-event
% # Inspect the startlist:
% curl http://localhost:8080/startlists?eventId=1234

Develop and run locally

Requirements

• pyenv (recommended)
• poetry
• nox

% pipx install nox
% pipx install poetry
% pipx inject nox nox-poetry

Install software

% git clone https://github.com/langrenn-sprint/race-service.git
% cd race-service
% pyenv install 3.11.2
% poetry install

Environment variables

To run the service locally, you need to supply a set of environment variables. A simple way to solve this is to supply a .env file in the root directory.

A minimal .env:

JWT_SECRET=secret
JWT_EXP_DELTA_SECONDS=3600
ADMIN_USERNAME=admin
ADMIN_PASSWORD=passw123
DB_USER=admin
DB_PASSWORD=admin
LOGGING_LEVEL=DEBUG

Running the API locally

Start the server locally:

% poetry run adev runserver -p 8080 --aux-port 8089 race_service

Running the API in a wsgi-server (gunicorn)

% poetry run gunicorn race_service:create_app --bind localhost:8080 --worker-class aiohttp.GunicornWebWorker

Running the wsgi-server in Docker

To build and run the api in a Docker container:

% docker build -t ghcr.io/langrenn-sprint/race-service:latest .
% docker run --env-file .env -p 8080:8080 -d ghcr.io/langrenn-sprint/race-service:latest

The easier way would be with docker-compose:

docker-compose up --build

Running tests

We use pytest for contract testing.

To run linters, checkers and tests:

% nox

To run specific test:

% nox -s integration_tests -- -k test_create_race_adapter_fails

To run tests with logging, do:

% nox -s integration_tests -- --log-cli-level=DEBUG