Efremenko Arhip
6517145622
Two ways to exercise every endpoint, both living in the repo rather than in a personal Postman workspace: - scripts/smoke.sh walks the full lifecycle and asserts each status, exiting non-zero on the first surprise, so it works in CI as well as by hand; - api/requests.http drives the same calls from an editor's REST client, with later requests reusing ids captured from earlier responses. It doubles as API documentation for the worker author. The script claims until it sees its own job's chunks instead of assuming an empty queue: a shared development database usually holds pending tasks from earlier runs, and it takes the attempt number from the claim response, since a task requeued after an expired lease comes back with attempt 2 or 3. Note for whoever extends the validation cases: Go matches JSON field names case-insensitively, so "worker_ID" is accepted as "worker_id". Only a genuinely unknown key trips DisallowUnknownFields.
73 lines
2.1 KiB
Makefile
73 lines
2.1 KiB
Makefile
.PHONY: build run test vet tidy migrate-up migrate-down up down logs ps rebuild psql
|
|
|
|
# --- build / run ---------------------------------------------------------
|
|
build:
|
|
go build ./...
|
|
|
|
run:
|
|
go run ./cmd/coordinator
|
|
|
|
test:
|
|
go test ./...
|
|
|
|
# Needs a running PostgreSQL; the spec forbids mocks for these guarantees.
|
|
# make test-integration TEST_DATABASE_URL='postgres://...'
|
|
test-integration:
|
|
TEST_DATABASE_URL="$(TEST_DATABASE_URL)" go test -tags=integration ./... -v
|
|
|
|
vet:
|
|
go vet ./...
|
|
|
|
# Runs golangci-lint without installing it system-wide. Install it for speed:
|
|
# pacman -S golangci-lint (Arch)
|
|
LINT_VERSION := v2.12.2
|
|
lint:
|
|
@command -v golangci-lint >/dev/null 2>&1 \
|
|
&& golangci-lint run --build-tags=integration ./... \
|
|
|| go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(LINT_VERSION) run --build-tags=integration ./...
|
|
|
|
tidy:
|
|
go mod tidy
|
|
|
|
# --- migrations ----------------------------------------------------------
|
|
# Requires the golang-migrate CLI:
|
|
# go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
|
|
# DATABASE_URL must be set, e.g.:
|
|
# export DATABASE_URL='postgres://scimesh:scimesh@localhost:5432/scimesh?sslmode=disable'
|
|
migrate-up:
|
|
migrate -path migrations -database "$(DATABASE_URL)" up
|
|
|
|
migrate-down:
|
|
migrate -path migrations -database "$(DATABASE_URL)" down 1
|
|
|
|
# --- docker --------------------------------------------------------------
|
|
# `up` starts Postgres, applies migrations, then launches the coordinator.
|
|
up:
|
|
docker compose up -d --build
|
|
|
|
down:
|
|
docker compose down
|
|
|
|
# Also drops the database volume — use when the schema is beyond repair.
|
|
down-clean:
|
|
docker compose down -v
|
|
|
|
logs:
|
|
docker compose logs -f coordinator
|
|
|
|
ps:
|
|
docker compose ps
|
|
|
|
rebuild:
|
|
docker compose up -d --build --force-recreate coordinator
|
|
|
|
psql:
|
|
docker compose exec postgres psql -U scimesh -d scimesh
|
|
|
|
# --- api ------------------------------------------------------------------
|
|
# Exercises every endpoint against a running coordinator; exits non-zero on the
|
|
# first unexpected status. See also api/requests.http for clicking through them
|
|
# one at a time in an editor.
|
|
smoke:
|
|
./scripts/smoke.sh
|