Compare commits
1
Commits
d98b1a55db
...
dcf5f7555b
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dcf5f7555b |
+19
-10
@@ -17,7 +17,17 @@
|
|||||||
# stage that compiles runs `git describe --tags --always` on .git, which
|
# stage that compiles runs `git describe --tags --always` on .git, which
|
||||||
# does not need .git/config; that file can hold a credential, such as a
|
# does not need .git/config; that file can hold a credential, such as a
|
||||||
# password in a remote URL or the token the CI checkout step stores there.
|
# password in a remote URL or the token the CI checkout step stores there.
|
||||||
.git/config
|
# Each submodule keeps a config with the same exposure in its git directory
|
||||||
|
# under .git/modules/, nested again for a submodule's own submodules, or in
|
||||||
|
# its own .git directory when it keeps one.
|
||||||
|
# KNOWN GAP: a submodule whose name has a `config` segment (`config`,
|
||||||
|
# `deploy/config`, `config/lib`) loses its whole git directory, because
|
||||||
|
# `**/.git/modules/**/config` also matches that segment's directory
|
||||||
|
# under .git/modules/. Go's version stamping then fails the build;
|
||||||
|
# nothing leaks. Name such a submodule without that segment:
|
||||||
|
# `git submodule add --name`.
|
||||||
|
**/.git/config
|
||||||
|
**/.git/modules/**/config
|
||||||
|
|
||||||
# Agent scratch: one full checkout of the repo per in-flight agent.
|
# Agent scratch: one full checkout of the repo per in-flight agent.
|
||||||
# Anchored because it occurs once where agents run at the repo root.
|
# Anchored because it occurs once where agents run at the repo root.
|
||||||
@@ -41,7 +51,9 @@
|
|||||||
**/[iI][dD]_[rR][sS][aA]
|
**/[iI][dD]_[rR][sS][aA]
|
||||||
**/[iI][dD]_[dD][sS][aA]
|
**/[iI][dD]_[dD][sS][aA]
|
||||||
**/[iI][dD]_[eE][cC][dD][sS][aA]
|
**/[iI][dD]_[eE][cC][dD][sS][aA]
|
||||||
|
**/[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
||||||
**/[iI][dD]_[eE][dD]25519
|
**/[iI][dD]_[eE][dD]25519
|
||||||
|
**/[iI][dD]_[eE][dD]25519_[sS][kK]
|
||||||
|
|
||||||
# Dependencies: restored inside the image, never copied in.
|
# Dependencies: restored inside the image, never copied in.
|
||||||
**/node_modules
|
**/node_modules
|
||||||
@@ -59,12 +71,9 @@
|
|||||||
**/.vscode
|
**/.vscode
|
||||||
**/*.sublime-*
|
**/*.sublime-*
|
||||||
|
|
||||||
# This repo's own entries.
|
# This repo's own host-built artifacts.
|
||||||
.gitea
|
/vaultik
|
||||||
*.md
|
/dist
|
||||||
LICENSE
|
/.tool
|
||||||
vaultik
|
/coverage.out
|
||||||
dist
|
/coverage.html
|
||||||
.tool
|
|
||||||
coverage.out
|
|
||||||
coverage.html
|
|
||||||
|
|||||||
@@ -10,3 +10,6 @@ insert_final_newline = true
|
|||||||
|
|
||||||
[Makefile]
|
[Makefile]
|
||||||
indent_style = tab
|
indent_style = tab
|
||||||
|
|
||||||
|
[*.go]
|
||||||
|
indent_style = tab
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
name: check
|
name: check
|
||||||
on:
|
on: [push]
|
||||||
push:
|
|
||||||
branches: [main, next]
|
|
||||||
pull_request:
|
|
||||||
branches: [main, next]
|
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
# actions/checkout v4, 2024-09-16
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
- name: Build and check
|
- run: script/cibuild
|
||||||
run: script/cibuild
|
|
||||||
|
|||||||
@@ -16,11 +16,12 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
# goreleaser is not a compiler: it shells out to `go` for the
|
# goreleaser is not a compiler: it shells out to `go` for the
|
||||||
# `before:` hook and for every one of the four cross-compiles.
|
# `before:` hook and for every one of the four cross-compiles.
|
||||||
# Nothing else in this repo puts a Go toolchain on the runner --
|
# Without this step the release either fails at the before-hook or,
|
||||||
# check.yml runs script/cibuild, which does all of its work inside
|
# worse, ships binaries built by whatever Go the runner happens to
|
||||||
# the digest-pinned Dockerfile images -- so without this step the
|
# carry. check.yml's script/cibuild also puts Go on its own runner,
|
||||||
# release either fails at the before-hook or, worse, ships binaries
|
# through script/bootstrap from the package manager at whatever
|
||||||
# built by whatever Go the runner happens to carry.
|
# version that ships, but uses it only for `go mod download` and
|
||||||
|
# gofmt; it compiles inside the digest-pinned Dockerfile images.
|
||||||
#
|
#
|
||||||
# actions/setup-go would pin the action by commit sha, but the Go
|
# actions/setup-go would pin the action by commit sha, but the Go
|
||||||
# tarball it downloads at runtime is verified against no value in
|
# tarball it downloads at runtime is verified against no value in
|
||||||
|
|||||||
+56
-22
@@ -1,28 +1,62 @@
|
|||||||
# Binary
|
|
||||||
/vaultik
|
|
||||||
|
|
||||||
# goreleaser output
|
|
||||||
/dist/
|
|
||||||
|
|
||||||
# Locally installed pinned tools (script/install-goreleaser)
|
|
||||||
/.tool/
|
|
||||||
|
|
||||||
# Test artifacts
|
|
||||||
*.out
|
|
||||||
*.test
|
|
||||||
coverage.html
|
|
||||||
coverage.out
|
|
||||||
|
|
||||||
# IDE
|
|
||||||
.vscode/
|
|
||||||
.idea/
|
|
||||||
*.swp
|
|
||||||
*.swo
|
|
||||||
|
|
||||||
# OS
|
# OS
|
||||||
.DS_Store
|
.DS_Store
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
|
||||||
# Local config for development
|
# Editors
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
*.bak
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
*.sublime-*
|
||||||
|
|
||||||
|
# Agent scratch (worktrees of this repo, created and destroyed by
|
||||||
|
# in-flight tooling). Unanchored: .gitignore patterns already match at
|
||||||
|
# every depth, so no prefix is wanted here. This is not a .dockerignore
|
||||||
|
# entry and must not be given a `**/` prefix on the way into one.
|
||||||
|
.claude/
|
||||||
|
|
||||||
|
# Node
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# Secrets. Unanchored like every entry above, so each matches at every
|
||||||
|
# depth. Matching is case-sensitive on Linux, so names use character
|
||||||
|
# ranges rather than a lowercase form that misses `Server.Key`.
|
||||||
|
|
||||||
|
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
||||||
|
# convention. Only the templates `example.env` and `sample.env` are
|
||||||
|
# re-included below. A repository that commits any other template adds
|
||||||
|
# its own negation after these lines, for example `!.env.example`.
|
||||||
|
*.[eE][nN][vV]
|
||||||
|
.[eE][nN][vV].*
|
||||||
|
.[eE][nN][vV][rR][cC]
|
||||||
|
!example.env
|
||||||
|
!sample.env
|
||||||
|
|
||||||
|
# Private keys and the bundles carrying them.
|
||||||
|
*.[pP][eE][mM]
|
||||||
|
*.[kK][eE][yY]
|
||||||
|
*.[pP]12
|
||||||
|
*.[pP][fF][xX]
|
||||||
|
[iI][dD]_[rR][sS][aA]
|
||||||
|
[iI][dD]_[dD][sS][aA]
|
||||||
|
[iI][dD]_[eE][cC][dD][sS][aA]
|
||||||
|
[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
||||||
|
[iI][dD]_[eE][dD]25519
|
||||||
|
[iI][dD]_[eE][dD]25519_[sS][kK]
|
||||||
|
|
||||||
|
# Go build and test output.
|
||||||
|
*.log
|
||||||
|
*.out
|
||||||
|
*.test
|
||||||
|
coverage.html
|
||||||
|
|
||||||
|
# This repo's own host-built artifacts.
|
||||||
|
/vaultik
|
||||||
|
/dist/
|
||||||
|
/.tool/
|
||||||
|
|
||||||
|
# Local configs for development; they hold storage credentials.
|
||||||
local-config.yaml
|
local-config.yaml
|
||||||
dev-config.yaml
|
dev-config.yaml
|
||||||
@@ -17,6 +17,7 @@ linters:
|
|||||||
disable:
|
disable:
|
||||||
# Genuinely incompatible with project patterns
|
# Genuinely incompatible with project patterns
|
||||||
- exhaustruct # Requires all struct fields
|
- exhaustruct # Requires all struct fields
|
||||||
|
- exhaustruct_v5 # Requires all struct fields (successor to exhaustruct)
|
||||||
- godot # Requires comments to end with periods
|
- godot # Requires comments to end with periods
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
|
|||||||
@@ -108,6 +108,23 @@ Version: 2025-06-08
|
|||||||
code that touches the affected tables) directly. After 1.0, each schema
|
code that touches the affected tables) directly. After 1.0, each schema
|
||||||
change is a new numbered file in that directory and a released file is
|
change is a new numbered file in that directory and a released file is
|
||||||
never edited; an existing local database is then migrated when vaultik
|
never edited; an existing local database is then migrated when vaultik
|
||||||
is updated. See
|
is updated. Before 1.0, a local database left on an older schema is
|
||||||
|
deleted and re-created by a full backup. See
|
||||||
[`docs/DATAMODEL.md`](docs/DATAMODEL.md#schema-migrations).
|
[`docs/DATAMODEL.md`](docs/DATAMODEL.md#schema-migrations).
|
||||||
|
|
||||||
|
14. Never use `git add -A`. Stage only the files you intentionally
|
||||||
|
changed.
|
||||||
|
|
||||||
|
15. Commit messages carry no attribution or advertising trailers for the
|
||||||
|
tool that helped write the code, or for its vendor: the owner is the
|
||||||
|
sole author of code written with a tool.
|
||||||
|
|
||||||
|
16. Run the whole test suite with `make test` every time, and read its full
|
||||||
|
output. Never run `go test`, a single test or a single package, and
|
||||||
|
never grep the output.
|
||||||
|
|
||||||
|
17. Do not stop working on a task until the definition of done given in the
|
||||||
|
initial instruction is met: all of the work, not part or most of it.
|
||||||
|
|
||||||
|
18. For estimates: backing up over 2.5Gbit/s ethernet to an S3 server
|
||||||
|
backed by 2000MB/sec SSD takes about 4 seconds per gigabyte.
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
# Rules
|
|
||||||
|
|
||||||
Read the rules in AGENTS.md and follow them.
|
|
||||||
|
|
||||||
# Memory
|
|
||||||
|
|
||||||
* Claude is an inanimate tool. The spam that Claude attempts to insert into
|
|
||||||
commit messages (which it erroneously refers to as "attribution") is not
|
|
||||||
attribution, as I am the sole author of code created using Claude. It is
|
|
||||||
corporate advertising for Anthropic and is therefore completely
|
|
||||||
unacceptable in commit messages.
|
|
||||||
|
|
||||||
* NEVER use `git add -A`. Always add only the files you intentionally
|
|
||||||
changed.
|
|
||||||
|
|
||||||
* Tests should always be run before committing code. No commits should be
|
|
||||||
made that do not pass tests.
|
|
||||||
|
|
||||||
* Code should always be formatted before committing. Do not commit
|
|
||||||
unformatted code.
|
|
||||||
|
|
||||||
* Code should always be linted before committing. Do not commit
|
|
||||||
unlinted code.
|
|
||||||
|
|
||||||
* The test suite is fast and local. When running tests, don't run
|
|
||||||
individual parts of the test suite, always run the whole thing by running
|
|
||||||
"make test".
|
|
||||||
|
|
||||||
* Do not stop working on a task until you have reached the definition of
|
|
||||||
done provided to you in the initial instruction. Don't do part or most of
|
|
||||||
the work, do all of the work until the criteria for done are met.
|
|
||||||
|
|
||||||
* We do not add migrations before 1.0; schema upgrades can be handled by
|
|
||||||
deleting the local state file and doing a full backup to re-create it.
|
|
||||||
|
|
||||||
* When testing on a 2.5Gbit/s ethernet to an s3 server backed by 2000MB/sec SSD,
|
|
||||||
estimate about 4 seconds per gigabyte of backup time.
|
|
||||||
|
|
||||||
* When running tests, don't run individual tests, or grep the output. run
|
|
||||||
the entire test suite every time and read the full output.
|
|
||||||
|
|
||||||
* When running tests, don't run individual tests, or try to grep the output.
|
|
||||||
never run "go test". only ever run "make test" to run the full test
|
|
||||||
suite, and examine the full output.
|
|
||||||
+57
-80
@@ -1,92 +1,69 @@
|
|||||||
# This file has no lint stage, deliberately.
|
# Lint phase. The linter is invoked directly rather than through `make
|
||||||
#
|
# lint` or `script/lint`, which are themselves a docker build and would
|
||||||
# Linting lives in Dockerfile.lint, built by script/lint, and
|
# recurse into a daemon that does not exist in a build step.
|
||||||
# script/cibuild builds both. A lint stage here would have to either
|
# golangci/golangci-lint:v2.14.0, 2026-10-05
|
||||||
# shell out to `make lint` -- which is now `docker build`, so
|
FROM golangci/golangci-lint:v2.14.0@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f AS lint
|
||||||
# docker-in-docker inside a BuildKit step with no daemon -- or call
|
|
||||||
# golangci-lint directly, which would mean a second, independently
|
|
||||||
# bumpable digest pin for the linter alongside the one in
|
|
||||||
# Dockerfile.lint. Two pins for one tool is the drift that
|
|
||||||
# https://git.eeqj.de/sneak/vaultik/issues/78 was filed over. See
|
|
||||||
# https://git.eeqj.de/sneak/vaultik/issues/113 for the ruling.
|
|
||||||
#
|
|
||||||
# Consequence, stated rather than left to be discovered: script/docker
|
|
||||||
# builds this file only and therefore does not lint. `make fmt-check`
|
|
||||||
# and `make test` still run here, so what a green build of this file
|
|
||||||
# means is "formatted, tested, and it compiles" -- the lint verdict
|
|
||||||
# comes from script/lint or script/cibuild.
|
|
||||||
|
|
||||||
# Build stage
|
|
||||||
# golang:1.26.1-alpine, 2026-03-17
|
|
||||||
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
|
||||||
|
|
||||||
# Build tooling: make, plus a C toolchain because `go test -race` needs cgo,
|
|
||||||
# and git, which derives the version below. The sqlite driver is pure Go
|
|
||||||
# (modernc.org/sqlite), so no sqlite library or CLI is required.
|
|
||||||
RUN apk add --no-cache make build-base git
|
|
||||||
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
|
||||||
# Copy go mod files first for better layer caching
|
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
# `golangci-lint run` silently ignores an unknown top-level key in
|
||||||
|
# .golangci.yml, such as a misspelt `linters:`; `config verify` fails on it.
|
||||||
|
RUN golangci-lint config verify --config .golangci.yml
|
||||||
|
RUN golangci-lint run --config .golangci.yml ./...
|
||||||
|
|
||||||
# Copy source code
|
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
||||||
|
# image ships and the alpine one does not.
|
||||||
|
# golang:1.26.1 (Debian trixie), 2026-10-05
|
||||||
|
FROM golang:1.26.1@sha256:cd78d88e00afadbedd272f977d375a6247455f3a4b1178f8ae8bbcb201743a8a AS test
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN go test -timeout 90s -race -cover ./... || \
|
||||||
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
|
go test -timeout 90s -race -v ./...; exit 1; }
|
||||||
|
|
||||||
|
# Build stage. Nothing is wanted from either phase above; the copies
|
||||||
|
# are what make BuildKit build them first, so this stage cannot run
|
||||||
|
# unless lint and test passed.
|
||||||
|
# golang:1.26.1-alpine, 2026-03-17
|
||||||
|
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
COPY --from=test /src/go.sum /dev/null
|
||||||
|
RUN apk add --no-cache git
|
||||||
|
# A tar-stream context keeps the sender's file owners, which git refuses.
|
||||||
|
RUN git config --system --add safe.directory /src
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# Run the format check and the tests.
|
# The VERSION build arg when one is given, otherwise
|
||||||
#
|
# `git describe --tags --always` on the .git in the build context. With
|
||||||
# CHECK_EPOCH must stay immediately above these RUNs. These layers are
|
# .git present, a version that is still empty, dev or unknown fails the
|
||||||
# keyed on its value, so they are cache-eligible only for a value
|
# build: git is missing or could not read the checkout. The commit and
|
||||||
# already built against this same tree. script/cibuild and script/docker
|
# its date always come from that .git. A context without .git, such as
|
||||||
# each pass a fresh value on every invocation, which is what makes their
|
# a source export, stamps "dev" and an "unknown" commit and date.
|
||||||
# green mean the checks really executed.
|
|
||||||
#
|
|
||||||
# The value is expanded into each check command rather than left to a
|
|
||||||
# bare declaration, so the cache miss does not depend on BuildKit's
|
|
||||||
# unreferenced-ARG handling staying as it is. It also puts the epoch in
|
|
||||||
# the build log, where a reader can see the layer was keyed fresh.
|
|
||||||
#
|
|
||||||
# A build that passes no CHECK_EPOCH, such as a plain `docker build .`,
|
|
||||||
# keys these layers on the empty string, so rebuilding an unchanged
|
|
||||||
# checkout replays them from cache and runs nothing. Only the scripts'
|
|
||||||
# builds mean the checks executed.
|
|
||||||
#
|
|
||||||
# Everything above this line (apk, go.mod, `go mod download`) is
|
|
||||||
# deliberately outside the busted range and keeps caching.
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && make fmt-check
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && make test
|
|
||||||
|
|
||||||
# Version, commit and build date: the build args when given (script/docker
|
|
||||||
# and script/cibuild pass the ones they compute on the host), otherwise
|
|
||||||
# derived from the .git in the build context. The version is then `git
|
|
||||||
# describe --tags --always`: the tag on a tagged commit, tag-N-gHASH after
|
|
||||||
# one, the short commit when no tag is reachable. A context that carries
|
|
||||||
# .git and still yields no version fails the build; one without .git, as
|
|
||||||
# from a source tarball, stamps "dev" and an "unknown" commit and date.
|
|
||||||
#
|
|
||||||
# These ARGs sit here, after the checks, rather than at the top of the
|
|
||||||
# stage: every commit changes their values, and a value change
|
|
||||||
# invalidates all layers below the ARG. Declared up top they would bust
|
|
||||||
# `go mod download`; here they only rekey this build layer, which the
|
|
||||||
# COPY of the sources above already rebuilds on any change anyway.
|
|
||||||
ARG VERSION
|
ARG VERSION
|
||||||
ARG COMMIT
|
RUN VERSION="${VERSION:-$(git describe --tags --always || echo dev)}"; \
|
||||||
ARG COMMIT_DATE
|
if [ -e .git ]; then \
|
||||||
|
case "$VERSION" in ""|dev|unknown) \
|
||||||
# Build (pure Go, no CGO required since we use modernc.org/sqlite)
|
echo "version is '$VERSION' although .git is present" >&2; \
|
||||||
RUN version="${VERSION:-$(git describe --tags --always || echo dev)}"; \
|
exit 1 ;; \
|
||||||
if [ -e .git ] && { [ -z "$version" ] || [ "$version" = dev ] || \
|
esac; \
|
||||||
[ "$version" = unknown ]; }; then \
|
|
||||||
echo "the build context carries .git but yields no version" >&2; \
|
|
||||||
exit 1; \
|
|
||||||
fi; \
|
fi; \
|
||||||
commit="${COMMIT:-$(git rev-parse HEAD || echo unknown)}"; \
|
commit="$(git rev-parse HEAD || echo unknown)"; \
|
||||||
commit_date="${COMMIT_DATE:-$(git show -s --format=%cs HEAD || echo unknown)}"; \
|
commit_date="$(git show -s --format=%cs HEAD || echo unknown)"; \
|
||||||
CGO_ENABLED=0 go build -ldflags "-X 'sneak.berlin/go/vaultik/internal/globals.Version=${version}' -X 'sneak.berlin/go/vaultik/internal/globals.Commit=${commit}' -X 'sneak.berlin/go/vaultik/internal/globals.CommitDate=${commit_date}'" -o /vaultik ./cmd/vaultik
|
globals=sneak.berlin/go/vaultik/internal/globals; \
|
||||||
|
CGO_ENABLED=0 go build -trimpath \
|
||||||
|
-ldflags="-s -w -X ${globals}.Version=${VERSION} \
|
||||||
|
-X ${globals}.Commit=${commit} \
|
||||||
|
-X ${globals}.CommitDate=${commit_date}" \
|
||||||
|
-o /vaultik ./cmd/vaultik
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage, and the last one: a plain `docker build .` builds this
|
||||||
|
# stage's chain and nothing else.
|
||||||
# alpine:3.21, 2026-02-25
|
# alpine:3.21, 2026-02-25
|
||||||
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
||||||
|
|
||||||
|
|||||||
-104
@@ -1,104 +0,0 @@
|
|||||||
# Lint image.
|
|
||||||
#
|
|
||||||
# Every lint run in this repo happens inside this image, invoked through
|
|
||||||
# script/lint, and linting is a BUILD STEP rather than a container
|
|
||||||
# command: a successful build of this file IS a clean lint. That shape
|
|
||||||
# also works where the docker daemon is remote and bind mounts are
|
|
||||||
# impossible, which `docker run` against a mounted worktree does not.
|
|
||||||
#
|
|
||||||
# This FROM line is the single source of truth for the linter version in
|
|
||||||
# this repo. Nothing else pins golangci-lint: the product Dockerfile has
|
|
||||||
# no lint stage, deliberately, so there is no second digest to bump and
|
|
||||||
# no pair of pins that can drift apart. Bump the tag AND the digest here
|
|
||||||
# and nowhere else.
|
|
||||||
#
|
|
||||||
# Note for readers coming from REPO_POLICIES.md: that document still
|
|
||||||
# describes the older pattern, a lint stage inside the product
|
|
||||||
# Dockerfile wired up with `COPY --from=lint /src/go.sum /dev/null`.
|
|
||||||
# That pattern is superseded here by the owner's ruling recorded in
|
|
||||||
# https://git.eeqj.de/sneak/vaultik/issues/113 -- lint runs in its own
|
|
||||||
# image, per run, with its own cache and its own lock, which is what
|
|
||||||
# makes concurrent runs on one host safe. The policy text is org-wide
|
|
||||||
# and is being amended separately; this file is what this repo does.
|
|
||||||
#
|
|
||||||
# golangci/golangci-lint:v2.12.2, 2026-08-10
|
|
||||||
FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
|
|
||||||
# Copy the dependency manifests first so the module download layer stays
|
|
||||||
# cached until they change. Everything above the ARG below is cacheable
|
|
||||||
# on purpose; a cold module download on every lint would make the inner
|
|
||||||
# loop unusable and buys nothing, because it is not what the gate is
|
|
||||||
# asserting.
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Force the check layers to execute on every invocation.
|
|
||||||
#
|
|
||||||
# CHECK_EPOCH must stay immediately above the RUNs below. Those layers
|
|
||||||
# are keyed on its value, so they are cache-eligible only for a value
|
|
||||||
# already built against this same tree; script/lint and script/cibuild
|
|
||||||
# each pass a fresh value on every invocation, which is what makes their
|
|
||||||
# green mean the linter really ran. Without it, `docker build -f
|
|
||||||
# Dockerfile.lint .` on an unchanged tree exits 0 in well under a second
|
|
||||||
# having linted nothing.
|
|
||||||
#
|
|
||||||
# The value is expanded into each check command itself rather than left
|
|
||||||
# to a bare declaration, so the cache miss does not depend on BuildKit's
|
|
||||||
# unreferenced-ARG handling staying as it is. It also puts the epoch in
|
|
||||||
# the build log, where a reader can see the layer was keyed fresh.
|
|
||||||
#
|
|
||||||
# The guard is what makes a build that omits --build-arg fail instead of
|
|
||||||
# lie. An unset ARG is an empty string, and an empty string is a
|
|
||||||
# perfectly stable cache key: without the guard the first such build
|
|
||||||
# lints and every one after it on an unchanged tree replays this layer,
|
|
||||||
# executes nothing, and still exits 0. Failed steps are never cached, so
|
|
||||||
# the guard fails on EVERY invocation rather than once. Do not give
|
|
||||||
# CHECK_EPOCH a default value; a default would satisfy the guard with a
|
|
||||||
# constant and restore the hole.
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
|
||||||
|
|
||||||
# Validate .golangci.yml before linting with it.
|
|
||||||
#
|
|
||||||
# This is not belt-and-braces; it closes a hole that `golangci-lint run`
|
|
||||||
# leaves wide open. `run` rejects YAML it cannot PARSE, but it silently
|
|
||||||
# IGNORES an unknown top-level KEY. Renaming `linters:` to `linterz:` --
|
|
||||||
# one character -- discards `default: all`, the whole disable list and
|
|
||||||
# every threshold, leaves only golangci-lint's small default linter set
|
|
||||||
# running, and exits 0 reporting `0 issues.` on a tree the real config
|
|
||||||
# fails. Demonstrated on this repo at this pin, recorded on
|
|
||||||
# https://git.eeqj.de/sneak/vaultik/pulls/114: with a planted
|
|
||||||
# over-length line, `script/lint` exits 1 naming the `revive` finding
|
|
||||||
# with `linters:` and exits 0 with `linterz:`. A set-but-ineffective
|
|
||||||
# config quietly falling back to defaults is precisely the false-green
|
|
||||||
# class this gate exists to eliminate, so it must not sit in the gate's
|
|
||||||
# own configuration.
|
|
||||||
#
|
|
||||||
# `config verify` catches it, and it does so OFFLINE at this pinned
|
|
||||||
# version -- verified, not assumed. Under `docker run --network none`
|
|
||||||
# against the pinned digest it exits 0 on this repo's config and exits 3
|
|
||||||
# on the `linterz:` variant with `additional properties 'linterz' not
|
|
||||||
# allowed`. An earlier revision of this file asserted the opposite, that
|
|
||||||
# the schema is fetched over live HTTPS from an unpinned URL, and used
|
|
||||||
# that to justify omitting this line. That claim was false at v2.12.2;
|
|
||||||
# the schema is embedded. If a future bump reintroduces a network fetch
|
|
||||||
# the failure is loud and this comment is where to record it.
|
|
||||||
#
|
|
||||||
# It is keyed on CHECK_EPOCH, like the lint run below, so it executes on
|
|
||||||
# every invocation. Content-addressing alone would arguably be enough --
|
|
||||||
# .golangci.yml arrives through `COPY . .`, so a cache hit here implies
|
|
||||||
# a byte-identical config was validated when the layer really ran. That
|
|
||||||
# argument is exactly the one that would also excuse caching the lint
|
|
||||||
# layer, and this repo has ruled it insufficient: a cached check layer
|
|
||||||
# checks nothing, and the cost of being wrong is silent. Forcing it costs
|
|
||||||
# milliseconds and puts the epoch in the log, where a reader can see that
|
|
||||||
# this validation ran rather than being replayed.
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && \
|
|
||||||
golangci-lint config verify --config .golangci.yml
|
|
||||||
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && \
|
|
||||||
golangci-lint run --config .golangci.yml ./...
|
|
||||||
@@ -40,9 +40,10 @@ setup:
|
|||||||
check:
|
check:
|
||||||
@script/check
|
@script/check
|
||||||
|
|
||||||
# Run tests only. This runs the ENTIRE suite -- there is no separate
|
# Run tests only, by building the test phase of the Dockerfile. This
|
||||||
# integration target and no build-tagged subset held back. In
|
# runs the ENTIRE suite -- there is no separate integration target and
|
||||||
# particular internal/vaultik/integration_test.go, which does full
|
# no build-tagged subset held back. In particular
|
||||||
|
# internal/vaultik/integration_test.go, which does full
|
||||||
# chunk -> pack -> encrypt -> upload -> restore round-trips, runs here.
|
# chunk -> pack -> encrypt -> upload -> restore round-trips, runs here.
|
||||||
# A `test-integration` target used to exist and was removed: no file in
|
# A `test-integration` target used to exist and was removed: no file in
|
||||||
# the repo carried a build tag, so `-tags=integration` selected nothing
|
# the repo carried a build tag, so `-tags=integration` selected nothing
|
||||||
@@ -87,17 +88,17 @@ clean:
|
|||||||
go clean
|
go clean
|
||||||
|
|
||||||
# Install dependencies. The linter is deliberately not installed here:
|
# Install dependencies. The linter is deliberately not installed here:
|
||||||
# script/lint lints by building Dockerfile.lint, whose FROM line is the
|
# script/lint lints by building the lint phase of the Dockerfile, whose
|
||||||
# single source of truth for the linter version. A second, separately
|
# FROM line is the single source of truth for the linter version. A
|
||||||
# pinned copy on PATH could drift from it and make a local `make lint`
|
# second, separately pinned copy on PATH could drift from it and make a
|
||||||
# disagree with CI.
|
# local `make lint` disagree with CI.
|
||||||
deps:
|
deps:
|
||||||
go mod download
|
go mod download
|
||||||
|
|
||||||
# Run tests with coverage. -count=1 for the same reason script/test
|
# Run tests with coverage, on the host. -count=1 because without it an
|
||||||
# uses it: without it an unchanged package is served from Go's test
|
# unchanged package is served from Go's test result cache, and a
|
||||||
# result cache, and a coverage profile assembled from cached results
|
# coverage profile assembled from cached results describes a run that
|
||||||
# describes a run that did not happen.
|
# did not happen.
|
||||||
test-coverage:
|
test-coverage:
|
||||||
go test -v -count=1 -coverprofile=coverage.out ./...
|
go test -v -count=1 -coverprofile=coverage.out ./...
|
||||||
go tool cover -html=coverage.out -o coverage.html
|
go tool cover -html=coverage.out -o coverage.html
|
||||||
|
|||||||
@@ -728,12 +728,11 @@ regardless of color setting (emoji are not color).
|
|||||||
## requirements
|
## requirements
|
||||||
|
|
||||||
* Go 1.26 or later
|
* Go 1.26 or later
|
||||||
* Docker, with a reachable daemon, to lint, check, or commit:
|
* Docker, with a reachable daemon, to test, lint, check, or commit:
|
||||||
`script/lint` lints by building `Dockerfile.lint`, which runs the
|
`script/test` and `script/lint` build the `test` and `lint` phases of
|
||||||
digest-pinned `golangci-lint` image as a build step, and `make check`
|
the `Dockerfile`, and `make check` and the pre-commit hook both run
|
||||||
and the pre-commit hook both run it. A `golangci-lint` installed on
|
them. A `golangci-lint` installed on `PATH` is not a substitute and is
|
||||||
`PATH` is not a substitute and is never used on a host, whatever its
|
never used on a host, whatever its version.
|
||||||
version.
|
|
||||||
* S3-compatible object storage (or local filesystem, or rclone remote)
|
* S3-compatible object storage (or local filesystem, or rclone remote)
|
||||||
|
|
||||||
## development workflow
|
## development workflow
|
||||||
@@ -772,9 +771,8 @@ them. We provide:
|
|||||||
* `script/projectname` — print the project name (used for the Docker
|
* `script/projectname` — print the project name (used for the Docker
|
||||||
image tag)
|
image tag)
|
||||||
* `script/version` — print the version string to bake into the binary.
|
* `script/version` — print the version string to bake into the binary.
|
||||||
The `Makefile`'s `LDFLAGS` call this, and `script/docker` and
|
The `Makefile`'s `LDFLAGS` call this. See [releasing](#releasing) for
|
||||||
`script/cibuild` pass its output to the image build. See
|
the rules.
|
||||||
[releasing](#releasing) for the rules.
|
|
||||||
* `script/install-goreleaser` — install the pinned `goreleaser` into
|
* `script/install-goreleaser` — install the pinned `goreleaser` into
|
||||||
`.tool/bin` from a sha256-verified release archive. Idempotent, and
|
`.tool/bin` from a sha256-verified release archive. Idempotent, and
|
||||||
called by `script/bootstrap`; the release workflow calls it directly
|
called by `script/bootstrap`; the release workflow calls it directly
|
||||||
@@ -787,97 +785,52 @@ them. We provide:
|
|||||||
nothing else on the release runner does. `actions/setup-go` is not
|
nothing else on the release runner does. `actions/setup-go` is not
|
||||||
used because it verifies the downloaded toolchain against no value in
|
used because it verifies the downloaded toolchain against no value in
|
||||||
this repo. Bumping Go edits `go.mod`, the checksum in this script, and
|
this repo. Bumping Go edits `go.mod`, the checksum in this script, and
|
||||||
the `Dockerfile` `golang` digest together.
|
the two `golang` digests in the `Dockerfile` together.
|
||||||
* `script/release` — cross-compile and publish the release artifacts
|
* `script/release` — cross-compile and publish the release artifacts
|
||||||
with the pinned `goreleaser`. Refuses a `goreleaser` on `PATH` whose
|
with the pinned `goreleaser`. Refuses a `goreleaser` on `PATH` whose
|
||||||
version is not the pinned one, on the same reasoning as `script/lint`.
|
version is not the pinned one, on the same reasoning as `script/lint`.
|
||||||
* `script/release-snapshot` — the same build with no publishing and no
|
* `script/release-snapshot` — the same build with no publishing and no
|
||||||
tagging, into `./dist`
|
tagging, into `./dist`
|
||||||
* `script/test` — run the test suite (verbose rerun on failure). This
|
* `script/test` — run the test suite by building the `test` phase of
|
||||||
runs *everything*: there is no separate integration target and no
|
the `Dockerfile` (verbose rerun on failure). This runs *everything*:
|
||||||
build-tagged subset held back, so the full round-trip tests in
|
there is no separate integration target and no build-tagged subset
|
||||||
`internal/vaultik/integration_test.go` run on every invocation. It
|
held back, so the full round-trip tests in
|
||||||
passes `-count=1`, which disables Go's test result cache. That is
|
`internal/vaultik/integration_test.go` run on every invocation. The
|
||||||
deliberate and it is not free: on this repo's suite it costs about 11
|
90s `-timeout` is a hang backstop rather than a performance budget; it
|
||||||
seconds on every repeat run (measured, back to back: 0.4s cached
|
applies per test binary, to test execution only.
|
||||||
versus 11.6s with `-count=1`). That is the price of the run meaning
|
* `script/lint` — lint by building the `lint` phase of the
|
||||||
anything, because without it an unchanged package prints
|
`Dockerfile`, which runs `golangci-lint config verify` and then
|
||||||
`ok <pkg> (cached)`, which is indistinguishable from a package that
|
`golangci-lint run --config .golangci.yml ./...` as build steps in
|
||||||
really ran, so the whole suite can report a full set of `ok` lines in
|
the digest-pinned `golangci-lint` image. Nothing lints on the host.
|
||||||
under half a second having executed nothing. The `-timeout` is a hang
|
That `FROM` line is the only pin of the linter version, and it changes
|
||||||
backstop rather than a performance budget — it applies per test binary
|
in the same commit as a re-vendored `.golangci.yml`.
|
||||||
to test execution only, not to compilation — and is set well above the
|
|
||||||
slowest package's measured runtime. Its 120s value deliberately
|
|
||||||
diverges from the 30s `REPO_POLICIES.md` mandates; the reasoning is in
|
|
||||||
the comment in the script, and issue #101 proposes amending the policy
|
|
||||||
text.
|
|
||||||
* `script/lint` — lint by building `Dockerfile.lint`, which runs
|
|
||||||
`golangci-lint run --config .golangci.yml ./...` as a build step
|
|
||||||
inside the digest-pinned `golangci-lint` image, so a successful build
|
|
||||||
*is* a clean lint. Nothing lints on the host, at any version, ever;
|
|
||||||
the script requires Docker and fails loudly rather than falling back
|
|
||||||
to a `golangci-lint` on `PATH`. That `FROM` line is the single source
|
|
||||||
of truth for the linter version — bump it there and nowhere else.
|
|
||||||
|
|
||||||
It takes no arguments, because a build step has no command line to
|
|
||||||
pass flags to, and it passes a fresh `--build-arg CHECK_EPOCH` on
|
|
||||||
every invocation so the lint layer cannot be replayed from cache (see
|
|
||||||
`script/cibuild` below for what that mechanism defends against). To
|
|
||||||
watch the linter execute, run it as
|
|
||||||
`BUILDKIT_PROGRESS=plain script/lint` and check that the lint layer
|
|
||||||
says `RUN … golangci-lint` rather than `CACHED`.
|
|
||||||
|
|
||||||
One container per run means one lint cache and one `golangci-lint`
|
|
||||||
lock per run, both private to it and discarded with it, so concurrent
|
|
||||||
runs on one host cannot contaminate or block each other.
|
|
||||||
* `script/lint-fix` — apply the linter's autofixes (rewrites files),
|
* `script/lint-fix` — apply the linter's autofixes (rewrites files),
|
||||||
using the same pinned image, parsed out of `Dockerfile.lint`. It
|
using the same pinned image, parsed out of the `lint` phase's `FROM`
|
||||||
cannot be a build step, because fixes have to land in the worktree, so
|
line. It cannot be a build step, because fixes have to land in the
|
||||||
it bind-mounts the tree into a `docker run` and therefore needs a
|
worktree, so it bind-mounts the tree into a `docker run` and therefore
|
||||||
*local* daemon. It is a developer convenience and never a gate: no
|
needs a *local* daemon. It is a developer convenience and never a
|
||||||
gate reads its exit status. Run `make lint` afterwards to find out
|
gate: no gate reads its exit status. Run `make lint` afterwards to
|
||||||
whether the tree is clean.
|
find out whether the tree is clean.
|
||||||
* `script/fmt` — format all code (writes)
|
* `script/fmt` — format all code (writes)
|
||||||
* `script/fmt-check` — check formatting (read-only)
|
* `script/fmt-check` — check formatting (read-only). It runs `gofmt` on
|
||||||
|
the host.
|
||||||
* `script/check` — run `script/test`, `script/lint`, and
|
* `script/check` — run `script/test`, `script/lint`, and
|
||||||
`script/fmt-check`. This is authoritative *because* `script/lint`
|
`script/fmt-check`.
|
||||||
builds `Dockerfile.lint`: a local `make check` and CI cannot disagree
|
|
||||||
about lint findings.
|
|
||||||
* `script/docker` — build the Docker image tagged via
|
* `script/docker` — build the Docker image tagged via
|
||||||
`script/projectname`. Passes a fresh `--build-arg CHECK_EPOCH` for the
|
`script/projectname`, stamped with the version
|
||||||
same reason `script/cibuild` does, so a local image build cannot be
|
`git describe --tags --always --dirty` gives on the host, or `unknown`
|
||||||
green on checks it replayed from cache. It builds the *product* image
|
outside a git checkout. The image's build stage depends on the `lint`
|
||||||
only, and the product `Dockerfile` has no lint stage, so it does not
|
and `test` phases, so this lints and tests too.
|
||||||
lint: a green here means formatted, tested, and it compiles.
|
* `script/cibuild` — CI entrypoint: runs `script/bootstrap`,
|
||||||
* `script/cibuild` — CI entrypoint, and the full gate. Two builds, in
|
`script/check`, and then the same image build as `script/docker`.
|
||||||
order: `Dockerfile.lint` (the linter, as a build step) and then
|
`.gitea/workflows/check.yml` runs it on every push.
|
||||||
`Dockerfile` (`make fmt-check` and `make test` in its builder stage,
|
|
||||||
then the product image). Either failing fails the script. It runs the
|
|
||||||
checks in the same containers CI does, from a clean copy of the tree,
|
|
||||||
so it also catches anything that depends on host state.
|
|
||||||
`.gitea/workflows/check.yml` runs it on every push to `main` and
|
|
||||||
`next` and on every pull request against either.
|
|
||||||
|
|
||||||
It passes a fresh `--build-arg CHECK_EPOCH` to each build, unique per
|
Every `docker build` in these scripts passes `--no-cache`, because on
|
||||||
invocation, which both files declare immediately above their check
|
an unchanged tree a cached check layer is replayed without running and
|
||||||
`RUN`s and expand into each check command. Those layers are keyed on
|
the build still exits 0. A plain `docker build .` is therefore no
|
||||||
that value, so a new value re-runs them even on a byte-identical tree,
|
evidence that the checks ran. The cost is that `script/cibuild` runs
|
||||||
and a green from this script means the checks executed. Dependency and
|
the `lint` and `test` phases twice: once in `script/check` and again
|
||||||
module layers sit above the `ARG` and still cache, so a build is not
|
in the image build.
|
||||||
cold.
|
|
||||||
|
|
||||||
A `docker build -f Dockerfile.lint .` that supplies no `CHECK_EPOCH`
|
|
||||||
fails rather than lying. An unset `ARG` is an empty string and an
|
|
||||||
empty string is a stable cache key, so without a guard such a build
|
|
||||||
would serve the lint layer from cache, execute nothing, and still exit
|
|
||||||
0. `Dockerfile.lint` therefore asserts the value is non-empty before
|
|
||||||
running anything, and because failed steps are never cached that
|
|
||||||
assertion fires on every invocation rather than once. The product
|
|
||||||
`Dockerfile` has no such guard, because a plain `docker build .` must
|
|
||||||
succeed: without `CHECK_EPOCH`, rebuilding an unchanged checkout
|
|
||||||
replays its check layers from cache. Use `script/lint`,
|
|
||||||
`script/docker` or `script/cibuild`, which pass the arg, when the
|
|
||||||
checks must run.
|
|
||||||
* `script/precommit` — pre-commit gate: `go mod tidy` + `go fmt` (must
|
* `script/precommit` — pre-commit gate: `go mod tidy` + `go fmt` (must
|
||||||
not change files), then `script/check`
|
not change files), then `script/check`
|
||||||
* `script/install-precommit` — install the git pre-commit hook that
|
* `script/install-precommit` — install the git pre-commit hook that
|
||||||
@@ -889,8 +842,8 @@ them. We provide:
|
|||||||
|
|
||||||
The version a binary reports comes from git, not from a constant in a
|
The version a binary reports comes from git, not from a constant in a
|
||||||
file. It is `git describe --tags --always --dirty`, which
|
file. It is `git describe --tags --always --dirty`, which
|
||||||
`script/version` runs for the `Makefile`, `script/docker` and
|
`script/version` runs for the `Makefile`, and `script/docker` and
|
||||||
`script/cibuild`:
|
`script/cibuild` run themselves:
|
||||||
|
|
||||||
* `HEAD` is exactly on a tag → that tag, such as `v1.0.0`.
|
* `HEAD` is exactly on a tag → that tag, such as `v1.0.0`.
|
||||||
* a commit after a tag → `<tag>-<N>-g<short sha>`.
|
* a commit after a tag → `<tag>-<N>-g<short sha>`.
|
||||||
@@ -902,14 +855,15 @@ A `docker build .` of a clone, with no build arguments, runs the same
|
|||||||
`git describe` (without `--dirty`) on the `.git` in its build context,
|
`git describe` (without `--dirty`) on the `.git` in its build context,
|
||||||
so it stamps the same value for a clean commit; the build fails if the
|
so it stamps the same value for a clean commit; the build fails if the
|
||||||
context carries `.git` and no version comes out. A binary built without
|
context carries `.git` and no version comes out. A binary built without
|
||||||
git metadata reports `dev`.
|
git metadata reports `dev`, or `unknown` when `script/docker` or
|
||||||
|
`script/cibuild` built it outside a git checkout.
|
||||||
|
|
||||||
`goreleaser` stamps a release binary with the tag minus its leading
|
`goreleaser` stamps a release binary with the tag minus its leading
|
||||||
`v`, so the tag `v1.0.0` produces `vaultik 1.0.0`, matching the archive
|
`v`, so the tag `v1.0.0` produces `vaultik 1.0.0`, matching the archive
|
||||||
name `vaultik_1.0.0_linux_amd64.tar.gz`. `goreleaser --snapshot` stamps
|
name `vaultik_1.0.0_linux_amd64.tar.gz`. `goreleaser --snapshot` stamps
|
||||||
`dev-<12 chars of the commit sha>` rather than inventing the next patch
|
`dev-<12 chars of the commit sha>` rather than inventing the next patch
|
||||||
number. `vaultik version` calls a build a development build when its
|
number. `vaultik version` calls a build a development build when its
|
||||||
version is `dev`, `dev-<sha>`, the short commit sha or
|
version is `dev`, `unknown`, `dev-<sha>`, the short commit sha or
|
||||||
`<tag>-<N>-g<short sha>`, with or without `-dirty`; only a plain tag,
|
`<tag>-<N>-g<short sha>`, with or without `-dirty`; only a plain tag,
|
||||||
such as `v1.0.0` or `1.0.0`, is a release. If `script/version` cannot
|
such as `v1.0.0` or `1.0.0`, is a release. If `script/version` cannot
|
||||||
be run at all, `make` stops with an error instead of building an
|
be run at all, `make` stops with an error instead of building an
|
||||||
|
|||||||
+355
-84
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-07-06
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -60,17 +60,28 @@ style conventions are in separate documents:
|
|||||||
prerequisite since nvm requires bash. yarn is then pinned via
|
prerequisite since nvm requires bash. yarn is then pinned via
|
||||||
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
|
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
|
||||||
always exact versions. `script/cibuild` runs the CI build: it changes to the
|
always exact versions. `script/cibuild` runs the CI build: it changes to the
|
||||||
repo root and runs `docker build .`; the Gitea workflow calls it. Four further
|
repo root, runs `script/bootstrap`, runs `script/check`, and builds the image
|
||||||
scripts are our own extensions to the standard: `script/check` runs
|
with the version; the Gitea workflow calls it. **`script/cibuild` runs
|
||||||
`script/test`, `script/lint`, and `script/fmt-check`; `script/precommit` is
|
`script/bootstrap` first**, because the workflow checks out the repo and runs
|
||||||
what the git pre-commit hook runs, and it calls `script/check`;
|
nothing else, while `script/fmt-check` runs the formatter on the host: on a
|
||||||
`script/install-precommit` installs the git pre-commit hook (the `make hooks`
|
pristine checkout with nothing installed the run dies there, after the
|
||||||
target shims to it); and `script/projectname` (literally that filename) simply
|
containerised gates have passed. **The bootstrap alone is not enough**:
|
||||||
outputs the project's name. Scripts that need the name call
|
`script/bootstrap` installs node and yarn under nvm and leaves neither on the
|
||||||
`script/projectname` — e.g. `script/docker` assembles its image tag from it —
|
`PATH` of the shell that called it, so a bare `yarn` still exits 127. The host
|
||||||
so those scripts stay byte-identical across all repos. Repo-type-specific
|
entrypoints that need yarn — `script/fmt` and `script/fmt-check` — therefore
|
||||||
pre-commit extras (e.g. `go mod tidy` verification in Go repos) belong in
|
source nvm for the pinned node version before invoking it, exactly as
|
||||||
`script/precommit`, not in the hook itself. Model scripts are at
|
`script/bootstrap`'s own install step does. A runner carrying nothing but
|
||||||
|
docker and git then gets through `script/check`. Four further scripts are our
|
||||||
|
own extensions to the standard: `script/check` runs `script/test`,
|
||||||
|
`script/lint` and `script/fmt-check`; `script/precommit` is what the git
|
||||||
|
pre-commit hook runs, and it calls `script/check`; `script/install-precommit`
|
||||||
|
installs the git pre-commit hook (the `make hooks` target shims to it); and
|
||||||
|
`script/projectname` (literally that filename) simply outputs the project's
|
||||||
|
name. Scripts that need the name call `script/projectname` — e.g.
|
||||||
|
`script/docker` assembles its image tag from it — so those scripts stay
|
||||||
|
byte-identical across all repos. Repo-type-specific pre-commit extras (e.g.
|
||||||
|
`go mod tidy` verification in Go repos) belong in `script/precommit`, not in
|
||||||
|
the hook itself. Model scripts are at
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
|
||||||
must document the provided scripts in an **Entrypoints** section (see the
|
must document the provided scripts in an **Entrypoints** section (see the
|
||||||
README requirements below).
|
README requirements below).
|
||||||
@@ -89,87 +100,198 @@ style conventions are in separate documents:
|
|||||||
contributor should be able to understand the entire development workflow by
|
contributor should be able to understand the entire development workflow by
|
||||||
reading the Makefile.
|
reading the Makefile.
|
||||||
|
|
||||||
- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check`
|
- Every repo should have a `Dockerfile`, and it carries the repo's gates: a
|
||||||
as a build step so the build fails if the branch is not green. For non-server
|
`lint` phase and a `test` phase, with the final stage depending on both so the
|
||||||
repos, the Dockerfile should bring up a development environment and run
|
image cannot be built unless they pass. For non-server repos the final stage
|
||||||
`make check`. For server repos, `make check` should run as an early build
|
brings up a development environment; for server repos it is the runtime image.
|
||||||
stage before the final image is assembled. Dockerfiles install development
|
The gate phases and the build stage start from their pinned base images and
|
||||||
prerequisites by running `script/bootstrap` rather than duplicating installs
|
install what those images lack either inline, as the canonical Go `Dockerfile`
|
||||||
inline; COPY `script/` and the dependency manifests (`package.json` +
|
below does for `git`, or by running `script/bootstrap`, as the `prompts`
|
||||||
`yarn.lock`, `go.mod` + `go.sum`, etc.) before running it so the bootstrap
|
repo's own `Dockerfile` does for its yarn packages. The development
|
||||||
layer stays cached until dependencies change.
|
environment stage installs development prerequisites by running
|
||||||
|
`script/bootstrap` rather than duplicating its installs inline. A stage that
|
||||||
|
runs `script/bootstrap` COPYs `script/` and the dependency manifests
|
||||||
|
(`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it.
|
||||||
|
|
||||||
- **Dockerfiles must use a separate lint stage for fail-fast feedback.** Go
|
- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
|
||||||
repos use a multistage build where linting runs in an independent stage based
|
no separate lint file. `script/lint` and `script/test` each build one phase
|
||||||
on the `golangci/golangci-lint` image (pinned by hash). This stage runs
|
and nothing else:
|
||||||
`make fmt-check` and `make lint` before the full build begins. The build stage
|
|
||||||
then declares an explicit dependency on the lint stage via
|
|
||||||
`COPY --from=lint /src/go.sum /dev/null`, which forces BuildKit to complete
|
|
||||||
linting before proceeding to compilation and tests. This ensures lint failures
|
|
||||||
surface in seconds rather than minutes, without blocking on dependency
|
|
||||||
download or compilation in the build stage.
|
|
||||||
|
|
||||||
The standard pattern for a Go repo Dockerfile is:
|
```sh
|
||||||
|
docker build --no-cache --target lint -t "$(script/projectname)-lint" .
|
||||||
|
docker build --no-cache --target test -t "$(script/projectname)-test" .
|
||||||
|
```
|
||||||
|
|
||||||
|
**A stage that is not the last one in the file is built only when the final
|
||||||
|
stage's chain depends on it, or when `--target` names it.** That is why the
|
||||||
|
two gates are always invoked by name here, and why the final stage carries a
|
||||||
|
`COPY --from=` of a harmless file from each of them: without that edge a
|
||||||
|
plain `docker build .` builds the last stage alone and exits 0 having linted
|
||||||
|
and tested nothing.
|
||||||
|
|
||||||
|
**Every `docker build` in `script/` is tagged**, here and in
|
||||||
|
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
|
||||||
|
image behind on every invocation, on every developer host and every CI
|
||||||
|
runner; a tagged one replaces the previous image.
|
||||||
|
|
||||||
|
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
|
||||||
|
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
|
||||||
|
themselves a `docker build` and would recurse into a daemon that does not
|
||||||
|
exist in a build step. Formatting is the exception and stays on the host:
|
||||||
|
`script/fmt` writes the working tree, and `script/fmt-check` is its
|
||||||
|
read-only twin.
|
||||||
|
|
||||||
|
**No lint verdict may come from a host invocation of the linter.** On a
|
||||||
|
shared host golangci-lint reads a result cache keyed on file content rather
|
||||||
|
than location, so a second checkout of the same content is served the first
|
||||||
|
one's findings, and a host-global lock in `$TMPDIR` makes concurrent runs
|
||||||
|
exit non-zero with `parallel golangci-lint is running` — a status a caller
|
||||||
|
cannot tell from real findings. Both have produced wrong verdicts in this
|
||||||
|
org, in both directions. A container has its own cache, its own `TMPDIR` and
|
||||||
|
a digest-pinned binary, so neither is reachable.
|
||||||
|
|
||||||
|
- **Any build that runs checks is built with `--no-cache`.** Docker invalidates
|
||||||
|
a `COPY` layer only when the copied content changes, so on an unchanged tree
|
||||||
|
the check `RUN` is served from cache, nothing executes, and the build still
|
||||||
|
exits 0. Every `docker build` in `script/` therefore passes `--no-cache`:
|
||||||
|
`script/lint`, `script/test`, `script/cibuild` and `script/docker` are the
|
||||||
|
four, and there is no fifth — `script/check` runs the two gate phases and
|
||||||
|
`script/fmt-check`, and builds no image of its own. A bare `docker build .` is
|
||||||
|
not evidence that anything ran: a sub-second build reporting success is a
|
||||||
|
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
|
||||||
|
and friends destroy a build cache shared with every other build on the host.
|
||||||
|
When a check is added or changed, prove it works by planting a defect it must
|
||||||
|
catch and watching the run fail on it, then revert the defect. A green run
|
||||||
|
alone shows neither that the check ran nor that it covers what it should.
|
||||||
|
|
||||||
|
- **The gate phases are separate stages, and the build stage depends on both.**
|
||||||
|
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
||||||
|
hash), so lint failures surface in seconds rather than after a full compile,
|
||||||
|
and the test phase is based on the Debian Go image. The canonical Go repo
|
||||||
|
`Dockerfile`:
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
# Lint stage — fast feedback on formatting and lint issues
|
# Lint phase
|
||||||
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
||||||
FROM golangci/golangci-lint@sha256:... AS lint
|
FROM golangci/golangci-lint@sha256:... AS lint
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN make fmt-check
|
RUN golangci-lint run --config .golangci.yml ./...
|
||||||
RUN make lint
|
|
||||||
|
|
||||||
# Build stage
|
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
||||||
# golang:1.x-alpine, YYYY-MM-DD
|
# image ships and the alpine one does not.
|
||||||
FROM golang@sha256:... AS builder
|
# golang:1.x, YYYY-MM-DD
|
||||||
|
FROM golang@sha256:... AS test
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
|
||||||
# Force BuildKit to run the lint stage before proceeding
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
|
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN make test
|
RUN go test -timeout 90s -race -cover ./... || \
|
||||||
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
|
go test -timeout 90s -race -v ./...; exit 1; }
|
||||||
|
|
||||||
ARG VERSION=dev
|
# Build stage. Nothing is wanted from either phase above; the copies
|
||||||
RUN CGO_ENABLED=0 go build -trimpath \
|
# are what make BuildKit build them first, so this stage cannot run
|
||||||
|
# unless lint and test passed.
|
||||||
|
# golang:1.x-alpine, YYYY-MM-DD
|
||||||
|
FROM golang@sha256:... AS builder
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
COPY --from=test /src/go.sum /dev/null
|
||||||
|
RUN apk add --no-cache git
|
||||||
|
# A tar-stream context keeps the sender's file owners, which git refuses.
|
||||||
|
RUN git config --system --add safe.directory /src
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# The VERSION build arg when one is given, otherwise
|
||||||
|
# `git describe --tags --always` on the .git in the build context. With
|
||||||
|
# .git present, a version that is still empty, dev or unknown fails the
|
||||||
|
# build: git is missing or could not read the checkout.
|
||||||
|
ARG VERSION
|
||||||
|
RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \
|
||||||
|
if [ -e .git ]; then \
|
||||||
|
case "$VERSION" in ""|dev|unknown) \
|
||||||
|
echo "version is '$VERSION' although .git is present" >&2; \
|
||||||
|
exit 1 ;; \
|
||||||
|
esac; \
|
||||||
|
fi; \
|
||||||
|
CGO_ENABLED=0 go build -trimpath \
|
||||||
-ldflags="-s -w -X main.Version=${VERSION}" \
|
-ldflags="-s -w -X main.Version=${VERSION}" \
|
||||||
-o /app ./cmd/app/
|
-o /app ./cmd/app/
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage, and the last one
|
||||||
FROM alpine@sha256:...
|
FROM alpine@sha256:...
|
||||||
COPY --from=builder /app /usr/local/bin/app
|
COPY --from=builder /app /usr/local/bin/app
|
||||||
ENTRYPOINT ["app"]
|
ENTRYPOINT ["app"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Key points:
|
Key points:
|
||||||
- The lint stage uses the `golangci/golangci-lint` image directly (it
|
- The lint phase uses the `golangci/golangci-lint` image directly (it has
|
||||||
includes both Go and the linter), so there is no need to install the
|
both Go and the linter), so nothing needs installing.
|
||||||
linter separately.
|
- `COPY --from=<phase> /src/go.sum /dev/null` is a no-op copy whose only
|
||||||
- `COPY --from=lint /src/go.sum /dev/null` is a no-op file copy that creates
|
purpose is the ordering edge. BuildKit runs stages in parallel by default,
|
||||||
a stage dependency. BuildKit runs stages in parallel by default; without
|
and a stage nothing depends on is not built at all, so without these two
|
||||||
this line, the build stage would not wait for lint to finish and a lint
|
lines a red gate would not fail the build.
|
||||||
failure might not fail the overall build.
|
- Keep the runtime stage last, and if you add a stage after it, give it the
|
||||||
|
same two copies. A plain `docker build .` builds the last stage's chain
|
||||||
|
and nothing else.
|
||||||
- If the project uses `//go:embed` directives that reference build artifacts
|
- If the project uses `//go:embed` directives that reference build artifacts
|
||||||
(e.g. a web frontend compiled in a separate stage), the lint stage must
|
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
||||||
create placeholder files so the embed directives resolve. Example:
|
create placeholder files so the embed directives resolve. Example:
|
||||||
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
||||||
The lint stage should not depend on the actual build output — it exists to
|
- If the project requires CGO or system libraries for linting, install them
|
||||||
fail fast.
|
in the lint phase. The `golangci/golangci-lint` image is Debian-based and
|
||||||
- If the project requires CGO or system libraries for linting (e.g.
|
has no `apk`, so install with `apt-get` under the Debian package name
|
||||||
`vips-dev`), install them in the lint stage with `apk add`.
|
(`libvips-dev`, where alpine says `vips-dev`), and delete the package
|
||||||
- The build stage runs `make test` after compilation setup. Tests run in the
|
lists in the same `RUN`, so the layer does not keep them:
|
||||||
build stage, not the lint stage, because they may require compiled
|
|
||||||
artifacts or heavier dependencies.
|
```dockerfile
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends libvips-dev \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
```
|
||||||
|
|
||||||
|
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
||||||
|
`config` at any depth (`**/.git/config`, `**/.git/modules/**/config`): the
|
||||||
|
repository's own, each submodule's under `.git/modules/`, and that of a
|
||||||
|
submodule keeping its own `.git` directory. `git describe` does not need
|
||||||
|
them, and each can hold a credential: a password in a remote URL, or the
|
||||||
|
token the CI checkout step stores there. A submodule whose name has a
|
||||||
|
`config` segment (`config`, `deploy/config`, `config/lib`) loses its whole
|
||||||
|
git directory to `**/.git/modules/**/config`, and Go's version stamping
|
||||||
|
then fails the build: give it a name without that segment
|
||||||
|
(`git submodule add --name`). The stage that compiles has `git` (the
|
||||||
|
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
|
||||||
|
takes the version from the `VERSION` build argument when one is given,
|
||||||
|
otherwise from `git describe --tags --always`. That gives the tag on a
|
||||||
|
tagged commit; on a later commit, the tag, the number of commits since it
|
||||||
|
and the short commit (`v1.2.3-4-gabc1234`); and the short commit when no
|
||||||
|
tag is reachable. The stage that compiles also marks its working directory
|
||||||
|
safe for git (`git config --system --add safe.directory /src`): a context
|
||||||
|
sent as a tar stream keeps the sender's file owners, and git refuses a
|
||||||
|
checkout owned by another user, so the version would come out empty.
|
||||||
|
`ARG VERSION` has no default, and the build fails if the context carries
|
||||||
|
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
|
||||||
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
|
|
||||||
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
runs `script/cibuild` (which runs `docker build .`) on push. Since the
|
runs `script/cibuild` on push, and checks out the repo as its only other step.
|
||||||
Dockerfile already runs `make check`, a successful build implies all checks
|
That script bootstraps, runs the gate phases, and then builds the image, so a
|
||||||
pass.
|
successful run means every check passed; a bare `docker build .` does not
|
||||||
|
carry the same guarantee, because its gate phases may come from the cache. The
|
||||||
|
image build is uncached and so runs the gate phases a second time. That is the
|
||||||
|
price of the rule above, and it is worth paying: the image that ships is built
|
||||||
|
from a run of its own gates rather than from a cache entry. A separate
|
||||||
|
workflow limited to `main` by a `branches` list under `on: push` cannot be
|
||||||
|
checked by review: to try a change to it, add the feature branch to that list
|
||||||
|
and push, then remove the branch from the list again before merging. Keep any
|
||||||
|
job in it that publishes behind `if: github.ref_name == 'main'`, so the run
|
||||||
|
from the feature branch publishes nothing.
|
||||||
|
|
||||||
- Use platform-standard formatters: `black` for Python, `prettier` for
|
- Use platform-standard formatters: `black` for Python, `prettier` for
|
||||||
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
||||||
@@ -189,14 +311,21 @@ style conventions are in separate documents:
|
|||||||
module under test to verify it compiles/parses. There is no excuse for
|
module under test to verify it compiles/parses. There is no excuse for
|
||||||
`make test` to be a no-op.
|
`make test` to be a no-op.
|
||||||
|
|
||||||
- `make test` must complete in under 20 seconds. Add a 30-second timeout in the
|
- `make test` must complete in under 60 seconds. That is the hard cap, and a
|
||||||
Makefile.
|
suite that exceeds it fails. Under 20 seconds is the target. A suite between
|
||||||
|
20 and 60 seconds is still green, but the overage must be filed as an
|
||||||
|
improvement bug against that repo. Add a 90-second timeout to the test
|
||||||
|
invocation (`go test -timeout 90s`). The backstop deliberately sits above the
|
||||||
|
hard cap so that it catches a genuinely hung test rather than a merely slow
|
||||||
|
one.
|
||||||
|
|
||||||
- **`make test` should use the conditional verbose rerun pattern.** Run tests
|
- **The test command should use the conditional verbose rerun pattern.** Run
|
||||||
without `-v` (verbose) first. If tests fail, automatically rerun with `-v` to
|
tests without `-v` (verbose) first. If tests fail, automatically rerun with
|
||||||
show full output. This keeps CI logs and `docker build` output clean on
|
`-v` to show full output. This keeps CI logs and `docker build` output clean
|
||||||
success (just package/suite summaries) while providing full diagnostic detail
|
on success (just package/suite summaries) while providing full diagnostic
|
||||||
on failure (every test case, every assertion). The general shell pattern:
|
detail on failure (every test case, every assertion). The command lives in the
|
||||||
|
`test` phase of the `Dockerfile`, since `script/test` builds that phase; the
|
||||||
|
Makefile form below is the same pattern for any repo-local invocation:
|
||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
test:
|
test:
|
||||||
@@ -209,11 +338,26 @@ style conventions are in separate documents:
|
|||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
test:
|
test:
|
||||||
@go test -timeout 30s -race -cover ./... || \
|
@go test -count=1 -timeout 90s -race -cover ./... || \
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
go test -timeout 30s -race -v ./...; exit 1; }
|
go test -count=1 -timeout 90s -race -v ./...; exit 1; }
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`-count=1` is required on both invocations: it defeats Go's test _result_
|
||||||
|
cache, so neither run can report a stored pass in place of running the
|
||||||
|
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
||||||
|
and no recompilation.
|
||||||
|
|
||||||
|
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
||||||
|
passing result in its cache directory (`GOCACHE`), and when the same tests
|
||||||
|
run again on unchanged code it prints that result, marked `(cached)`,
|
||||||
|
without running them. That matters on a developer's machine, where this
|
||||||
|
target runs and the directory lasts from one run to the next. The `test`
|
||||||
|
phase of the `Dockerfile` needs no `-count=1`: its base image holds no
|
||||||
|
result for this repo's tests and nothing before its `go test` step runs a
|
||||||
|
test, so there is nothing to replay. `--no-cache` (above) is what makes that
|
||||||
|
step run on an unchanged tree.
|
||||||
|
|
||||||
Python example:
|
Python example:
|
||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
@@ -239,10 +383,84 @@ style conventions are in separate documents:
|
|||||||
must be in `.gitignore`. No exceptions.
|
must be in `.gitignore`. No exceptions.
|
||||||
|
|
||||||
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
||||||
editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`.
|
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
|
||||||
Fetch the standard `.gitignore` from
|
language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up
|
from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
|
||||||
a new repo.
|
setting up a new repo. These patterns are written to `.gitignore`'s own
|
||||||
|
semantics, in which an unanchored pattern already matches at every depth; they
|
||||||
|
are not a `.dockerignore` and must not be transplanted into one unmodified.
|
||||||
|
|
||||||
|
- **`.dockerignore` does not use `.gitignore` semantics, and copying patterns
|
||||||
|
across unmodified leaves secrets in the build context.** Docker matches with
|
||||||
|
`moby/patternmatcher`: `filepath.Match` semantics plus a `**` extension, so
|
||||||
|
`*` does not cross `/` and a pattern without a leading `**/` is anchored at
|
||||||
|
the build-context root. A `.dockerignore` listing `.env`, `*.pem` and `*.key`
|
||||||
|
therefore excludes only the copies at the repository root, while `config/.env`
|
||||||
|
and `certs/server.key` still reach the context and can land in an image layer
|
||||||
|
— which is more dangerous than a short file with no secret patterns at all,
|
||||||
|
because it reads as solved and stops anyone looking. Give every
|
||||||
|
depth-independent pattern the `**/` prefix and leave only genuinely
|
||||||
|
root-anchored entries unprefixed: `.claude`, and the repo's own host-built
|
||||||
|
binary, written `/myapp` and never `**/myapp`, which would also match
|
||||||
|
`cmd/myapp/` and delete the package directory from the context. Matching is
|
||||||
|
case-sensitive, and an ALL-CAPS twin per pattern still misses `Server.Key`, so
|
||||||
|
secret names use character ranges — `**/*.[kK][eE][yY]`, `**/*.[pP][eE][mM]`,
|
||||||
|
and likewise for `.envrc` and the extensionless SSH keys. Where such a pattern
|
||||||
|
also catches something the build needs, re-include it with a negation
|
||||||
|
(`!docs/example.env`); deleting the pattern reopens the exposure for every
|
||||||
|
other file it covers. Fetch the standard `.dockerignore` from
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore` and extend
|
||||||
|
it with the repo's own artifacts.
|
||||||
|
|
||||||
|
- **In-repo agent scratch belongs in both files, written to each file's own
|
||||||
|
semantics.** `.claude/` holds one worktree per in-flight agent — an entire
|
||||||
|
additional checkout of the repo — so under `COPY . .` the build context
|
||||||
|
inflates by a multiple of the repo and another session's unreviewed work can
|
||||||
|
be copied into an image layer. In `.gitignore` the entry is `.claude/`,
|
||||||
|
unanchored. In `.dockerignore` it is `.claude`, anchored and with **no** `**/`
|
||||||
|
prefix, because the prefixed form would also delete any nested directory of
|
||||||
|
that name from the build. Anchoring carries a known gap that the canonical
|
||||||
|
`.dockerignore` states in its own comment, since consuming repos receive the
|
||||||
|
file and not the tracker: the directory is created in the agent's working
|
||||||
|
directory, so a repo running agents in subdirectories still ships
|
||||||
|
`services/api/.claude/` and must add its own anchored entry there.
|
||||||
|
|
||||||
|
- **A plain `docker build .` of a clone stamps the version that
|
||||||
|
`git describe --tags --always` gives**, derived from the `.git` in the build
|
||||||
|
context as the canonical `Dockerfile` above shows. Without its failure check,
|
||||||
|
a missing `git` or an unreadable checkout would leave `-X main.Version=` empty
|
||||||
|
and the build would still exit 0. `script/docker` and `script/cibuild` pass
|
||||||
|
the version they compute on the host; it takes precedence. They do this
|
||||||
|
byte-identically across repos:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Own line: a failing command substitution inside an argument does not
|
||||||
|
# trip `set -e`, so the inline form degrades to an empty constant.
|
||||||
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
|
[ -n "$version" ] || version="unknown"
|
||||||
|
docker build --no-cache \
|
||||||
|
--build-arg VERSION="$version" \
|
||||||
|
-t "$(script/projectname)" .
|
||||||
|
```
|
||||||
|
|
||||||
|
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
||||||
|
than failing, and the `[ -n "$version" ]` line is the single place the
|
||||||
|
fallback is applied — a live check that fires on a build from an export with
|
||||||
|
no `.git` and on a repository with no commits yet. Do not fold it into the
|
||||||
|
substitution as `|| echo unknown`, which makes the guard unreachable. The
|
||||||
|
Dockerfile's side is `ARG VERSION` in the stage that compiles, declared
|
||||||
|
there because `ARG` is stage-scoped; passing `VERSION` to a repo whose
|
||||||
|
Dockerfile declares no such `ARG` is ignored and costs nothing, which is why
|
||||||
|
the scripts stay byte-identical. One consequence for CI: the standard
|
||||||
|
checkout action clones shallow and fetches no tags, so a repo that embeds a
|
||||||
|
tag-derived version must set `fetch-depth: 0` on its checkout step.
|
||||||
|
|
||||||
|
- **Verify `.dockerignore` by enumerating the image, not by reading the
|
||||||
|
patterns.** Plant files at the root _and_ at least two directories deep, build
|
||||||
|
a probe image that does `COPY . .`, and list what actually landed
|
||||||
|
(`docker run --rm --entrypoint find IMAGE /app`). The `transferring context`
|
||||||
|
size is not a substitute: a nested secret is a few bytes, and BuildKit
|
||||||
|
transfers only the delta from the previous build.
|
||||||
|
|
||||||
- **No build artifacts in version control.** Code-derived data (compiled
|
- **No build artifacts in version control.** Code-derived data (compiled
|
||||||
bundles, minified output, generated assets) must never be committed to the
|
bundles, minified output, generated assets) must never be committed to the
|
||||||
@@ -258,9 +476,56 @@ style conventions are in separate documents:
|
|||||||
- Make all changes on a feature branch. You can do whatever you want on a
|
- Make all changes on a feature branch. You can do whatever you want on a
|
||||||
feature branch.
|
feature branch.
|
||||||
|
|
||||||
- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only
|
- `.golangci.yml` is standardized. The vendored copy in a consuming repo must
|
||||||
manually by the user. Fetch from
|
_NEVER_ be modified by an agent: fetch it from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`.
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and keep it
|
||||||
|
byte-identical, so that no repo can quietly loosen its own linting. Linter
|
||||||
|
configuration changes are made to the canonical copy in the `prompts` repo and
|
||||||
|
reach consuming repos by re-vendoring; an agent may open a PR against
|
||||||
|
canonical, which only the user merges. One list is exempt from byte-identity,
|
||||||
|
because it cannot be written once for every repo: the `deny` list of the
|
||||||
|
`test-support` depguard rule, where a repo names its own test-support packages
|
||||||
|
by full import path. A repo adds entries there and changes nothing else, and a
|
||||||
|
re-vendor carries its entries forward. The canonical golangci-lint version is
|
||||||
|
v2.14.0 (released 2026-09-24), pinned as the digest of the lint phase's base
|
||||||
|
image
|
||||||
|
(`golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f`,
|
||||||
|
which reports `2.14.0 built with go1.27.0 from 114493f9`). A module's `go`
|
||||||
|
directive must not name a newer Go minor version than the one golangci-lint
|
||||||
|
was built with, or golangci-lint refuses to lint it: this release lints
|
||||||
|
`go 1.27.1` but not `go 1.28`. That digest is the only pin, since no repo
|
||||||
|
installs golangci-lint on the host. A repo sets the lint phase digest to the
|
||||||
|
one named here and re-vendors `.golangci.yml` in the same commit, whichever of
|
||||||
|
the two prompted the change: the canonical copy can name linters that an older
|
||||||
|
golangci-lint rejects, and a newer golangci-lint can add linters that
|
||||||
|
`default: all` switches on until the canonical copy disables them.
|
||||||
|
|
||||||
|
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
|
||||||
|
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
|
||||||
|
`PATH` only, so on an already-provisioned machine the pin is inert and a
|
||||||
|
version bump is a silent no-op — while the Dockerfile, installing into a clean
|
||||||
|
image, gets the pinned version, so a local `make check` and `make docker` can
|
||||||
|
disagree about what the tool even is. The canonical form:
|
||||||
|
- compares the installed version against the pin over the **whole** version
|
||||||
|
token; a parser that stops at the first `-` reports `2.12.2` for a host
|
||||||
|
running `2.12.2-rc1` and skips the install;
|
||||||
|
- treats absent, non-zero, empty or unrecognised `--version` output as a
|
||||||
|
mismatch, so the failure direction is a redundant install and never a
|
||||||
|
skipped one;
|
||||||
|
- after installing, re-resolves the binary the way callers do — `hash -r`,
|
||||||
|
then through `PATH`, not through the directory the installer wrote to —
|
||||||
|
and fails naming the resolved path, since an install that a shadowing
|
||||||
|
binary hides succeeds while changing nothing any caller sees;
|
||||||
|
- is actually called, and prints the version on both success paths: a
|
||||||
|
function defined and never invoked has the same exit status and the same
|
||||||
|
empty output as one that worked.
|
||||||
|
|
||||||
|
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
|
||||||
|
|
||||||
|
A Go tool a repo needs on the host is installed with `go install` pinned to
|
||||||
|
a commit hash (`go install <package>@<commit hash>`). It is never tracked as
|
||||||
|
a `go.mod` tool dependency or through a `tools.go` file, either of which
|
||||||
|
pulls the tool's own dependencies into the repo's `go.mod` and `go.sum`.
|
||||||
|
|
||||||
- When pinning images or packages by hash, add a comment above the reference
|
- When pinning images or packages by hash, add a comment above the reference
|
||||||
with the version and date (YYYY-MM-DD).
|
with the version and date (YYYY-MM-DD).
|
||||||
@@ -374,12 +639,14 @@ style conventions are in separate documents:
|
|||||||
settings.
|
settings.
|
||||||
|
|
||||||
- Avoid putting files in the repo root unless necessary. Root should contain
|
- Avoid putting files in the repo root unless necessary. Root should contain
|
||||||
only project-level config files (`README.md`, `Makefile`, `Dockerfile`,
|
only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
|
||||||
`LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and
|
`Dockerfile`, `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`,
|
||||||
language-specific config). Everything else goes in a subdirectory. Canonical
|
and language-specific config). Everything else goes in a subdirectory.
|
||||||
subdirectory names:
|
Canonical subdirectory names:
|
||||||
- `bin/` — executable scripts and tools
|
- `bin/` — executable scripts and tools
|
||||||
- `cmd/` — Go command entrypoints
|
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
||||||
|
body is a single call into `internal/` or `pkg/`, no project logic in
|
||||||
|
`cmd/`
|
||||||
- `configs/` — configuration templates and examples
|
- `configs/` — configuration templates and examples
|
||||||
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
||||||
- `docs/` — documentation and markdown (README.md stays in root)
|
- `docs/` — documentation and markdown (README.md stays in root)
|
||||||
@@ -406,3 +673,7 @@ style conventions are in separate documents:
|
|||||||
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||||
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||||
- Python: `pyproject.toml`
|
- Python: `pyproject.toml`
|
||||||
|
|
||||||
|
- Guidance for coding agents lives in one `AGENTS.md` at the repository root. It
|
||||||
|
is never committed under a file or directory named after one agent tool, such
|
||||||
|
as `CLAUDE.md` or `.claude/`, and never split into separate memory files.
|
||||||
|
|||||||
@@ -22,6 +22,15 @@ the tag exists and is exercised; what is left is merging `next` to
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-06: Re-vendored the canonical files from `sneak/prompts` at
|
||||||
|
`dd4027b` ([issue #213](https://git.eeqj.de/sneak/vaultik/issues/213)).
|
||||||
|
Linting and testing are now the `lint` and `test` phases of the
|
||||||
|
`Dockerfile`, and the build stage depends on both. `Dockerfile.lint`,
|
||||||
|
`CHECK_EPOCH` and the tests that checked them are gone; every
|
||||||
|
`docker build` in `script/` passes `--no-cache` instead. golangci-lint
|
||||||
|
is v2.14.0, with its new findings fixed in the code, and the rules in
|
||||||
|
`CLAUDE.md` now live in `AGENTS.md`.
|
||||||
|
|
||||||
- 2026-10-06: Made a backup re-chunk a known file that lists a chunk no
|
- 2026-10-06: Made a backup re-chunk a known file that lists a chunk no
|
||||||
uploaded blob holds
|
uploaded blob holds
|
||||||
([issue #214](https://git.eeqj.de/sneak/vaultik/issues/214)). File
|
([issue #214](https://git.eeqj.de/sneak/vaultik/issues/214)). File
|
||||||
|
|||||||
@@ -12,48 +12,42 @@ import (
|
|||||||
// #75). The failure it protects against is silent: the image still
|
// #75). The failure it protects against is silent: the image still
|
||||||
// builds and runs, but `vaultik version` inside it reports "commit:
|
// builds and runs, but `vaultik version` inside it reports "commit:
|
||||||
// unknown" or a version of "dev", so an operator cannot tell which
|
// unknown" or a version of "dev", so an operator cannot tell which
|
||||||
// source produced a given backup. The build takes the values as build
|
// source produced a given backup. The build takes the version as a
|
||||||
// args, which script/docker computes on the host, and otherwise derives
|
// build arg, which script/docker computes on the host, and otherwise
|
||||||
// them from the .git in its context.
|
// derives it from the .git in its context; the commit and its date
|
||||||
|
// always come from that .git.
|
||||||
//
|
//
|
||||||
// These are parses of the committed files, for the same reason the lint
|
// These are parses of the committed files, because shelling out to
|
||||||
// guards next door are: shelling out to docker would nest a build
|
// docker would nest a build inside `make test`. That `vaultik version`
|
||||||
// inside `make test`. That `vaultik version` in the built image really
|
// in the built image really prints the host's version is verified by
|
||||||
// prints the host's version is verified by hand and recorded on the
|
// hand.
|
||||||
// pull request.
|
|
||||||
|
|
||||||
// dockerScript is script/docker, relative to the repository root.
|
// The files under guard, relative to the repository root.
|
||||||
const dockerScript = "script/docker"
|
const (
|
||||||
|
productDockerfile = "Dockerfile"
|
||||||
|
dockerScript = "script/docker"
|
||||||
|
)
|
||||||
|
|
||||||
// versionArgs are the ldflag targets the build stamps and, matching
|
// TestProductDockerfileTakesVersionAsBuildArg fails unless the build
|
||||||
// them, the build args the host must supply. The names line up so the
|
// declares ARG VERSION, with no default, and stamps it into the binary
|
||||||
// same list checks both files.
|
// whenever it is given, ahead of the value derived in the container.
|
||||||
func versionArgs() []string {
|
func TestProductDockerfileTakesVersionAsBuildArg(t *testing.T) {
|
||||||
return []string{"VERSION", "COMMIT", "COMMIT_DATE"}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProductDockerfileTakesVersionAsBuildArgs fails unless the build
|
|
||||||
// declares each version arg, with no default, and stamps it into the
|
|
||||||
// binary whenever it is given, ahead of the value derived in the
|
|
||||||
// container.
|
|
||||||
func TestProductDockerfileTakesVersionAsBuildArgs(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
found := instructions(t, productDockerfile)
|
found := instructions(t, productDockerfile)
|
||||||
|
|
||||||
for _, arg := range versionArgs() {
|
require.Contains(t, found, "ARG VERSION",
|
||||||
require.Contains(t, found, "ARG "+arg,
|
"%s must declare `ARG VERSION`, with no default, so the host can"+
|
||||||
"%s must declare `ARG %s`, with no default, so the host can"+
|
" pass it in", productDockerfile)
|
||||||
" pass it in", productDockerfile, arg)
|
|
||||||
|
|
||||||
assertLdflagReferences(t, found, arg)
|
assertLdflagReferences(t, found, "VERSION")
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestProductDockerfileDerivesVersionFromGit fails unless a build given
|
// TestProductDockerfileDerivesVersionFromGit fails unless a build given
|
||||||
// no VERSION, such as a plain `docker build .` of a clone, takes it from
|
// no VERSION, such as a plain `docker build .` of a clone, takes it from
|
||||||
// `git describe` of the .git in its context, and fails rather than
|
// `git describe` of the .git in its context, stamps "dev" when the
|
||||||
// stamp "dev" when that .git yields no version.
|
// context has no .git, and fails rather than stamp "dev" when that .git
|
||||||
|
// yields no version. The commit and its date come from the same .git.
|
||||||
func TestProductDockerfileDerivesVersionFromGit(t *testing.T) {
|
func TestProductDockerfileDerivesVersionFromGit(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -62,31 +56,27 @@ func TestProductDockerfileDerivesVersionFromGit(t *testing.T) {
|
|||||||
buildAt := indexContaining(found, "go build")
|
buildAt := indexContaining(found, "go build")
|
||||||
require.GreaterOrEqual(t, buildAt, 0, "%s must build", productDockerfile)
|
require.GreaterOrEqual(t, buildAt, 0, "%s must build", productDockerfile)
|
||||||
|
|
||||||
assert.Contains(t, found[buildAt], "git describe --tags --always",
|
assert.Contains(t, found[buildAt], "git describe --tags --always || echo dev",
|
||||||
"%s must derive the version from git when no VERSION is given",
|
"%s must derive the version from git when no VERSION is given,"+
|
||||||
productDockerfile)
|
" and stamp dev when the context has no .git", productDockerfile)
|
||||||
assert.Contains(t, found[buildAt], "[ -e .git ]",
|
assert.Contains(t, found[buildAt], "[ -e .git ]",
|
||||||
"%s must fail when the context carries .git but yields no version",
|
"%s must fail when the context carries .git but yields no version",
|
||||||
productDockerfile)
|
productDockerfile)
|
||||||
|
assert.Contains(t, found[buildAt], "git rev-parse HEAD",
|
||||||
|
"%s must stamp the commit from git", productDockerfile)
|
||||||
|
assert.Contains(t, found[buildAt], "git show -s --format=%cs HEAD",
|
||||||
|
"%s must stamp the commit date from git", productDockerfile)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestDockerScriptComputesVersionOnTheHost fails unless script/docker
|
// TestDockerScriptComputesVersionOnTheHost fails unless script/docker
|
||||||
// derives each value where .git exists and passes it as a build arg,
|
// passes the version it derives where .git exists as a build arg.
|
||||||
// with VERSION coming from script/version so a Docker build reports the
|
|
||||||
// same string a local build of the same tree would.
|
|
||||||
func TestDockerScriptComputesVersionOnTheHost(t *testing.T) {
|
func TestDockerScriptComputesVersionOnTheHost(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
script := readRepoFile(t, dockerScript)
|
script := readRepoFile(t, dockerScript)
|
||||||
|
|
||||||
for _, arg := range versionArgs() {
|
assert.Contains(t, script, "--build-arg VERSION=",
|
||||||
assert.Contains(t, script, "--build-arg "+arg+"=",
|
"%s must pass --build-arg VERSION to the build", dockerScript)
|
||||||
"%s must pass --build-arg %s to the build", dockerScript, arg)
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Contains(t, script, "/version",
|
|
||||||
"%s must take VERSION from script/version, as the Makefile does",
|
|
||||||
dockerScript)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// assertLdflagReferences fails unless the build instruction uses the
|
// assertLdflagReferences fails unless the build instruction uses the
|
||||||
@@ -107,3 +97,47 @@ func assertLdflagReferences(t *testing.T, found []string, arg string) {
|
|||||||
"the go build in %s must use ${%s:-...}, or the arg is passed and"+
|
"the go build in %s must use ${%s:-...}, or the arg is passed and"+
|
||||||
" discarded", productDockerfile, arg)
|
" discarded", productDockerfile, arg)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// instructions returns the Dockerfile's instructions, one per element,
|
||||||
|
// with comments and blank lines dropped and continuation lines joined,
|
||||||
|
// so a multi-line RUN is one string.
|
||||||
|
func instructions(t *testing.T, name string) []string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var (
|
||||||
|
out []string
|
||||||
|
continued string
|
||||||
|
isContinued bool
|
||||||
|
)
|
||||||
|
|
||||||
|
for line := range strings.SplitSeq(readRepoFile(t, name), "\n") {
|
||||||
|
trimmed := strings.TrimSpace(line)
|
||||||
|
if !isContinued && (trimmed == "" || strings.HasPrefix(trimmed, "#")) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
isContinued = strings.HasSuffix(trimmed, `\`)
|
||||||
|
continued += strings.TrimSuffix(trimmed, `\`)
|
||||||
|
|
||||||
|
if isContinued {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
out = append(out, strings.Join(strings.Fields(continued), " "))
|
||||||
|
continued = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// indexContaining returns the position of the first instruction
|
||||||
|
// containing want; -1 if there is none.
|
||||||
|
func indexContaining(found []string, want string) int {
|
||||||
|
for i, instruction := range found {
|
||||||
|
if strings.Contains(instruction, want) {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,368 +0,0 @@
|
|||||||
package main_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// This file guards the shape of the lint gate. Every property asserted
|
|
||||||
// here is one whose loss is SILENT: the build still exits 0, the gate
|
|
||||||
// still looks green, and nothing was linted or tested.
|
|
||||||
//
|
|
||||||
// The gate is a build step. script/lint builds Dockerfile.lint, which
|
|
||||||
// runs golangci-lint as a RUN instruction, so a successful build is a
|
|
||||||
// clean lint. BuildKit will happily replay that RUN from cache on an
|
|
||||||
// unchanged tree in well under a second, which is why the check layers
|
|
||||||
// are keyed on a CHECK_EPOCH build arg that the calling script
|
|
||||||
// regenerates per invocation, and why an empty value is a hard error
|
|
||||||
// rather than a stable cache key.
|
|
||||||
//
|
|
||||||
// These are parses rather than invocations. Shelling out to docker from
|
|
||||||
// the test suite would nest a build inside `make test`, which itself
|
|
||||||
// runs inside a build in CI. The one property a parse cannot establish
|
|
||||||
// -- that a real finding actually fails the build -- is verified by
|
|
||||||
// hand against a deliberately broken tree, recorded on the pull
|
|
||||||
// request.
|
|
||||||
//
|
|
||||||
// One property is deliberately NOT tested here: that no script runs the
|
|
||||||
// linter on the host. script/lint is the only lint entry point, and it
|
|
||||||
// runs golangci-lint only inside the container; keeping it that way is a
|
|
||||||
// review matter, not something a test in this file establishes.
|
|
||||||
|
|
||||||
// The files under guard, relative to the repository root.
|
|
||||||
const (
|
|
||||||
lintDockerfile = "Dockerfile.lint"
|
|
||||||
productDockerfile = "Dockerfile"
|
|
||||||
lintScript = "script/lint"
|
|
||||||
cibuildScript = "script/cibuild"
|
|
||||||
)
|
|
||||||
|
|
||||||
// linterBinary is the linter's command name, used to locate the
|
|
||||||
// config-verify and lint steps in Dockerfile.lint.
|
|
||||||
const linterBinary = "golangci-lint"
|
|
||||||
|
|
||||||
// checkEpochARG is the declaration, with no default value. A default
|
|
||||||
// would satisfy the non-empty guard with a constant, and a constant is
|
|
||||||
// a stable cache key: the checks would be replayed from cache forever
|
|
||||||
// after the first build.
|
|
||||||
const checkEpochARG = "ARG CHECK_EPOCH"
|
|
||||||
|
|
||||||
// checkEpochGuard is what turns a build that omits --build-arg into a
|
|
||||||
// loud failure instead of a quiet green. Failed steps are never cached,
|
|
||||||
// so it fires on every such invocation rather than once.
|
|
||||||
const checkEpochGuard = `RUN [ -n "$CHECK_EPOCH" ] || exit 1`
|
|
||||||
|
|
||||||
// freshEpoch is the epoch computation the calling scripts must use, as
|
|
||||||
// a bare assignment on its own line. Inline in an argument, a failing
|
|
||||||
// `date` would not abort under `set -eu`; CHECK_EPOCH would become the
|
|
||||||
// empty string, and the guard above would be the only thing standing
|
|
||||||
// between that and a permanently cached green. `$$` is required because
|
|
||||||
// `date +%s` is second-granular and busybox silently drops `%N`, so
|
|
||||||
// without the pid two concurrent runs in one second can collide.
|
|
||||||
const freshEpoch = `epoch="$(date +%s%N)$$"`
|
|
||||||
|
|
||||||
// TestLintDockerfilePinsTheLinterByDigest fails if the lint image stops
|
|
||||||
// being pinned. An unpinned tag makes the gate's verdict depend on
|
|
||||||
// whatever the registry currently serves under that name.
|
|
||||||
func TestLintDockerfilePinsTheLinterByDigest(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
from := ""
|
|
||||||
|
|
||||||
for _, instruction := range instructions(t, lintDockerfile) {
|
|
||||||
if strings.HasPrefix(instruction, "FROM ") {
|
|
||||||
from = instruction
|
|
||||||
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NotEmpty(t, from, "%s declares no FROM", lintDockerfile)
|
|
||||||
assert.Contains(t, from, "golangci/golangci-lint",
|
|
||||||
"the lint image must be the golangci-lint image")
|
|
||||||
assert.Contains(t, from, "@sha256:",
|
|
||||||
"the lint image must be pinned by digest, not by tag alone")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLintDockerfileCannotBeCachedGreen pins the whole cache-busting
|
|
||||||
// mechanism in the file that lints: the declaration with no default,
|
|
||||||
// the non-empty guard, and the value expanded into the lint command
|
|
||||||
// itself rather than merely declared.
|
|
||||||
func TestLintDockerfileCannotBeCachedGreen(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
found := instructions(t, lintDockerfile)
|
|
||||||
|
|
||||||
argAt := indexOf(found, checkEpochARG)
|
|
||||||
require.GreaterOrEqual(t, argAt, 0,
|
|
||||||
"%s must declare `%s` with no default value",
|
|
||||||
lintDockerfile, checkEpochARG)
|
|
||||||
|
|
||||||
assert.GreaterOrEqual(t, indexOf(found, checkEpochGuard), argAt,
|
|
||||||
"%s must guard against an empty CHECK_EPOCH with `%s`",
|
|
||||||
lintDockerfile, checkEpochGuard)
|
|
||||||
|
|
||||||
assertEpochExpandedInto(t, found[argAt:], "golangci-lint run")
|
|
||||||
|
|
||||||
// Dependency layers must stay above the ARG, or every lint run
|
|
||||||
// re-downloads the module cache and the inner loop becomes
|
|
||||||
// unusable.
|
|
||||||
download := indexOf(found, "RUN go mod download")
|
|
||||||
require.GreaterOrEqual(t, download, 0,
|
|
||||||
"%s must download modules in their own layer", lintDockerfile)
|
|
||||||
assert.Less(t, download, argAt,
|
|
||||||
"`%s` must come after `go mod download` so dependency layers"+
|
|
||||||
" still cache", checkEpochARG)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLintDockerfileVerifiesTheLinterConfig guards the validation of
|
|
||||||
// .golangci.yml itself. `golangci-lint run` rejects a config it cannot
|
|
||||||
// parse but silently IGNORES an unknown top-level key, so renaming
|
|
||||||
// `linters:` to `linterz:` discards `default: all` and every threshold
|
|
||||||
// and still exits 0 reporting no issues. `config verify` is what turns
|
|
||||||
// that into a failure, and it has to run BEFORE the lint, or the lint
|
|
||||||
// spends a minute reporting a verdict from a config already known to be
|
|
||||||
// wrong.
|
|
||||||
func TestLintDockerfileVerifiesTheLinterConfig(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
found := instructions(t, lintDockerfile)
|
|
||||||
verify := linterBinary + " config verify"
|
|
||||||
|
|
||||||
verifyAt := indexContaining(found, verify)
|
|
||||||
require.GreaterOrEqual(t, verifyAt, 0,
|
|
||||||
"%s must run `%s --config .golangci.yml`: without it a typo'd"+
|
|
||||||
" top-level key in .golangci.yml is silently ignored and the"+
|
|
||||||
" gate passes with only the default linter set", lintDockerfile,
|
|
||||||
verify)
|
|
||||||
|
|
||||||
runAt := indexContaining(found, linterBinary+" run")
|
|
||||||
require.GreaterOrEqual(t, runAt, 0, "%s must lint", lintDockerfile)
|
|
||||||
assert.Less(t, verifyAt, runAt,
|
|
||||||
"%s must verify the config before linting with it", lintDockerfile)
|
|
||||||
|
|
||||||
// Keyed on the epoch like every other check layer, so it executes
|
|
||||||
// per invocation rather than being replayed. A cached validation
|
|
||||||
// validates nothing.
|
|
||||||
assertEpochExpandedInto(t, found, verify)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProductDockerfileKeysChecksOnTheEpoch holds the same line for the
|
|
||||||
// checks that remain in the product image build, but without the guard:
|
|
||||||
// a plain `docker build .` with no build arguments must succeed.
|
|
||||||
func TestProductDockerfileKeysChecksOnTheEpoch(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
found := instructions(t, productDockerfile)
|
|
||||||
|
|
||||||
argAt := indexOf(found, checkEpochARG)
|
|
||||||
require.GreaterOrEqual(t, argAt, 0,
|
|
||||||
"%s must declare `%s`", productDockerfile, checkEpochARG)
|
|
||||||
|
|
||||||
assert.Equal(t, -1, indexOf(found, checkEpochGuard),
|
|
||||||
"%s must not refuse an empty CHECK_EPOCH: a plain `docker build .`"+
|
|
||||||
" must succeed", productDockerfile)
|
|
||||||
|
|
||||||
assertEpochExpandedInto(t, found[argAt:], "make fmt-check")
|
|
||||||
assertEpochExpandedInto(t, found[argAt:], "make test")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProductDockerfileDoesNotLint records the split deliberately: the
|
|
||||||
// linter lives in Dockerfile.lint and nowhere else, so there is exactly
|
|
||||||
// one digest pinning it. A lint stage reintroduced here would either be
|
|
||||||
// docker-in-docker (`make lint` is now `docker build`) or a second,
|
|
||||||
// independently bumpable pin.
|
|
||||||
func TestProductDockerfileDoesNotLint(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
contents := readRepoFile(t, productDockerfile)
|
|
||||||
|
|
||||||
for _, forbidden := range []string{"golangci", "make lint"} {
|
|
||||||
assert.NotContains(t, instructionText(contents), forbidden,
|
|
||||||
"%s must not lint: the linter is pinned once, in %s",
|
|
||||||
productDockerfile, lintDockerfile)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLintScriptBuildsTheLintDockerfileWithAFreshEpoch is the other
|
|
||||||
// half of the mechanism. The Dockerfile's guard only rejects an EMPTY
|
|
||||||
// epoch; a constant non-empty one would satisfy it and still be served
|
|
||||||
// from cache forever.
|
|
||||||
func TestLintScriptBuildsTheLintDockerfileWithAFreshEpoch(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
script := readRepoFile(t, lintScript)
|
|
||||||
|
|
||||||
assertBareEpochAssignment(t, script, lintScript)
|
|
||||||
assert.Contains(t, script, `--build-arg CHECK_EPOCH="$epoch"`,
|
|
||||||
"%s must pass the fresh epoch to the build", lintScript)
|
|
||||||
assert.Contains(t, script, lintDockerfile,
|
|
||||||
"%s must build %s", lintScript, lintDockerfile)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCibuildBuildsBothDockerfilesWithFreshEpochs guards the CI gate:
|
|
||||||
// dropping either build silently removes a whole class of check from
|
|
||||||
// CI while leaving it green.
|
|
||||||
func TestCibuildBuildsBothDockerfilesWithFreshEpochs(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
script := readRepoFile(t, cibuildScript)
|
|
||||||
|
|
||||||
assertBareEpochAssignment(t, script, cibuildScript)
|
|
||||||
assert.Equal(t, 2, strings.Count(script, freshEpoch),
|
|
||||||
"%s must compute a fresh epoch for each of its two builds",
|
|
||||||
cibuildScript)
|
|
||||||
assert.Equal(t, 2,
|
|
||||||
strings.Count(script, `--build-arg CHECK_EPOCH="$epoch"`),
|
|
||||||
"%s must pass a fresh epoch to both builds", cibuildScript)
|
|
||||||
assert.Contains(t, script, "-f Dockerfile.lint",
|
|
||||||
"%s must build %s", cibuildScript, lintDockerfile)
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertEpochExpandedInto fails unless some instruction runs the named
|
|
||||||
// command with the epoch expanded into it. Expansion, not mere
|
|
||||||
// declaration: an ARG that no instruction references is not guaranteed
|
|
||||||
// to key the layer, and the expansion also puts the value in the build
|
|
||||||
// log where a reader can see the layer was keyed fresh.
|
|
||||||
func assertEpochExpandedInto(t *testing.T, found []string, command string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for _, instruction := range found {
|
|
||||||
if !strings.HasPrefix(instruction, "RUN ") {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(instruction, command) &&
|
|
||||||
strings.Contains(instruction, "${CHECK_EPOCH}") {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Fail(t, "no epoch-keyed layer runs the command",
|
|
||||||
"`%s` must run in a layer that expands ${CHECK_EPOCH}, or it"+
|
|
||||||
" will be replayed from cache without executing", command)
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertBareEpochAssignment fails unless the script computes the epoch
|
|
||||||
// as a bare assignment on its own line.
|
|
||||||
func assertBareEpochAssignment(t *testing.T, script, name string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for line := range strings.SplitSeq(script, "\n") {
|
|
||||||
if strings.TrimSpace(line) == freshEpoch {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Fail(t, "no bare epoch assignment",
|
|
||||||
"%s must compute `%s` as a bare assignment on its own line, so"+
|
|
||||||
" `set -e` catches a failing date instead of quietly"+
|
|
||||||
" building with an empty epoch", name, freshEpoch)
|
|
||||||
}
|
|
||||||
|
|
||||||
// instructions returns the Dockerfile's instructions, one per element,
|
|
||||||
// with comments and blank lines dropped and continuation lines joined,
|
|
||||||
// so a multi-line RUN is one string.
|
|
||||||
func instructions(t *testing.T, name string) []string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
return strings.Split(instructionText(readRepoFile(t, name)), "\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// instructionText is instructions' parse, before splitting: it is also
|
|
||||||
// what a "must not contain" assertion should look at, so that a word
|
|
||||||
// appearing only in a comment is not mistaken for behaviour.
|
|
||||||
func instructionText(contents string) string {
|
|
||||||
var (
|
|
||||||
out []string
|
|
||||||
continued string
|
|
||||||
isContinued bool
|
|
||||||
)
|
|
||||||
|
|
||||||
for line := range strings.SplitSeq(contents, "\n") {
|
|
||||||
trimmed := strings.TrimSpace(line)
|
|
||||||
if !isContinued && (trimmed == "" || strings.HasPrefix(trimmed, "#")) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
isContinued = strings.HasSuffix(trimmed, `\`)
|
|
||||||
continued += strings.TrimSuffix(trimmed, `\`)
|
|
||||||
|
|
||||||
if isContinued {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
out = append(out, strings.Join(strings.Fields(continued), " "))
|
|
||||||
continued = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Join(out, "\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// indexOf returns the position of the first instruction equal to, or
|
|
||||||
// beginning with, want; -1 if there is none. An `ARG NAME=default`
|
|
||||||
// counts as beginning with `ARG NAME`, so a declared arg is found
|
|
||||||
// whether or not it carries a default.
|
|
||||||
func indexOf(found []string, want string) int {
|
|
||||||
for i, instruction := range found {
|
|
||||||
if instruction == want ||
|
|
||||||
strings.HasPrefix(instruction, want+" ") ||
|
|
||||||
strings.HasPrefix(instruction, want+"=") {
|
|
||||||
return i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
|
|
||||||
// indexContaining returns the position of the first instruction
|
|
||||||
// containing want; -1 if there is none.
|
|
||||||
func indexContaining(found []string, want string) int {
|
|
||||||
for i, instruction := range found {
|
|
||||||
if strings.Contains(instruction, want) {
|
|
||||||
return i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
|
|
||||||
// readRepoFile reads a file by its path relative to the repository
|
|
||||||
// root.
|
|
||||||
func readRepoFile(t *testing.T, name string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
//nolint:gosec // G304: the path is a constant relative to this repo
|
|
||||||
contents, err := os.ReadFile(filepath.Join(repoRoot(t), name))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
return string(contents)
|
|
||||||
}
|
|
||||||
|
|
||||||
// repoRoot returns the repository root. The test binary runs with its
|
|
||||||
// package directory as the working directory, so the root is found by
|
|
||||||
// walking up until the module file appears.
|
|
||||||
func repoRoot(t *testing.T) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
dir, err := os.Getwd()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
for {
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "go.mod"))
|
|
||||||
if err == nil {
|
|
||||||
return dir
|
|
||||||
}
|
|
||||||
|
|
||||||
parent := filepath.Dir(dir)
|
|
||||||
require.NotEqual(t, dir, parent,
|
|
||||||
"walked to the filesystem root without finding a go.mod")
|
|
||||||
|
|
||||||
dir = parent
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
package main_test
|
package main_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"regexp"
|
"regexp"
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -84,14 +86,48 @@ func TestBuildTargetBuildsTheBinary(t *testing.T) {
|
|||||||
"`make build` must depend on the rule that builds the binary")
|
"`make build` must depend on the rule that builds the binary")
|
||||||
}
|
}
|
||||||
|
|
||||||
// readMakefile returns the contents of the repository's Makefile. The
|
// readMakefile returns the contents of the repository's Makefile.
|
||||||
// root is located by the shared walk in lintdocker_test.go.
|
|
||||||
func readMakefile(t *testing.T) string {
|
func readMakefile(t *testing.T) string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
return readRepoFile(t, "Makefile")
|
return readRepoFile(t, "Makefile")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// readRepoFile reads a file by its path relative to the repository
|
||||||
|
// root.
|
||||||
|
func readRepoFile(t *testing.T, name string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
//nolint:gosec // G304: the path is a constant relative to this repo
|
||||||
|
contents, err := os.ReadFile(filepath.Join(repoRoot(t), name))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
return string(contents)
|
||||||
|
}
|
||||||
|
|
||||||
|
// repoRoot returns the repository root. The test binary runs with its
|
||||||
|
// package directory as the working directory, so the root is found by
|
||||||
|
// walking up until the module file appears.
|
||||||
|
func repoRoot(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dir, err := os.Getwd()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
for {
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "go.mod"))
|
||||||
|
if err == nil {
|
||||||
|
return dir
|
||||||
|
}
|
||||||
|
|
||||||
|
parent := filepath.Dir(dir)
|
||||||
|
require.NotEqual(t, dir, parent,
|
||||||
|
"walked to the filesystem root without finding a go.mod")
|
||||||
|
|
||||||
|
dir = parent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// phonyTargets returns every name declared phony, across all .PHONY
|
// phonyTargets returns every name declared phony, across all .PHONY
|
||||||
// lines.
|
// lines.
|
||||||
func phonyTargets(makefile string) []string {
|
func phonyTargets(makefile string) []string {
|
||||||
|
|||||||
@@ -16,8 +16,6 @@ var (
|
|||||||
// Size represents a byte size that can be specified in configuration files.
|
// Size represents a byte size that can be specified in configuration files.
|
||||||
// It can unmarshal from both numeric values (interpreted as bytes) and
|
// It can unmarshal from both numeric values (interpreted as bytes) and
|
||||||
// human-readable strings like "10MB", "2.5GB", or "1TB".
|
// human-readable strings like "10MB", "2.5GB", or "1TB".
|
||||||
//
|
|
||||||
//nolint:recvcheck // UnmarshalYAML requires a pointer; String/Int64 are value reads
|
|
||||||
type Size int64
|
type Size int64
|
||||||
|
|
||||||
// UnmarshalYAML implements yaml.Unmarshaler for Size, allowing it to be
|
// UnmarshalYAML implements yaml.Unmarshaler for Size, allowing it to be
|
||||||
|
|||||||
@@ -220,7 +220,7 @@ func (r *ChunkFileRepository) CreateBatch(
|
|||||||
cf.ChunkHash.String(), cf.FileID.String(), cf.FileOffset, cf.Length)
|
cf.ChunkHash.String(), cf.FileID.String(), cf.FileOffset, cf.Length)
|
||||||
}
|
}
|
||||||
|
|
||||||
query += querySb183.String() //nolint:gosec // G202: appends "?" placeholders only
|
query += querySb183.String()
|
||||||
|
|
||||||
query += " ON CONFLICT(chunk_hash, file_id) DO NOTHING"
|
query += " ON CONFLICT(chunk_hash, file_id) DO NOTHING"
|
||||||
|
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ func (r *ChunkRepository) GetByHashes(
|
|||||||
args[i] = hash
|
args[i] = hash
|
||||||
}
|
}
|
||||||
|
|
||||||
query += querySb75.String() //nolint:gosec // G202: appends "?" placeholders only
|
query += querySb75.String()
|
||||||
|
|
||||||
query += ") ORDER BY chunk_hash"
|
query += ") ORDER BY chunk_hash"
|
||||||
|
|
||||||
|
|||||||
@@ -253,7 +253,7 @@ func (r *FileChunkRepository) CreateBatch(
|
|||||||
args = append(args, fc.FileID.String(), fc.Idx, fc.ChunkHash.String())
|
args = append(args, fc.FileID.String(), fc.Idx, fc.ChunkHash.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
query += querySb211.String() //nolint:gosec // G202: appends "?" placeholders only
|
query += querySb211.String()
|
||||||
|
|
||||||
query += " ON CONFLICT(file_id, idx) DO NOTHING"
|
query += " ON CONFLICT(file_id, idx) DO NOTHING"
|
||||||
|
|
||||||
|
|||||||
@@ -391,7 +391,7 @@ func (r *FileRepository) CreateBatch(
|
|||||||
f.LinkTarget.String())
|
f.LinkTarget.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
query += querySb325.String() //nolint:gosec // G202: appends "?" placeholders only
|
query += querySb325.String()
|
||||||
|
|
||||||
query += ` ON CONFLICT(path) DO UPDATE SET
|
query += ` ON CONFLICT(path) DO UPDATE SET
|
||||||
source_path = excluded.source_path,
|
source_path = excluded.source_path,
|
||||||
|
|||||||
@@ -395,7 +395,7 @@ func (r *SnapshotRepository) AddFilesByIDBatch(
|
|||||||
args = append(args, snapshotID, fileID.String())
|
args = append(args, snapshotID, fileID.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
query += querySb312.String() //nolint:gosec // G202: appends "?" placeholders only
|
query += querySb312.String()
|
||||||
|
|
||||||
var err error
|
var err error
|
||||||
if tx != nil {
|
if tx != nil {
|
||||||
|
|||||||
@@ -72,9 +72,12 @@ func New() (*Globals, error) {
|
|||||||
// safe reading of "we could not establish that this is a release" is
|
// safe reading of "we could not establish that this is a release" is
|
||||||
// that it is not one. The Makefile refuses to build at all in that
|
// that it is not one. The Makefile refuses to build at all in that
|
||||||
// case; this is the second line of defence, for a binary linked by
|
// case; this is the second line of defence, for a binary linked by
|
||||||
// something other than the Makefile.
|
// something other than the Makefile. "unknown" counts for the same
|
||||||
|
// reason: script/docker and script/cibuild stamp it when the host has
|
||||||
|
// no git checkout.
|
||||||
func IsDevVersion(v string) bool {
|
func IsDevVersion(v string) bool {
|
||||||
if v == "" || v == DevVersion || strings.HasPrefix(v, DevVersion+"-") ||
|
if v == "" || v == "unknown" || v == DevVersion ||
|
||||||
|
strings.HasPrefix(v, DevVersion+"-") ||
|
||||||
strings.HasSuffix(v, "-dirty") {
|
strings.HasSuffix(v, "-dirty") {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -74,6 +74,9 @@ func TestIsDevVersion(t *testing.T) {
|
|||||||
// as one. The Makefile refuses to build when script/version
|
// as one. The Makefile refuses to build when script/version
|
||||||
// yields nothing; this covers a binary linked some other way.
|
// yields nothing; this covers a binary linked some other way.
|
||||||
{"", true},
|
{"", true},
|
||||||
|
// What script/docker and script/cibuild stamp when the host
|
||||||
|
// has no git checkout.
|
||||||
|
{"unknown", true},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
|
|||||||
@@ -1388,8 +1388,7 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
// record a file whose chunk is in no blob and cannot be restored, so
|
// record a file whose chunk is in no blob and cannot be restored, so
|
||||||
// abort the run even under --skip-errors. Only open and read errors
|
// abort the run even under --skip-errors. Only open and read errors
|
||||||
// are skipped below.
|
// are skipped below.
|
||||||
var pErr *packerError
|
if _, ok := errors.AsType[*packerError](err); ok {
|
||||||
if errors.As(err, &pErr) {
|
|
||||||
return false, fmt.Errorf("processing file %s: %w", fileToProcess.Path, err)
|
return false, fmt.Errorf("processing file %s: %w", fileToProcess.Path, err)
|
||||||
}
|
}
|
||||||
// Handle files that were deleted between scan and process phases
|
// Handle files that were deleted between scan and process phases
|
||||||
|
|||||||
@@ -161,8 +161,7 @@ func rejectUnknownParams(query url.Values, allowed ...string) error {
|
|||||||
// *url.Error that url.Parse returns embeds the raw URL in its message, so
|
// *url.Error that url.Parse returns embeds the raw URL in its message, so
|
||||||
// wrapping it directly would echo a credential-bearing URL into logs.
|
// wrapping it directly would echo a credential-bearing URL into logs.
|
||||||
func wrapParseError(err error) error {
|
func wrapParseError(err error) error {
|
||||||
var uerr *url.Error
|
if uerr, ok := errors.AsType[*url.Error](err); ok {
|
||||||
if errors.As(err, &uerr) {
|
|
||||||
return fmt.Errorf("invalid URL: %w", uerr.Err)
|
return fmt.Errorf("invalid URL: %w", uerr.Err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+25
-19
@@ -38,7 +38,12 @@ pkg_install() {
|
|||||||
detect_pkgmgr
|
detect_pkgmgr
|
||||||
case "$PKGMGR" in
|
case "$PKGMGR" in
|
||||||
nix) nix-env -iA "nixpkgs.$1" ;;
|
nix) nix-env -iA "nixpkgs.$1" ;;
|
||||||
apt) $SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2" ;;
|
# A fresh image, such as the CI runner's, has no package lists,
|
||||||
|
# so apt-get install finds nothing until they are fetched.
|
||||||
|
apt)
|
||||||
|
$SUDO apt-get update
|
||||||
|
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2"
|
||||||
|
;;
|
||||||
brew) brew install "$3" ;;
|
brew) brew install "$3" ;;
|
||||||
apk) apk add --no-cache "$4" ;;
|
apk) apk add --no-cache "$4" ;;
|
||||||
esac
|
esac
|
||||||
@@ -48,12 +53,12 @@ missing() {
|
|||||||
! command -v "$1" >/dev/null 2>&1
|
! command -v "$1" >/dev/null 2>&1
|
||||||
}
|
}
|
||||||
|
|
||||||
# Docker is a hard requirement, not a nice-to-have: script/lint lints by
|
# Docker is a hard requirement, not a nice-to-have: script/lint and
|
||||||
# building Dockerfile.lint, whose digest-pinned golangci-lint image is
|
# script/test build the lint and test phases of the Dockerfile, the only
|
||||||
# the only place the linter runs, and script/check and script/precommit
|
# place the linter and the tests run, and script/check and
|
||||||
# both run script/lint. A bootstrap that prints "bootstrap complete" on a
|
# script/precommit both run them. A bootstrap that prints "bootstrap
|
||||||
# machine where `make check` cannot run is a false success, so this fails
|
# complete" on a machine where `make check` cannot run is a false
|
||||||
# instead.
|
# success, so this fails instead.
|
||||||
#
|
#
|
||||||
# Installing docker from here was considered and rejected: it needs root,
|
# Installing docker from here was considered and rejected: it needs root,
|
||||||
# a running daemon, and on macOS a GUI cask, so an attempt would itself
|
# a running daemon, and on macOS a GUI cask, so an attempt would itself
|
||||||
@@ -80,15 +85,15 @@ bootstrap: FAILED - $reason.
|
|||||||
|
|
||||||
Docker is required to develop this repo. Without it these do not work:
|
Docker is required to develop this repo. Without it these do not work:
|
||||||
|
|
||||||
script/lint builds Dockerfile.lint, which runs the linter as a
|
script/lint builds the lint phase of the Dockerfile, which runs
|
||||||
build step in a digest-pinned golangci-lint image.
|
the linter as a build step in a digest-pinned
|
||||||
That FROM line is the single source of truth for the
|
golangci-lint image
|
||||||
linter version
|
script/test builds the test phase of the Dockerfile
|
||||||
script/check runs script/lint
|
script/check runs script/test and script/lint
|
||||||
script/precommit runs script/check, so commits are blocked by the
|
script/precommit runs script/check, so commits are blocked by the
|
||||||
pre-commit hook installed by script/setup
|
pre-commit hook installed by script/setup
|
||||||
script/cibuild builds Dockerfile.lint and Dockerfile, which is what
|
script/cibuild runs script/check and builds the image, which is
|
||||||
CI runs
|
what CI runs
|
||||||
|
|
||||||
Install docker (and start the daemon, checking DOCKER_HOST and your
|
Install docker (and start the daemon, checking DOCKER_HOST and your
|
||||||
group membership), then re-run script/bootstrap. golangci-lint on PATH
|
group membership), then re-run script/bootstrap. golangci-lint on PATH
|
||||||
@@ -108,11 +113,12 @@ main() {
|
|||||||
if missing go; then pkg_install go golang go go; fi
|
if missing go; then pkg_install go golang go go; fi
|
||||||
|
|
||||||
# golangci-lint is deliberately NOT installed: script/lint lints by
|
# golangci-lint is deliberately NOT installed: script/lint lints by
|
||||||
# building Dockerfile.lint, whose digest-pinned image is the only
|
# building the lint phase of the Dockerfile, whose digest-pinned
|
||||||
# place the linter runs, so whatever a package manager happens to
|
# image is the only place the linter runs, so whatever a package
|
||||||
# ship would only be a shadow of the pinned version that could drift
|
# manager happens to ship would only be a shadow of the pinned
|
||||||
# from CI. Nothing on the host is ever used as a linter, at any
|
# version that could drift from CI. Nothing on the host is ever used
|
||||||
# version, so installing one here would buy nothing.
|
# as a linter, at any version, so installing one here would buy
|
||||||
|
# nothing.
|
||||||
|
|
||||||
# goreleaser, at the version pinned by script/install-goreleaser and
|
# goreleaser, at the version pinned by script/install-goreleaser and
|
||||||
# verified against a hardcoded sha256. Package managers are not used
|
# verified against a hardcoded sha256. Package managers are not used
|
||||||
|
|||||||
+3
-2
@@ -1,7 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/check: run all checks (test, lint, fmt-check). Our own
|
# script/check: run all checks (test, lint, fmt-check). Our own
|
||||||
# extension to scripts-to-rule-them-all. Must not modify any files.
|
# extension to scripts-to-rule-them-all. test and lint are Docker
|
||||||
# Generic: usually needs no adaptation.
|
# phases; fmt-check is native, because a formatter writes the working
|
||||||
|
# tree. Must not modify any files.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|||||||
+18
-68
@@ -1,78 +1,28 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build. This is the full gate, and it is two
|
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
||||||
# builds, in this order:
|
# checks out and runs this and nothing else, and script/fmt-check runs
|
||||||
#
|
# the formatter on the host, which a pristine checkout cannot do.
|
||||||
# Dockerfile.lint the linter, as a build step (a clean build IS a
|
# --no-cache for the same reason as script/docker: the gate phases the
|
||||||
# clean lint)
|
# final stage depends on are RUN steps, and a cached one is a check that
|
||||||
# Dockerfile `make fmt-check` and `make test` in the builder
|
# did not run.
|
||||||
# stage, then the product image
|
|
||||||
#
|
|
||||||
# Either one failing fails this script. Note what follows from the
|
|
||||||
# split: script/docker builds only the product image and so no longer
|
|
||||||
# lints -- this script and script/check (which runs script/lint) are the
|
|
||||||
# things that decide whether the tree is clean.
|
|
||||||
#
|
|
||||||
# Generic apart from the two Dockerfiles: the Gitea workflow runs this
|
|
||||||
# on push.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Both Dockerfiles key their check layers on CHECK_EPOCH, so a fresh
|
"$SCRIPT_DIR/bootstrap"
|
||||||
# value is what forces those layers to re-run: without it an
|
"$SCRIPT_DIR/check"
|
||||||
# unchanged tree replays them from cache, the checks never execute,
|
# Own line: a failing command substitution inside an argument does
|
||||||
# and the build still exits 0. Each ARG sits immediately above the
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# check RUNs, so dependency and module layers still cache.
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# Dockerfile.lint also refuses to build at all when CHECK_EPOCH is
|
# the version a build stage derives from the .git in the context.
|
||||||
# empty, so a missing value fails its build loudly rather than passing
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
# quietly; the product Dockerfile does not, because a plain `docker
|
[ -n "$version" ] || version="unknown"
|
||||||
# build .` must succeed.
|
docker build --no-cache \
|
||||||
#
|
|
||||||
# The value must be unique per invocation, not per second. `date +%s`
|
|
||||||
# is second-granular, so two concurrent invocations in the same
|
|
||||||
# second get identical epochs and the later one can be served from
|
|
||||||
# cache -- the original defect in miniature. `%N` alone does not fix
|
|
||||||
# it: busybox silently drops %N, exits 0, and hands back second
|
|
||||||
# granularity with no warning. `$$` is what makes this correct
|
|
||||||
# regardless, since concurrent invocations have different pids.
|
|
||||||
#
|
|
||||||
# Assign the epoch on its own line rather than inline in the
|
|
||||||
# argument. Under `set -eu` a command substitution that fails
|
|
||||||
# inside an argument does NOT abort the script: CHECK_EPOCH would
|
|
||||||
# become an empty string, an empty string is a constant, and a
|
|
||||||
# constant CHECK_EPOCH is exactly the cached-check false green this
|
|
||||||
# script exists to prevent -- so the guard would disarm itself and
|
|
||||||
# still exit 0. As a bare assignment, `set -e` catches a failing
|
|
||||||
# `date` and no build starts.
|
|
||||||
#
|
|
||||||
# A separate value per build, because they are separate builds: one
|
|
||||||
# `date` shared between them would still be fresh, but reusing it
|
|
||||||
# invites the two to be collapsed into a single value that is
|
|
||||||
# computed somewhere else and passed in.
|
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
# cacheonly for the lint build: its verdict is the exit status and
|
|
||||||
# the image is never run, so exporting it is pure cost. See
|
|
||||||
# script/lint.
|
|
||||||
docker build --output=type=cacheonly \
|
|
||||||
--build-arg CHECK_EPOCH="$epoch" -f Dockerfile.lint .
|
|
||||||
|
|
||||||
# Version, commit and build date are computed here on the host, the
|
|
||||||
# same way script/docker does, and passed into the product build,
|
|
||||||
# where they take precedence over what the build would derive from
|
|
||||||
# the .git in its context. VERSION comes from script/version, as in
|
|
||||||
# the Makefile.
|
|
||||||
version="$("$ROOT/script/version")"
|
|
||||||
commit="$(git rev-parse HEAD 2>/dev/null || echo unknown)"
|
|
||||||
commit_date="$(git show -s --format=%cs HEAD 2>/dev/null || echo unknown)"
|
|
||||||
|
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
docker build --build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
--build-arg COMMIT="$commit" \
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
--build-arg COMMIT_DATE="$commit_date" \
|
|
||||||
.
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+10
-31
@@ -1,15 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the Docker image tagged with the project name.
|
||||||
# The tag comes from script/projectname. Unlike the canonical copy in
|
# Identical in all repos; the tag comes from script/projectname.
|
||||||
# sneak/prompts, it passes a fresh CHECK_EPOCH instead of --no-cache, and
|
# --no-cache because the gate phases the final stage depends on are RUN
|
||||||
# COMMIT and COMMIT_DATE as well as VERSION.
|
# steps, and a cached one is a check that did not run.
|
||||||
#
|
|
||||||
# This builds the PRODUCT image only, and the product Dockerfile has no
|
|
||||||
# lint stage: linting lives in Dockerfile.lint and is run by
|
|
||||||
# script/lint. So a green here means `make fmt-check` and `make test`
|
|
||||||
# passed and the image built -- it says nothing about lint. The gates
|
|
||||||
# are script/check (which runs script/lint) and script/cibuild (which
|
|
||||||
# builds both files).
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -17,28 +10,14 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Same CHECK_EPOCH contract as script/cibuild, for the same reason
|
# Own line: a failing command substitution inside an argument does
|
||||||
# and with the same bare-assignment and `$$` requirements -- see the
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# comments there. This script is not the CI gate, but a local build
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# is almost always warm, so without this it would report a green the
|
# the version a build stage derives from the .git in the context.
|
||||||
# tree had not earned and the two entrypoints would disagree about
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
# whether the tree is clean.
|
[ -n "$version" ] || version="unknown"
|
||||||
epoch="$(date +%s%N)$$"
|
docker build --no-cache \
|
||||||
|
|
||||||
# Version, commit and build date are computed here on the host and
|
|
||||||
# passed into the build, where they take precedence over what the
|
|
||||||
# build would derive from the .git in its context. VERSION comes
|
|
||||||
# from script/version, as in the Makefile, so the image reports the
|
|
||||||
# same string, -dirty included, that a local build of the same tree
|
|
||||||
# would.
|
|
||||||
version="$("$SCRIPT_DIR/version")"
|
|
||||||
commit="$(git rev-parse HEAD 2>/dev/null || echo unknown)"
|
|
||||||
commit_date="$(git show -s --format=%cs HEAD 2>/dev/null || echo unknown)"
|
|
||||||
|
|
||||||
docker build --build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
--build-arg COMMIT="$commit" \
|
|
||||||
--build-arg COMMIT_DATE="$commit_date" \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+7
-4
@@ -7,9 +7,11 @@
|
|||||||
# Only .gitea/workflows/release.yml calls this. goreleaser is not a
|
# Only .gitea/workflows/release.yml calls this. goreleaser is not a
|
||||||
# compiler: it shells out to `go` for the `before:` hook and for every
|
# compiler: it shells out to `go` for the `before:` hook and for every
|
||||||
# one of the four cross-compiles, so the release runner needs a Go
|
# one of the four cross-compiles, so the release runner needs a Go
|
||||||
# toolchain on PATH. check.yml never does -- it builds inside the
|
# toolchain on PATH. check.yml compiles nothing on the host: it uses
|
||||||
# digest-pinned Dockerfile images -- so this is the release path's only
|
# whatever Go script/bootstrap finds or installs only for that script's
|
||||||
# host Go, and per REPO_POLICIES.md it must be pinned by hash.
|
# `go mod download` and for gofmt in script/fmt-check. So this is the
|
||||||
|
# only host Go that builds anything, and per REPO_POLICIES.md it must be
|
||||||
|
# pinned by hash.
|
||||||
# actions/setup-go exposes no checksum input, so Go is installed the way
|
# actions/setup-go exposes no checksum input, so Go is installed the way
|
||||||
# script/install-goreleaser installs goreleaser: download the exact
|
# script/install-goreleaser installs goreleaser: download the exact
|
||||||
# archive from go.dev and refuse it unless its sha256 matches the value
|
# archive from go.dev and refuse it unless its sha256 matches the value
|
||||||
@@ -18,7 +20,8 @@
|
|||||||
# The version is go.mod's `go` directive, the single source of truth for
|
# The version is go.mod's `go` directive, the single source of truth for
|
||||||
# the toolchain. GO_VERSION below MUST equal it, and this script fails
|
# the toolchain. GO_VERSION below MUST equal it, and this script fails
|
||||||
# when they disagree -- so bumping Go is one reviewed change touching
|
# when they disagree -- so bumping Go is one reviewed change touching
|
||||||
# go.mod, the checksum here, and the Dockerfile golang digest together.
|
# go.mod, the checksum here, and the Dockerfile's two golang digests
|
||||||
|
# together.
|
||||||
#
|
#
|
||||||
# Linux only, because that is what the release runner is. A darwin dev
|
# Linux only, because that is what the release runner is. A darwin dev
|
||||||
# building a snapshot uses their own Go; supporting an OS means adding
|
# building a snapshot uses their own Go; supporting an OS means adding
|
||||||
|
|||||||
+13
-98
@@ -1,108 +1,23 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run the linter.
|
# script/lint: run the linter. Linting is a phase of the Dockerfile and
|
||||||
|
# this builds that phase alone; the linter is never installed or run on
|
||||||
|
# a developer host, where a shared result cache and a host-global lock
|
||||||
|
# make its answer untrustworthy.
|
||||||
#
|
#
|
||||||
# The linter runs inside the image built by Dockerfile.lint, and it runs
|
# The phase is not the last stage in the file, so it is built only when
|
||||||
# there as a BUILD STEP: a successful build of that file IS a clean
|
# --target names it. --no-cache because a cached lint layer is a lint
|
||||||
# lint. Nothing lints on the host, at any version, ever. That FROM line
|
# that did not run. The tag makes each build replace the previous image
|
||||||
# is the single source of truth for the linter version in this repo, so
|
# instead of leaving a dangling one behind.
|
||||||
# a local run and a CI run of the same tree cannot disagree.
|
|
||||||
#
|
|
||||||
# One container per run means one lint cache and one golangci-lint lock
|
|
||||||
# per run, both private to that run and thrown away with it. That is
|
|
||||||
# what makes concurrent runs on a shared host safe, and it is why this
|
|
||||||
# script no longer carries per-worktree cache directories, a lock-retry
|
|
||||||
# loop, or an output audit: there is no shared state left for them to
|
|
||||||
# defend (issue https://git.eeqj.de/sneak/vaultik/issues/113).
|
|
||||||
#
|
|
||||||
# To watch the linter execute, set BUILDKIT_PROGRESS=plain, which docker
|
|
||||||
# honours directly:
|
|
||||||
#
|
|
||||||
# BUILDKIT_PROGRESS=plain script/lint
|
|
||||||
#
|
|
||||||
# The check layers -- `golangci-lint config verify` and then
|
|
||||||
# `golangci-lint run` -- must appear as executing rather than CACHED on
|
|
||||||
# every run; see the CHECK_EPOCH comment in Dockerfile.lint.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
DOCKERFILE="$ROOT/Dockerfile.lint"
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
require_docker() {
|
|
||||||
if ! command -v docker >/dev/null 2>&1; then
|
|
||||||
cat >&2 <<EOF
|
|
||||||
lint: docker is required to run the pinned linter.
|
|
||||||
|
|
||||||
lint image declared by: $DOCKERFILE
|
|
||||||
|
|
||||||
Install docker. Linting with any other golangci-lint is not supported:
|
|
||||||
it is what lets a local run pass while CI fails. A golangci-lint on
|
|
||||||
PATH is never used, whatever its version.
|
|
||||||
EOF
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if ! docker info >/dev/null 2>&1; then
|
|
||||||
cat >&2 <<EOF
|
|
||||||
lint: the docker daemon is not reachable, so the pinned linter cannot
|
|
||||||
run.
|
|
||||||
|
|
||||||
lint image declared by: $DOCKERFILE
|
|
||||||
|
|
||||||
Start the daemon (and check DOCKER_HOST / your group membership). This
|
|
||||||
script will not fall back to a different linter version or to an
|
|
||||||
unpinned binary on PATH.
|
|
||||||
EOF
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
usage() {
|
|
||||||
cat >&2 <<EOF
|
|
||||||
usage: $(basename "$0")
|
|
||||||
|
|
||||||
script/lint takes no arguments. The linter runs as a build step, so
|
|
||||||
there is no command line to pass flags to; anything accepted here would
|
|
||||||
have to be silently dropped. To apply autofixes, use script/lint-fix,
|
|
||||||
which runs the same pinned image as a container for exactly this
|
|
||||||
reason.
|
|
||||||
EOF
|
|
||||||
exit 2
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
[ "$#" -eq 0 ] || usage
|
|
||||||
|
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
require_docker
|
docker build --no-cache \
|
||||||
|
--target lint \
|
||||||
# A fresh epoch per invocation is what forces the check layers to
|
-t "$("$SCRIPT_DIR/projectname")-lint" .
|
||||||
# execute; the layers above the ARG in Dockerfile.lint still cache,
|
|
||||||
# so a run is not cold. The value must be unique per invocation, not
|
|
||||||
# per second: `date +%s` is second-granular, so two concurrent
|
|
||||||
# invocations in the same second would get identical epochs and the
|
|
||||||
# later one could be served from cache -- the false green in
|
|
||||||
# miniature. `%N` alone does not fix it either, because busybox
|
|
||||||
# silently drops %N, exits 0, and hands back second granularity with
|
|
||||||
# no warning. `$$` is what makes this correct regardless, since
|
|
||||||
# concurrent invocations have different pids.
|
|
||||||
#
|
|
||||||
# Assign it on its own line rather than inline in the argument.
|
|
||||||
# Under `set -eu` a command substitution that fails inside an
|
|
||||||
# argument does NOT abort the script: CHECK_EPOCH would become an
|
|
||||||
# empty string, an empty string is a constant, and a constant epoch
|
|
||||||
# is exactly the cached-lint false green this guards against. As a
|
|
||||||
# bare assignment, `set -e` catches a failing `date` and no build
|
|
||||||
# starts.
|
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
|
|
||||||
# cacheonly: the lint verdict is the build's exit status, and the
|
|
||||||
# image it would otherwise produce is never run. Exporting it costs
|
|
||||||
# most of the wall time of a warm run and leaves a dangling image
|
|
||||||
# behind on every invocation, on a host that may be running many.
|
|
||||||
docker build \
|
|
||||||
--output=type=cacheonly \
|
|
||||||
--build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
-f "$DOCKERFILE" \
|
|
||||||
"$ROOT"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+9
-8
@@ -5,27 +5,28 @@
|
|||||||
#
|
#
|
||||||
# THIS IS A DEVELOPER CONVENIENCE AND NEVER A GATE. Nothing in
|
# THIS IS A DEVELOPER CONVENIENCE AND NEVER A GATE. Nothing in
|
||||||
# script/check, script/precommit or script/cibuild calls it, and no gate
|
# script/check, script/precommit or script/cibuild calls it, and no gate
|
||||||
# reads its exit status. The gate is script/lint, which builds
|
# reads its exit status. The gate is script/lint, which builds the lint
|
||||||
# Dockerfile.lint; run that afterwards to find out whether the tree is
|
# phase of the Dockerfile; run that afterwards to find out whether the
|
||||||
# actually clean.
|
# tree is actually clean.
|
||||||
#
|
#
|
||||||
# Unlike script/lint this cannot be a build step: a build step writes
|
# Unlike script/lint this cannot be a build step: a build step writes
|
||||||
# into an image, and fixes have to land in the worktree. So it runs the
|
# into an image, and fixes have to land in the worktree. So it runs the
|
||||||
# same pinned image as a container with the tree bind-mounted, which
|
# same pinned image as a container with the tree bind-mounted, which
|
||||||
# means it needs a LOCAL docker daemon -- a remote daemon has no access
|
# means it needs a LOCAL docker daemon -- a remote daemon has no access
|
||||||
# to these files, and this script will appear to do nothing there. The
|
# to these files, and this script will appear to do nothing there. The
|
||||||
# image reference is parsed out of Dockerfile.lint's FROM line, so the
|
# image reference is parsed out of the lint phase's FROM line, so the
|
||||||
# autofixer is always the same version as the linter that gates; fixes
|
# autofixer is always the same version as the linter that gates; fixes
|
||||||
# written by a different version are not necessarily fixes for the
|
# written by a different version are not necessarily fixes for the
|
||||||
# version that decides.
|
# version that decides.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
DOCKERFILE="$ROOT/Dockerfile.lint"
|
DOCKERFILE="$ROOT/Dockerfile"
|
||||||
|
|
||||||
# The image reference from Dockerfile.lint, tag and digest included.
|
# The image reference from the FROM line ending `AS lint`, tag and
|
||||||
|
# digest included.
|
||||||
lint_image() {
|
lint_image() {
|
||||||
awk '$1 == "FROM" { print $2; exit }' "$DOCKERFILE"
|
awk '$1 == "FROM" && $NF == "lint" { print $2; exit }' "$DOCKERFILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
@@ -33,7 +34,7 @@ main() {
|
|||||||
|
|
||||||
image="$(lint_image)"
|
image="$(lint_image)"
|
||||||
if [ -z "$image" ]; then
|
if [ -z "$image" ]; then
|
||||||
echo "lint-fix: no FROM line found in $DOCKERFILE" >&2
|
echo "lint-fix: no FROM ... AS lint line found in $DOCKERFILE" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
+10
-60
@@ -1,69 +1,19 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test: run the test suite. Quiet on success; on failure, rerun
|
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
||||||
# verbosely for full diagnostic output (the exit 1 ensures the rerun
|
# and this builds that phase alone, on the same terms as script/lint:
|
||||||
# never turns a failure into a pass).
|
# --target because a phase that is not the last stage is built only when
|
||||||
|
# named, --no-cache because a cached test layer is a test that did not
|
||||||
|
# run, and a tag so each build replaces the previous image.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
# The flags live in one function so the quiet run and the verbose rerun
|
|
||||||
# below cannot drift apart. A rerun that used different flags would
|
|
||||||
# diagnose a different program than the one that failed.
|
|
||||||
#
|
|
||||||
# -count=1 is the documented way to bypass Go's test result cache, and
|
|
||||||
# it is not optional here. Without it, a package whose inputs are
|
|
||||||
# unchanged prints `ok <pkg> (cached)`, and that line is
|
|
||||||
# indistinguishable -- to every check this repo performs -- from a
|
|
||||||
# package that actually ran. The whole suite reports its full set of
|
|
||||||
# `ok` lines in under half a second having executed nothing. That
|
|
||||||
# matters beyond the local inner loop: the Dockerfile's `RUN make test`
|
|
||||||
# is forced to re-execute by CHECK_EPOCH, but a GOCACHE baked into an
|
|
||||||
# earlier image layer survives into the re-executed step, so the step
|
|
||||||
# can re-run and still do no work. It is applied unconditionally rather
|
|
||||||
# than only in the containerised path because the pre-commit hook runs
|
|
||||||
# this same script; a gate that is honest only in CI is dishonest
|
|
||||||
# exactly where people lean on it most.
|
|
||||||
#
|
|
||||||
# -timeout is a hang backstop, not a performance budget: its job is to
|
|
||||||
# turn a deadlocked test into a stack dump instead of a wedged CI job,
|
|
||||||
# so it wants to sit far above the slowest legitimate runtime, not just
|
|
||||||
# above it. It is per test binary and covers test execution only -- the
|
|
||||||
# clock starts inside testing.M.Run, after compilation and linking, so
|
|
||||||
# build time is not charged against it. (Measured: a containerised run
|
|
||||||
# with an empty GOCACHE reports per-package durations within noise of a
|
|
||||||
# warm host run. A shell `timeout 30 go test ./...` would include
|
|
||||||
# compilation, but that is a different mechanism from this flag.)
|
|
||||||
#
|
|
||||||
# The 120s value DELIBERATELY DIVERGES from REPO_POLICIES.md:192, which
|
|
||||||
# mandates "Add a 30-second timeout", and from that file's canonical Go
|
|
||||||
# recipe at :212-214, which uses -timeout 30s. REPO_POLICIES.md is
|
|
||||||
# org-canonical and cannot be amended from this repo, so the divergence
|
|
||||||
# is recorded here instead, and issue #101 proposes amending the policy
|
|
||||||
# text upstream. Do not revert this to 30s without reading #101 first.
|
|
||||||
#
|
|
||||||
# Why it diverges: the slowest packages are internal/database and
|
|
||||||
# internal/vaultik, observed under -race at about 6.4s warm, 8.1s in a
|
|
||||||
# cold containerised run on a contended host, and 10.2s in an
|
|
||||||
# independent cold run on this same host. The worst case is not tightly
|
|
||||||
# characterised -- each fresh measurement has come in above the last --
|
|
||||||
# which is itself an argument for generous headroom. Against the 10.2s
|
|
||||||
# observation, 30s is only 2.9x: not a safety margin but a flake
|
|
||||||
# waiting for a slow day, whose failure mode is a timeout that looks
|
|
||||||
# like a real defect. 120s leaves about 12x while still bounding a hung
|
|
||||||
# package -- including the verbose rerun below -- to a few minutes. The
|
|
||||||
# cost of that choice, also recorded on #101: because of the rerun, a
|
|
||||||
# hung package pays the timeout twice.
|
|
||||||
run_tests() {
|
|
||||||
go test -race -timeout 120s -count=1 "$@" ./...
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
run_tests || {
|
docker build --no-cache \
|
||||||
echo "--- Rerunning with -v for details ---"
|
--target test \
|
||||||
run_tests -v
|
-t "$("$SCRIPT_DIR/projectname")-test" .
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+2
-3
@@ -3,9 +3,8 @@
|
|||||||
# Our own extension to scripts-to-rule-them-all. The Makefile's LDFLAGS
|
# Our own extension to scripts-to-rule-them-all. The Makefile's LDFLAGS
|
||||||
# call this rather than carrying a hardcoded constant, which is what used
|
# call this rather than carrying a hardcoded constant, which is what used
|
||||||
# to make every local build claim to be 1.0.0-rc.1 regardless of git
|
# to make every local build claim to be 1.0.0-rc.1 regardless of git
|
||||||
# state. script/docker and script/cibuild pass its output to the image
|
# state. script/docker and script/cibuild run the same `git describe`
|
||||||
# build; given no version, the image build runs `git describe --tags
|
# themselves, and fall back to "unknown" rather than "dev".
|
||||||
# --always` itself, without `--dirty`.
|
|
||||||
#
|
#
|
||||||
# The version is `git describe --tags --always --dirty`: the tag on a
|
# The version is `git describe --tags --always --dirty`: the tag on a
|
||||||
# tagged commit, tag-N-gHASH on a commit after one, the short commit
|
# tagged commit, tag-N-gHASH on a commit after one, the short commit
|
||||||
|
|||||||
Reference in New Issue
Block a user