build: unify the gate so root make check covers the backend (closes #16)
All checks were successful
check / check (push) Successful in 42s
All checks were successful
check / check (push) Successful in 42s
Root `make check` only ever ran the frontend, so the "main is always green" policy was satisfied vacuously: the Go backend could be entirely broken and the root gate stayed green. - The backend moves onto scripts-to-rule-them-all. Its test, lint, fmt, fmt-check, build, run and clean implementations now live in `backend/script/`, and `backend/Makefile` is thin shims. The backend is its own project (own module, README, LICENSE, linter config, Dockerfile stage), and `Dockerfile.backend` only copies `backend/` into its builder, so its scripts have to live under `backend/`. - The root `script/test`, `script/lint`, `script/fmt` and `script/fmt-check` now run the frontend step and then the matching `backend/script/*` step, so `script/check` — and therefore the pre-commit hook — gates both halves. The frontend-only steps moved into `script/frontend-*` so nothing is duplicated. - `script/frontend-check` is the frontend half of the gate, exposed as the `check-frontend` target, for the frontend Dockerfile: its build stage is a node image with no Go toolchain. The backend half is gated by `Dockerfile.backend`, and `script/cibuild` builds both images, so the two Dockerfiles together still gate the whole repo. The `check-backend` target is the mirror of it. - `script/cibuild` builds both images through one `build_image` helper, and the Gitea workflow's only build step is `script/cibuild`; the raw `docker build -f Dockerfile.backend .` is gone from the workflow. `script/docker` likewise builds and tags both images. - `backend/Makefile`'s `hooks` target is removed. It wrote the same `.git/hooks/pre-commit` as `script/install-precommit`, so the two clobbered each other and the developer silently ended up gating on only one half of the repo. `script/install-precommit` is now the only installer, and the hook it writes runs the repo-wide `script/check`. - `backend/Makefile`'s `docker` target is removed too: the backend image builds from the repo root with a root-level Dockerfile, so it belongs to the root `script/docker` and `script/cibuild` rather than to a backend script that would have to reach outside `backend/`. - `backend/script/lint` verifies that `.golangci.yml` still matches its pinned sha256 before running the linter. Offline hash comparison, no network. READMEs at the root and in `backend/` document every script, and `TODO.md` records the change.
This commit is contained in:
@@ -1,53 +1,38 @@
|
||||
UNAME_S := $(shell uname -s)
|
||||
VERSION := $(shell git describe --always --dirty)
|
||||
BUILDARCH := $(shell uname -m)
|
||||
BINARY := netwatch-server
|
||||
# Standard targets are thin shims; the implementations live in
|
||||
# backend/script/ per the scripts-to-rule-them-all pattern (see the
|
||||
# Entrypoints section of README.md).
|
||||
#
|
||||
# There is no `hooks` target here: the repo has exactly one pre-commit
|
||||
# hook installer, the root `script/install-precommit`, and the hook it
|
||||
# installs gates both halves of the repo. There is no `docker` target
|
||||
# either: the backend image is built from Dockerfile.backend with the
|
||||
# repo root as its context, so it belongs to the root `make docker` and
|
||||
# `script/cibuild`.
|
||||
|
||||
GOLDFLAGS += -X main.Version=$(VERSION)
|
||||
GOLDFLAGS += -X main.Buildarch=$(BUILDARCH)
|
||||
|
||||
ifeq ($(UNAME_S),Darwin)
|
||||
GOFLAGS := -ldflags "$(GOLDFLAGS)"
|
||||
else
|
||||
GOFLAGS = -ldflags "-linkmode external -extldflags -static $(GOLDFLAGS)"
|
||||
endif
|
||||
|
||||
.PHONY: all build test lint fmt fmt-check check docker hooks run clean
|
||||
.PHONY: all build test lint fmt fmt-check check run clean
|
||||
|
||||
all: build
|
||||
|
||||
build: ./$(BINARY)
|
||||
|
||||
./$(BINARY): $(shell find . -name '*.go' -type f) go.mod go.sum
|
||||
go build -o $@ $(GOFLAGS) ./cmd/netwatch-server/
|
||||
build:
|
||||
@script/build
|
||||
|
||||
test:
|
||||
timeout 30 go test ./...
|
||||
@script/test
|
||||
|
||||
lint:
|
||||
golangci-lint run ./...
|
||||
@script/lint
|
||||
|
||||
fmt:
|
||||
go fmt ./...
|
||||
@script/fmt
|
||||
|
||||
fmt-check:
|
||||
@test -z "$$(gofmt -l .)" || \
|
||||
(echo "Files not formatted:"; gofmt -l .; exit 1)
|
||||
@script/fmt-check
|
||||
|
||||
check: test lint fmt-check
|
||||
check:
|
||||
@script/check
|
||||
|
||||
docker:
|
||||
timeout 300 docker build -t netwatch-server -f ../Dockerfile.backend ..
|
||||
|
||||
hooks:
|
||||
@printf '#!/bin/sh\ncd backend && make check\n' > \
|
||||
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
||||
@chmod +x \
|
||||
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
||||
@echo "Pre-commit hook installed"
|
||||
|
||||
run: build
|
||||
./$(BINARY)
|
||||
run:
|
||||
@script/run
|
||||
|
||||
clean:
|
||||
rm -f ./$(BINARY)
|
||||
@script/clean
|
||||
|
||||
@@ -11,11 +11,38 @@ make run
|
||||
# Run tests, lint, and format check
|
||||
make check
|
||||
|
||||
# Docker
|
||||
docker build -t netwatch-server .
|
||||
# Docker (from the repo root; the image's build context is the repo root)
|
||||
make docker
|
||||
docker run -p 8080:8080 netwatch-server
|
||||
```
|
||||
|
||||
## Entrypoints
|
||||
|
||||
This project follows the same
|
||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
||||
pattern as the repo root: the implementations live in `backend/script/` and the
|
||||
targets in `backend/Makefile` are thin shims that call them. The repo root's
|
||||
`script/test`, `script/lint`, `script/fmt` and `script/fmt-check` call these
|
||||
too, so the root `make check` covers the backend.
|
||||
|
||||
- `script/build` — compile `netwatch-server` with the version and architecture
|
||||
stamped in via ldflags (statically linked on Linux)
|
||||
- `script/test` — run the Go tests under a 30-second timeout
|
||||
- `script/lint` — assert `.golangci.yml` still matches its pinned sha256, then
|
||||
run golangci-lint
|
||||
- `script/fmt` — format the Go sources (writes)
|
||||
- `script/fmt-check` — check Go formatting (read-only)
|
||||
- `script/check` — run test, lint, and fmt-check
|
||||
- `script/run` — build and run the server locally
|
||||
- `script/clean` — remove build artifacts
|
||||
|
||||
There is deliberately no `hooks` target here: the repo has exactly one
|
||||
pre-commit hook installer, the root `script/install-precommit`, and the hook it
|
||||
installs runs the root `script/check`, which gates both halves of the repo.
|
||||
There is no `docker` target either: `Dockerfile.backend` lives at the repo root
|
||||
and builds with the repo root as its context, so the backend image is built by
|
||||
the root `make docker` and by `script/cibuild`.
|
||||
|
||||
## Rationale
|
||||
|
||||
The NetWatch frontend collects latency measurements from the browser but has no
|
||||
|
||||
27
backend/script/build
Executable file
27
backend/script/build
Executable file
@@ -0,0 +1,27 @@
|
||||
#!/bin/sh
|
||||
# script/build: compile the netwatch-server binary into the backend
|
||||
# project root. Version and architecture are stamped into the binary via
|
||||
# ldflags; on Linux the binary is statically linked.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
BINARY="netwatch-server"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
|
||||
# git describe fails outside a working repo (e.g. a source tarball),
|
||||
# which must not abort the build.
|
||||
version="$(git describe --always --dirty 2>/dev/null || echo unknown)"
|
||||
buildarch="$(uname -m)"
|
||||
|
||||
ldflags="-X main.Version=$version -X main.Buildarch=$buildarch"
|
||||
if [ "$(uname -s)" != "Darwin" ]; then
|
||||
ldflags="-linkmode external -extldflags -static $ldflags"
|
||||
fi
|
||||
|
||||
go build -o "$BINARY" -ldflags "$ldflags" ./cmd/netwatch-server/
|
||||
}
|
||||
|
||||
main "$@"
|
||||
15
backend/script/check
Executable file
15
backend/script/check
Executable file
@@ -0,0 +1,15 @@
|
||||
#!/bin/sh
|
||||
# script/check: run all backend checks (test, lint, fmt-check). Must not
|
||||
# modify any files. The root script/check calls this, so the repo-wide
|
||||
# gate covers the backend.
|
||||
set -eu
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
|
||||
main() {
|
||||
"$SCRIPT_DIR/test"
|
||||
"$SCRIPT_DIR/lint"
|
||||
"$SCRIPT_DIR/fmt-check"
|
||||
}
|
||||
|
||||
main "$@"
|
||||
12
backend/script/clean
Executable file
12
backend/script/clean
Executable file
@@ -0,0 +1,12 @@
|
||||
#!/bin/sh
|
||||
# script/clean: remove build artifacts.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
rm -f netwatch-server
|
||||
}
|
||||
|
||||
main "$@"
|
||||
12
backend/script/fmt
Executable file
12
backend/script/fmt
Executable file
@@ -0,0 +1,12 @@
|
||||
#!/bin/sh
|
||||
# script/fmt: format all Go sources in the backend (writes).
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
go fmt ./...
|
||||
}
|
||||
|
||||
main "$@"
|
||||
18
backend/script/fmt-check
Executable file
18
backend/script/fmt-check
Executable file
@@ -0,0 +1,18 @@
|
||||
#!/bin/sh
|
||||
# script/fmt-check: check Go formatting (read-only). Same scope as
|
||||
# script/fmt, but fails instead of writing.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
unformatted="$(gofmt -l .)"
|
||||
if [ -n "$unformatted" ]; then
|
||||
echo "Files not formatted:"
|
||||
echo "$unformatted"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
main "$@"
|
||||
46
backend/script/lint
Executable file
46
backend/script/lint
Executable file
@@ -0,0 +1,46 @@
|
||||
#!/bin/sh
|
||||
# script/lint: run the Go linter over the backend.
|
||||
#
|
||||
# .golangci.yml is standardized org-wide and must never be edited here
|
||||
# (REPO_POLICIES.md). Its last silent drift replaced the v2 schema with
|
||||
# v1 keys, which left every threshold in the file inert while the build
|
||||
# stayed green. This script therefore asserts the file still matches the
|
||||
# pinned copy byte for byte before the linter runs. The check is a local
|
||||
# hash comparison: no network, no remote schema, nothing unpinned in the
|
||||
# build path.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
# sha256 of the pinned backend/.golangci.yml.
|
||||
GOLANGCI_CONFIG_SHA256="33ba2bf7fe4a44779d09b0fb31d6daf03685f8dc9d2bc417f963d7aabb0d17dc"
|
||||
|
||||
# sha256 <file>: print the file's sha256, coreutils or Darwin/busybox.
|
||||
sha256() {
|
||||
if command -v sha256sum >/dev/null 2>&1; then
|
||||
sha256sum "$1" | cut -d' ' -f1
|
||||
else
|
||||
shasum -a 256 "$1" | cut -d' ' -f1
|
||||
fi
|
||||
}
|
||||
|
||||
check_config_hash() {
|
||||
actual="$(sha256 .golangci.yml)"
|
||||
if [ "$actual" != "$GOLANGCI_CONFIG_SHA256" ]; then
|
||||
echo ".golangci.yml has drifted from the pinned config."
|
||||
echo " expected $GOLANGCI_CONFIG_SHA256"
|
||||
echo " actual $actual"
|
||||
echo "Restore it verbatim from sneak/prompts; do not edit it."
|
||||
echo "Only update GOLANGCI_CONFIG_SHA256 in this script when the"
|
||||
echo "pinned config is deliberately replaced with a new standard."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
check_config_hash
|
||||
golangci-lint run ./...
|
||||
}
|
||||
|
||||
main "$@"
|
||||
14
backend/script/run
Executable file
14
backend/script/run
Executable file
@@ -0,0 +1,14 @@
|
||||
#!/bin/sh
|
||||
# script/run: build and run netwatch-server locally.
|
||||
set -eu
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
"$SCRIPT_DIR/build"
|
||||
cd "$ROOT"
|
||||
exec ./netwatch-server "$@"
|
||||
}
|
||||
|
||||
main "$@"
|
||||
12
backend/script/test
Executable file
12
backend/script/test
Executable file
@@ -0,0 +1,12 @@
|
||||
#!/bin/sh
|
||||
# script/test: run the backend test suite.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
timeout 30 go test ./...
|
||||
}
|
||||
|
||||
main "$@"
|
||||
Reference in New Issue
Block a user