The eligibility service determines if workers are eligible for jobs. To do this, the service stores worker profiles, and the criteria (or filters) each job has defined. The eligibility service can be classified as a purely backend microservice in use by the core Expand domain.
For full API documentation
- Install Go (On OS X with Homebrew you can just run
brew install go.) - [optional to debug] Postman
Clone the repository with:
go get -u github.com/expandorg/eligibility
OR
create a directory $GOPATH/src/github/expandorg and execute: git clone git@github.com:expandorg/eligibility.git
Run the project dependencies (db, etc.) with make up
Run the latest migration with make migrate-latest
Run the project with make run
We use dep to manage our dependencies.
To add a new vendor, use:
deps ensure -add DEPENDENCY
To update vendors for built project, run:
make update-deps
make add-migration name="migration_name"
For migration names be descriptive and start with verbs: create_, drop_, add_, etc.
This will look at the latest migrated version (1, 2, 3) and creates 2 files with new version:
2_migration_name.up.sql and 2_migration_name.down.sql
You can migrate to latest:
make migrate-latest
OR
You can migrate up and migrate down a version:
make run-migrations action="goto" version="1"
When you migrate up, you can see in the schema_migrations the last migrated version. When you migrate down, it updates the the version column in schema_migrations.
make run-tests
We keep all unit tests close to the code and withing the same package. For example, if you want to test the service package, then you would add the tests in that folder marked package service.
We keep all functional tests in tests/ folder. Create a new test file for every function.
We use Google Cloud for CI/CD:
note: please don't modify the following files unless you know what you're doing :)
cloudbuild.yaml: this effectively our CI, it run tests on every PR and will ✓ or x.
cloudbuild.cd.yaml: this effectively our CD, it run tests, builds and pushes the image to the container registry and deploys to production on every Master commit, so master has to be always clean.
k8s.yaml: this is the kubernetes setup, including workload and service setup. cloudbuild.cd uses this file to deploy.
If you're interested in contributing to the eligibility service:
- Start by reading the Contributing guide.
Eligibility service is licensed under the MPL-2 license