Compare commits
40 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0cf41409f1 | |||
| 9de9dffab1 | |||
| d77607c4f0 | |||
| ff8ac5ea2d | |||
| 81ae4041cd | |||
| 2610ea5c09 | |||
| 1b90e60aeb | |||
| 90ce747a61 | |||
| 7510187243 | |||
| 3de9d35699 | |||
| 72adebbf8b | |||
| 3f990c841d | |||
| 78d83b7a61 | |||
| 7bc4082cb0 | |||
| cdced6536e | |||
| 72a8923c3d | |||
| 62aeaf063b | |||
| 6380270ac6 | |||
| 6d0e954cce | |||
| 387653a3c0 | |||
| c1c02c01cf | |||
| 4bbeaae8f0 | |||
| 5c0eb1e899 | |||
| d04c5aa58d | |||
| 7c6ec361ae | |||
| 46dfe48adc | |||
| 71e42811fb | |||
| 985b58c406 | |||
| 7ef0e28e96 | |||
| d9645ec5e4 | |||
| 155392a809 | |||
| 47118215b4 | |||
| 26cd05e961 | |||
| 68805a8cde | |||
| 61bb464e32 | |||
| 60b08f1198 | |||
| fda3761ead | |||
| 05cc0874d6 | |||
| 61e73ada51 | |||
| 6a82b88947 |
@@ -1,7 +1,9 @@
|
||||
# built binaries (repo root only — not the cmd/ source dirs)
|
||||
/agentpr
|
||||
/watchpr
|
||||
/agentws
|
||||
# cross-compiled release artifacts (e.g. agentpr-linux-amd64)
|
||||
/agentpr-*
|
||||
/watchpr-*
|
||||
/agentws-*
|
||||
dist/
|
||||
|
||||
+10
-3
@@ -13,10 +13,11 @@ repos:
|
||||
rev: v0.5.1
|
||||
hooks:
|
||||
- id: go-fmt
|
||||
- id: go-unit-tests
|
||||
|
||||
# go-vet at the module level (dnephin's go-vet runs at repo root, which has no
|
||||
# .go files here since both tools live under cmd/). The CI pre-commit image
|
||||
# go vet and go test at the module level (dnephin's run at repo root, which has
|
||||
# no .go files here since both tools live under cmd/, and its go-unit-tests
|
||||
# caps every package at 30s and re-runs the whole module once per file batch —
|
||||
# the git-fixture tests outgrew both). The CI pre-commit image
|
||||
# (almalinux9-gobuilder) has go installed.
|
||||
- repo: local
|
||||
hooks:
|
||||
@@ -26,3 +27,9 @@ repos:
|
||||
language: system
|
||||
types: [go]
|
||||
pass_filenames: false
|
||||
- id: go-test-mod
|
||||
name: go test (module)
|
||||
entry: go test ./...
|
||||
language: system
|
||||
types: [go]
|
||||
pass_filenames: false
|
||||
|
||||
@@ -17,7 +17,7 @@ steps:
|
||||
memory: 2Gi
|
||||
cpu: 2
|
||||
|
||||
# Build both binaries into dist/ (consumed by the RPM step) plus the
|
||||
# Build every binary into dist/ (consumed by the RPM step) plus the
|
||||
# cross-platform binaries attached to the Gitea release. Each tool is a
|
||||
# separate main package, so they are built individually per os/arch.
|
||||
- name: build
|
||||
@@ -28,7 +28,7 @@ steps:
|
||||
# for the shell instead of substituting them (as pipeline vars) at parse
|
||||
# time. ${CI_COMMIT_TAG} is a real Woodpecker var and stays single-$.
|
||||
- |
|
||||
for entry in "agentpr:./cmd/agentpr" "watchpr:./cmd/watchpr"; do
|
||||
for entry in "agentpr:./cmd/agentpr" "watchpr:./cmd/watchpr" "agentws:./cmd/agentws" "agentvault:./cmd/agentvault"; do
|
||||
name="$${entry%%:*}"; pkg="$${entry##*:}"
|
||||
for osarch in linux/amd64 linux/arm64 darwin/amd64 darwin/arm64; do
|
||||
os="$${osarch%/*}"; arch="$${osarch#*/}"
|
||||
@@ -135,7 +135,7 @@ steps:
|
||||
# root; the package step writes the RPM to dist/. Generate a checksums
|
||||
# manifest over everything we attach so downloads can be verified.
|
||||
RPM=$$(ls dist/*.rpm 2>/dev/null | head -1)
|
||||
ASSETS="agentpr-linux-amd64 agentpr-linux-arm64 agentpr-darwin-amd64 agentpr-darwin-arm64 watchpr-linux-amd64 watchpr-linux-arm64 watchpr-darwin-amd64 watchpr-darwin-arm64"
|
||||
ASSETS="agentpr-linux-amd64 agentpr-linux-arm64 agentpr-darwin-amd64 agentpr-darwin-arm64 watchpr-linux-amd64 watchpr-linux-arm64 watchpr-darwin-amd64 watchpr-darwin-arm64 agentws-linux-amd64 agentws-linux-arm64 agentws-darwin-amd64 agentws-darwin-arm64 agentvault-linux-amd64 agentvault-linux-arm64 agentvault-darwin-amd64 agentvault-darwin-arm64"
|
||||
[ -n "$$RPM" ] && ASSETS="$$ASSETS $$RPM"
|
||||
sha256sum $$ASSETS > sha256sums.txt
|
||||
tea releases assets create "${CI_COMMIT_TAG}" $$ASSETS sha256sums.txt \
|
||||
|
||||
@@ -2,36 +2,53 @@
|
||||
|
||||
## Project Overview
|
||||
|
||||
This repo ships two Gitea-automation CLIs in one RPM (`agent-tools`). Both act
|
||||
as the `unkin-agent` user by minting a scoped Gitea token from Vault, so
|
||||
actions are attributed to the agent rather than to whoever runs the tool.
|
||||
This repo ships several Gitea-automation CLIs in one RPM (`agent-tools`). They
|
||||
act as an agent user (`unkin-agent` by default) by minting a scoped Gitea token
|
||||
from Vault, so actions are attributed to the agent rather than to whoever runs
|
||||
the tool. Setting `AGENT_LOGIN` selects a different agent identity, so a service
|
||||
like repospawner can run these tools as itself.
|
||||
|
||||
- **`agentpr`** — create pull requests and post PR comments as `unkin-agent`
|
||||
(fixes the "tea posts as Ben" attribution problem). Subcommands:
|
||||
`pr create`, `pr comment`, `whoami`.
|
||||
- **`agentpr`** — create and edit pull requests and issues, close and reopen
|
||||
issues, and post comments on either, as `unkin-agent` (fixes the "tea posts
|
||||
as Ben" attribution problem). Subcommands: `pr create`, `pr comment`,
|
||||
`pr edit`, `issue create`, `issue comment`, `issue edit`, `issue close`,
|
||||
`issue reopen`, `whoami`.
|
||||
- **`watchpr`** — poll one or more PRs and exit when a tracked PR changes
|
||||
meaningfully: it merges/closes, gets a new non-agent comment, its CI fails,
|
||||
or it loses mergeability. Benign transitions (CI pending→success, the agent's
|
||||
own comments) are ignored.
|
||||
- **`agentws`** — manage per-branch git worktrees for `unkin-agent`. Clones
|
||||
repos into the source root (`~/src/prodenv/<repo>`), creates worktrees under
|
||||
the worktree root (`~/.cache/agentws/<repo>__<branch>`), and authenticates
|
||||
clone/fetch/push via an ephemeral credential helper. Subcommands: `new`,
|
||||
`list`, `rm`, `prune`, `clean`, `token`, `credential`.
|
||||
|
||||
Both tools are separate `main` packages under `cmd/` and share the
|
||||
All tools are separate `main` packages under `cmd/` and share the
|
||||
`internal/agent` package (Vault AppRole login, Gitea REST client, PR-ref
|
||||
parsing, watch-state comparison).
|
||||
parsing, watch-state comparison, git worktree helpers).
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
cmd/agentpr/main.go # agentpr CLI (pr create / pr comment / whoami)
|
||||
cmd/agentpr/main.go # agentpr CLI (pr + issue create/comment/edit, issue close/reopen, whoami)
|
||||
cmd/watchpr/main.go # watchpr CLI (poll + meaningful-change exit)
|
||||
cmd/agentws/main.go # agentws CLI (new / list / rm / clean / token / credential)
|
||||
cmd/agentws/prune.go # agentws prune (classify worktrees, remove the safe ones)
|
||||
cmd/agentvault/main.go # agentvault CLI (seed-outpost / seed-oauth)
|
||||
internal/agent/ # shared plumbing:
|
||||
token.go # env config + in-process Gitea-token cache
|
||||
vault.go # AppRole login + read gitea/creds/unkin-agent
|
||||
gitea.go # Gitea REST client (PR create/get, comments, status, whoami)
|
||||
vault.go # AppRole login + read the gitea creds path
|
||||
gitea.go # Gitea REST client (PR/issue create/edit/get, issue state, comments, status, whoami)
|
||||
parse.go # owner/repo#N and owner/repo parsing
|
||||
watch.go # PRState snapshot + MeaningfulChange comparison
|
||||
git.go # git worktree/clone/fetch helpers (os/exec, no go-git)
|
||||
vaultkv.go # AppRole-authenticated Vault client + KV-v2 read/write
|
||||
authentik.go # Authentik REST client (outpost search, token view_key)
|
||||
seedoutpost.go # seed-outpost flow (Authentik token -> Vault KV)
|
||||
seedoauth.go # seed-oauth flow (oauth2-proxy credential set in Vault KV)
|
||||
go.mod # module git.unkin.net/unkin/agent-tools
|
||||
Makefile # build / test / lint / completions / rpm / version-bump
|
||||
packaging/nfpm.yaml # nfpm spec (envsubst-templated) for the RPM (both binaries)
|
||||
packaging/nfpm.yaml # nfpm spec (envsubst-templated) for the RPM (all binaries)
|
||||
scripts/build-rpm.sh # generates completions + packages the RPM with nfpm
|
||||
.woodpecker/ # CI: build, test, pre-commit (PR) + release (tag)
|
||||
dist/ # build output: binaries, completions, RPM (not committed)
|
||||
@@ -42,11 +59,13 @@ own `-o` (a single `go build ./...` can't emit multiple mains to one file).
|
||||
|
||||
## Token acquisition (shared)
|
||||
|
||||
Both tools call `agent.GiteaToken()`, which (once per process):
|
||||
All tools call `agent.GiteaToken()`, which (once per process):
|
||||
|
||||
1. AppRole login: `POST $VAULT_ADDR/v1/auth/approle/login` with `role_id` only
|
||||
(no `secret_id`) → `client_token`.
|
||||
2. `GET $VAULT_ADDR/v1/gitea/creds/unkin-agent` with `X-Vault-Token` → `.data.token`.
|
||||
2. `GET $VAULT_ADDR/v1/<creds path>` with `X-Vault-Token` → `.data.token`, where
|
||||
the creds path is `GITEA_CREDS_PATH` if set, else `gitea/creds/$AGENT_LOGIN`
|
||||
(so unset env still reads `gitea/creds/unkin-agent`).
|
||||
|
||||
Config via env (all have defaults):
|
||||
|
||||
@@ -55,12 +74,32 @@ Config via env (all have defaults):
|
||||
| `VAULT_ADDR` | `https://vault.service.consul:8200` | Vault/OpenBao address |
|
||||
| `AGENT_APPROLE_ROLE_ID` | built-in default | AppRole role_id (overridable) |
|
||||
| `GITEA_URL` | `https://git.unkin.net` | Gitea base URL |
|
||||
| `AGENT_LOGIN` | `unkin-agent` | login whose comments watchpr ignores |
|
||||
| `AGENT_LOGIN` | `unkin-agent` | agent identity: selects `gitea/creds/<login>`; login whose comments watchpr ignores; agentws git identity |
|
||||
| `GITEA_CREDS_PATH` | `gitea/creds/$AGENT_LOGIN` | Vault path minting the Gitea token (wins over `AGENT_LOGIN`) |
|
||||
| `AGENTWS_SRC_ROOT` | `~/src/prodenv` | agentws source-of-truth checkout root |
|
||||
| `AGENTWS_ROOT` | `~/.cache/agentws` | agentws worktree root |
|
||||
| `AGENTWS_OWNER` | `unkin` | Gitea org that owns agentws-managed repos |
|
||||
| `AUTHENTIK_URL` | `https://identity.k8s.syd1.au.unkin.net` | Authentik base URL (`agentvault`) |
|
||||
|
||||
### agentws git auth (ephemeral credential helper)
|
||||
|
||||
Gitea tokens are ~1h ephemeral, so `agentws` never bakes one into a remote URL
|
||||
or config. `agentws token` prints a fresh token; `agentws credential get`
|
||||
implements the git credential protocol (reads the key=value request on stdin,
|
||||
and for the configured Gitea host only emits `username=$AGENT_LOGIN` +
|
||||
`password=<fresh token>`). `agentws new` wires this per worktree — it enables
|
||||
`extensions.worktreeConfig` on the repo once, then writes `user.name`,
|
||||
`user.email` and `credential.helper = !<agentws> credential` to the
|
||||
**per-worktree** config so the shared checkout's identity/config is untouched.
|
||||
Clone/fetch pass the same helper transiently via `-c credential.helper=...`.
|
||||
Worktrees are created FROM `~/src/prodenv/<repo>` (`git worktree add`) so agent
|
||||
branches are visible in Ben's main checkout; `rm`/`clean` fetch there afterwards
|
||||
to keep the default branch current.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
make build # -> dist/agentpr, dist/watchpr (CGO disabled, static)
|
||||
make build # -> dist/agentpr, dist/watchpr, dist/agentws, dist/agentvault (CGO disabled, static)
|
||||
```
|
||||
|
||||
Requires Go 1.21+. Dependency: `github.com/spf13/cobra` (CLI).
|
||||
@@ -68,11 +107,12 @@ Requires Go 1.21+. Dependency: `github.com/spf13/cobra` (CLI).
|
||||
## Packaging (RPM)
|
||||
|
||||
```bash
|
||||
make rpm # build both binaries + package into dist/*.rpm via nfpm
|
||||
make rpm # build all binaries + package into dist/*.rpm via nfpm
|
||||
```
|
||||
|
||||
`scripts/build-rpm.sh` generates bash/zsh/fish completions from the built
|
||||
binaries and bundles them alongside `/usr/bin/agentpr` and `/usr/bin/watchpr`.
|
||||
binaries and bundles them alongside `/usr/bin/agentpr`, `/usr/bin/watchpr`,
|
||||
`/usr/bin/agentws` and `/usr/bin/agentvault`.
|
||||
On a `v*` tag the release pipeline builds the RPM and `PUT`s it to the
|
||||
artifactapi `rpm-internal` repo, then cuts a Gitea release.
|
||||
|
||||
@@ -91,13 +131,101 @@ make test # go test -v -race ./...
|
||||
|
||||
`internal/agent` covers PR-ref parsing, the `MeaningfulChange` table (benign vs
|
||||
alerting transitions), request-body construction, and the Vault+Gitea client
|
||||
against `httptest` servers (fake AppRole login + gitea creds + PR create /
|
||||
comment / whoami / status). No live Vault/Gitea access is required for tests.
|
||||
against `httptest` servers (fake AppRole login + gitea creds + PR/issue create
|
||||
+ edit / close / reopen / comment / whoami / status). No live Vault/Gitea access
|
||||
is required for tests.
|
||||
|
||||
## agentvault seed-outpost
|
||||
|
||||
`agentvault seed-outpost --outpost <name> --dest-path <kv/path>` does the whole
|
||||
flow in-process:
|
||||
|
||||
1. AppRole login (shared `approleLogin`), then KV-v2 read of
|
||||
`kv/service/authentik/agent-api-token` (field `token`, falling back to
|
||||
`api_token`).
|
||||
2. `GET /api/v3/outposts/instances/?search=<name>` — Authentik's `search` is a
|
||||
substring match, so the exact `name` is re-checked client-side.
|
||||
3. `GET /api/v3/core/tokens/<token_identifier>/view_key/` for the key.
|
||||
4. KV-v2 write to `--dest-path` under `--dest-key` (default `token`).
|
||||
|
||||
Only the outpost name, token identifier, dest path and new KV version are
|
||||
printed. Errors are wrapped per stage (login / read denied / outpost missing /
|
||||
view_key / write denied) via the `ErrVaultDenied`, `ErrVaultNotFound` and
|
||||
`ErrOutpostNotFound` sentinels.
|
||||
|
||||
## agentvault seed-oauth
|
||||
|
||||
`agentvault seed-oauth --path <kv/path> --client-id <id>` makes a KV-v2 path
|
||||
hold a complete oauth2-proxy credential set, in-process:
|
||||
|
||||
1. AppRole login (shared `approleLogin`), then a KV-v2 read via
|
||||
`ReadKVOptional` — a 404 or a deleted version means "empty", not an error,
|
||||
so the first seed of a path works.
|
||||
2. Desired keys are computed over the existing map: `client_id` from the flag
|
||||
(`kept`/`created`/`updated`), `client_secret` and `cookie_secret` generated
|
||||
from 32 `crypto/rand` bytes only when absent or when `--rotate` is set
|
||||
(`kept`/`created`/`rotated`). `cookie_secret` is base64url so it decodes to
|
||||
exactly the 32 bytes oauth2-proxy demands; `client_secret` is standard
|
||||
base64.
|
||||
3. Any other key on the path is carried through unchanged (`preserved`), which
|
||||
is why the write goes through `WriteKVAny` rather than `WriteKV`.
|
||||
4. The write is skipped entirely when nothing changed; the command then prints
|
||||
`version: unchanged`.
|
||||
|
||||
Only key names, per-key actions and the new KV version are printed. Errors are
|
||||
wrapped per stage (login / read denied / write denied) via `ErrVaultDenied`.
|
||||
|
||||
## Gotchas
|
||||
|
||||
- `watchpr` exits 0 with no output changes on `--once` (just prints state).
|
||||
- The token cache is process-wide (`sync.Once`); tests call the unexported
|
||||
`fetchGiteaToken` to avoid it.
|
||||
- Gitea tokens expire in ~1h, shorter than a watch: the client re-mints once when
|
||||
the credential it sent was rejected and replays the request. If the fresh token
|
||||
is rejected too, `watchpr` exits non-zero rather than polling blind.
|
||||
- A 401/403 is classified before anything is re-minted, because only one of the
|
||||
three cases is a stale token: `ErrNoCredential` (the request carried no token —
|
||||
anonymous access to something not public), `IsPermissionDenied` (a 403 whose
|
||||
body names no credential, so the identity is simply not allowed) and
|
||||
`IsCredentialRejected` (any 401, or a 403 mentioning a token/scope/sign-in,
|
||||
which is what Gitea returns for a token missing a scope). Only the last
|
||||
re-mints; the others abort immediately, since a fresh token cannot fix them and
|
||||
blaming one hides the real cause. `IsAuthError` stays "any 401/403" — all three
|
||||
end a watch.
|
||||
- `watchpr` polls anonymously when no token can be minted (public repos work
|
||||
fine); an anonymous run never reaches for Vault, on any status code.
|
||||
- A re-mint that hands back an empty token is an error: replaying with it would
|
||||
drop the Authorization header and silently continue as an anonymous watcher.
|
||||
- The token cache is process-wide (mutex-guarded); `RefreshGiteaToken` replaces
|
||||
it. Tests call the unexported `fetchGiteaToken` to avoid the cache.
|
||||
- `agentvault` never puts a secret in an error string: Vault decode failures and
|
||||
Authentik `view_key` responses are reported without their bodies, and
|
||||
`seed-oauth` reports key names only.
|
||||
- `--rotate` regenerates the `client_secret` too, which then no longer matches
|
||||
the IdP provider unless that is rotated alongside.
|
||||
- `agentws prune` is a dry run unless `--yes`. It matches a branch to its PR on
|
||||
`head.label`: Gitea rewrites `head.ref` to `refs/pull/<n>/head` once the branch
|
||||
is deleted, which merging does, so `head.ref` matching misses every merged PR.
|
||||
Git signals (`merge-base --is-ancestor`, `git cherry`) are authoritative and
|
||||
offline-safe; an unreachable Gitea only means no branch gets deleted without
|
||||
git proof. A PR's state never authorises a branch delete on its own — HEAD
|
||||
must be contained in the PR's head commit or in `origin/<branch>`, otherwise
|
||||
the worktree goes and the branch stays. `origin/<branch>` is only evidence when
|
||||
this run's pruning fetch succeeded; a failed fetch leaves stale tracking refs,
|
||||
so those verdicts fall back to keeping the branch.
|
||||
- `agentws prune` discovers worktrees from the worktree root *and* from
|
||||
`git worktree list` on each source checkout, merging the two so git's own
|
||||
`locked`/`prunable` flags reach entries the directory scan already found.
|
||||
Removing a worktree is only safe because the local branch keeps its commits, so
|
||||
the cases with no branch to fall back on are kept: a detached HEAD carrying
|
||||
commits on no remote, a locked checkout, or one with a sequencer operation
|
||||
half-finished (`rebase-merge`, `MERGE_HEAD`, `CHERRY_PICK_HEAD`, …). A directory
|
||||
whose backing repo is gone is deleted outright, but only ever inside the
|
||||
worktree root.
|
||||
- CI "combined status" comes from `/commits/{sha}/status`; an empty head SHA
|
||||
yields an empty state without an API call.
|
||||
- Gitea backs every PR with an issue of the same number and serves comments from
|
||||
`/issues/{n}/comments`, so `agentpr pr comment` and `agentpr issue comment`
|
||||
are one implementation under two flag names (`--pr` / `--issue`).
|
||||
- `issue close`/`issue reopen` read the issue before the PATCH: Gitea answers a
|
||||
no-op state change with 200, so without the read an already-closed issue would
|
||||
report success. There is no `pr close`: closing a pull request is a human's
|
||||
call, not an agent's.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# All shipped binaries and the package path each is built from. Both tools live
|
||||
# under cmd/; the module root ships no binary of its own.
|
||||
BINARIES := agentpr watchpr
|
||||
BINARIES := agentpr watchpr agentws agentvault
|
||||
DIST := dist
|
||||
VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo dev)
|
||||
GOFLAGS := -ldflags="-s -w -X main.version=$(VERSION)"
|
||||
|
||||
@@ -1,19 +1,26 @@
|
||||
# agent-tools
|
||||
|
||||
Two small Gitea-automation CLIs, shipped together in one RPM (`agent-tools`).
|
||||
Both act as the **`unkin-agent`** user by minting a scoped Gitea token from
|
||||
Vault, so automated PRs and comments are attributed to the agent — not to
|
||||
whoever happens to run the command.
|
||||
Small Gitea-automation CLIs, shipped together in one RPM (`agent-tools`). They
|
||||
act as an agent user (**`unkin-agent`** by default) by minting a scoped Gitea
|
||||
token from Vault, so automated PRs, comments and pushes are attributed to the
|
||||
agent — not to whoever happens to run the command. Set `AGENT_LOGIN` to act as a
|
||||
different agent identity.
|
||||
|
||||
- **`agentpr`** — create pull requests and post PR comments as `unkin-agent`.
|
||||
- **`agentpr`** — create and edit pull requests and issues, close and reopen
|
||||
issues, and post comments on either, as the agent user.
|
||||
- **`watchpr`** — poll one or more PRs and exit when one changes in a way worth
|
||||
acting on.
|
||||
- **`agentws`** — manage per-branch git worktrees for `unkin-agent`, cloning
|
||||
into Ben's source checkout and isolating agent work under the XDG cache.
|
||||
- **`agentvault`** — run deterministic Vault flows in one invocation, so agents
|
||||
never plumb secret material through a shell.
|
||||
|
||||
## How it gets a token
|
||||
|
||||
On first use each tool performs a Vault AppRole login (`role_id` only, no
|
||||
`secret_id`), then reads `gitea/creds/unkin-agent` to obtain a short-lived Gitea
|
||||
token, cached in-process for the run.
|
||||
`secret_id`), then reads `gitea/creds/$AGENT_LOGIN` — or `GITEA_CREDS_PATH` when
|
||||
set — to obtain a short-lived Gitea token, cached in-process for the run. With
|
||||
neither variable set that is `gitea/creds/unkin-agent`, as before.
|
||||
|
||||
Everything is configured by environment variables, all with defaults:
|
||||
|
||||
@@ -22,12 +29,17 @@ Everything is configured by environment variables, all with defaults:
|
||||
| `VAULT_ADDR` | `https://vault.service.consul:8200` | Vault/OpenBao address |
|
||||
| `AGENT_APPROLE_ROLE_ID` | built-in default | AppRole role_id (overridable) |
|
||||
| `GITEA_URL` | `https://git.unkin.net` | Gitea base URL |
|
||||
| `AGENT_LOGIN` | `unkin-agent` | login whose comments `watchpr` ignores |
|
||||
| `AGENT_LOGIN` | `unkin-agent` | agent identity: selects `gitea/creds/<login>`, and the login whose comments `watchpr` ignores |
|
||||
| `GITEA_CREDS_PATH` | `gitea/creds/$AGENT_LOGIN` | Vault path minting the Gitea token (wins over `AGENT_LOGIN`) |
|
||||
| `AGENTWS_SRC_ROOT` | `~/src/prodenv` | source-of-truth checkout root (`agentws`) |
|
||||
| `AGENTWS_ROOT` | `~/.cache/agentws` | worktree root (`agentws`) |
|
||||
| `AGENTWS_OWNER` | `unkin` | Gitea org that owns the repos (`agentws`) |
|
||||
| `AUTHENTIK_URL` | `https://identity.k8s.syd1.au.unkin.net` | Authentik base URL (`agentvault`) |
|
||||
|
||||
## agentpr
|
||||
|
||||
```bash
|
||||
# Verify identity (should print: unkin-agent)
|
||||
# Verify identity (prints the agent login, unkin-agent by default)
|
||||
agentpr whoami
|
||||
|
||||
# Open a PR
|
||||
@@ -39,6 +51,29 @@ agentpr pr create --repo unkin/argocd-apps \
|
||||
# Comment on a PR
|
||||
agentpr pr comment --repo unkin/argocd-apps --pr 42 --body "Rebased, CI green."
|
||||
|
||||
# Edit a PR's title and/or body; an omitted flag is left unchanged
|
||||
agentpr pr edit --repo unkin/argocd-apps --pr 42 --body "Adds the ServiceAccount ..."
|
||||
agentpr pr edit --repo unkin/argocd-apps --pr 42 --title "Add woodpecker SA"
|
||||
# prints: #<number> <html_url>
|
||||
|
||||
# File an issue (--body optional)
|
||||
agentpr issue create --repo unkin/argocd-apps \
|
||||
--title "Woodpecker SA missing" --body "The pipeline fails with ..."
|
||||
# prints: #<number> <html_url>
|
||||
|
||||
# Comment on an issue (the same Gitea endpoint `pr comment` posts to)
|
||||
agentpr issue comment --repo unkin/argocd-apps --issue 43 --body "Fixed in #44."
|
||||
|
||||
# Edit an issue's title and/or body; an omitted flag is left unchanged
|
||||
agentpr issue edit --repo unkin/argocd-apps --issue 43 --body "The pipeline fails with ..."
|
||||
# prints: #<number> <html_url>
|
||||
|
||||
# Close or reopen an issue; an issue already in that state is an error, not a
|
||||
# silent success
|
||||
agentpr issue close --repo unkin/argocd-apps --issue 43
|
||||
agentpr issue reopen --repo unkin/argocd-apps --issue 43
|
||||
# prints: #<number> <state> <html_url>
|
||||
|
||||
agentpr --version
|
||||
agentpr --help
|
||||
```
|
||||
@@ -59,6 +94,9 @@ watchpr unkin/argocd-apps#42
|
||||
# Multiple PRs, custom interval; refs accept #N or :N
|
||||
watchpr --interval 30s unkin/argocd-apps#42 unkin/terraform-vault:98
|
||||
|
||||
# --interval takes a duration (30s, 2m, 1h30m) or a bare number of seconds
|
||||
watchpr --interval 30 unkin/argocd-apps#42
|
||||
|
||||
# One-shot: print current state and exit 0 (great for scripts)
|
||||
watchpr --once unkin/argocd-apps#42
|
||||
watchpr --once --json unkin/argocd-apps#42
|
||||
@@ -67,10 +105,246 @@ watchpr --once --json unkin/argocd-apps#42
|
||||
On a meaningful change `watchpr` prints the reason and the PR's current state,
|
||||
then exits 0. Use `--json` for machine-readable output.
|
||||
|
||||
### Exit behaviour
|
||||
|
||||
A watcher that sees nothing must not look healthy, so every terminal failure
|
||||
exits non-zero naming its cause:
|
||||
|
||||
| Cause | Message |
|
||||
|---|---|
|
||||
| the token was rejected and a fresh one was too | `gitea rejected the token and re-minting did not recover it` |
|
||||
| authenticated but not allowed (Gitea 403, no token named) | `gitea denied access to <login>` |
|
||||
| polling anonymously and the PR is not public | `gitea requires authentication and no token could be minted` |
|
||||
| the PR lookup 404s (repo deleted, renamed, made private) | `PR no longer visible` |
|
||||
|
||||
Gitea tokens expire in ~1h, far shorter than a watch, so a rejected token is
|
||||
re-minted once and the request replayed; only a failure that survives that
|
||||
re-mint ends the watch. Anonymous polling of a public repo is unaffected — with
|
||||
no token there is nothing to reject and Vault is never reached for one.
|
||||
Transient failures (5xx, network errors, rate limiting) are warned about and
|
||||
retried, and give up after 20 consecutive failures of the same PR.
|
||||
|
||||
## agentws
|
||||
|
||||
`agentws` gives an agent an isolated git worktree per branch without disturbing
|
||||
Ben's shared checkouts. Repos are cloned into the **source root**
|
||||
(`~/src/prodenv/<repo>`) so branches created here are visible in the main
|
||||
checkout too; the worktrees themselves live under the **worktree root**
|
||||
(`~/.cache/agentws/<repo>__<branch>`).
|
||||
|
||||
```bash
|
||||
# Clone unkin/argocd-apps into ~/src/prodenv if missing, then add a worktree for
|
||||
# the branch. Prints the worktree path.
|
||||
agentws new argocd-apps --branch benvin/my-change
|
||||
|
||||
# Branch off a specific base instead of the remote default (new branches only)
|
||||
agentws new argocd-apps --branch benvin/hotfix --from release-1.2
|
||||
|
||||
# List managed worktrees (repo, branch, path)
|
||||
agentws list
|
||||
|
||||
# Remove a worktree (by path or branch); refreshes the source repo afterwards
|
||||
agentws rm benvin/my-change
|
||||
agentws rm ~/.cache/agentws/argocd-apps__benvin-my-change --delete-branch
|
||||
|
||||
# Classify every worktree found; dry run unless --yes is given
|
||||
agentws prune
|
||||
agentws prune --json
|
||||
agentws prune --no-fetch
|
||||
agentws prune --yes
|
||||
agentws prune --yes --keep-branches
|
||||
|
||||
# Remove every managed worktree and prune each source repo
|
||||
agentws clean
|
||||
|
||||
# Print a fresh Gitea token for the agent login
|
||||
agentws token
|
||||
```
|
||||
|
||||
`agentws new` fetches first, then takes one of two paths and names the one it
|
||||
took on its last output line. A branch that **already exists on origin** is
|
||||
checked out at `origin/<branch>` and set to track it, so the worktree starts on
|
||||
the branch's own commits (`branch <b> (tracking origin/<b> at <sha>)`); a local
|
||||
branch left from an earlier run is fast-forwarded onto it. A branch origin does
|
||||
**not** have is created from `--from`, or from the remote's default branch when
|
||||
`--from` is absent (`branch <b> (new, from origin/<base>)`) — the default is read
|
||||
from `origin/HEAD`, so a repo on `master` forks from `master`. `--from` is
|
||||
ignored, with a note, when the branch is already on origin.
|
||||
|
||||
The one case the worktree does not land on `origin/<branch>` is a local branch
|
||||
carrying commits origin has never seen. Those commits exist nowhere else, so the
|
||||
checkout is left on them and the output says how many.
|
||||
|
||||
### prune
|
||||
|
||||
`agentws prune` finds worktrees two ways and merges the results: the managed
|
||||
directories under the worktree root, and `git worktree list` on every source
|
||||
checkout — so hand-made worktrees, stale registrations whose directory is gone,
|
||||
and leftover directories whose source repo was deleted all show up too.
|
||||
|
||||
It then decides, per worktree, whether its work is safely upstream:
|
||||
|
||||
| Signal (first match wins) | Verdict |
|
||||
|---|---|
|
||||
| working tree gone (registration only) | prune the registration |
|
||||
| backing repo gone | delete the leftover directory |
|
||||
| locked by `git worktree lock` | keep |
|
||||
| rebase, merge, cherry-pick, revert or bisect in progress | keep |
|
||||
| uncommitted, staged or untracked changes | keep |
|
||||
| branch has an open PR | keep |
|
||||
| tip contained in `origin/<default>` | remove worktree + local branch |
|
||||
| every commit patch-equivalent to one in `origin/<default>`'s history | remove worktree + local branch |
|
||||
| PR merged **and** HEAD contained in the PR's head commit (or in a verified `origin/<branch>`) | remove worktree + local branch |
|
||||
| PR closed **and** HEAD contained in a verified `origin/<branch>` | remove worktree + local branch |
|
||||
| detached HEAD carrying commits on no remote | keep |
|
||||
| anything else | remove worktree, keep the branch |
|
||||
|
||||
A branch is deleted only where git proves its commits survive elsewhere. PR
|
||||
state alone never authorises that: a merged or closed PR whose branch picked up
|
||||
commits since keeps its branch, because those commits exist nowhere but here.
|
||||
The delete runs `git branch -d` first so git's own unmerged check is a backstop,
|
||||
falling back to `-D` only for a proven branch — squash merges keep the guard
|
||||
tripping even once the work has landed.
|
||||
|
||||
Patch equivalence comes from `git cherry`, which these squash-merging repos need
|
||||
because a merged branch's commits carry different SHAs upstream. It proves the
|
||||
patches reached the default branch's history at some point — a later revert
|
||||
still counts — not that they stand at its tip.
|
||||
|
||||
`origin/<branch>` counts as evidence only when this run's `git fetch --prune`
|
||||
succeeded. A tracking ref left over from an earlier fetch may name a branch that
|
||||
is already gone upstream and is itself due for deletion, so a failed fetch
|
||||
downgrades those verdicts to `remove` and keeps the branch. Proofs that read
|
||||
only local objects — containment in `origin/<default>`, patch equivalence, and
|
||||
containment in a merged PR's head SHA — stand on their own.
|
||||
|
||||
Gitea PR state only adds to the git answer: when it cannot be reached, prune
|
||||
says so and never deletes a branch it could not prove, and a PR listing that
|
||||
hits the pagination cap is reported rather than read as "no PR". Matching a
|
||||
branch to its PR uses `head.label`, since Gitea rewrites `head.ref` to
|
||||
`refs/pull/<n>/head` once the branch is deleted on merge.
|
||||
|
||||
The last row is safe only because the local branch keeps the commits, so the
|
||||
reason names the branch it is relying on. A detached HEAD has no such branch, so
|
||||
unique commits there are kept instead.
|
||||
|
||||
Output is a table (`REPO BRANCH PATH VERDICT REASON`) with every verdict's reason
|
||||
spelled out, or `--json` for scripting. Neither form needs a terminal.
|
||||
|
||||
| Flag | Effect |
|
||||
|---|---|
|
||||
| `--yes` | apply the plan; without it nothing is touched |
|
||||
| `--keep-branches` | remove worktrees only; verdicts print as `remove` |
|
||||
| `--no-fetch` | judge against the refs already on disk, for offline use |
|
||||
| `--json` | emit the report as JSON on stdout, notes on stderr |
|
||||
| `--include-unmanaged` | also remove worktrees outside the worktree root |
|
||||
| `--include-keep` | dangerous: also remove worktrees classified `keep`, destroying uncommitted and in-progress work |
|
||||
|
||||
Without `--include-unmanaged` a hand-made worktree is reported and then skipped,
|
||||
naming the flag that would remove it. `--include-keep` is the only way past a
|
||||
`keep`. It leaves the branch, so committed work outlives the worktree, but
|
||||
`git worktree remove --force` discards a dirty working tree and a paused
|
||||
rebase's sequencer state without a word, and no branch was carrying those.
|
||||
|
||||
A directory under the worktree root is deleted outright only when its git dir
|
||||
and the repo's shared `.git` are both proven absent by `stat`. When git merely
|
||||
fails to answer for a checkout, the verdict is `keep` with the error as its
|
||||
reason: an unread state is never a dead one.
|
||||
|
||||
### Auth / credential-helper design
|
||||
|
||||
Gitea tokens minted from Vault are short-lived (~1h), so `agentws` never
|
||||
persists one in a remote URL or in git config. Instead it wires itself as an
|
||||
**ephemeral git credential helper**:
|
||||
|
||||
- `agentws token` prints a fresh token to stdout (handy for scripts).
|
||||
- `agentws credential get` speaks the git credential protocol on stdin and, for
|
||||
the configured Gitea host only, emits `username=$AGENT_LOGIN` +
|
||||
`password=<fresh token>`.
|
||||
|
||||
`agentws new` sets this up per worktree without touching the shared checkout: it
|
||||
enables `extensions.worktreeConfig` on the repo once, then writes
|
||||
`user.name` / `user.email` and `credential.helper = !<agentws> credential` to
|
||||
the **per-worktree** config. Clone/fetch use the same helper via a transient
|
||||
`-c credential.helper=...`; the shared `origin` URL is left clean. On worktree
|
||||
removal `agentws` fetches in `~/src/prodenv/<repo>` so its default branch stays
|
||||
current.
|
||||
|
||||
## agentvault
|
||||
|
||||
Deterministic Vault flows, each a single self-contained invocation: the tool
|
||||
reads and writes the secrets itself, and prints only identifiers.
|
||||
|
||||
### seed-outpost
|
||||
|
||||
Copy an Authentik outpost's token into Vault KV-v2. `agentvault` reads the
|
||||
Authentik API token from `kv/service/authentik/agent-api-token`, resolves the
|
||||
named outpost's `token_identifier`, fetches its key via
|
||||
`/api/v3/core/tokens/<identifier>/view_key/` and writes it to the destination
|
||||
KV path. The token value is never printed or logged.
|
||||
|
||||
```bash
|
||||
agentvault seed-outpost \
|
||||
--outpost k8s-outpost \
|
||||
--dest-path kubernetes/namespace/authentik/default/outpost-token
|
||||
```
|
||||
|
||||
```
|
||||
outpost: k8s-outpost
|
||||
token_identifier: ak-outpost-k8s-outpost
|
||||
dest: kv/kubernetes/namespace/authentik/default/outpost-token
|
||||
version: 3
|
||||
```
|
||||
|
||||
Re-running is safe: it writes a new KV version. Flags: `--outpost` and
|
||||
`--dest-path` are required; `--dest-key` (default `token`), `--kv-mount`
|
||||
(default `kv`), `--token-path` (default `service/authentik/agent-api-token`) and
|
||||
`--authentik-url` override the rest.
|
||||
|
||||
Errors name the failing stage: AppRole login, KV read denied (policy not
|
||||
applied), outpost not found (terraform not applied), `view_key` failure, or KV
|
||||
write denied.
|
||||
|
||||
### seed-oauth
|
||||
|
||||
Make a Vault KV-v2 path hold a complete oauth2-proxy credential set. It is a
|
||||
read-modify-write: `client_id` is set from the flag, `client_secret` and
|
||||
`cookie_secret` are generated (32 bytes from `crypto/rand`) only when missing,
|
||||
every other key on the path is written back untouched, and nothing is written
|
||||
at all when the secret is already correct. `cookie_secret` is base64url so it
|
||||
decodes to exactly the 32 bytes oauth2-proxy requires.
|
||||
|
||||
```bash
|
||||
agentvault seed-oauth \
|
||||
--path kubernetes/namespace/repospawner/default/oauth-credentials \
|
||||
--client-id 4f1c…
|
||||
```
|
||||
|
||||
```
|
||||
path: kv/kubernetes/namespace/repospawner/default/oauth-credentials
|
||||
keys: client_id, client_secret, cookie_secret
|
||||
client_id: created
|
||||
client_secret: kept
|
||||
cookie_secret: created
|
||||
version: 4
|
||||
```
|
||||
|
||||
That is the common case: the provider's `client_secret` already lives on the
|
||||
path, so only the missing keys are added. A run with nothing to do prints
|
||||
`version: unchanged` and issues no write.
|
||||
|
||||
Flags: `--path` and `--client-id` are required; `--kv-mount` (default `kv`) and
|
||||
`--rotate` override the rest. `--rotate` regenerates both secrets — only use it
|
||||
when the IdP provider's secret is being rotated alongside, since a rotated
|
||||
`client_secret` no longer matches the provider.
|
||||
|
||||
Errors name the failing stage: AppRole login, KV read denied, or KV write
|
||||
denied. Only key names, actions and the KV version are printed.
|
||||
|
||||
## Build & package
|
||||
|
||||
```bash
|
||||
make build # -> dist/agentpr, dist/watchpr
|
||||
make build # -> dist/agentpr, dist/watchpr, dist/agentws, dist/agentvault
|
||||
make test # go test -race ./...
|
||||
make rpm # build + package dist/agent-tools-<version>-1.x86_64.rpm
|
||||
```
|
||||
|
||||
+223
-19
@@ -1,10 +1,16 @@
|
||||
// Command agentpr manages Gitea pull requests and comments as the unkin-agent
|
||||
// user. It obtains a scoped Gitea token from Vault (AppRole login, then reads
|
||||
// gitea/creds/unkin-agent) so actions are attributed to the agent rather than
|
||||
// to whoever runs the tool.
|
||||
// Command agentpr manages Gitea pull requests and comments as an agent user. It
|
||||
// obtains a scoped Gitea token from Vault (AppRole login, then reads
|
||||
// gitea/creds/<AGENT_LOGIN>, or GITEA_CREDS_PATH when set) so actions are
|
||||
// attributed to that agent rather than to whoever runs the tool.
|
||||
//
|
||||
// agentpr pr create --repo owner/repo --base main --head feature --title T --body B
|
||||
// agentpr pr comment --repo owner/repo --pr 12 --body "..."
|
||||
// agentpr pr edit --repo owner/repo --pr 12 --title T --body B
|
||||
// agentpr issue create --repo owner/repo --title T --body B
|
||||
// agentpr issue comment --repo owner/repo --issue 12 --body "..."
|
||||
// agentpr issue edit --repo owner/repo --issue 12 --title T --body B
|
||||
// agentpr issue close --repo owner/repo --issue 12
|
||||
// agentpr issue reopen --repo owner/repo --issue 12
|
||||
// agentpr whoami
|
||||
package main
|
||||
|
||||
@@ -33,14 +39,14 @@ func main() {
|
||||
func newRootCmd() *cobra.Command {
|
||||
root := &cobra.Command{
|
||||
Use: "agentpr",
|
||||
Short: "Manage Gitea PRs and comments as the unkin-agent user.",
|
||||
Long: "agentpr manages Gitea pull requests and comments as unkin-agent, using a\nGitea token minted from Vault (AppRole login + gitea/creds/unkin-agent).",
|
||||
Short: "Manage Gitea PRs, issues and comments as an agent user.",
|
||||
Long: "agentpr manages Gitea pull requests, issues and comments as an agent user,\nusing a Gitea token minted from Vault (AppRole login + gitea/creds/<AGENT_LOGIN>).\nSet AGENT_LOGIN to act as another agent identity, or GITEA_CREDS_PATH to name\nthe Vault creds path outright.",
|
||||
Version: version,
|
||||
SilenceUsage: true,
|
||||
}
|
||||
root.SetVersionTemplate("{{.Version}}\n")
|
||||
|
||||
root.AddCommand(newPRCmd(), newWhoamiCmd(), newVersionCmd())
|
||||
root.AddCommand(newPRCmd(), newIssueCmd(), newWhoamiCmd(), newVersionCmd())
|
||||
return root
|
||||
}
|
||||
|
||||
@@ -56,9 +62,24 @@ func client() (*agent.GiteaClient, error) {
|
||||
func newPRCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "pr",
|
||||
Short: "Create PRs and post PR comments",
|
||||
Short: "Create and edit PRs, and post PR comments",
|
||||
}
|
||||
cmd.AddCommand(newPRCreateCmd(), newPRCommentCmd())
|
||||
cmd.AddCommand(newPRCreateCmd(), newCommentCmd("pr", "PR", "Post a comment on a pull request"), newPREditCmd())
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newIssueCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "issue",
|
||||
Short: "File, edit, close and reopen issues, and post issue comments",
|
||||
}
|
||||
cmd.AddCommand(
|
||||
newIssueCreateCmd(),
|
||||
newCommentCmd("issue", "issue", "Post a comment on an issue"),
|
||||
newIssueEditCmd(),
|
||||
newIssueStateCmd("close", "Close an issue", agent.IssueStateClosed),
|
||||
newIssueStateCmd("reopen", "Reopen a closed issue", agent.IssueStateOpen),
|
||||
)
|
||||
return cmd
|
||||
}
|
||||
|
||||
@@ -103,12 +124,56 @@ func newPRCreateCmd() *cobra.Command {
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newPRCommentCmd() *cobra.Command {
|
||||
// newCommentCmd builds a comment command whose number flag is named numFlag.
|
||||
// Gitea backs every PR with an issue of the same number and serves comments
|
||||
// from the issue endpoint, so `pr comment` and `issue comment` are one command
|
||||
// under two flag names rather than two implementations that could drift.
|
||||
func newCommentCmd(numFlag, noun, short string) *cobra.Command {
|
||||
var repo, body string
|
||||
var pr int
|
||||
var number int
|
||||
cmd := &cobra.Command{
|
||||
Use: "comment",
|
||||
Short: "Post a comment on a pull request",
|
||||
Short: short,
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, name, err := agent.ParseRepo(repo)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if number <= 0 {
|
||||
return fmt.Errorf("--%s must be a positive %s number", numFlag, noun)
|
||||
}
|
||||
if body == "" {
|
||||
return fmt.Errorf("--body is required")
|
||||
}
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cm, err := c.CreateComment(owner+"/"+name, number, body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("comment %d posted on %s/%s#%d\n", cm.ID, owner, name, number)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&repo, "repo", "", "Repository as owner/repo (required)")
|
||||
f.IntVar(&number, numFlag, 0, noun+" number (required)")
|
||||
f.StringVar(&body, "body", "", "Comment body (required)")
|
||||
_ = cmd.MarkFlagRequired("repo")
|
||||
_ = cmd.MarkFlagRequired(numFlag)
|
||||
_ = cmd.MarkFlagRequired("body")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newPREditCmd() *cobra.Command {
|
||||
var repo, title, body string
|
||||
var pr int
|
||||
cmd := &cobra.Command{
|
||||
Use: "edit",
|
||||
Short: "Edit a pull request's title and/or body",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, name, err := agent.ParseRepo(repo)
|
||||
@@ -118,35 +183,174 @@ func newPRCommentCmd() *cobra.Command {
|
||||
if pr <= 0 {
|
||||
return fmt.Errorf("--pr must be a positive PR number")
|
||||
}
|
||||
if body == "" {
|
||||
return fmt.Errorf("--body is required")
|
||||
opts, err := editOptions(cmd, title, body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cm, err := c.CreateComment(owner+"/"+name, pr, body)
|
||||
updated, err := c.EditPR(owner+"/"+name, pr, opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("comment %d posted on %s/%s#%d\n", cm.ID, owner, name, pr)
|
||||
fmt.Printf("#%d %s\n", updated.Number, updated.HTMLURL)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&repo, "repo", "", "Repository as owner/repo (required)")
|
||||
f.IntVar(&pr, "pr", 0, "PR number (required)")
|
||||
f.StringVar(&body, "body", "", "Comment body (required)")
|
||||
f.StringVar(&title, "title", "", "New PR title (unchanged when omitted)")
|
||||
f.StringVar(&body, "body", "", "New PR body (unchanged when omitted)")
|
||||
_ = cmd.MarkFlagRequired("repo")
|
||||
_ = cmd.MarkFlagRequired("pr")
|
||||
_ = cmd.MarkFlagRequired("body")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// editOptions turns the --title/--body flags actually given into an edit
|
||||
// payload. Only the flags present are sent: omitting --title must leave the
|
||||
// title as it is, not blank it.
|
||||
func editOptions(cmd *cobra.Command, title, body string) (agent.EditOptions, error) {
|
||||
var opts agent.EditOptions
|
||||
if cmd.Flags().Changed("title") {
|
||||
// Gitea ignores an empty title, so sending one would report success
|
||||
// while changing nothing.
|
||||
if title == "" {
|
||||
return opts, fmt.Errorf("--title cannot be empty: a title can be set but not cleared")
|
||||
}
|
||||
opts.Title = &title
|
||||
}
|
||||
if cmd.Flags().Changed("body") {
|
||||
opts.Body = &body
|
||||
}
|
||||
if opts.Title == nil && opts.Body == nil {
|
||||
return opts, fmt.Errorf("at least one of --title or --body is required")
|
||||
}
|
||||
return opts, nil
|
||||
}
|
||||
|
||||
func newIssueCreateCmd() *cobra.Command {
|
||||
var repo, title, body string
|
||||
cmd := &cobra.Command{
|
||||
Use: "create",
|
||||
Short: "File an issue",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, name, err := agent.ParseRepo(repo)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if title == "" {
|
||||
return fmt.Errorf("--title is required")
|
||||
}
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
issue, err := c.CreateIssue(owner+"/"+name, agent.CreateIssueOptions{
|
||||
Title: title,
|
||||
Body: body,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("#%d %s\n", issue.Number, issue.HTMLURL)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&repo, "repo", "", "Repository as owner/repo (required)")
|
||||
f.StringVar(&title, "title", "", "Issue title (required)")
|
||||
f.StringVar(&body, "body", "", "Issue body")
|
||||
_ = cmd.MarkFlagRequired("repo")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newIssueEditCmd() *cobra.Command {
|
||||
var repo, title, body string
|
||||
var issue int
|
||||
cmd := &cobra.Command{
|
||||
Use: "edit",
|
||||
Short: "Edit an issue's title and/or body",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, name, err := agent.ParseRepo(repo)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if issue <= 0 {
|
||||
return fmt.Errorf("--issue must be a positive issue number")
|
||||
}
|
||||
opts, err := editOptions(cmd, title, body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
updated, err := c.EditIssue(owner+"/"+name, issue, opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("#%d %s\n", updated.Number, updated.HTMLURL)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&repo, "repo", "", "Repository as owner/repo (required)")
|
||||
f.IntVar(&issue, "issue", 0, "Issue number (required)")
|
||||
f.StringVar(&title, "title", "", "New issue title (unchanged when omitted)")
|
||||
f.StringVar(&body, "body", "", "New issue body (unchanged when omitted)")
|
||||
_ = cmd.MarkFlagRequired("repo")
|
||||
_ = cmd.MarkFlagRequired("issue")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// newIssueStateCmd builds `issue close` and `issue reopen`, which differ only
|
||||
// in the state they ask for. An issue already in that state is an error, not a
|
||||
// silent success: Gitea answers the PATCH with 200 either way.
|
||||
func newIssueStateCmd(use, short, state string) *cobra.Command {
|
||||
var repo string
|
||||
var issue int
|
||||
cmd := &cobra.Command{
|
||||
Use: use,
|
||||
Short: short,
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, name, err := agent.ParseRepo(repo)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if issue <= 0 {
|
||||
return fmt.Errorf("--issue must be a positive issue number")
|
||||
}
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
updated, err := c.SetIssueState(owner+"/"+name, issue, state)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("#%d %s %s\n", updated.Number, updated.State, updated.HTMLURL)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&repo, "repo", "", "Repository as owner/repo (required)")
|
||||
f.IntVar(&issue, "issue", 0, "Issue number (required)")
|
||||
_ = cmd.MarkFlagRequired("repo")
|
||||
_ = cmd.MarkFlagRequired("issue")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newWhoamiCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "whoami",
|
||||
Short: "Print the authenticated Gitea login (should be unkin-agent)",
|
||||
Short: "Print the authenticated Gitea login (the identity PRs are opened as)",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
c, err := client()
|
||||
|
||||
@@ -2,7 +2,10 @@ package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// A malformed --repo must fail the command (so main exits non-zero). ParseRepo
|
||||
@@ -16,3 +19,186 @@ func TestExecuteBadRepoErrors(t *testing.T) {
|
||||
t.Fatal("Execute() = nil, want error for a malformed --repo")
|
||||
}
|
||||
}
|
||||
|
||||
// `pr edit` with neither --title nor --body has nothing to send; it must fail
|
||||
// with a usage error before any Vault/Gitea call, so this stays hermetic.
|
||||
func TestPREditRequiresTitleOrBody(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"pr", "edit", "--repo", "unkin/repo", "--pr", "7"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when neither --title nor --body is given")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--title or --body") {
|
||||
t.Errorf("error = %q, want it to name the missing flags", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Gitea silently ignores an empty title, so `pr edit --title ""` would report
|
||||
// success while changing nothing; it must fail before any Vault/Gitea call.
|
||||
func TestPREditRejectsEmptyTitle(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"pr", "edit", "--repo", "unkin/repo", "--pr", "7", "--title", ""})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error for an empty --title")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--title cannot be empty") {
|
||||
t.Errorf("error = %q, want it to reject the empty title", err)
|
||||
}
|
||||
}
|
||||
|
||||
// execute runs the command tree with args, discarding output, so tests assert
|
||||
// on the error alone. Every case here fails before any Vault/Gitea call.
|
||||
func execute(args ...string) error {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs(args)
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
return cmd.Execute()
|
||||
}
|
||||
|
||||
// An issue needs a title; Gitea rejects an empty one, so the command must too.
|
||||
func TestIssueCreateRequiresTitle(t *testing.T) {
|
||||
err := execute("issue", "create", "--repo", "unkin/repo", "--body", "b")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when --title is missing")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--title is required") {
|
||||
t.Errorf("error = %q, want it to name the missing flag", err)
|
||||
}
|
||||
}
|
||||
|
||||
// --repo is required, and cobra must reject its absence before anything reaches
|
||||
// for a token.
|
||||
func TestIssueCreateRequiresRepo(t *testing.T) {
|
||||
err := execute("issue", "create", "--title", "t")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when --repo is missing")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "repo") {
|
||||
t.Errorf("error = %q, want it to name the missing flag", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIssueCreateBadRepoErrors(t *testing.T) {
|
||||
if err := execute("issue", "create", "--repo", "not-a-repo", "--title", "t"); err == nil {
|
||||
t.Fatal("Execute() = nil, want error for a malformed --repo")
|
||||
}
|
||||
}
|
||||
|
||||
// `issue comment` addresses the issue by --issue, not --pr, and needs it.
|
||||
func TestIssueCommentRequiresIssueNumber(t *testing.T) {
|
||||
err := execute("issue", "comment", "--repo", "unkin/repo", "--body", "hi")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when --issue is missing")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "issue") {
|
||||
t.Errorf("error = %q, want it to name the missing --issue flag", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIssueEditRequiresTitleOrBody(t *testing.T) {
|
||||
err := execute("issue", "edit", "--repo", "unkin/repo", "--issue", "12")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when neither --title nor --body is given")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--title or --body") {
|
||||
t.Errorf("error = %q, want it to name the missing flags", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIssueEditRejectsEmptyTitle(t *testing.T) {
|
||||
err := execute("issue", "edit", "--repo", "unkin/repo", "--issue", "12", "--title", "")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error for an empty --title")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--title cannot be empty") {
|
||||
t.Errorf("error = %q, want it to reject the empty title", err)
|
||||
}
|
||||
}
|
||||
|
||||
// PRs and issues share Gitea's comment endpoint, so both comment commands are
|
||||
// built from one constructor: they must stay identical apart from the flag
|
||||
// naming the number.
|
||||
func TestCommentCommandsStayInStep(t *testing.T) {
|
||||
find := func(group string) *cobra.Command {
|
||||
t.Helper()
|
||||
cmd, _, err := newRootCmd().Find([]string{group, "comment"})
|
||||
if err != nil || cmd.Name() != "comment" {
|
||||
t.Fatalf("%s comment not found: %v", group, err)
|
||||
}
|
||||
return cmd
|
||||
}
|
||||
has := func(cmd *cobra.Command, name string) bool { return cmd.Flags().Lookup(name) != nil }
|
||||
|
||||
prCmd, issueCmd := find("pr"), find("issue")
|
||||
for _, name := range []string{"repo", "body"} {
|
||||
if !has(prCmd, name) || !has(issueCmd, name) {
|
||||
t.Errorf("--%s missing: pr=%t issue=%t", name, has(prCmd, name), has(issueCmd, name))
|
||||
}
|
||||
}
|
||||
if !has(prCmd, "pr") || has(prCmd, "issue") {
|
||||
t.Error("pr comment must take --pr and only --pr")
|
||||
}
|
||||
if !has(issueCmd, "issue") || has(issueCmd, "pr") {
|
||||
t.Error("issue comment must take --issue and only --issue")
|
||||
}
|
||||
}
|
||||
|
||||
// Both state commands need a repo and an issue number; cobra and the RunE
|
||||
// guard must reject their absence before anything reaches for a token.
|
||||
func TestIssueStateCommandsRequireFlags(t *testing.T) {
|
||||
for _, verb := range []string{"close", "reopen"} {
|
||||
t.Run(verb+" without --issue", func(t *testing.T) {
|
||||
err := execute("issue", verb, "--repo", "unkin/repo")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when --issue is missing")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "issue") {
|
||||
t.Errorf("error = %q, want it to name the missing --issue flag", err)
|
||||
}
|
||||
})
|
||||
t.Run(verb+" without --repo", func(t *testing.T) {
|
||||
err := execute("issue", verb, "--issue", "12")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error when --repo is missing")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "repo") {
|
||||
t.Errorf("error = %q, want it to name the missing --repo flag", err)
|
||||
}
|
||||
})
|
||||
t.Run(verb+" with a zero --issue", func(t *testing.T) {
|
||||
err := execute("issue", verb, "--repo", "unkin/repo", "--issue", "0")
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want an error for a non-positive issue number")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--issue must be a positive") {
|
||||
t.Errorf("error = %q, want it to reject the issue number", err)
|
||||
}
|
||||
})
|
||||
t.Run(verb+" with a malformed --repo", func(t *testing.T) {
|
||||
if err := execute("issue", verb, "--repo", "not-a-repo", "--issue", "12"); err == nil {
|
||||
t.Fatal("Execute() = nil, want error for a malformed --repo")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Closing and reopening are issue-only: a PR is closed by a human, so the pr
|
||||
// group must not grow these verbs by accident.
|
||||
func TestPRHasNoStateCommands(t *testing.T) {
|
||||
for _, verb := range []string{"close", "reopen"} {
|
||||
if cmd, _, err := newRootCmd().Find([]string{"pr", verb}); err == nil && cmd.Name() == verb {
|
||||
t.Errorf("pr %s exists; closing a PR is not agentpr's to do", verb)
|
||||
}
|
||||
cmd, _, err := newRootCmd().Find([]string{"issue", verb})
|
||||
if err != nil || cmd.Name() != verb {
|
||||
t.Fatalf("issue %s not found: %v", verb, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,127 @@
|
||||
// Command agentvault runs deterministic Vault flows for agents in a single
|
||||
// invocation, so credentials are never plumbed through a shell. It authenticates
|
||||
// with the same Vault AppRole as agentpr (role_id only, no secret_id).
|
||||
//
|
||||
// agentvault seed-outpost --outpost <name> --dest-path <kv/path>
|
||||
// agentvault seed-oauth --path <kv/path> --client-id <id>
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"git.unkin.net/unkin/agent-tools/internal/agent"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
var version = "dev"
|
||||
|
||||
func main() {
|
||||
if err := newRootCmd().Execute(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
// newRootCmd builds the agentvault command tree. Separated from main so tests
|
||||
// can execute it against httptest servers.
|
||||
func newRootCmd() *cobra.Command {
|
||||
root := &cobra.Command{
|
||||
Use: "agentvault",
|
||||
Short: "Run deterministic Vault flows as the agent AppRole.",
|
||||
Long: "agentvault performs self-contained Vault flows for agents: it logs in with the\nagent AppRole and moves secret material between systems without ever printing it.",
|
||||
Version: version,
|
||||
SilenceUsage: true,
|
||||
}
|
||||
root.SetVersionTemplate("{{.Version}}\n")
|
||||
root.AddCommand(newSeedOutpostCmd(), newSeedOAuthCmd(), newVersionCmd())
|
||||
return root
|
||||
}
|
||||
|
||||
func newSeedOutpostCmd() *cobra.Command {
|
||||
opts := agent.SeedOutpostOptions{}
|
||||
cmd := &cobra.Command{
|
||||
Use: "seed-outpost",
|
||||
Short: "Copy an Authentik outpost token into Vault KV",
|
||||
Long: "Read the Authentik API token from Vault KV, resolve the named outpost's\n" +
|
||||
"token_identifier, fetch its key and write it to a Vault KV path. Re-running\n" +
|
||||
"writes a new KV version. The token value is never printed or logged.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.VaultAddr = agent.VaultAddr()
|
||||
opts.RoleID = agent.RoleID()
|
||||
res, err := agent.SeedOutpost(opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
out := cmd.OutOrStdout()
|
||||
_, _ = fmt.Fprintf(out, "outpost: %s\n", res.Outpost)
|
||||
_, _ = fmt.Fprintf(out, "token_identifier: %s\n", res.TokenIdentifier)
|
||||
_, _ = fmt.Fprintf(out, "dest: %s/%s\n", res.KVMount, res.DestPath)
|
||||
_, _ = fmt.Fprintf(out, "version: %d\n", res.Version)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&opts.Outpost, "outpost", "", "Authentik outpost name (required)")
|
||||
f.StringVar(&opts.DestPath, "dest-path", "", "KV-v2 path to write the token to, e.g. kubernetes/namespace/authentik/default/outpost-token (required)")
|
||||
f.StringVar(&opts.DestKey, "dest-key", agent.DefaultDestKey, "Field to write the token under")
|
||||
f.StringVar(&opts.KVMount, "kv-mount", agent.DefaultKVMount, "KV-v2 mount holding both the API token and the destination")
|
||||
f.StringVar(&opts.TokenPath, "token-path", agent.DefaultOutpostTokenPath, "KV-v2 path of the Authentik API token")
|
||||
f.StringVar(&opts.AuthentikURL, "authentik-url", agent.AuthentikURL(), "Authentik base URL")
|
||||
_ = cmd.MarkFlagRequired("outpost")
|
||||
_ = cmd.MarkFlagRequired("dest-path")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newSeedOAuthCmd() *cobra.Command {
|
||||
opts := agent.SeedOAuthOptions{}
|
||||
cmd := &cobra.Command{
|
||||
Use: "seed-oauth",
|
||||
Short: "Seed an oauth2-proxy credential set into Vault KV",
|
||||
Long: "Make a Vault KV-v2 path hold a complete oauth2-proxy credential set: the\n" +
|
||||
"given client_id, plus a client_secret and a 32-byte cookie_secret that are\n" +
|
||||
"generated only when missing (or with --rotate). Existing keys are preserved\n" +
|
||||
"and nothing is written when the secret is already correct. Secret values are\n" +
|
||||
"never printed or logged.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.VaultAddr = agent.VaultAddr()
|
||||
opts.RoleID = agent.RoleID()
|
||||
res, err := agent.SeedOAuth(opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
out := cmd.OutOrStdout()
|
||||
_, _ = fmt.Fprintf(out, "path: %s/%s\n", res.KVMount, res.Path)
|
||||
_, _ = fmt.Fprintf(out, "keys: %s\n", strings.Join(res.KeyNames(), ", "))
|
||||
for _, k := range res.Keys {
|
||||
_, _ = fmt.Fprintf(out, " %-14s %s\n", k.Name+":", k.Action)
|
||||
}
|
||||
if res.Changed {
|
||||
_, _ = fmt.Fprintf(out, "version: %d\n", res.Version)
|
||||
} else {
|
||||
_, _ = fmt.Fprintf(out, "version: unchanged\n")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&opts.Path, "path", "", "KV-v2 path holding the credentials, e.g. kubernetes/namespace/repospawner/default/oauth-credentials (required)")
|
||||
f.StringVar(&opts.ClientID, "client-id", "", "OIDC client id to store (required)")
|
||||
f.StringVar(&opts.KVMount, "kv-mount", agent.DefaultKVMount, "KV-v2 mount holding the path")
|
||||
f.BoolVar(&opts.Rotate, "rotate", false, "Regenerate client_secret and cookie_secret even when they already exist")
|
||||
_ = cmd.MarkFlagRequired("path")
|
||||
_ = cmd.MarkFlagRequired("client-id")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newVersionCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "Print the version",
|
||||
Run: func(cmd *cobra.Command, args []string) { fmt.Println(version) },
|
||||
SilenceUsage: true,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,180 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const (
|
||||
apiToken = "ak-api-token-secret"
|
||||
outpostKey = "outpost-key-secret"
|
||||
destPath = "kubernetes/namespace/authentik/default/outpost-token"
|
||||
)
|
||||
|
||||
// fakeEstate serves the Vault (approle + KV-v2 read/write) and Authentik
|
||||
// (outpost search + view_key) endpoints the seed flow needs.
|
||||
func fakeEstate(t *testing.T) (vaultURL, authentikURL string) {
|
||||
t.Helper()
|
||||
vmux := http.NewServeMux()
|
||||
vmux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"s.vaulttoken"}}`)
|
||||
})
|
||||
vmux.HandleFunc("/v1/kv/data/service/authentik/agent-api-token", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"data":{"data":{"token":"`+apiToken+`"}}}`)
|
||||
})
|
||||
vmux.HandleFunc("/v1/kv/data/"+destPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"data":{"version":7}}`)
|
||||
})
|
||||
vs := httptest.NewServer(vmux)
|
||||
t.Cleanup(vs.Close)
|
||||
|
||||
amux := http.NewServeMux()
|
||||
amux.HandleFunc("/api/v3/outposts/instances/", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"results":[{"pk":"1","name":"k8s-outpost","token_identifier":"ak-outpost-k8s"}]}`)
|
||||
})
|
||||
amux.HandleFunc("/api/v3/core/tokens/ak-outpost-k8s/view_key/", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"key":"`+outpostKey+`"}`)
|
||||
})
|
||||
as := httptest.NewServer(amux)
|
||||
t.Cleanup(as.Close)
|
||||
|
||||
return vs.URL, as.URL
|
||||
}
|
||||
|
||||
// The command prints identifiers and the KV version only — never a secret.
|
||||
func TestSeedOutpostOutputHasNoSecrets(t *testing.T) {
|
||||
vaultURL, authentikURL := fakeEstate(t)
|
||||
t.Setenv("VAULT_ADDR", vaultURL)
|
||||
t.Setenv("AGENT_APPROLE_ROLE_ID", "role-xyz")
|
||||
|
||||
var out bytes.Buffer
|
||||
cmd := newRootCmd()
|
||||
cmd.SetOut(&out)
|
||||
cmd.SetErr(&out)
|
||||
cmd.SetArgs([]string{
|
||||
"seed-outpost",
|
||||
"--outpost", "k8s-outpost",
|
||||
"--dest-path", destPath,
|
||||
"--authentik-url", authentikURL,
|
||||
})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("Execute: %v", err)
|
||||
}
|
||||
|
||||
got := out.String()
|
||||
for _, want := range []string{"k8s-outpost", "ak-outpost-k8s", "kv/" + destPath, "version: 7"} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Errorf("output missing %q:\n%s", want, got)
|
||||
}
|
||||
}
|
||||
for _, secret := range []string{apiToken, outpostKey} {
|
||||
if strings.Contains(got, secret) {
|
||||
t.Fatalf("output leaks a secret:\n%s", got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const oauthPath = "kubernetes/namespace/repospawner/default/oauth-credentials"
|
||||
|
||||
// fakeOAuthVault serves approle login plus a KV-v2 path that already holds a
|
||||
// client_secret, and records what gets written back.
|
||||
func fakeOAuthVault(t *testing.T, existing map[string]string) (vaultURL string, written *map[string]string) {
|
||||
t.Helper()
|
||||
writes := map[string]string{}
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"s.vaulttoken"}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/kv/data/"+oauthPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method == http.MethodPost {
|
||||
var body struct {
|
||||
Data map[string]string `json:"data"`
|
||||
}
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
for k, v := range body.Data {
|
||||
writes[k] = v
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"data":{"version":4}}`)
|
||||
return
|
||||
}
|
||||
payload, _ := json.Marshal(map[string]any{"data": map[string]any{"data": existing}})
|
||||
_, _ = w.Write(payload)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
t.Cleanup(srv.Close)
|
||||
return srv.URL, &writes
|
||||
}
|
||||
|
||||
// The command prints key names and the KV version only — never a value.
|
||||
func TestSeedOAuthOutputHasNoSecrets(t *testing.T) {
|
||||
const existingSecret = "existing-client-secret-value"
|
||||
vaultURL, written := fakeOAuthVault(t, map[string]string{"client_secret": existingSecret})
|
||||
t.Setenv("VAULT_ADDR", vaultURL)
|
||||
t.Setenv("AGENT_APPROLE_ROLE_ID", "role-xyz")
|
||||
|
||||
var out bytes.Buffer
|
||||
cmd := newRootCmd()
|
||||
cmd.SetOut(&out)
|
||||
cmd.SetErr(&out)
|
||||
cmd.SetArgs([]string{"seed-oauth", "--path", oauthPath, "--client-id", "mediamark-client-id"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("Execute: %v", err)
|
||||
}
|
||||
|
||||
got := out.String()
|
||||
for _, want := range []string{"kv/" + oauthPath, "client_id, client_secret, cookie_secret", "client_secret: kept", "cookie_secret: created", "version: 4"} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Errorf("output missing %q:\n%s", want, got)
|
||||
}
|
||||
}
|
||||
for key, value := range *written {
|
||||
if key == "client_id" {
|
||||
continue
|
||||
}
|
||||
if strings.Contains(got, value) {
|
||||
t.Fatalf("output leaks the %s value:\n%s", key, got)
|
||||
}
|
||||
}
|
||||
if strings.Contains(got, existingSecret) {
|
||||
t.Fatalf("output leaks the existing client_secret:\n%s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthRequiresFlags(t *testing.T) {
|
||||
for name, args := range map[string][]string{
|
||||
"no path": {"seed-oauth", "--client-id", "mediamark-client-id"},
|
||||
"no client-id": {"seed-oauth", "--path", oauthPath},
|
||||
} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
cmd.SetArgs(args)
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("Execute() = nil, want a missing-required-flag error")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostRequiresFlags(t *testing.T) {
|
||||
for name, args := range map[string][]string{
|
||||
"no outpost": {"seed-outpost", "--dest-path", destPath},
|
||||
"no dest-path": {"seed-outpost", "--outpost", "k8s-outpost"},
|
||||
} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
cmd.SetArgs(args)
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("Execute() = nil, want a missing-required-flag error")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,810 @@
|
||||
// Command agentws (agentic workspace) manages git worktrees for the unkin-agent
|
||||
// user so agents can work on isolated branches without disturbing Ben's shared
|
||||
// checkouts.
|
||||
//
|
||||
// Repositories are cloned into the source root (default ~/src/prodenv/<repo>) so
|
||||
// branches created here are visible in the main checkout too. Worktrees live
|
||||
// under the worktree root (default ~/.cache/agentws/<repo>__<branch>). Auth for
|
||||
// clone/fetch/push comes from a short-lived Gitea token minted from Vault via
|
||||
// agent.GiteaToken(); it is supplied through an ephemeral git credential helper
|
||||
// (`agentws credential get`) rather than being persisted in any remote URL or
|
||||
// config, since the tokens expire in about an hour.
|
||||
//
|
||||
// agentws new <repo> [--branch benvin/<name>] [--from <base-branch>]
|
||||
// agentws list
|
||||
// agentws rm <path-or-branch> [--delete-branch]
|
||||
// agentws prune [--yes] [--keep-branches] [--no-fetch] [--json]
|
||||
// [--include-unmanaged] [--include-keep]
|
||||
// agentws clean
|
||||
// agentws token
|
||||
// agentws credential get # git credential-helper protocol on stdin
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"git.unkin.net/unkin/agent-tools/internal/agent"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
var version = "dev"
|
||||
|
||||
func main() {
|
||||
if err := newRootCmd().Execute(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
// newRootCmd builds the agentws command tree. Separated from main so tests can
|
||||
// invoke Execute and assert behaviour without spawning a process.
|
||||
func newRootCmd() *cobra.Command {
|
||||
root := &cobra.Command{
|
||||
Use: "agentws",
|
||||
Short: "Manage git worktrees for the unkin-agent user.",
|
||||
Long: "agentws manages per-branch git worktrees for unkin-agent. Repos are cloned into\nthe source root (~/src/prodenv) and worktrees live under the worktree root\n(~/.cache/agentws), authenticated by an ephemeral Vault-minted Gitea token.",
|
||||
Version: version,
|
||||
SilenceUsage: true,
|
||||
}
|
||||
root.SetVersionTemplate("{{.Version}}\n")
|
||||
root.AddCommand(
|
||||
newNewCmd(),
|
||||
newListCmd(),
|
||||
newRmCmd(),
|
||||
newPruneCmd(),
|
||||
newCleanCmd(),
|
||||
newTokenCmd(),
|
||||
newCredentialCmd(),
|
||||
newVersionCmd(),
|
||||
)
|
||||
return root
|
||||
}
|
||||
|
||||
// --- configuration (env-overridable) --------------------------------------
|
||||
|
||||
// srcRoot is where source-of-truth checkouts live (default ~/src/prodenv).
|
||||
func srcRoot() (string, error) {
|
||||
if v := os.Getenv("AGENTWS_SRC_ROOT"); v != "" {
|
||||
return v, nil
|
||||
}
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return filepath.Join(home, "src", "prodenv"), nil
|
||||
}
|
||||
|
||||
// worktreeRoot is where managed worktrees live (default ~/.cache/agentws).
|
||||
func worktreeRoot() (string, error) {
|
||||
if v := os.Getenv("AGENTWS_ROOT"); v != "" {
|
||||
return v, nil
|
||||
}
|
||||
cache, err := os.UserCacheDir()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return filepath.Join(cache, "agentws"), nil
|
||||
}
|
||||
|
||||
// owner is the Gitea org that owns the repos (default unkin).
|
||||
func owner() string {
|
||||
if v := os.Getenv("AGENTWS_OWNER"); v != "" {
|
||||
return v
|
||||
}
|
||||
return "unkin"
|
||||
}
|
||||
|
||||
// cloneURL builds the (token-free) HTTPS clone URL for a repo.
|
||||
func cloneURL(repo string) string {
|
||||
return strings.TrimRight(agent.GiteaURL(), "/") + "/" + owner() + "/" + repo + ".git"
|
||||
}
|
||||
|
||||
// credentialHelperArgs returns git global args that wire this binary as an
|
||||
// ephemeral credential helper, so clone/fetch/push authenticate without
|
||||
// persisting a token anywhere.
|
||||
func credentialHelperArgs() []string {
|
||||
exe, err := os.Executable()
|
||||
if err != nil || exe == "" {
|
||||
exe = "agentws"
|
||||
}
|
||||
return []string{"-c", "credential.helper=!" + exe + " credential"}
|
||||
}
|
||||
|
||||
// --- new ------------------------------------------------------------------
|
||||
|
||||
func newNewCmd() *cobra.Command {
|
||||
var branch, from string
|
||||
cmd := &cobra.Command{
|
||||
Use: "new <repo>",
|
||||
Short: "Clone (if needed) and create a worktree for a branch",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
repo := strings.TrimSpace(args[0])
|
||||
if repo == "" || strings.Contains(repo, "/") {
|
||||
return fmt.Errorf("repo must be a bare repository name (owner comes from AGENTWS_OWNER, default %q)", owner())
|
||||
}
|
||||
if branch == "" {
|
||||
return fmt.Errorf("--branch is required (e.g. benvin/<name>)")
|
||||
}
|
||||
|
||||
sr, err := srcRoot()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
wr, err := worktreeRoot()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
srcDir := filepath.Join(sr, repo)
|
||||
auth := credentialHelperArgs()
|
||||
|
||||
// a. Clone the source-of-truth checkout if missing.
|
||||
if _, statErr := os.Stat(srcDir); statErr != nil {
|
||||
if !os.IsNotExist(statErr) {
|
||||
return statErr
|
||||
}
|
||||
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "cloning %s into %s\n", cloneURL(repo), srcDir)
|
||||
if err := agent.GitClone(cloneURL(repo), srcDir, auth...); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// b. Refresh so the base branch is current.
|
||||
if err := agent.GitFetch(srcDir, "origin", auth...); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// c. A branch origin already has is work in progress and must be
|
||||
// checked out as it stands; only a branch origin does not have is
|
||||
// forked from a base.
|
||||
onRemote := agent.GitRemoteBranchExists(srcDir, "origin", branch)
|
||||
startPoint := "origin/" + branch
|
||||
base := from
|
||||
if onRemote {
|
||||
if from != "" {
|
||||
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "note: --from %s ignored, origin/%s already exists\n", from, branch)
|
||||
}
|
||||
} else {
|
||||
if base == "" {
|
||||
base, err = agent.GitRemoteDefaultBranch(srcDir, "origin")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
startPoint = "origin/" + base
|
||||
}
|
||||
|
||||
// d. Create the worktree FROM the source checkout so the branch is
|
||||
// visible in the main checkout too.
|
||||
wtPath := filepath.Join(wr, agent.WorktreeDirName(repo, branch))
|
||||
if _, statErr := os.Stat(wtPath); statErr == nil {
|
||||
return fmt.Errorf("worktree already exists at %s", wtPath)
|
||||
}
|
||||
if err := agent.GitWorktreeAdd(srcDir, wtPath, branch, startPoint); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// e. Set the agent identity + auth WITHOUT polluting the shared
|
||||
// checkout: per-worktree config only.
|
||||
if err := agent.GitConfigSet(srcDir, false, "extensions.worktreeConfig", "true"); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := agent.GitConfigSet(wtPath, true, "user.name", agent.AgentLogin()); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := agent.GitConfigSet(wtPath, true, "user.email", agent.AgentLogin()+"@unkin.net"); err != nil {
|
||||
return err
|
||||
}
|
||||
exe, _ := os.Executable()
|
||||
if exe == "" {
|
||||
exe = "agentws"
|
||||
}
|
||||
if err := agent.GitConfigSet(wtPath, true, "credential.helper", "!"+exe+" credential"); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// f. A local branch left from an earlier run may sit behind origin,
|
||||
// so reusing it is not enough on its own.
|
||||
summary := fmt.Sprintf("branch %s (new, from origin/%s)", branch, base)
|
||||
if onRemote {
|
||||
summary, err = alignToRemote(cmd.OutOrStdout(), wtPath, branch)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// g. Report the worktree path and which of the two paths was taken.
|
||||
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "%s\n", wtPath)
|
||||
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "%s\n", summary)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&branch, "branch", "", "Branch to check out/create (e.g. benvin/<name>) (required)")
|
||||
f.StringVar(&from, "from", "", "Base branch to branch from (default: remote default branch)")
|
||||
_ = cmd.MarkFlagRequired("branch")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// alignToRemote puts the worktree on origin/<branch> and reports what that took.
|
||||
// A reused local branch can be stale, and a fast-forward is the only move that
|
||||
// adds no commit and drops none; a local branch carrying commits origin does not
|
||||
// have is left where it stands, because those commits exist nowhere else.
|
||||
func alignToRemote(out io.Writer, wtPath, branch string) (string, error) {
|
||||
remoteRef := "origin/" + branch
|
||||
want, err := agent.GitRevParse(wtPath, remoteRef)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
head, err := agent.GitRevParse(wtPath, "HEAD")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if head != want {
|
||||
ahead, err := agent.GitAheadCount(wtPath, remoteRef, "HEAD")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if ahead > 0 {
|
||||
return fmt.Sprintf("branch %s (local, %s not on %s, left at %s)",
|
||||
branch, commitCount(ahead), remoteRef, shortSHA(head)), nil
|
||||
}
|
||||
if err := agent.GitMergeFFOnly(wtPath, remoteRef); err != nil {
|
||||
return "", err
|
||||
}
|
||||
_, _ = fmt.Fprintf(out, "fast-forwarded stale %s to %s\n", branch, remoteRef)
|
||||
}
|
||||
if err := agent.GitSetUpstream(wtPath, branch, remoteRef); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return fmt.Sprintf("branch %s (tracking %s at %s)", branch, remoteRef, shortSHA(want)), nil
|
||||
}
|
||||
|
||||
func shortSHA(sha string) string {
|
||||
if len(sha) > 7 {
|
||||
return sha[:7]
|
||||
}
|
||||
return sha
|
||||
}
|
||||
|
||||
// --- list -----------------------------------------------------------------
|
||||
|
||||
func newListCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "List managed worktrees under the worktree root",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
managed, err := managedWorktrees()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
out := cmd.OutOrStdout()
|
||||
if len(managed) == 0 {
|
||||
_, _ = fmt.Fprintln(out, "no managed worktrees")
|
||||
return nil
|
||||
}
|
||||
for _, w := range managed {
|
||||
branch := w.branch
|
||||
switch {
|
||||
case w.orphan:
|
||||
branch = "(orphan)"
|
||||
case w.inspectErr != nil:
|
||||
branch = "(unreadable)"
|
||||
}
|
||||
_, _ = fmt.Fprintf(out, "%s\t%s\t%s\n", w.repo, branch, w.path)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// managedWt describes one worktree living under the worktree root.
|
||||
type managedWt struct {
|
||||
repo string
|
||||
branch string
|
||||
path string
|
||||
srcDir string
|
||||
// managed is false for worktrees found via `git worktree list` that live
|
||||
// outside the worktree root, i.e. somebody made them by hand.
|
||||
managed bool
|
||||
// detached is true when the worktree has no branch to fall back on, so its
|
||||
// commits die with the checkout.
|
||||
detached bool
|
||||
// locked records git's own "do not remove me" marker.
|
||||
locked bool
|
||||
// missing is a registration whose working tree is gone: nothing to inspect,
|
||||
// nothing to lose.
|
||||
missing bool
|
||||
// orphan is a directory under the worktree root whose backing git dir is
|
||||
// proven gone, so no git state can be read from it ever again.
|
||||
orphan bool
|
||||
// inspectErr is set when git refused to answer for a checkout and the reason
|
||||
// was not a proven-absent backing repo. The state is unknown, never removable.
|
||||
inspectErr error
|
||||
}
|
||||
|
||||
// managedWorktrees scans the worktree root and resolves each entry's repo and
|
||||
// branch from git so branch names are accurate (not the sanitized dir name).
|
||||
// Directories whose backing repo is proven gone are returned as orphans rather
|
||||
// than dropped, so callers can see (and clean up) the leftovers; a directory git
|
||||
// merely failed to answer for is returned with its error instead, because an
|
||||
// unread state must never be mistaken for a dead one.
|
||||
func managedWorktrees() ([]managedWt, error) {
|
||||
wr, err := worktreeRoot()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
entries, err := os.ReadDir(wr)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil, nil
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
var out []managedWt
|
||||
for _, e := range entries {
|
||||
if !e.IsDir() {
|
||||
continue
|
||||
}
|
||||
path := filepath.Join(wr, e.Name())
|
||||
if _, err := os.Stat(filepath.Join(path, ".git")); err != nil {
|
||||
continue // not a worktree checkout at all
|
||||
}
|
||||
branch, branchErr := agent.GitCurrentBranch(path)
|
||||
srcDir, srcErr := agent.SourceRepoDir(path)
|
||||
if branchErr != nil || srcErr != nil {
|
||||
entry := managedWt{repo: repoFromDirName(e.Name()), path: path, managed: true}
|
||||
if gone, err := backingRepoGone(path); err == nil && gone {
|
||||
entry.orphan = true
|
||||
} else if branchErr != nil {
|
||||
entry.inspectErr = branchErr
|
||||
} else {
|
||||
entry.inspectErr = srcErr
|
||||
}
|
||||
out = append(out, entry)
|
||||
continue
|
||||
}
|
||||
out = append(out, managedWt{
|
||||
repo: filepath.Base(srcDir),
|
||||
branch: branch,
|
||||
path: path,
|
||||
srcDir: srcDir,
|
||||
managed: true,
|
||||
detached: branch == "HEAD",
|
||||
})
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// backingRepoGone proves, by stat alone, that a worktree directory's backing
|
||||
// repo no longer exists: its .git file names a git dir that is absent, and the
|
||||
// repo's shared .git the git dir lived in is absent too. Only that pair licenses
|
||||
// deleting the directory. Every other outcome — an unreadable .git file, a git
|
||||
// dir still on disk, a stat that failed for any reason other than "not there",
|
||||
// or a mere lost registration in a repo that is still present — reports false,
|
||||
// so a transient or unexplained failure can never be read as "safe to delete".
|
||||
func backingRepoGone(path string) (bool, error) {
|
||||
dot := filepath.Join(path, ".git")
|
||||
info, err := os.Lstat(dot)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
if info.IsDir() {
|
||||
return false, nil // a standalone checkout, not a linked worktree
|
||||
}
|
||||
data, err := os.ReadFile(dot)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
rest, ok := strings.CutPrefix(strings.TrimSpace(string(data)), "gitdir:")
|
||||
if !ok {
|
||||
return false, fmt.Errorf("%s: not a worktree gitdir pointer", dot)
|
||||
}
|
||||
gitDir := strings.TrimSpace(rest)
|
||||
if gitDir == "" {
|
||||
return false, fmt.Errorf("%s: empty gitdir", dot)
|
||||
}
|
||||
if !filepath.IsAbs(gitDir) {
|
||||
gitDir = filepath.Join(path, gitDir)
|
||||
}
|
||||
// The git dir is "<repo>/.git/worktrees/<name>"; both it and the shared .git
|
||||
// it sits in must be absent before the repo counts as gone.
|
||||
for _, dir := range []string{gitDir, filepath.Dir(filepath.Dir(gitDir))} {
|
||||
if _, err := os.Stat(dir); err == nil {
|
||||
return false, nil
|
||||
} else if !os.IsNotExist(err) {
|
||||
return false, err
|
||||
}
|
||||
}
|
||||
return true, nil
|
||||
}
|
||||
|
||||
// repoFromDirName recovers the repo name from the "<repo>__<branch>" layout used
|
||||
// under the worktree root, for entries git can no longer answer for.
|
||||
func repoFromDirName(name string) string {
|
||||
if repo, _, ok := strings.Cut(name, "__"); ok {
|
||||
return repo
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
// allWorktrees is every worktree prune should consider: the managed ones under
|
||||
// the worktree root, plus whatever `git worktree list` reports for the repos
|
||||
// they belong to and for every checkout in the source root. The second source
|
||||
// finds hand-made worktrees and stale registrations whose directory is gone, and
|
||||
// carries git's own locked/prunable flags onto the entries the first source
|
||||
// already found.
|
||||
func allWorktrees() ([]managedWt, error) {
|
||||
managed, err := managedWorktrees()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
wr, err := worktreeRoot()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
out := make([]managedWt, 0, len(managed))
|
||||
index := map[string]int{}
|
||||
for _, w := range managed {
|
||||
index[resolvePath(w.path)] = len(out)
|
||||
out = append(out, w)
|
||||
}
|
||||
|
||||
for _, srcDir := range sourceRepos(managed) {
|
||||
wts, err := agent.GitWorktreeList(srcDir)
|
||||
if err != nil {
|
||||
continue // not a repo any more, or unreadable; managed entries still stand
|
||||
}
|
||||
for _, wt := range wts {
|
||||
if wt.Bare || sameDir(wt.Path, srcDir) {
|
||||
continue
|
||||
}
|
||||
_, statErr := os.Stat(wt.Path)
|
||||
entry := managedWt{
|
||||
repo: filepath.Base(srcDir),
|
||||
branch: worktreeBranch(wt),
|
||||
path: wt.Path,
|
||||
srcDir: srcDir,
|
||||
managed: underRoot(wt.Path, wr),
|
||||
detached: wt.Detached,
|
||||
locked: wt.Locked,
|
||||
missing: wt.Prunable != "" || os.IsNotExist(statErr),
|
||||
}
|
||||
key := resolvePath(wt.Path)
|
||||
if i, ok := index[key]; ok {
|
||||
// Keep the managed scan's own view, but adopt the flags only git knows.
|
||||
out[i].locked = entry.locked
|
||||
out[i].missing = out[i].missing || entry.missing
|
||||
out[i].detached = out[i].detached || entry.detached
|
||||
continue
|
||||
}
|
||||
index[key] = len(out)
|
||||
out = append(out, entry)
|
||||
}
|
||||
}
|
||||
sort.Slice(out, func(i, j int) bool {
|
||||
if out[i].repo != out[j].repo {
|
||||
return out[i].repo < out[j].repo
|
||||
}
|
||||
return out[i].path < out[j].path
|
||||
})
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// resolvePath is a path key that matches however git spells the same directory.
|
||||
func resolvePath(path string) string {
|
||||
if p, err := filepath.EvalSymlinks(path); err == nil {
|
||||
return p
|
||||
}
|
||||
return filepath.Clean(path)
|
||||
}
|
||||
|
||||
// worktreeBranch names a worktree's branch, reporting a detached checkout as
|
||||
// "HEAD" so it reads the same as GitCurrentBranch does.
|
||||
func worktreeBranch(wt agent.Worktree) string {
|
||||
if wt.Branch != "" {
|
||||
return wt.Branch
|
||||
}
|
||||
return "HEAD"
|
||||
}
|
||||
|
||||
// sourceRepos is every repo to enumerate worktrees from: the ones the managed
|
||||
// worktrees point back at, plus every git checkout directly under the source
|
||||
// root (so a repo with only hand-made worktrees is still covered). Each is
|
||||
// normalised to its main checkout, because a directory in the source root may
|
||||
// itself be a linked worktree — enumerating from there would report the repo's
|
||||
// real checkout as a removable worktree of itself.
|
||||
func sourceRepos(managed []managedWt) []string {
|
||||
seen := map[string]bool{}
|
||||
var dirs []string
|
||||
add := func(dir string) {
|
||||
if dir == "" {
|
||||
return
|
||||
}
|
||||
if main, err := agent.SourceRepoDir(dir); err == nil {
|
||||
dir = main
|
||||
}
|
||||
key := resolvePath(dir)
|
||||
if seen[key] {
|
||||
return
|
||||
}
|
||||
seen[key] = true
|
||||
dirs = append(dirs, dir)
|
||||
}
|
||||
for _, w := range managed {
|
||||
add(w.srcDir)
|
||||
}
|
||||
if sr, err := srcRoot(); err == nil {
|
||||
if entries, err := os.ReadDir(sr); err == nil {
|
||||
for _, e := range entries {
|
||||
if !e.IsDir() {
|
||||
continue
|
||||
}
|
||||
dir := filepath.Join(sr, e.Name())
|
||||
if _, err := os.Stat(filepath.Join(dir, ".git")); err == nil {
|
||||
add(dir)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
sort.Strings(dirs)
|
||||
return dirs
|
||||
}
|
||||
|
||||
// sameDir compares two paths after resolving symlinks, because git reports
|
||||
// worktree paths fully resolved while our own paths may not be.
|
||||
func sameDir(a, b string) bool {
|
||||
if a == b {
|
||||
return true
|
||||
}
|
||||
ra, errA := filepath.EvalSymlinks(a)
|
||||
rb, errB := filepath.EvalSymlinks(b)
|
||||
return errA == nil && errB == nil && ra == rb
|
||||
}
|
||||
|
||||
// underRoot reports whether path sits inside root, comparing resolved paths
|
||||
// because git hands back worktree paths with symlinks already resolved.
|
||||
func underRoot(path, root string) bool {
|
||||
if r, err := filepath.EvalSymlinks(root); err == nil {
|
||||
root = r
|
||||
}
|
||||
if p, err := filepath.EvalSymlinks(path); err == nil {
|
||||
path = p
|
||||
}
|
||||
rel, err := filepath.Rel(root, path)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
return rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))
|
||||
}
|
||||
|
||||
// --- rm -------------------------------------------------------------------
|
||||
|
||||
func newRmCmd() *cobra.Command {
|
||||
var deleteBranch bool
|
||||
cmd := &cobra.Command{
|
||||
Use: "rm <path-or-branch>",
|
||||
Short: "Remove a managed worktree and refresh its source repo",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
target := strings.TrimSpace(args[0])
|
||||
wt, err := resolveWorktree(target)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Naming one worktree to delete is explicit, so rm keeps the force fallback.
|
||||
return removeWorktree(cmd.OutOrStdout(), wt, deleteBranch, true)
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolVar(&deleteBranch, "delete-branch", false, "Also delete the local branch after removing the worktree")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// resolveWorktree finds a managed worktree by exact path or by branch name.
|
||||
func resolveWorktree(target string) (managedWt, error) {
|
||||
managed, err := managedWorktrees()
|
||||
if err != nil {
|
||||
return managedWt{}, err
|
||||
}
|
||||
abs, _ := filepath.Abs(target)
|
||||
for _, w := range managed {
|
||||
if w.path == target || w.path == abs || (w.branch != "" && w.branch == target) {
|
||||
return w, nil
|
||||
}
|
||||
}
|
||||
return managedWt{}, fmt.Errorf("no managed worktree matching %q (try `agentws list`)", target)
|
||||
}
|
||||
|
||||
// removeWorktree removes a managed worktree and, when asked, its local branch.
|
||||
// forceBranch overrides git's unmerged-branch guard, so only a caller that
|
||||
// proved the commits survive elsewhere may set it.
|
||||
func removeWorktree(out io.Writer, wt managedWt, deleteBranch, forceBranch bool) error {
|
||||
switch {
|
||||
case wt.inspectErr != nil:
|
||||
// No srcDir to act through and no idea what is in there; --include-keep
|
||||
// must not turn that into a delete.
|
||||
return fmt.Errorf("refusing to remove %s: git state unreadable: %w", wt.path, wt.inspectErr)
|
||||
case wt.orphan:
|
||||
return removeOrphanDir(out, wt)
|
||||
case wt.missing:
|
||||
// The working tree is already gone; only the registration is left.
|
||||
_, _ = fmt.Fprintf(out, "pruned stale registration %s\n", wt.path)
|
||||
return agent.GitWorktreePrune(wt.srcDir)
|
||||
}
|
||||
if err := agent.GitWorktreeRemove(wt.srcDir, wt.path, true); err != nil {
|
||||
return err
|
||||
}
|
||||
_, _ = fmt.Fprintf(out, "removed worktree %s\n", wt.path)
|
||||
if deleteBranch {
|
||||
if err := deleteLocalBranch(wt, forceBranch); err != nil {
|
||||
return err
|
||||
}
|
||||
_, _ = fmt.Fprintf(out, "deleted branch %s\n", wt.branch)
|
||||
}
|
||||
// Refresh the source repo's default branch, then prune.
|
||||
if err := agent.GitFetch(wt.srcDir, "origin", credentialHelperArgs()...); err != nil {
|
||||
return err
|
||||
}
|
||||
return agent.GitWorktreePrune(wt.srcDir)
|
||||
}
|
||||
|
||||
// removeOrphanDir deletes a worktree directory whose backing repo is gone. git
|
||||
// cannot act on it, so this is a plain delete — confined to the worktree root so
|
||||
// a bad path can never reach a real checkout.
|
||||
func removeOrphanDir(out io.Writer, wt managedWt) error {
|
||||
wr, err := worktreeRoot()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !underRoot(wt.path, wr) || sameDir(wt.path, wr) {
|
||||
return fmt.Errorf("refusing to delete %s: not inside the worktree root %s", wt.path, wr)
|
||||
}
|
||||
if err := os.RemoveAll(wt.path); err != nil {
|
||||
return err
|
||||
}
|
||||
_, _ = fmt.Fprintf(out, "deleted orphaned worktree directory %s\n", wt.path)
|
||||
return nil
|
||||
}
|
||||
|
||||
// deleteLocalBranch tries the guarded delete first so git refuses to drop
|
||||
// unmerged commits on its own; force is a fallback, never the first attempt.
|
||||
func deleteLocalBranch(wt managedWt, force bool) error {
|
||||
err := agent.GitDeleteBranch(wt.srcDir, wt.branch, false)
|
||||
if err == nil || !force {
|
||||
return err
|
||||
}
|
||||
return agent.GitDeleteBranch(wt.srcDir, wt.branch, true)
|
||||
}
|
||||
|
||||
// --- clean ----------------------------------------------------------------
|
||||
|
||||
func newCleanCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "clean",
|
||||
Short: "Remove all managed worktrees and prune their source repos",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
managed, err := managedWorktrees()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
out := cmd.OutOrStdout()
|
||||
if len(managed) == 0 {
|
||||
_, _ = fmt.Fprintln(out, "no managed worktrees")
|
||||
return nil
|
||||
}
|
||||
for _, w := range managed {
|
||||
if err := removeWorktree(out, w, false, false); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// --- token ----------------------------------------------------------------
|
||||
|
||||
func newTokenCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "token",
|
||||
Short: "Print a fresh unkin-agent Gitea token",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
tok, err := agent.GiteaToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
_, _ = fmt.Fprintln(cmd.OutOrStdout(), tok)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// --- credential (git credential-helper protocol) --------------------------
|
||||
|
||||
func newCredentialCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "credential <get|store|erase>",
|
||||
Short: "git credential-helper: emit unkin-agent creds for git.unkin.net",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
switch args[0] {
|
||||
case "get":
|
||||
return credentialGet(cmd.InOrStdin(), cmd.OutOrStdout())
|
||||
case "store", "erase":
|
||||
// Nothing to persist/erase for an ephemeral helper; git ignores
|
||||
// empty output and moves on.
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("unknown credential action %q", args[0])
|
||||
}
|
||||
},
|
||||
}
|
||||
return cmd
|
||||
}
|
||||
|
||||
// credentialGet implements the `get` half of the git credential protocol: read
|
||||
// the key=value request on stdin and, for the configured Gitea host, emit a
|
||||
// username/password pair (unkin-agent + a fresh Vault-minted token).
|
||||
func credentialGet(stdin io.Reader, stdout io.Writer) error {
|
||||
req := map[string]string{}
|
||||
sc := bufio.NewScanner(stdin)
|
||||
for sc.Scan() {
|
||||
line := sc.Text()
|
||||
if line == "" {
|
||||
break
|
||||
}
|
||||
if k, v, ok := strings.Cut(line, "="); ok {
|
||||
req[k] = v
|
||||
}
|
||||
}
|
||||
if err := sc.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
// Only answer for the configured Gitea host to avoid handing the token to
|
||||
// any other remote git might ask about.
|
||||
if host := req["host"]; host != "" && host != giteaHost() {
|
||||
return nil
|
||||
}
|
||||
tok, err := agent.GiteaToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
_, _ = fmt.Fprintf(stdout, "username=%s\n", agent.AgentLogin())
|
||||
_, _ = fmt.Fprintf(stdout, "password=%s\n", tok)
|
||||
return nil
|
||||
}
|
||||
|
||||
// giteaHost returns the host portion of the configured Gitea URL.
|
||||
func giteaHost() string {
|
||||
u := agent.GiteaURL()
|
||||
u = strings.TrimPrefix(u, "https://")
|
||||
u = strings.TrimPrefix(u, "http://")
|
||||
if i := strings.IndexByte(u, '/'); i >= 0 {
|
||||
u = u[:i]
|
||||
}
|
||||
return u
|
||||
}
|
||||
|
||||
// --- version --------------------------------------------------------------
|
||||
|
||||
func newVersionCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "Print the version",
|
||||
Run: func(cmd *cobra.Command, args []string) { fmt.Println(version) },
|
||||
SilenceUsage: true,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// `new` with a bad repo name (contains a slash) must fail before any network
|
||||
// call, keeping the test hermetic.
|
||||
func TestNewRejectsOwnerQualifiedRepo(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"new", "unkin/argocd-apps", "--branch", "benvin/x"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("Execute() = nil, want error for owner-qualified repo name")
|
||||
}
|
||||
}
|
||||
|
||||
// `new` without --branch must fail (cobra required-flag check) before any
|
||||
// network call.
|
||||
func TestNewRequiresBranch(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"new", "argocd-apps"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("Execute() = nil, want error when --branch is missing")
|
||||
}
|
||||
}
|
||||
|
||||
// An unknown credential action must fail.
|
||||
func TestCredentialUnknownAction(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"credential", "bogus"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("Execute() = nil, want error for unknown credential action")
|
||||
}
|
||||
}
|
||||
|
||||
// credentialGet must stay silent (and never mint a token) when git asks about a
|
||||
// host other than the configured Gitea host. This exercises the stdin parser
|
||||
// without any network access.
|
||||
func TestCredentialGetIgnoresOtherHost(t *testing.T) {
|
||||
in := strings.NewReader("protocol=https\nhost=github.com\n\n")
|
||||
var out bytes.Buffer
|
||||
if err := credentialGet(in, &out); err != nil {
|
||||
t.Fatalf("credentialGet: %v", err)
|
||||
}
|
||||
if out.Len() != 0 {
|
||||
t.Errorf("expected no output for non-Gitea host, got %q", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestGiteaHost(t *testing.T) {
|
||||
if h := giteaHost(); h != "git.unkin.net" {
|
||||
t.Errorf("giteaHost() = %q, want git.unkin.net", h)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,192 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.unkin.net/unkin/agent-tools/internal/agent"
|
||||
)
|
||||
|
||||
// newFixtureOn builds the same origin/source/worktree-root layout as the prune
|
||||
// fixture but with a chosen default branch, so `new` can be tested against a
|
||||
// repo whose default is not "main".
|
||||
func newFixtureOn(t *testing.T, defBranch string) *fixture {
|
||||
t.Helper()
|
||||
root := t.TempDir()
|
||||
f := &fixture{
|
||||
root: root,
|
||||
bare: filepath.Join(root, "origin.git"),
|
||||
srcDir: filepath.Join(root, "src", "repo"),
|
||||
wtRoot: filepath.Join(root, "worktrees"),
|
||||
}
|
||||
git(t, root, "init", "--bare", "-b", defBranch, f.bare)
|
||||
|
||||
seed := filepath.Join(root, "seed")
|
||||
git(t, root, "init", "-b", defBranch, seed)
|
||||
identity(t, seed)
|
||||
writeCommit(t, seed, "README.md", "hi\n", "init")
|
||||
git(t, seed, "remote", "add", "origin", f.bare)
|
||||
git(t, seed, "push", "-u", "origin", defBranch)
|
||||
|
||||
git(t, root, "clone", f.bare, f.srcDir)
|
||||
identity(t, f.srcDir)
|
||||
|
||||
t.Setenv("AGENTWS_ROOT", f.wtRoot)
|
||||
t.Setenv("AGENTWS_SRC_ROOT", filepath.Join(root, "src"))
|
||||
t.Setenv("AGENTWS_OWNER", "unkin")
|
||||
return f
|
||||
}
|
||||
|
||||
// runNew invokes `agentws new repo --branch <branch>` and returns its output.
|
||||
func runNew(t *testing.T, branch string, extra ...string) string {
|
||||
t.Helper()
|
||||
var out bytes.Buffer
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs(append([]string{"new", "repo", "--branch", branch}, extra...))
|
||||
cmd.SetOut(&out)
|
||||
cmd.SetErr(&out)
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("new %s: %v (output %q)", branch, err, out.String())
|
||||
}
|
||||
return out.String()
|
||||
}
|
||||
|
||||
// pushBranch creates branch on origin carrying one commit and returns its SHA.
|
||||
func pushBranch(t *testing.T, f *fixture, branch, file, content string) string {
|
||||
t.Helper()
|
||||
seed := filepath.Join(f.root, "seed")
|
||||
git(t, seed, "checkout", "-b", branch)
|
||||
writeCommit(t, seed, file, content, "work on "+branch)
|
||||
git(t, seed, "push", "origin", branch)
|
||||
return git(t, seed, "rev-parse", "HEAD")
|
||||
}
|
||||
|
||||
func wtPathFor(f *fixture, branch string) string {
|
||||
return filepath.Join(f.wtRoot, agent.WorktreeDirName("repo", branch))
|
||||
}
|
||||
|
||||
// The regression: a branch that already exists on origin must be checked out at
|
||||
// origin's tip, not forked from the default branch.
|
||||
func TestNewChecksOutExistingRemoteBranch(t *testing.T) {
|
||||
f := newFixtureOn(t, "main")
|
||||
want := pushBranch(t, f, "benvin/existing", "a.txt", "a\n")
|
||||
|
||||
out := runNew(t, "benvin/existing")
|
||||
|
||||
path := wtPathFor(f, "benvin/existing")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want origin/benvin/existing %s", got, want)
|
||||
}
|
||||
if upstream := git(t, path, "rev-parse", "--abbrev-ref", "HEAD@{upstream}"); upstream != "origin/benvin/existing" {
|
||||
t.Errorf("upstream = %q, want origin/benvin/existing", upstream)
|
||||
}
|
||||
if !contains(out, "tracking origin/benvin/existing") {
|
||||
t.Errorf("output %q does not say the remote branch was checked out", out)
|
||||
}
|
||||
}
|
||||
|
||||
// A branch origin does not have is still forked from the default branch, and the
|
||||
// output must say so rather than leaving the caller to guess.
|
||||
func TestNewForksBranchMissingFromRemote(t *testing.T) {
|
||||
f := newFixtureOn(t, "main")
|
||||
want := git(t, f.srcDir, "rev-parse", "origin/main")
|
||||
|
||||
out := runNew(t, "benvin/fresh")
|
||||
|
||||
path := wtPathFor(f, "benvin/fresh")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want origin/main %s", got, want)
|
||||
}
|
||||
if !contains(out, "branch benvin/fresh (new, from origin/main)") {
|
||||
t.Errorf("output %q does not report a new branch", out)
|
||||
}
|
||||
}
|
||||
|
||||
// The base is the remote's own default branch, so a repo defaulting to master
|
||||
// forks from master.
|
||||
func TestNewForksFromMasterDefaultBranch(t *testing.T) {
|
||||
f := newFixtureOn(t, "master")
|
||||
want := git(t, f.srcDir, "rev-parse", "origin/master")
|
||||
|
||||
out := runNew(t, "benvin/on-master")
|
||||
|
||||
path := wtPathFor(f, "benvin/on-master")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want origin/master %s", got, want)
|
||||
}
|
||||
if !contains(out, "from origin/master") {
|
||||
t.Errorf("output %q does not name origin/master as the base", out)
|
||||
}
|
||||
}
|
||||
|
||||
// An existing remote branch beats --from: the flag is ignored and the caller is
|
||||
// told, rather than the branch being silently re-forked.
|
||||
func TestNewIgnoresFromWhenBranchIsOnRemote(t *testing.T) {
|
||||
f := newFixtureOn(t, "main")
|
||||
want := pushBranch(t, f, "benvin/with-from", "a.txt", "a\n")
|
||||
|
||||
out := runNew(t, "benvin/with-from", "--from", "main")
|
||||
|
||||
path := wtPathFor(f, "benvin/with-from")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want origin/benvin/with-from %s", got, want)
|
||||
}
|
||||
if !contains(out, "--from main ignored") {
|
||||
t.Errorf("output %q does not report the ignored --from", out)
|
||||
}
|
||||
}
|
||||
|
||||
// A local branch left behind by an earlier run must not pin the worktree to a
|
||||
// commit origin has moved past.
|
||||
func TestNewFastForwardsStaleLocalBranch(t *testing.T) {
|
||||
f := newFixtureOn(t, "main")
|
||||
stale := pushBranch(t, f, "benvin/stale", "a.txt", "a\n")
|
||||
git(t, f.srcDir, "fetch", "origin")
|
||||
git(t, f.srcDir, "branch", "benvin/stale", "origin/benvin/stale")
|
||||
|
||||
seed := filepath.Join(f.root, "seed")
|
||||
writeCommit(t, seed, "b.txt", "b\n", "more work")
|
||||
git(t, seed, "push", "origin", "benvin/stale")
|
||||
want := git(t, seed, "rev-parse", "HEAD")
|
||||
if want == stale {
|
||||
t.Fatal("fixture did not move origin/benvin/stale on")
|
||||
}
|
||||
|
||||
out := runNew(t, "benvin/stale")
|
||||
|
||||
path := wtPathFor(f, "benvin/stale")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want origin/benvin/stale %s", got, want)
|
||||
}
|
||||
if !contains(out, "fast-forwarded stale benvin/stale") {
|
||||
t.Errorf("output %q does not report the fast-forward", out)
|
||||
}
|
||||
}
|
||||
|
||||
// A local branch carrying commits origin does not have keeps them: they exist
|
||||
// nowhere else, so the worktree stays put and the output says so.
|
||||
func TestNewKeepsLocalCommitsAheadOfRemote(t *testing.T) {
|
||||
f := newFixtureOn(t, "main")
|
||||
pushBranch(t, f, "benvin/ahead", "a.txt", "a\n")
|
||||
git(t, f.srcDir, "fetch", "origin")
|
||||
git(t, f.srcDir, "checkout", "-b", "benvin/ahead", "origin/benvin/ahead")
|
||||
writeCommit(t, f.srcDir, "local.txt", "local\n", "local only")
|
||||
want := git(t, f.srcDir, "rev-parse", "HEAD")
|
||||
git(t, f.srcDir, "checkout", "main")
|
||||
|
||||
out := runNew(t, "benvin/ahead")
|
||||
|
||||
path := wtPathFor(f, "benvin/ahead")
|
||||
if got := git(t, path, "rev-parse", "HEAD"); got != want {
|
||||
t.Errorf("worktree HEAD = %s, want the local tip %s", got, want)
|
||||
}
|
||||
if !contains(out, "1 commit not on origin/benvin/ahead") {
|
||||
t.Errorf("output %q does not report the unpushed commit", out)
|
||||
}
|
||||
}
|
||||
|
||||
func contains(haystack, needle string) bool {
|
||||
return strings.Contains(haystack, needle)
|
||||
}
|
||||
@@ -0,0 +1,480 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
"text/tabwriter"
|
||||
|
||||
"git.unkin.net/unkin/agent-tools/internal/agent"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// Verdicts a worktree can be classified into.
|
||||
const (
|
||||
verdictKeep = "keep"
|
||||
verdictRemove = "remove"
|
||||
verdictRemoveBranch = "remove+branch"
|
||||
)
|
||||
|
||||
// prLister is the slice of the Gitea client prune needs, so tests can drive
|
||||
// classification without a live server.
|
||||
type prLister interface {
|
||||
ListPRs(repoPath, state string) ([]agent.PullRequest, error)
|
||||
}
|
||||
|
||||
type pruneResult struct {
|
||||
wt managedWt
|
||||
verdict string
|
||||
reason string
|
||||
// proven records that git itself confirmed the branch's commits survive
|
||||
// elsewhere; only then may a branch delete override git's own guard.
|
||||
proven bool
|
||||
}
|
||||
|
||||
// repoCtx is the per-repo state classification is decided against.
|
||||
type repoCtx struct {
|
||||
srcDir string
|
||||
defBranch string
|
||||
prs map[string]agent.PullRequest
|
||||
prsKnown bool
|
||||
// fetched records that this run's pruning fetch succeeded; without it an
|
||||
// origin/<branch> ref may be stale and due for deletion, so it proves nothing.
|
||||
fetched bool
|
||||
// unfetched explains why, so a verdict can say which it was.
|
||||
unfetched string
|
||||
}
|
||||
|
||||
// pruneOpts is the knob set runPrune is driven by.
|
||||
type pruneOpts struct {
|
||||
apply bool
|
||||
keepBranches bool
|
||||
noFetch bool
|
||||
jsonOut bool
|
||||
includeKeep bool
|
||||
includeUnmanaged bool
|
||||
}
|
||||
|
||||
// reportEntry is the --json shape: one object per worktree, mirroring the table.
|
||||
type reportEntry struct {
|
||||
Repo string `json:"repo"`
|
||||
Branch string `json:"branch"`
|
||||
Path string `json:"path"`
|
||||
Verdict string `json:"verdict"`
|
||||
Reason string `json:"reason"`
|
||||
Managed bool `json:"managed"`
|
||||
Applied bool `json:"applied"`
|
||||
}
|
||||
|
||||
func newPruneCmd() *cobra.Command {
|
||||
var opts pruneOpts
|
||||
cmd := &cobra.Command{
|
||||
Use: "prune",
|
||||
Short: "Classify worktrees and remove the ones whose work is safely upstream",
|
||||
Long: "prune inspects every worktree it can find — the managed ones under the worktree\nroot plus whatever `git worktree list` reports for the source checkouts — and\nclassifies each against git and its Gitea pull request. It reports and changes\nnothing unless --yes is given.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runPrune(cmd.OutOrStdout(), cmd.ErrOrStderr(), pruneClient(), opts)
|
||||
},
|
||||
}
|
||||
f := cmd.Flags()
|
||||
f.BoolVar(&opts.apply, "yes", false, "Actually remove worktrees (default is a dry run)")
|
||||
f.BoolVar(&opts.keepBranches, "keep-branches", false, "Never delete a local branch, whatever the classification")
|
||||
f.BoolVar(&opts.noFetch, "no-fetch", false, "Do not fetch; judge against the refs already on disk")
|
||||
f.BoolVar(&opts.jsonOut, "json", false, "Emit JSON instead of a table")
|
||||
f.BoolVar(&opts.includeKeep, "include-keep", false, "Dangerous: also remove worktrees classified keep (needs --yes). Destroys uncommitted changes and paused rebase/merge state, which no branch is carrying; only the branch itself survives")
|
||||
f.BoolVar(&opts.includeUnmanaged, "include-unmanaged", false, "Also remove worktrees that live outside the worktree root")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// pruneClient builds a Gitea client, falling back to anonymous access when no
|
||||
// token can be minted; prune degrades to git-only signals if that fails too.
|
||||
func pruneClient() prLister {
|
||||
tok, err := agent.GiteaToken()
|
||||
if err != nil {
|
||||
tok = ""
|
||||
}
|
||||
return agent.NewGiteaClient(tok)
|
||||
}
|
||||
|
||||
func runPrune(out, errOut io.Writer, prs prLister, opts pruneOpts) error {
|
||||
// In JSON mode stdout carries the document alone, so notes go to stderr.
|
||||
notes := out
|
||||
if opts.jsonOut {
|
||||
notes = errOut
|
||||
}
|
||||
|
||||
worktrees, err := allWorktrees()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(worktrees) == 0 {
|
||||
if opts.jsonOut {
|
||||
_, _ = fmt.Fprintln(out, "[]")
|
||||
return nil
|
||||
}
|
||||
_, _ = fmt.Fprintln(out, "no managed worktrees")
|
||||
return nil
|
||||
}
|
||||
|
||||
results := classifyAll(notes, prs, worktrees, opts)
|
||||
if err := report(out, results, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
if !opts.apply {
|
||||
if !opts.jsonOut {
|
||||
_, _ = fmt.Fprintln(out, "dry run: nothing removed (pass --yes to apply)")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
return applyPrune(notes, results, opts)
|
||||
}
|
||||
|
||||
// classifyAll groups worktrees by source repo so each repo is fetched and its
|
||||
// PRs listed once, then classifies every worktree against that repo's state.
|
||||
func classifyAll(notes io.Writer, prs prLister, worktrees []managedWt, opts pruneOpts) []pruneResult {
|
||||
byRepo := map[string][]managedWt{}
|
||||
var results []pruneResult
|
||||
for _, w := range worktrees {
|
||||
switch {
|
||||
case w.inspectErr != nil:
|
||||
// Unknown is not gone: a checkout git refused to answer for keeps.
|
||||
results = append(results, pruneResult{wt: w, verdict: verdictKeep, reason: "inspection failed: " + oneLine(w.inspectErr.Error())})
|
||||
case w.orphan:
|
||||
results = append(results, pruneResult{wt: w, verdict: verdictRemove, reason: "backing repo gone, no git state to read"})
|
||||
default:
|
||||
byRepo[w.srcDir] = append(byRepo[w.srcDir], w)
|
||||
}
|
||||
}
|
||||
|
||||
srcDirs := make([]string, 0, len(byRepo))
|
||||
for dir := range byRepo {
|
||||
srcDirs = append(srcDirs, dir)
|
||||
}
|
||||
sort.Strings(srcDirs)
|
||||
|
||||
for _, srcDir := range srcDirs {
|
||||
ctx, err := newRepoCtx(notes, prs, srcDir, opts.noFetch)
|
||||
if err != nil {
|
||||
for _, w := range byRepo[srcDir] {
|
||||
results = append(results, pruneResult{wt: w, verdict: verdictKeep, reason: "repo state unknown: " + oneLine(err.Error())})
|
||||
}
|
||||
continue
|
||||
}
|
||||
for _, w := range byRepo[srcDir] {
|
||||
res, err := classify(w, ctx)
|
||||
if err != nil {
|
||||
res = pruneResult{wt: w, verdict: verdictKeep, reason: "inspection failed: " + oneLine(err.Error())}
|
||||
}
|
||||
results = append(results, res)
|
||||
}
|
||||
}
|
||||
sort.SliceStable(results, func(i, j int) bool {
|
||||
if results[i].wt.repo != results[j].wt.repo {
|
||||
return results[i].wt.repo < results[j].wt.repo
|
||||
}
|
||||
return results[i].wt.path < results[j].wt.path
|
||||
})
|
||||
return results
|
||||
}
|
||||
|
||||
// report writes the classification as a table or as JSON.
|
||||
func report(out io.Writer, results []pruneResult, opts pruneOpts) error {
|
||||
if opts.jsonOut {
|
||||
entries := make([]reportEntry, 0, len(results))
|
||||
for _, r := range results {
|
||||
entries = append(entries, reportEntry{
|
||||
Repo: r.wt.repo,
|
||||
Branch: r.wt.branch,
|
||||
Path: r.wt.path,
|
||||
Verdict: plannedVerdict(r, opts),
|
||||
Reason: r.reason,
|
||||
Managed: r.wt.managed,
|
||||
Applied: opts.apply && willRemove(r, opts),
|
||||
})
|
||||
}
|
||||
enc := json.NewEncoder(out)
|
||||
enc.SetIndent("", " ")
|
||||
return enc.Encode(entries)
|
||||
}
|
||||
|
||||
// Padded with spaces only, so the table reads the same with or without a TTY.
|
||||
tw := tabwriter.NewWriter(out, 0, 0, 2, ' ', 0)
|
||||
_, _ = fmt.Fprintln(tw, "REPO\tBRANCH\tPATH\tVERDICT\tREASON")
|
||||
for _, r := range results {
|
||||
_, _ = fmt.Fprintf(tw, "%s\t%s\t%s\t%s\t%s\n",
|
||||
dash(r.wt.repo), dash(r.wt.branch), abbrevHome(r.wt.path), plannedVerdict(r, opts), r.reason)
|
||||
}
|
||||
return tw.Flush()
|
||||
}
|
||||
|
||||
// oneLine flattens a git error onto a single line so one row stays one row.
|
||||
func oneLine(s string) string {
|
||||
return strings.Join(strings.Fields(s), " ")
|
||||
}
|
||||
|
||||
func dash(s string) string {
|
||||
if s == "" {
|
||||
return "-"
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
// abbrevHome shortens $HOME to ~ so paths do not dominate the table.
|
||||
func abbrevHome(path string) string {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil || home == "" || !strings.HasPrefix(path, home+string(filepath.Separator)) {
|
||||
return path
|
||||
}
|
||||
return "~" + path[len(home):]
|
||||
}
|
||||
|
||||
// applyPrune performs the removals the classification authorised, reporting each
|
||||
// one and collecting failures so one bad worktree does not stop the rest.
|
||||
func applyPrune(out io.Writer, results []pruneResult, opts pruneOpts) error {
|
||||
var errs []error
|
||||
for _, r := range results {
|
||||
if !willRemove(r, opts) {
|
||||
if !r.wt.managed && r.verdict != verdictKeep {
|
||||
_, _ = fmt.Fprintf(out, "skipped %s: outside the worktree root (pass --include-unmanaged)\n", r.wt.path)
|
||||
}
|
||||
continue
|
||||
}
|
||||
if r.verdict == verdictKeep {
|
||||
_, _ = fmt.Fprintf(out, "warn: removing %s despite %q (--include-keep)\n", r.wt.path, r.reason)
|
||||
}
|
||||
deleteBranch := plannedVerdict(r, opts) == verdictRemoveBranch
|
||||
if err := removeWorktree(out, r.wt, deleteBranch, r.proven); err != nil {
|
||||
errs = append(errs, fmt.Errorf("%s: %w", r.wt.path, err))
|
||||
}
|
||||
}
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
// willRemove is the single gate on destruction: a keep verdict needs
|
||||
// --include-keep, and a worktree outside the worktree root needs
|
||||
// --include-unmanaged.
|
||||
func willRemove(r pruneResult, opts pruneOpts) bool {
|
||||
if !r.wt.managed && !opts.includeUnmanaged {
|
||||
return false
|
||||
}
|
||||
if r.verdict == verdictKeep {
|
||||
return opts.includeKeep
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
// plannedVerdict is what will actually happen, so no flag prints an action it
|
||||
// will not perform. A detached HEAD has no branch to delete, and a keep forced
|
||||
// through with --include-keep never takes its branch with it.
|
||||
func plannedVerdict(r pruneResult, opts pruneOpts) string {
|
||||
if r.verdict != verdictRemoveBranch {
|
||||
return r.verdict
|
||||
}
|
||||
if opts.keepBranches || r.wt.detached {
|
||||
return verdictRemove
|
||||
}
|
||||
return verdictRemoveBranch
|
||||
}
|
||||
|
||||
// newRepoCtx refreshes a source repo and collects the signals prune classifies
|
||||
// against. A failed or skipped fetch and an unreachable Gitea are reported and
|
||||
// tolerated: the signals that hold offline still work, and the rest are recorded
|
||||
// as unverified.
|
||||
func newRepoCtx(out io.Writer, prs prLister, srcDir string, noFetch bool) (repoCtx, error) {
|
||||
ctx := repoCtx{srcDir: srcDir, prs: map[string]agent.PullRequest{}}
|
||||
repo := filepath.Base(srcDir)
|
||||
if noFetch {
|
||||
ctx.unfetched = "fetch skipped"
|
||||
_, _ = fmt.Fprintf(out, "warn: fetch %s skipped (--no-fetch, remote state unverified)\n", repo)
|
||||
} else if err := agent.GitFetchPrune(srcDir, "origin", credentialHelperArgs()...); err != nil {
|
||||
ctx.unfetched = "fetch failed"
|
||||
_, _ = fmt.Fprintf(out, "warn: fetch %s: %v (remote state unverified)\n", repo, err)
|
||||
} else {
|
||||
ctx.fetched = true
|
||||
}
|
||||
def, err := agent.GitRemoteDefaultBranch(srcDir, "origin")
|
||||
if err != nil {
|
||||
return repoCtx{}, err
|
||||
}
|
||||
ctx.defBranch = def
|
||||
|
||||
if prs == nil {
|
||||
return ctx, nil
|
||||
}
|
||||
list, err := prs.ListPRs(repoPath(srcDir, repo), "all")
|
||||
switch {
|
||||
case errors.Is(err, agent.ErrPRListTruncated):
|
||||
// A branch missing from a partial listing must not read as "no PR".
|
||||
_, _ = fmt.Fprintf(out, "warn: list PRs for %s: %v (older PRs unseen)\n", repo, err)
|
||||
ctx.prs = prsByBranch(list)
|
||||
case err != nil:
|
||||
_, _ = fmt.Fprintf(out, "warn: list PRs for %s: %v (git signals only)\n", repo, err)
|
||||
default:
|
||||
ctx.prs = prsByBranch(list)
|
||||
ctx.prsKnown = true
|
||||
}
|
||||
return ctx, nil
|
||||
}
|
||||
|
||||
// repoPath is the Gitea "owner/repo" for a checkout, read from origin's URL
|
||||
// because not every managed repo lives under AGENTWS_OWNER.
|
||||
func repoPath(srcDir, repo string) string {
|
||||
url, err := agent.GitRemoteURL(srcDir, "origin")
|
||||
if err == nil && agent.RemoteHost(url) == giteaHost() {
|
||||
if path, err := agent.RepoPathFromRemoteURL(url); err == nil {
|
||||
return path
|
||||
}
|
||||
}
|
||||
return owner() + "/" + repo
|
||||
}
|
||||
|
||||
// prsByBranch indexes PRs by head branch, preferring an open PR and otherwise
|
||||
// the most recent one when a branch has been used more than once.
|
||||
func prsByBranch(list []agent.PullRequest) map[string]agent.PullRequest {
|
||||
out := map[string]agent.PullRequest{}
|
||||
for _, pr := range list {
|
||||
branch := agent.PRHeadBranch(pr)
|
||||
if branch == "" {
|
||||
continue
|
||||
}
|
||||
if cur, ok := out[branch]; ok && !supersedes(pr, cur) {
|
||||
continue
|
||||
}
|
||||
out[branch] = pr
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func supersedes(a, b agent.PullRequest) bool {
|
||||
if a.IsOpen() != b.IsOpen() {
|
||||
return a.IsOpen()
|
||||
}
|
||||
if a.Merged != b.Merged {
|
||||
return a.Merged
|
||||
}
|
||||
return a.Number > b.Number
|
||||
}
|
||||
|
||||
// headContainedIn reports whether the worktree's HEAD is reachable from ref. A
|
||||
// ref that cannot be resolved proves nothing, so it reads as not contained.
|
||||
func headContainedIn(dir, ref string) bool {
|
||||
if ref == "" {
|
||||
return false
|
||||
}
|
||||
ok, err := agent.GitIsAncestor(dir, "HEAD", ref)
|
||||
return err == nil && ok
|
||||
}
|
||||
|
||||
// classify applies the prune precedence. Removal must never destroy state that
|
||||
// exists nowhere else: a vanished working tree is the one case with nothing to
|
||||
// lose, a locked or mid-rebase checkout holds sequencer state git itself refuses
|
||||
// to discard, and a dirty checkout or a detached HEAD with unique commits holds
|
||||
// work no branch is carrying. Past those guards, provably-upstream work loses its
|
||||
// branch too, and anything unproven keeps its branch so no commit becomes
|
||||
// unreachable. A PR's state alone never authorises deleting a branch — git must
|
||||
// confirm HEAD is contained in what merged or in what origin still holds, and
|
||||
// origin's refs only count when this run's pruning fetch refreshed them.
|
||||
func classify(wt managedWt, ctx repoCtx) (pruneResult, error) {
|
||||
res := pruneResult{wt: wt}
|
||||
if wt.missing {
|
||||
res.verdict, res.reason = verdictRemove, "working tree gone, stale registration only"
|
||||
return res, nil
|
||||
}
|
||||
if wt.locked {
|
||||
res.verdict, res.reason = verdictKeep, "locked"
|
||||
return res, nil
|
||||
}
|
||||
op, err := agent.GitInProgressOp(wt.path)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
if op != "" {
|
||||
res.verdict, res.reason = verdictKeep, op+" in progress"
|
||||
return res, nil
|
||||
}
|
||||
dirty, err := agent.GitIsDirty(wt.path)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
if dirty {
|
||||
res.verdict, res.reason = verdictKeep, "dirty"
|
||||
return res, nil
|
||||
}
|
||||
|
||||
pr, hasPR := ctx.prs[wt.branch]
|
||||
if hasPR && pr.IsOpen() {
|
||||
res.verdict, res.reason = verdictKeep, fmt.Sprintf("PR open #%d", pr.Number)
|
||||
return res, nil
|
||||
}
|
||||
|
||||
upstream := "origin/" + ctx.defBranch
|
||||
contained, err := agent.GitIsAncestor(wt.path, "HEAD", upstream)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
if contained {
|
||||
res.verdict, res.reason, res.proven = verdictRemoveBranch, "contained in "+upstream, true
|
||||
return res, nil
|
||||
}
|
||||
unmerged, err := agent.GitUnmergedCommits(wt.path, upstream, "HEAD")
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
if unmerged == 0 {
|
||||
// git cherry proves the patches reached that history, not that they stand at its tip.
|
||||
res.verdict, res.reason, res.proven = verdictRemoveBranch, "patch-equivalent commits in "+upstream+" history", true
|
||||
return res, nil
|
||||
}
|
||||
|
||||
local, err := agent.GitCommitsNotOnRemotes(wt.path)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
if wt.detached && local > 0 {
|
||||
res.verdict, res.reason = verdictKeep, fmt.Sprintf("detached HEAD carrying %s on no remote", commitCount(local))
|
||||
return res, nil
|
||||
}
|
||||
|
||||
remote := "origin/" + wt.branch
|
||||
onOrigin := hasPR && ctx.fetched && agent.GitRemoteBranchExists(ctx.srcDir, "origin", wt.branch)
|
||||
switch {
|
||||
case hasPR && pr.Merged && headContainedIn(wt.path, pr.Head.Sha):
|
||||
res.verdict, res.reason, res.proven = verdictRemoveBranch, fmt.Sprintf("PR merged #%d, HEAD contained in the merged head", pr.Number), true
|
||||
case hasPR && pr.Merged && onOrigin && headContainedIn(wt.path, remote):
|
||||
res.verdict, res.reason, res.proven = verdictRemoveBranch, fmt.Sprintf("PR merged #%d, HEAD contained in %s", pr.Number, remote), true
|
||||
case hasPR && pr.Merged && !ctx.fetched:
|
||||
res.verdict, res.reason = verdictRemove, fmt.Sprintf("PR merged #%d, %s so %s is unverified", pr.Number, ctx.unfetched, remote)
|
||||
case hasPR && pr.Merged:
|
||||
res.verdict, res.reason = verdictRemove, fmt.Sprintf("PR merged #%d, local commits not in the merged head", pr.Number)
|
||||
case hasPR && onOrigin && headContainedIn(wt.path, remote):
|
||||
res.verdict, res.reason, res.proven = verdictRemoveBranch, fmt.Sprintf("PR closed #%d, HEAD contained in %s", pr.Number, remote), true
|
||||
case hasPR && onOrigin:
|
||||
res.verdict, res.reason = verdictRemove, fmt.Sprintf("PR closed #%d, local commits not on %s", pr.Number, remote)
|
||||
case hasPR && !ctx.fetched:
|
||||
res.verdict, res.reason = verdictRemove, fmt.Sprintf("PR closed #%d, %s so %s is unverified", pr.Number, ctx.unfetched, remote)
|
||||
case hasPR:
|
||||
res.verdict, res.reason = verdictRemove, fmt.Sprintf("PR closed #%d, branch gone", pr.Number)
|
||||
case ctx.prsKnown:
|
||||
res.verdict, res.reason = verdictRemove, "no PR"
|
||||
default:
|
||||
res.verdict, res.reason = verdictRemove, "PR state unknown"
|
||||
}
|
||||
if res.verdict == verdictRemove && local > 0 {
|
||||
res.reason += fmt.Sprintf(", %s on no remote so branch %s is kept", commitCount(local), wt.branch)
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func commitCount(n int) string {
|
||||
if n == 1 {
|
||||
return "1 commit"
|
||||
}
|
||||
return fmt.Sprintf("%d commits", n)
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+35
-11
@@ -7,6 +7,7 @@
|
||||
// watchpr owner/repo#12 owner/repo:15
|
||||
// watchpr --once --json owner/repo#12
|
||||
// watchpr --interval 30s owner/repo#12
|
||||
// watchpr --interval 30 owner/repo#12
|
||||
package main
|
||||
|
||||
import (
|
||||
@@ -34,7 +35,7 @@ func main() {
|
||||
// tests can invoke Execute and assert the exit behaviour without spawning a
|
||||
// process.
|
||||
func newRootCmd() *cobra.Command {
|
||||
var interval time.Duration
|
||||
var intervalFlag string
|
||||
var once, jsonMode bool
|
||||
|
||||
root := &cobra.Command{
|
||||
@@ -50,6 +51,10 @@ func newRootCmd() *cobra.Command {
|
||||
if len(args) == 0 {
|
||||
return fmt.Errorf("no PR references given (e.g. owner/repo#12)")
|
||||
}
|
||||
interval, err := agent.ParseDurationFlag("interval", intervalFlag)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
refs := make([]agent.PRRef, 0, len(args))
|
||||
for _, a := range args {
|
||||
ref, err := agent.ParsePRRef(a)
|
||||
@@ -58,10 +63,7 @@ func newRootCmd() *cobra.Command {
|
||||
}
|
||||
refs = append(refs, ref)
|
||||
}
|
||||
c, err := clientFor()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
c := clientFor()
|
||||
if once {
|
||||
return runOnce(c, refs, jsonMode)
|
||||
}
|
||||
@@ -71,7 +73,7 @@ func newRootCmd() *cobra.Command {
|
||||
root.SetVersionTemplate("{{.Version}}\n")
|
||||
|
||||
f := root.Flags()
|
||||
f.DurationVar(&interval, "interval", 60*time.Second, "Polling interval")
|
||||
f.StringVar(&intervalFlag, "interval", "60s", "Polling interval: a duration (30s, 2m, 1h30m) or a bare number of seconds")
|
||||
f.BoolVar(&once, "once", false, "Check once, print current state, and exit")
|
||||
f.BoolVar(&jsonMode, "json", false, "Emit JSON")
|
||||
|
||||
@@ -84,12 +86,16 @@ func newRootCmd() *cobra.Command {
|
||||
return root
|
||||
}
|
||||
|
||||
func clientFor() (*agent.GiteaClient, error) {
|
||||
// clientFor builds the Gitea client. Watching public repos works anonymously,
|
||||
// so an unavailable token is a warning, not a failure; a poll that is actually
|
||||
// rejected re-mints then.
|
||||
func clientFor() *agent.GiteaClient {
|
||||
token, err := agent.GiteaToken()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
fmt.Fprintf(os.Stderr, "warning: no Gitea token (%v); polling anonymously\n", err)
|
||||
token = ""
|
||||
}
|
||||
return agent.NewGiteaClient(token), nil
|
||||
return agent.NewGiteaClient(token)
|
||||
}
|
||||
|
||||
// runOnce fetches and prints the current state of each PR, then exits 0.
|
||||
@@ -99,7 +105,7 @@ func runOnce(c *agent.GiteaClient, refs []agent.PRRef, jsonMode bool) error {
|
||||
for _, ref := range refs {
|
||||
st, err := agent.FetchState(c, ref, login)
|
||||
if err != nil {
|
||||
return err
|
||||
return describeFailure(err)
|
||||
}
|
||||
states = append(states, st)
|
||||
}
|
||||
@@ -131,12 +137,30 @@ func runWatch(c *agent.GiteaClient, refs []agent.PRRef, interval time.Duration,
|
||||
|
||||
res, err := agent.Watch(c, refs, login, ticker.C, onBaseline, onError)
|
||||
if err != nil {
|
||||
return err
|
||||
return describeFailure(err)
|
||||
}
|
||||
report(res.Ref.String(), res.Reason, res.State, jsonMode)
|
||||
return nil
|
||||
}
|
||||
|
||||
// describeFailure names the cause of a terminal failure so a watcher that stops
|
||||
// says why. An anonymous rejection, a permission boundary and a token that
|
||||
// outlived its Vault lease are three different problems and only the last is
|
||||
// fixed by a fresh token.
|
||||
func describeFailure(err error) error {
|
||||
switch {
|
||||
case agent.IsNoCredential(err):
|
||||
return fmt.Errorf("gitea requires authentication and no token could be minted, aborted: %w", err)
|
||||
case agent.IsPermissionDenied(err):
|
||||
return fmt.Errorf("gitea denied access to %s (a fresh token will not help), aborted: %w", agent.AgentLogin(), err)
|
||||
case agent.IsAuthError(err):
|
||||
return fmt.Errorf("gitea rejected the token and re-minting did not recover it, aborted: %w", err)
|
||||
case agent.IsPRGone(err):
|
||||
return fmt.Errorf("PR no longer visible (repo deleted, renamed, or made private), aborted: %w", err)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// report emits the change that ended the watch.
|
||||
func report(key, reason string, st agent.PRState, jsonMode bool) {
|
||||
if jsonMode {
|
||||
|
||||
@@ -1,8 +1,15 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.unkin.net/unkin/agent-tools/internal/agent"
|
||||
)
|
||||
|
||||
// A bad PR reference must fail the command (so main exits non-zero) rather than
|
||||
@@ -28,3 +35,150 @@ func TestExecuteNoArgsErrors(t *testing.T) {
|
||||
t.Fatal("Execute() = nil, want error when no PR references are given")
|
||||
}
|
||||
}
|
||||
|
||||
// Watching a public repo with no credentials available must work: the failed
|
||||
// mint is a warning, the poll goes out unauthenticated, and the command exits 0.
|
||||
func TestOnceRunsAnonymouslyWhenNoTokenIsAvailable(t *testing.T) {
|
||||
vault := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
}))
|
||||
defer vault.Close()
|
||||
|
||||
authHeaders := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Header.Get("Authorization") != "" {
|
||||
authHeaders++
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/cafebabe/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `[]`)
|
||||
})
|
||||
gitea := httptest.NewServer(mux)
|
||||
defer gitea.Close()
|
||||
|
||||
t.Setenv("VAULT_ADDR", vault.URL)
|
||||
t.Setenv("GITEA_URL", gitea.URL)
|
||||
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"--once", "unkin/repo#7"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("anonymous --once should succeed without a token: %v", err)
|
||||
}
|
||||
if authHeaders != 0 {
|
||||
t.Errorf("sent %d Authorization headers, want none", authHeaders)
|
||||
}
|
||||
}
|
||||
|
||||
// A bare integer interval means seconds and must survive flag parsing: the
|
||||
// command should fail on the missing PR reference, not on the flag value.
|
||||
func TestExecuteBareIntervalIsSeconds(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"--interval", "15"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want the no-references error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "no PR references given") {
|
||||
t.Fatalf("Execute() error = %v, want the no-references error", err)
|
||||
}
|
||||
}
|
||||
|
||||
// An unparseable interval is rejected before any Vault/Gitea call, with an
|
||||
// error naming the flag and showing valid forms.
|
||||
func TestExecuteBadIntervalErrors(t *testing.T) {
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"--interval", "soon", "unkin/repo#1"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want error for an unparseable --interval")
|
||||
}
|
||||
for _, want := range []string{"--interval", "30s"} {
|
||||
if !strings.Contains(err.Error(), want) {
|
||||
t.Errorf("Execute() error %q does not mention %q", err, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// failingVault serves an AppRole login that never issues a token, so the
|
||||
// command falls back to anonymous polling exactly as it does when Vault is
|
||||
// unreachable.
|
||||
func failingVault(t *testing.T) *httptest.Server {
|
||||
t.Helper()
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
}))
|
||||
t.Cleanup(srv.Close)
|
||||
return srv
|
||||
}
|
||||
|
||||
// An anonymous run against a repo that is not public must exit non-zero saying
|
||||
// no token was available — not claim a token expired, and not keep going.
|
||||
func TestOnceAnonymousRejectionNamesTheMissingToken(t *testing.T) {
|
||||
vault := failingVault(t)
|
||||
|
||||
requests := 0
|
||||
gitea := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = io.WriteString(w, `{"message":"invalid username, password or token"}`)
|
||||
}))
|
||||
defer gitea.Close()
|
||||
|
||||
t.Setenv("VAULT_ADDR", vault.URL)
|
||||
t.Setenv("GITEA_URL", gitea.URL)
|
||||
|
||||
cmd := newRootCmd()
|
||||
cmd.SetArgs([]string{"--once", "unkin/repo#7"})
|
||||
cmd.SetOut(io.Discard)
|
||||
cmd.SetErr(io.Discard)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("Execute() = nil, want a non-zero exit when the poll is rejected")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "no token could be minted") {
|
||||
t.Errorf("Execute() error = %q, want it to name the missing token", err)
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Errorf("gitea requests = %d, want 1 (no replay without a credential)", requests)
|
||||
}
|
||||
}
|
||||
|
||||
// describeFailure must tell the four terminal causes apart: each one sends the
|
||||
// reader somewhere different, and a watcher that stops without saying why is
|
||||
// the failure this names.
|
||||
func TestDescribeFailureNamesTheCause(t *testing.T) {
|
||||
rejected := &agent.APIError{Method: "GET", Path: "/p", StatusCode: 401, Body: `{"message":"invalid username, password or token"}`}
|
||||
forbidden := &agent.APIError{Method: "GET", Path: "/p", StatusCode: 403, Body: `{"message":"Forbidden"}`}
|
||||
tests := []struct {
|
||||
name string
|
||||
err error
|
||||
want string
|
||||
}{
|
||||
{"anonymous", fmt.Errorf("%w: %w", agent.ErrNoCredential, rejected), "no token could be minted"},
|
||||
{"permission boundary", error(forbidden), "denied access"},
|
||||
{"rejected token", error(rejected), "re-minting did not recover it"},
|
||||
{"other", errors.New("dial tcp: timeout"), "dial tcp: timeout"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := describeFailure(tt.err)
|
||||
if got == nil || !strings.Contains(got.Error(), tt.want) {
|
||||
t.Errorf("describeFailure = %v, want it to mention %q", got, tt.want)
|
||||
}
|
||||
if !errors.Is(got, tt.err) {
|
||||
t.Errorf("describeFailure dropped the underlying error %v", tt.err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ErrOutpostNotFound marks a search that returned no exactly-named outpost.
|
||||
var ErrOutpostNotFound = errors.New("outpost not found")
|
||||
|
||||
// AuthentikClient talks to the Authentik REST API with a bearer API token. The
|
||||
// internal CA is in the OS trust store, so the default transport suffices.
|
||||
type AuthentikClient struct {
|
||||
BaseURL string
|
||||
Token string
|
||||
HTTP *http.Client
|
||||
}
|
||||
|
||||
// NewAuthentikClient builds a client for the given Authentik base URL.
|
||||
func NewAuthentikClient(baseURL, token string) *AuthentikClient {
|
||||
return &AuthentikClient{BaseURL: strings.TrimRight(baseURL, "/"), Token: token, HTTP: httpClient}
|
||||
}
|
||||
|
||||
// Outpost is the subset of Authentik's outpost object we need.
|
||||
type Outpost struct {
|
||||
PK string `json:"pk"`
|
||||
Name string `json:"name"`
|
||||
TokenIdentifier string `json:"token_identifier"`
|
||||
}
|
||||
|
||||
// get issues an authenticated GET and decodes into out. Error text never
|
||||
// includes a successful response body, which may carry key material.
|
||||
func (c *AuthentikClient) get(path string, out any) error {
|
||||
req, err := http.NewRequest(http.MethodGet, c.BaseURL+path, nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Set("Authorization", "Bearer "+c.Token)
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
resp, err := c.HTTP.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("authentik GET %s: %w", path, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
data, _ := io.ReadAll(resp.Body)
|
||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||
return fmt.Errorf("authentik GET %s: HTTP %d: %s", path, resp.StatusCode, strings.TrimSpace(string(data)))
|
||||
}
|
||||
if err := json.Unmarshal(data, out); err != nil {
|
||||
return fmt.Errorf("authentik GET %s: decoding response: %w", path, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// FindOutpost searches outpost instances and returns the one whose name matches
|
||||
// exactly (search is a substring match, so the exact name is re-checked here).
|
||||
func (c *AuthentikClient) FindOutpost(name string) (Outpost, error) {
|
||||
var out struct {
|
||||
Results []Outpost `json:"results"`
|
||||
}
|
||||
path := "/api/v3/outposts/instances/?search=" + url.QueryEscape(name)
|
||||
if err := c.get(path, &out); err != nil {
|
||||
return Outpost{}, err
|
||||
}
|
||||
for _, o := range out.Results {
|
||||
if o.Name == name {
|
||||
return o, nil
|
||||
}
|
||||
}
|
||||
return Outpost{}, fmt.Errorf("authentik outpost %q: %w (searched %d result(s))", name, ErrOutpostNotFound, len(out.Results))
|
||||
}
|
||||
|
||||
// TokenKey returns the key behind a token identifier
|
||||
// (GET /api/v3/core/tokens/<identifier>/view_key/).
|
||||
func (c *AuthentikClient) TokenKey(identifier string) (string, error) {
|
||||
var out struct {
|
||||
Key string `json:"key"`
|
||||
}
|
||||
path := "/api/v3/core/tokens/" + url.PathEscape(identifier) + "/view_key/"
|
||||
if err := c.get(path, &out); err != nil {
|
||||
return "", err
|
||||
}
|
||||
if out.Key == "" {
|
||||
return "", fmt.Errorf("authentik view_key for %q: response has no key field", identifier)
|
||||
}
|
||||
return out.Key, nil
|
||||
}
|
||||
@@ -2,14 +2,19 @@ package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// fakeVault serves the AppRole login and gitea creds endpoints.
|
||||
func fakeVault(t *testing.T, wantRoleID, giteaToken string) *httptest.Server {
|
||||
// fakeVault serves the AppRole login and the gitea creds secret at credsPath
|
||||
// only, so a read of any other path 404s.
|
||||
func fakeVault(t *testing.T, wantRoleID, credsPath, giteaToken string) *httptest.Server {
|
||||
t.Helper()
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -26,7 +31,7 @@ func fakeVault(t *testing.T, wantRoleID, giteaToken string) *httptest.Server {
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"s.vaulttoken"}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/"+GiteaCredsPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
mux.HandleFunc("/v1/"+credsPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
if got := r.Header.Get("X-Vault-Token"); got != "s.vaulttoken" {
|
||||
t.Errorf("X-Vault-Token = %q, want s.vaulttoken", got)
|
||||
}
|
||||
@@ -36,10 +41,10 @@ func fakeVault(t *testing.T, wantRoleID, giteaToken string) *httptest.Server {
|
||||
}
|
||||
|
||||
func TestFetchGiteaToken(t *testing.T) {
|
||||
srv := fakeVault(t, "role-xyz", "gitea-abc")
|
||||
srv := fakeVault(t, "role-xyz", "gitea/creds/unkin-agent", "gitea-abc")
|
||||
defer srv.Close()
|
||||
|
||||
tok, err := fetchGiteaToken(srv.URL, "role-xyz")
|
||||
tok, err := fetchGiteaToken(srv.URL, "role-xyz", "gitea/creds/unkin-agent")
|
||||
if err != nil {
|
||||
t.Fatalf("fetchGiteaToken: %v", err)
|
||||
}
|
||||
@@ -57,7 +62,7 @@ func TestFetchGiteaTokenLoginError(t *testing.T) {
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
if _, err := fetchGiteaToken(srv.URL, "role-xyz"); err == nil {
|
||||
if _, err := fetchGiteaToken(srv.URL, "role-xyz", "gitea/creds/unkin-agent"); err == nil {
|
||||
t.Fatal("expected error on 403 login")
|
||||
}
|
||||
}
|
||||
@@ -94,6 +99,80 @@ func TestCreatePRRequestBody(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// An edit must send only the fields it was given: Gitea overwrites whatever
|
||||
// key it receives, so an omitted --title arriving as "" would blank the title.
|
||||
func TestEditPRSendsOnlySuppliedFields(t *testing.T) {
|
||||
title, body, empty := "new title", "new body", ""
|
||||
tests := []struct {
|
||||
name string
|
||||
opts EditOptions
|
||||
want map[string]any
|
||||
}{
|
||||
{"body only", EditOptions{Body: &body}, map[string]any{"body": "new body"}},
|
||||
{"title only", EditOptions{Title: &title}, map[string]any{"title": "new title"}},
|
||||
{"both", EditOptions{Title: &title, Body: &body}, map[string]any{"title": "new title", "body": "new body"}},
|
||||
{"explicit empty body is sent", EditOptions{Body: &empty}, map[string]any{"body": ""}},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
var gotMethod, gotPath string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
gotMethod, gotPath = r.Method, r.URL.Path
|
||||
_ = json.NewDecoder(r.Body).Decode(&gotBody)
|
||||
_, _ = io.WriteString(w, `{"number":7,"title":"new title","html_url":"https://git.unkin.net/unkin/repo/pulls/7"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "gitea-abc", HTTP: srv.Client()}
|
||||
pr, err := c.EditPR("unkin/repo", 7, tt.opts)
|
||||
if err != nil {
|
||||
t.Fatalf("EditPR: %v", err)
|
||||
}
|
||||
if gotMethod != http.MethodPatch {
|
||||
t.Errorf("method = %s, want PATCH", gotMethod)
|
||||
}
|
||||
if gotPath != "/api/v1/repos/unkin/repo/pulls/7" {
|
||||
t.Errorf("path = %q", gotPath)
|
||||
}
|
||||
if len(gotBody) != len(tt.want) {
|
||||
t.Errorf("payload = %v, want exactly the supplied fields %v", gotBody, tt.want)
|
||||
}
|
||||
for k, v := range tt.want {
|
||||
if gotBody[k] != v {
|
||||
t.Errorf("payload[%q] = %v, want %v", k, gotBody[k], v)
|
||||
}
|
||||
}
|
||||
if pr.Number != 7 || pr.HTMLURL == "" {
|
||||
t.Errorf("parsed PR = %+v", pr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// A non-2xx must surface the API's own message rather than a bare status.
|
||||
func TestEditPRAPIError(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = io.WriteString(w, `{"message":"not found","url":"https://git.unkin.net/api/swagger","errors":null}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
title := "new title"
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.EditPR("unkin/repo", 7, EditOptions{Title: &title})
|
||||
if err == nil {
|
||||
t.Fatal("expected error on 404")
|
||||
}
|
||||
if !strings.Contains(err.Error(), `"message":"not found"`) {
|
||||
t.Errorf("error %q should carry the API message", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateComment(t *testing.T) {
|
||||
var gotBody map[string]string
|
||||
mux := http.NewServeMux()
|
||||
@@ -163,6 +242,153 @@ func TestFetchState(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// A merged PR whose branch was deleted leaves its head commit unreachable, so
|
||||
// the commit-status endpoint 404s. FetchState must still return the (merged)
|
||||
// state rather than failing, otherwise the watch loop never sees the merge.
|
||||
func TestFetchStateToleratesMissingCommit(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"closed","merged":true,"mergeable":true,"title":"feat","html_url":"u","head":{"sha":"cafebabecafebabe"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/cafebabecafebabe/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = io.WriteString(w, `{"message":"not found"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
st, err := FetchState(c, ref, "unkin-agent")
|
||||
if err != nil {
|
||||
t.Fatalf("FetchState must tolerate a 404 status for a gone commit: %v", err)
|
||||
}
|
||||
if !st.Merged || st.State != "closed" {
|
||||
t.Errorf("merged/state = %t/%q, want true/closed", st.Merged, st.State)
|
||||
}
|
||||
if st.CIStatus != "" {
|
||||
t.Errorf("CIStatus = %q, want empty (no status for a gone commit)", st.CIStatus)
|
||||
}
|
||||
}
|
||||
|
||||
// A non-404 error from the status endpoint is still fatal: only "commit gone" is
|
||||
// tolerated, not, say, an auth or server failure.
|
||||
func TestFetchStateFailsOnNon404StatusError(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":"cafebabecafebabe"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/cafebabecafebabe/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
_, _ = io.WriteString(w, `{"message":"boom"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
if _, err := FetchState(c, ref, "unkin-agent"); err == nil {
|
||||
t.Fatal("FetchState should surface a 500 from the status endpoint")
|
||||
}
|
||||
}
|
||||
|
||||
// Gitea rewrites head.ref to "refs/pull/<n>/head" once the PR's branch is
|
||||
// deleted, which merging does in these repos. Matching a branch against
|
||||
// head.ref alone therefore finds nothing for every merged PR; head.label keeps
|
||||
// the original name.
|
||||
func TestPRHeadBranch(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
ref, label string
|
||||
want string
|
||||
}{
|
||||
{"merged, branch deleted", "refs/pull/12/head", "benvin/merged", "benvin/merged"},
|
||||
{"open PR", "benvin/open", "benvin/open", "benvin/open"},
|
||||
{"fully qualified ref", "refs/heads/benvin/x", "", "benvin/x"},
|
||||
{"no label falls back to ref", "benvin/y", "", "benvin/y"},
|
||||
{"cross-repo label", "benvin/z", "someone:benvin/z", "benvin/z"},
|
||||
{"nothing usable", "refs/pull/12/head", "", ""},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var pr PullRequest
|
||||
pr.Head.Ref = tt.ref
|
||||
pr.Head.Label = tt.label
|
||||
if got := PRHeadBranch(pr); got != tt.want {
|
||||
t.Errorf("PRHeadBranch(ref=%q,label=%q) = %q, want %q", tt.ref, tt.label, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestListPRsPaginates(t *testing.T) {
|
||||
var pages []string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls", func(w http.ResponseWriter, r *http.Request) {
|
||||
q := r.URL.Query()
|
||||
pages = append(pages, q.Get("page"))
|
||||
if q.Get("state") != "all" {
|
||||
t.Errorf("state = %q, want all", q.Get("state"))
|
||||
}
|
||||
if q.Get("page") == "1" {
|
||||
full := make([]string, 0, prPageSize)
|
||||
for i := 0; i < prPageSize; i++ {
|
||||
full = append(full, fmt.Sprintf(`{"number":%d,"state":"closed","merged":true,"head":{"ref":"refs/pull/%d/head","label":"benvin/b%d"}}`, i+1, i+1, i+1))
|
||||
}
|
||||
_, _ = io.WriteString(w, "["+strings.Join(full, ",")+"]")
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `[{"number":99,"state":"open","head":{"ref":"benvin/last","label":"benvin/last"}}]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, HTTP: srv.Client()}
|
||||
prs, err := c.ListPRs("unkin/repo", "all")
|
||||
if err != nil {
|
||||
t.Fatalf("ListPRs: %v", err)
|
||||
}
|
||||
if len(prs) != prPageSize+1 {
|
||||
t.Fatalf("got %d PRs, want %d", len(prs), prPageSize+1)
|
||||
}
|
||||
if len(pages) != 2 || pages[0] != "1" || pages[1] != "2" {
|
||||
t.Errorf("pages requested = %v, want [1 2]", pages)
|
||||
}
|
||||
if got := PRHeadBranch(prs[0]); got != "benvin/b1" {
|
||||
t.Errorf("first PR head branch = %q, want benvin/b1", got)
|
||||
}
|
||||
if !prs[len(prs)-1].IsOpen() {
|
||||
t.Error("last PR should be open")
|
||||
}
|
||||
}
|
||||
|
||||
// A listing that fills every page is truncated: the caller must be told rather
|
||||
// than treating a partial view as the whole repo.
|
||||
func TestListPRsReportsTruncation(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls", func(w http.ResponseWriter, r *http.Request) {
|
||||
full := make([]string, 0, prPageSize)
|
||||
for i := 0; i < prPageSize; i++ {
|
||||
full = append(full, fmt.Sprintf(`{"number":%s,"state":"open"}`, r.URL.Query().Get("page")))
|
||||
}
|
||||
_, _ = io.WriteString(w, "["+strings.Join(full, ",")+"]")
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, HTTP: srv.Client()}
|
||||
prs, err := c.ListPRs("unkin/repo", "all")
|
||||
if !errors.Is(err, ErrPRListTruncated) {
|
||||
t.Fatalf("ListPRs err = %v, want ErrPRListTruncated", err)
|
||||
}
|
||||
if len(prs) != maxPRPages*prPageSize {
|
||||
t.Errorf("got %d PRs, want %d", len(prs), maxPRPages*prPageSize)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGiteaAPIError(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls", func(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -177,3 +403,687 @@ func TestGiteaAPIError(t *testing.T) {
|
||||
t.Fatal("expected error on 422")
|
||||
}
|
||||
}
|
||||
|
||||
// expiringGitea serves the PR endpoint, rejecting every token other than
|
||||
// wantToken with a 401 exactly as Gitea does once a Vault-minted token expires.
|
||||
// It records the tokens it saw, newest last.
|
||||
func expiringGitea(t *testing.T, wantToken string, seen *[]string) *httptest.Server {
|
||||
t.Helper()
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
tok := strings.TrimPrefix(r.Header.Get("Authorization"), "token ")
|
||||
*seen = append(*seen, tok)
|
||||
if tok != wantToken {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = io.WriteString(w, `{"message":"invalid username, password or token"}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
return httptest.NewServer(mux)
|
||||
}
|
||||
|
||||
// The production failure: the token expired mid-run. The client must re-mint
|
||||
// once and replay the request with the fresh token.
|
||||
func TestExpiredTokenIsRemintedAndRetried(t *testing.T) {
|
||||
var seen []string
|
||||
srv := expiringGitea(t, "fresh", &seen)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "fresh", nil }}
|
||||
|
||||
pr, err := c.GetPR("unkin/repo", 7)
|
||||
if err != nil {
|
||||
t.Fatalf("GetPR after re-mint: %v", err)
|
||||
}
|
||||
if pr.Number != 7 {
|
||||
t.Errorf("PR number = %d, want 7", pr.Number)
|
||||
}
|
||||
if refreshes != 1 {
|
||||
t.Errorf("refreshes = %d, want 1", refreshes)
|
||||
}
|
||||
if len(seen) != 2 || seen[0] != "stale" || seen[1] != "fresh" {
|
||||
t.Errorf("tokens seen = %v, want [stale fresh]", seen)
|
||||
}
|
||||
if c.Token != "fresh" {
|
||||
t.Errorf("client token = %q, want the refreshed token", c.Token)
|
||||
}
|
||||
}
|
||||
|
||||
// A fresh token that is also rejected is a real auth failure: report it as one
|
||||
// rather than re-minting forever.
|
||||
func TestAuthFailureSurvivesRemint(t *testing.T) {
|
||||
var seen []string
|
||||
srv := expiringGitea(t, "never-issued", &seen)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "still-bad", nil }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil {
|
||||
t.Fatal("GetPR should fail when the fresh token is rejected too")
|
||||
}
|
||||
if !IsAuthError(err) {
|
||||
t.Errorf("IsAuthError(%v) = false, want true", err)
|
||||
}
|
||||
if refreshes != 1 {
|
||||
t.Errorf("refreshes = %d, want 1 (re-mint exactly once)", refreshes)
|
||||
}
|
||||
if len(seen) != 2 {
|
||||
t.Errorf("requests = %d, want 2", len(seen))
|
||||
}
|
||||
}
|
||||
|
||||
// A refresh that itself fails must surface as an auth error, not as a silent
|
||||
// success or a bare Vault error.
|
||||
func TestRemintErrorIsReportedAsAuthFailure(t *testing.T) {
|
||||
var seen []string
|
||||
srv := expiringGitea(t, "fresh", &seen)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { return "", errors.New("vault approle login: HTTP 503") }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil || !IsAuthError(err) {
|
||||
t.Fatalf("GetPR error = %v, want an auth error", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "vault approle login") {
|
||||
t.Errorf("error %q should name the re-mint failure", err)
|
||||
}
|
||||
if len(seen) != 1 {
|
||||
t.Errorf("requests = %d, want 1 (no replay without a token)", len(seen))
|
||||
}
|
||||
}
|
||||
|
||||
// A 5xx is transient, not an auth problem: no re-mint, no retry, and the caller
|
||||
// keeps its existing retry behaviour.
|
||||
func TestServerErrorDoesNotRemint(t *testing.T) {
|
||||
requests := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusBadGateway)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "fresh", nil }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil {
|
||||
t.Fatal("expected error on 502")
|
||||
}
|
||||
if IsAuthError(err) {
|
||||
t.Errorf("502 must not be an auth error")
|
||||
}
|
||||
if refreshes != 0 || requests != 1 {
|
||||
t.Errorf("refreshes = %d, requests = %d, want 0 and 1", refreshes, requests)
|
||||
}
|
||||
}
|
||||
|
||||
// The replayed request must carry the original body, not an empty one.
|
||||
func TestRemintReplaysRequestBody(t *testing.T) {
|
||||
var bodies []CreatePROptions
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls", func(w http.ResponseWriter, r *http.Request) {
|
||||
var body CreatePROptions
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
bodies = append(bodies, body)
|
||||
if strings.TrimPrefix(r.Header.Get("Authorization"), "token ") != "fresh" {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { return "fresh", nil }}
|
||||
|
||||
if _, err := c.CreatePR("unkin/repo", CreatePROptions{Base: "main", Head: "feature", Title: "T", Body: "B"}); err != nil {
|
||||
t.Fatalf("CreatePR: %v", err)
|
||||
}
|
||||
if len(bodies) != 2 {
|
||||
t.Fatalf("requests = %d, want 2", len(bodies))
|
||||
}
|
||||
if bodies[1] != bodies[0] {
|
||||
t.Errorf("replayed body = %+v, want %+v", bodies[1], bodies[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsAuthError(t *testing.T) {
|
||||
tests := []struct {
|
||||
status int
|
||||
want bool
|
||||
}{
|
||||
{http.StatusUnauthorized, true},
|
||||
{http.StatusForbidden, true},
|
||||
{http.StatusNotFound, false},
|
||||
{http.StatusUnprocessableEntity, false},
|
||||
{http.StatusBadGateway, false},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
err := error(&APIError{Method: "GET", Path: "/p", StatusCode: tt.status})
|
||||
if got := IsAuthError(err); got != tt.want {
|
||||
t.Errorf("IsAuthError(HTTP %d) = %v, want %v", tt.status, got, tt.want)
|
||||
}
|
||||
}
|
||||
if IsAuthError(errors.New("dial tcp: timeout")) {
|
||||
t.Errorf("a network error is not an auth error")
|
||||
}
|
||||
}
|
||||
|
||||
// Anonymous polling of a public repo is a supported mode: with no token the
|
||||
// client must send no Authorization header, and must never reach for Vault.
|
||||
func TestAnonymousPollingNeverMints(t *testing.T) {
|
||||
authHeaders := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Header.Get("Authorization") != "" {
|
||||
authHeaders++
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/cafebabe/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "", errors.New("vault unreachable") }}
|
||||
|
||||
st, err := FetchState(c, PRRef{Owner: "unkin", Repo: "repo", Number: 7}, "unkin-agent")
|
||||
if err != nil {
|
||||
t.Fatalf("anonymous FetchState: %v", err)
|
||||
}
|
||||
if st.State != "open" || st.CIStatus != "success" || st.HeadSHA != "cafebabe" {
|
||||
t.Errorf("state = %+v", st)
|
||||
}
|
||||
if refreshes != 0 {
|
||||
t.Errorf("refreshes = %d, want 0 (a 200 must never trigger a mint)", refreshes)
|
||||
}
|
||||
if authHeaders != 0 {
|
||||
t.Errorf("sent %d Authorization headers, want none", authHeaders)
|
||||
}
|
||||
}
|
||||
|
||||
// Anonymous access to something that is not public is not a stale credential:
|
||||
// nothing was sent to be rejected, so the client must not burn a Vault mint on
|
||||
// every poll, and the error must say a token was missing rather than expired.
|
||||
func TestAnonymousAuthFailureNeverMints(t *testing.T) {
|
||||
requests := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = io.WriteString(w, `{"message":"invalid username, password or token"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "fresh", nil }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error on an anonymous 401")
|
||||
}
|
||||
if !IsNoCredential(err) {
|
||||
t.Errorf("IsNoCredential(%v) = false, want true", err)
|
||||
}
|
||||
if !IsAuthError(err) {
|
||||
t.Errorf("IsAuthError(%v) = false; an anonymous rejection still ends a watch", err)
|
||||
}
|
||||
if refreshes != 0 {
|
||||
t.Errorf("refreshes = %d, want 0 (nothing was rejected)", refreshes)
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Errorf("requests = %d, want 1 (no replay)", requests)
|
||||
}
|
||||
}
|
||||
|
||||
// Gitea's bare "Forbidden" is a permission boundary, not an expired token. A
|
||||
// re-mint cannot grant a permission the identity lacks, so the client must not
|
||||
// spend one, and the failure must not be reported as an auth expiry.
|
||||
func TestPermissionDeniedIsNotRemintedOrRetried(t *testing.T) {
|
||||
requests := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
_, _ = io.WriteString(w, `{"errors":null,"message":"Forbidden","url":"https://git.unkin.net/api/swagger"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "fresh", nil }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error on a 403")
|
||||
}
|
||||
if !IsPermissionDenied(err) {
|
||||
t.Errorf("IsPermissionDenied(%v) = false, want true", err)
|
||||
}
|
||||
if IsCredentialRejected(err) {
|
||||
t.Errorf("a bare Forbidden must not read as a rejected credential")
|
||||
}
|
||||
if refreshes != 0 || requests != 1 {
|
||||
t.Errorf("refreshes = %d, requests = %d, want 0 and 1", refreshes, requests)
|
||||
}
|
||||
}
|
||||
|
||||
// A 403 that names the token is a credential problem after all (Gitea reports a
|
||||
// missing scope this way), so it keeps the re-mint-and-replay path.
|
||||
func TestScopeForbiddenIsRemintedAndRetried(t *testing.T) {
|
||||
var seen []string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
tok := strings.TrimPrefix(r.Header.Get("Authorization"), "token ")
|
||||
seen = append(seen, tok)
|
||||
if tok != "fresh" {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
_, _ = io.WriteString(w, `{"message":"token does not have at least one of required scope(s): [read:repository]"}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "fresh", nil }}
|
||||
|
||||
pr, err := c.GetPR("unkin/repo", 7)
|
||||
if err != nil {
|
||||
t.Fatalf("GetPR after re-mint: %v", err)
|
||||
}
|
||||
if pr.Number != 7 || refreshes != 1 {
|
||||
t.Errorf("PR = %+v, refreshes = %d, want PR 7 and 1 re-mint", pr, refreshes)
|
||||
}
|
||||
if len(seen) != 2 || seen[1] != "fresh" {
|
||||
t.Errorf("tokens seen = %v, want [stale fresh]", seen)
|
||||
}
|
||||
}
|
||||
|
||||
// A re-mint that hands back an empty token must fail loudly. Replaying with it
|
||||
// would drop the Authorization header, and on a public repo that anonymous
|
||||
// replay succeeds — the watch would carry on having quietly lost its identity.
|
||||
func TestEmptyRemintedTokenFailsInsteadOfGoingAnonymous(t *testing.T) {
|
||||
var seen []string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
tok := strings.TrimPrefix(r.Header.Get("Authorization"), "token ")
|
||||
seen = append(seen, tok)
|
||||
if tok == "stale" {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = io.WriteString(w, `{"message":"invalid username, password or token"}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "stale", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { return "", nil }}
|
||||
|
||||
_, err := c.GetPR("unkin/repo", 7)
|
||||
if err == nil {
|
||||
t.Fatal("an empty re-minted token must be an error, not an anonymous retry")
|
||||
}
|
||||
if !IsAuthError(err) {
|
||||
t.Errorf("IsAuthError(%v) = false, want true", err)
|
||||
}
|
||||
if len(seen) != 1 {
|
||||
t.Errorf("requests = %d, want 1 (no anonymous replay)", len(seen))
|
||||
}
|
||||
}
|
||||
|
||||
// The real-world rotation case end to end: the watch runs happily for several
|
||||
// polls, then the Vault lease expires and Gitea rejects every token, the fresh
|
||||
// one included. Watch must end with a named auth failure instead of polling on.
|
||||
func TestWatchAbortsWhenTokenExpiresMidWatch(t *testing.T) {
|
||||
polls := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
polls++
|
||||
if polls > 3 {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = io.WriteString(w, `{"message":"invalid username, password or token"}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":7,"state":"open","mergeable":true,"head":{"sha":"cafebabe"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/cafebabe/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
refreshes := 0
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t1", HTTP: srv.Client(),
|
||||
Refresh: func() (string, error) { refreshes++; return "t2", nil }}
|
||||
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
ticks := make(chan time.Time, 5)
|
||||
for i := 0; i < 5; i++ {
|
||||
ticks <- time.Now()
|
||||
}
|
||||
close(ticks)
|
||||
|
||||
warned := 0
|
||||
_, err := Watch(c, []PRRef{ref}, "unkin-agent", ticks, nil, func(PRRef, error) { warned++ })
|
||||
if err == nil {
|
||||
t.Fatal("Watch returned nil: an expired token must end the watch, not be polled past")
|
||||
}
|
||||
if !IsAuthError(err) {
|
||||
t.Errorf("Watch error = %v, want an auth error", err)
|
||||
}
|
||||
if IsNoCredential(err) {
|
||||
t.Errorf("a rejected token must not be reported as a missing one: %v", err)
|
||||
}
|
||||
if refreshes != 1 {
|
||||
t.Errorf("refreshes = %d, want 1", refreshes)
|
||||
}
|
||||
if warned != 0 {
|
||||
t.Errorf("auth failure logged as a warning %d time(s); it must abort", warned)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateIssueRequestBody(t *testing.T) {
|
||||
var gotPath, gotMethod, gotAuth string
|
||||
var gotBody CreateIssueOptions
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues", func(w http.ResponseWriter, r *http.Request) {
|
||||
gotPath, gotMethod = r.URL.Path, r.Method
|
||||
gotAuth = r.Header.Get("Authorization")
|
||||
_ = json.NewDecoder(r.Body).Decode(&gotBody)
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"open","title":"T","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "gitea-abc", HTTP: srv.Client()}
|
||||
issue, err := c.CreateIssue("unkin/repo", CreateIssueOptions{Title: "T", Body: "B"})
|
||||
if err != nil {
|
||||
t.Fatalf("CreateIssue: %v", err)
|
||||
}
|
||||
if gotMethod != http.MethodPost || gotPath != "/api/v1/repos/unkin/repo/issues" {
|
||||
t.Errorf("request = %s %s, want POST /api/v1/repos/unkin/repo/issues", gotMethod, gotPath)
|
||||
}
|
||||
if gotAuth != "token gitea-abc" {
|
||||
t.Errorf("auth header = %q, want 'token gitea-abc'", gotAuth)
|
||||
}
|
||||
if gotBody.Title != "T" || gotBody.Body != "B" {
|
||||
t.Errorf("request body = %+v", gotBody)
|
||||
}
|
||||
if issue.Number != 12 || issue.HTMLURL != "https://git.unkin.net/unkin/repo/issues/12" {
|
||||
t.Errorf("parsed issue = %+v", issue)
|
||||
}
|
||||
}
|
||||
|
||||
// Filing against a repo that does not exist (or that the token may not see)
|
||||
// gets Gitea's 404, which must surface as a not-found error carrying the API's
|
||||
// own message rather than a bare status.
|
||||
func TestCreateIssueRepoNotFound(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = io.WriteString(w, `{"errors":null,"message":"user redirect does not exist [name: ghost]","url":"https://git.unkin.net/api/swagger"}`)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.CreateIssue("ghost/repo", CreateIssueOptions{Title: "T"})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for a repo that does not exist")
|
||||
}
|
||||
if !IsNotFound(err) {
|
||||
t.Errorf("IsNotFound(%v) = false, want true", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "user redirect does not exist") {
|
||||
t.Errorf("error %q should carry the API message", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Any other non-2xx is a plain API failure: reported, not retried, and not
|
||||
// mistaken for a missing repo.
|
||||
func TestCreateIssueAPIError(t *testing.T) {
|
||||
requests := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues", func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusUnprocessableEntity)
|
||||
_, _ = io.WriteString(w, `{"errors":null,"message":"Validation Error: title is empty","url":"https://git.unkin.net/api/swagger"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.CreateIssue("unkin/repo", CreateIssueOptions{Title: "T"})
|
||||
if err == nil {
|
||||
t.Fatal("expected error on 422")
|
||||
}
|
||||
if IsNotFound(err) {
|
||||
t.Errorf("a 422 must not read as not-found: %v", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "Validation Error") {
|
||||
t.Errorf("error %q should carry the API message", err)
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Errorf("requests = %d, want 1 (a 422 is not retried)", requests)
|
||||
}
|
||||
}
|
||||
|
||||
// An issue edit sends only the fields it was given, for the same reason a PR
|
||||
// edit does: Gitea overwrites whatever key it receives.
|
||||
func TestEditIssueSendsOnlySuppliedFields(t *testing.T) {
|
||||
title, body := "new title", "new body"
|
||||
tests := []struct {
|
||||
name string
|
||||
opts EditOptions
|
||||
want map[string]any
|
||||
}{
|
||||
{"body only", EditOptions{Body: &body}, map[string]any{"body": "new body"}},
|
||||
{"title only", EditOptions{Title: &title}, map[string]any{"title": "new title"}},
|
||||
{"both", EditOptions{Title: &title, Body: &body}, map[string]any{"title": "new title", "body": "new body"}},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
var gotMethod, gotPath string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/12", func(w http.ResponseWriter, r *http.Request) {
|
||||
gotMethod, gotPath = r.Method, r.URL.Path
|
||||
_ = json.NewDecoder(r.Body).Decode(&gotBody)
|
||||
_, _ = io.WriteString(w, `{"number":12,"title":"new title","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
issue, err := c.EditIssue("unkin/repo", 12, tt.opts)
|
||||
if err != nil {
|
||||
t.Fatalf("EditIssue: %v", err)
|
||||
}
|
||||
if gotMethod != http.MethodPatch {
|
||||
t.Errorf("method = %s, want PATCH", gotMethod)
|
||||
}
|
||||
if gotPath != "/api/v1/repos/unkin/repo/issues/12" {
|
||||
t.Errorf("path = %q", gotPath)
|
||||
}
|
||||
if len(gotBody) != len(tt.want) {
|
||||
t.Errorf("payload = %v, want exactly the supplied fields %v", gotBody, tt.want)
|
||||
}
|
||||
for k, v := range tt.want {
|
||||
if gotBody[k] != v {
|
||||
t.Errorf("payload[%q] = %v, want %v", k, gotBody[k], v)
|
||||
}
|
||||
}
|
||||
if issue.Number != 12 || issue.HTMLURL == "" {
|
||||
t.Errorf("parsed issue = %+v", issue)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Closing and reopening differ only in the state sent; both must read the
|
||||
// issue first and then PATCH the issue endpoint with that state alone.
|
||||
func TestSetIssueStateRequest(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
current string
|
||||
state string
|
||||
}{
|
||||
{"close an open issue", IssueStateOpen, IssueStateClosed},
|
||||
{"reopen a closed issue", IssueStateClosed, IssueStateOpen},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var methods []string
|
||||
var gotBody map[string]any
|
||||
var gotPath string
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/12", func(w http.ResponseWriter, r *http.Request) {
|
||||
methods = append(methods, r.Method)
|
||||
gotPath = r.URL.Path
|
||||
if r.Method == http.MethodGet {
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"`+tt.current+`","title":"T","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
return
|
||||
}
|
||||
_ = json.NewDecoder(r.Body).Decode(&gotBody)
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"`+tt.state+`","title":"T","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "gitea-abc", HTTP: srv.Client()}
|
||||
issue, err := c.SetIssueState("unkin/repo", 12, tt.state)
|
||||
if err != nil {
|
||||
t.Fatalf("SetIssueState: %v", err)
|
||||
}
|
||||
if len(methods) != 2 || methods[0] != http.MethodGet || methods[1] != http.MethodPatch {
|
||||
t.Errorf("requests = %v, want a GET then a PATCH", methods)
|
||||
}
|
||||
if gotPath != "/api/v1/repos/unkin/repo/issues/12" {
|
||||
t.Errorf("path = %q", gotPath)
|
||||
}
|
||||
if len(gotBody) != 1 || gotBody["state"] != tt.state {
|
||||
t.Errorf("payload = %v, want only {\"state\":%q}", gotBody, tt.state)
|
||||
}
|
||||
if issue.State != tt.state || issue.Number != 12 {
|
||||
t.Errorf("parsed issue = %+v", issue)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Gitea answers a no-op state change with 200, so an issue already in the
|
||||
// requested state must fail rather than report a change that never happened —
|
||||
// and no PATCH may be sent.
|
||||
func TestSetIssueStateAlreadyInState(t *testing.T) {
|
||||
patches := 0
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/12", func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method == http.MethodPatch {
|
||||
patches++
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"closed","title":"T","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.SetIssueState("unkin/repo", 12, IssueStateClosed)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error closing an already-closed issue")
|
||||
}
|
||||
if !errors.Is(err, ErrIssueStateUnchanged) {
|
||||
t.Errorf("errors.Is(%v, ErrIssueStateUnchanged) = false", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "unkin/repo#12") {
|
||||
t.Errorf("error %q should name the issue", err)
|
||||
}
|
||||
if patches != 0 {
|
||||
t.Errorf("PATCH requests = %d, want 0", patches)
|
||||
}
|
||||
}
|
||||
|
||||
// A non-2xx on either leg must surface the API's own message, not a bare
|
||||
// status, and must not be mistaken for a successful change.
|
||||
func TestSetIssueStateAPIError(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
failOn string
|
||||
status int
|
||||
}{
|
||||
{"read fails", http.MethodGet, http.StatusNotFound},
|
||||
{"write fails", http.MethodPatch, http.StatusForbidden},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/12", func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method == tt.failOn {
|
||||
w.WriteHeader(tt.status)
|
||||
_, _ = io.WriteString(w, `{"message":"no dice","url":"https://git.unkin.net/api/swagger","errors":null}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"open","title":"T","html_url":"https://git.unkin.net/unkin/repo/issues/12"}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.SetIssueState("unkin/repo", 12, IssueStateClosed)
|
||||
if err == nil {
|
||||
t.Fatalf("expected an error when %s returns %d", tt.failOn, tt.status)
|
||||
}
|
||||
if !strings.Contains(err.Error(), `"message":"no dice"`) {
|
||||
t.Errorf("error %q should carry the API message", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Only Gitea's two states are accepted, and a bad one is rejected before any
|
||||
// request goes out.
|
||||
func TestSetIssueStateRejectsUnknownState(t *testing.T) {
|
||||
requests := 0
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
_, err := c.SetIssueState("unkin/repo", 12, "merged")
|
||||
if err == nil {
|
||||
t.Fatal("expected an error for an unknown state")
|
||||
}
|
||||
if !strings.Contains(err.Error(), `invalid issue state "merged"`) {
|
||||
t.Errorf("error = %q, want it to name the invalid state", err)
|
||||
}
|
||||
if requests != 0 {
|
||||
t.Errorf("requests = %d, want 0", requests)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,393 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ensureDir creates dir (and parents) if it does not already exist.
|
||||
func ensureDir(dir string) error {
|
||||
if dir == "" {
|
||||
return nil
|
||||
}
|
||||
return os.MkdirAll(dir, 0o755)
|
||||
}
|
||||
|
||||
// Worktree is one entry from `git worktree list --porcelain`.
|
||||
type Worktree struct {
|
||||
Path string
|
||||
Head string
|
||||
Branch string // short branch name ("" when detached or bare)
|
||||
Bare bool
|
||||
Detached bool
|
||||
Locked bool
|
||||
// Prunable is git's own reason a registration is stale (e.g. "gitdir file
|
||||
// points to non-existent location"); empty when the worktree is intact.
|
||||
Prunable string
|
||||
}
|
||||
|
||||
// runGit runs git with args, using dir as the working directory (empty = the
|
||||
// process cwd). It returns trimmed stdout, or an error that includes stderr so
|
||||
// failures like "branch already checked out" surface verbatim.
|
||||
func runGit(dir string, args ...string) (string, error) {
|
||||
cmd := exec.Command("git", args...)
|
||||
if dir != "" {
|
||||
cmd.Dir = dir
|
||||
}
|
||||
var stdout, stderr bytes.Buffer
|
||||
cmd.Stdout = &stdout
|
||||
cmd.Stderr = &stderr
|
||||
if err := cmd.Run(); err != nil {
|
||||
msg := strings.TrimSpace(stderr.String())
|
||||
if msg == "" {
|
||||
msg = strings.TrimSpace(stdout.String())
|
||||
}
|
||||
return "", fmt.Errorf("git %s: %w: %s", strings.Join(args, " "), err, msg)
|
||||
}
|
||||
return strings.TrimSpace(stdout.String()), nil
|
||||
}
|
||||
|
||||
// GitClone clones url into dir. Any globalArgs (e.g. "-c",
|
||||
// "credential.helper=...") are passed before the clone subcommand so auth can be
|
||||
// supplied without persisting it in the resulting checkout's config.
|
||||
func GitClone(url, dir string, globalArgs ...string) error {
|
||||
if err := ensureDir(filepath.Dir(dir)); err != nil {
|
||||
return err
|
||||
}
|
||||
args := append(append([]string{}, globalArgs...), "clone", url, dir)
|
||||
_, err := runGit(filepath.Dir(dir), args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitFetch runs `git fetch <remote>` in repoDir. globalArgs are passed before
|
||||
// the subcommand (used to inject an ephemeral credential helper).
|
||||
func GitFetch(repoDir, remote string, globalArgs ...string) error {
|
||||
args := append(append([]string{}, globalArgs...), "fetch", remote)
|
||||
_, err := runGit(repoDir, args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitFetchPrune runs `git fetch --prune <remote>` in repoDir so remote-tracking
|
||||
// refs for branches deleted on the remote (e.g. after a merge) disappear.
|
||||
func GitFetchPrune(repoDir, remote string, globalArgs ...string) error {
|
||||
args := append(append([]string{}, globalArgs...), "fetch", "--prune", remote)
|
||||
_, err := runGit(repoDir, args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitRemoteDefaultBranch returns the short name of remote's default branch
|
||||
// (e.g. "main") by resolving refs/remotes/<remote>/HEAD.
|
||||
func GitRemoteDefaultBranch(repoDir, remote string) (string, error) {
|
||||
out, err := runGit(repoDir, "rev-parse", "--abbrev-ref", remote+"/HEAD")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return strings.TrimPrefix(out, remote+"/"), nil
|
||||
}
|
||||
|
||||
// GitBranchExists reports whether a local branch exists.
|
||||
func GitBranchExists(repoDir, branch string) bool {
|
||||
_, err := runGit(repoDir, "show-ref", "--verify", "--quiet", "refs/heads/"+branch)
|
||||
return err == nil
|
||||
}
|
||||
|
||||
// GitRemoteURL returns the configured URL for a remote.
|
||||
func GitRemoteURL(repoDir, remote string) (string, error) {
|
||||
return runGit(repoDir, "remote", "get-url", remote)
|
||||
}
|
||||
|
||||
// GitRemoteBranchExists reports whether a remote-tracking ref for branch exists
|
||||
// (accurate only after a pruning fetch).
|
||||
func GitRemoteBranchExists(repoDir, remote, branch string) bool {
|
||||
_, err := runGit(repoDir, "show-ref", "--verify", "--quiet", "refs/remotes/"+remote+"/"+branch)
|
||||
return err == nil
|
||||
}
|
||||
|
||||
// GitRevParse resolves ref to a full object id in repoDir.
|
||||
func GitRevParse(repoDir, ref string) (string, error) {
|
||||
return runGit(repoDir, "rev-parse", ref)
|
||||
}
|
||||
|
||||
// GitAheadCount counts commits reachable from head that upstream does not hold.
|
||||
func GitAheadCount(repoDir, upstream, head string) (int, error) {
|
||||
out, err := runGit(repoDir, "rev-list", "--count", upstream+".."+head)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
n, err := strconv.Atoi(strings.TrimSpace(out))
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("parse rev-list count %q: %w", out, err)
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// GitMergeFFOnly advances the branch checked out at dir to ref, failing rather
|
||||
// than writing a merge commit when the move is not a fast-forward.
|
||||
func GitMergeFFOnly(dir, ref string) error {
|
||||
_, err := runGit(dir, "merge", "--ff-only", ref)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitSetUpstream points branch at the remote-tracking ref upstream.
|
||||
func GitSetUpstream(repoDir, branch, upstream string) error {
|
||||
_, err := runGit(repoDir, "branch", "--set-upstream-to="+upstream, branch)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitIsDirty reports whether the checkout at dir has uncommitted or untracked
|
||||
// changes.
|
||||
func GitIsDirty(dir string) (bool, error) {
|
||||
out, err := runGit(dir, "status", "--porcelain")
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return strings.TrimSpace(out) != "", nil
|
||||
}
|
||||
|
||||
// GitDir returns the absolute path to the git directory backing the checkout at
|
||||
// dir (per-worktree, unlike GitCommonDir).
|
||||
func GitDir(dir string) (string, error) {
|
||||
return runGit(dir, "rev-parse", "--path-format=absolute", "--git-dir")
|
||||
}
|
||||
|
||||
// inProgressMarkers maps a sentinel inside the git dir to the operation it means
|
||||
// is half-finished. Such a checkout holds state that lives nowhere else.
|
||||
var inProgressMarkers = []struct{ path, op string }{
|
||||
{"rebase-merge", "rebase"},
|
||||
{"rebase-apply", "rebase"},
|
||||
{"MERGE_HEAD", "merge"},
|
||||
{"CHERRY_PICK_HEAD", "cherry-pick"},
|
||||
{"REVERT_HEAD", "revert"},
|
||||
{"BISECT_LOG", "bisect"},
|
||||
}
|
||||
|
||||
// GitInProgressOp names the sequencer operation underway in the checkout at dir,
|
||||
// or "" when none is.
|
||||
func GitInProgressOp(dir string) (string, error) {
|
||||
gitDir, err := GitDir(dir)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
for _, m := range inProgressMarkers {
|
||||
if _, err := os.Stat(filepath.Join(gitDir, m.path)); err == nil {
|
||||
return m.op, nil
|
||||
} else if !os.IsNotExist(err) {
|
||||
return "", err
|
||||
}
|
||||
}
|
||||
return "", nil
|
||||
}
|
||||
|
||||
// GitCommitsNotOnRemotes counts commits reachable from HEAD that no
|
||||
// remote-tracking ref holds, i.e. work that exists only in this checkout.
|
||||
func GitCommitsNotOnRemotes(dir string) (int, error) {
|
||||
out, err := runGit(dir, "rev-list", "--count", "HEAD", "--not", "--remotes")
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
n, err := strconv.Atoi(strings.TrimSpace(out))
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("parse rev-list count %q: %w", out, err)
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// GitIsAncestor reports whether ancestor is reachable from descendant.
|
||||
func GitIsAncestor(repoDir, ancestor, descendant string) (bool, error) {
|
||||
cmd := exec.Command("git", "merge-base", "--is-ancestor", ancestor, descendant)
|
||||
cmd.Dir = repoDir
|
||||
var stderr bytes.Buffer
|
||||
cmd.Stderr = &stderr
|
||||
if err := cmd.Run(); err != nil {
|
||||
// Exit 1 is the documented "not an ancestor" answer; anything else is a
|
||||
// real failure (bad ref, not a repo).
|
||||
var exitErr *exec.ExitError
|
||||
if errors.As(err, &exitErr) && exitErr.ExitCode() == 1 {
|
||||
return false, nil
|
||||
}
|
||||
return false, fmt.Errorf("git merge-base --is-ancestor %s %s: %w: %s",
|
||||
ancestor, descendant, err, strings.TrimSpace(stderr.String()))
|
||||
}
|
||||
return true, nil
|
||||
}
|
||||
|
||||
// GitUnmergedCommits counts commits on head whose patch has no equivalent on
|
||||
// upstream, using `git cherry` so squash- and rebase-merged work is recognised
|
||||
// despite its rewritten SHAs.
|
||||
func GitUnmergedCommits(repoDir, upstream, head string) (int, error) {
|
||||
out, err := runGit(repoDir, "cherry", upstream, head)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
n := 0
|
||||
for _, line := range strings.Split(out, "\n") {
|
||||
if strings.HasPrefix(strings.TrimSpace(line), "+") {
|
||||
n++
|
||||
}
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// GitWorktreeAdd adds a worktree at path checked out to branch. When the branch
|
||||
// already exists it is reused; otherwise it is created from startPoint.
|
||||
func GitWorktreeAdd(repoDir, path, branch, startPoint string) error {
|
||||
if err := ensureDir(filepath.Dir(path)); err != nil {
|
||||
return err
|
||||
}
|
||||
var args []string
|
||||
if GitBranchExists(repoDir, branch) {
|
||||
args = []string{"worktree", "add", path, branch}
|
||||
} else {
|
||||
args = []string{"worktree", "add", path, "-b", branch, startPoint}
|
||||
}
|
||||
_, err := runGit(repoDir, args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitWorktreeRemove removes the worktree at path (force skips the dirty check).
|
||||
func GitWorktreeRemove(repoDir, path string, force bool) error {
|
||||
args := []string{"worktree", "remove", path}
|
||||
if force {
|
||||
args = append(args, "--force")
|
||||
}
|
||||
_, err := runGit(repoDir, args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitWorktreePrune prunes stale worktree administrative entries.
|
||||
func GitWorktreePrune(repoDir string) error {
|
||||
_, err := runGit(repoDir, "worktree", "prune")
|
||||
return err
|
||||
}
|
||||
|
||||
// GitWorktreeList returns the worktrees registered for repoDir.
|
||||
func GitWorktreeList(repoDir string) ([]Worktree, error) {
|
||||
out, err := runGit(repoDir, "worktree", "list", "--porcelain")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return ParseWorktreeList(out), nil
|
||||
}
|
||||
|
||||
// GitDeleteBranch deletes a local branch (force uses -D).
|
||||
func GitDeleteBranch(repoDir, branch string, force bool) error {
|
||||
flag := "-d"
|
||||
if force {
|
||||
flag = "-D"
|
||||
}
|
||||
_, err := runGit(repoDir, "branch", flag, branch)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitConfigSet sets a config key in repoDir. When worktree is true the value is
|
||||
// written to the per-worktree config (extensions.worktreeConfig must be enabled)
|
||||
// so it does not touch the shared checkout's config.
|
||||
func GitConfigSet(repoDir string, worktree bool, key, value string) error {
|
||||
args := []string{"config"}
|
||||
if worktree {
|
||||
args = append(args, "--worktree")
|
||||
}
|
||||
args = append(args, key, value)
|
||||
_, err := runGit(repoDir, args...)
|
||||
return err
|
||||
}
|
||||
|
||||
// GitCommonDir returns the absolute path to the shared .git directory for the
|
||||
// checkout at dir (a worktree's common dir points back at its source repo).
|
||||
func GitCommonDir(dir string) (string, error) {
|
||||
out, err := runGit(dir, "rev-parse", "--path-format=absolute", "--git-common-dir")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// GitCurrentBranch returns the short branch name checked out at dir.
|
||||
func GitCurrentBranch(dir string) (string, error) {
|
||||
return runGit(dir, "rev-parse", "--abbrev-ref", "HEAD")
|
||||
}
|
||||
|
||||
// SourceRepoDir maps a worktree checkout to its source repo directory by walking
|
||||
// from the shared .git common dir up to the repo root.
|
||||
func SourceRepoDir(worktreeDir string) (string, error) {
|
||||
common, err := GitCommonDir(worktreeDir)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
// common is ".../<repo>/.git"; the repo dir is its parent.
|
||||
return filepath.Dir(common), nil
|
||||
}
|
||||
|
||||
// ParseWorktreeList parses the output of `git worktree list --porcelain`.
|
||||
func ParseWorktreeList(out string) []Worktree {
|
||||
var wts []Worktree
|
||||
var cur *Worktree
|
||||
flush := func() {
|
||||
if cur != nil {
|
||||
wts = append(wts, *cur)
|
||||
cur = nil
|
||||
}
|
||||
}
|
||||
for _, line := range strings.Split(out, "\n") {
|
||||
line = strings.TrimRight(line, "\r")
|
||||
if line == "" {
|
||||
flush()
|
||||
continue
|
||||
}
|
||||
key, val, _ := strings.Cut(line, " ")
|
||||
switch key {
|
||||
case "worktree":
|
||||
flush()
|
||||
cur = &Worktree{Path: val}
|
||||
case "HEAD":
|
||||
if cur != nil {
|
||||
cur.Head = val
|
||||
}
|
||||
case "branch":
|
||||
if cur != nil {
|
||||
cur.Branch = strings.TrimPrefix(val, "refs/heads/")
|
||||
}
|
||||
case "bare":
|
||||
if cur != nil {
|
||||
cur.Bare = true
|
||||
}
|
||||
case "detached":
|
||||
if cur != nil {
|
||||
cur.Detached = true
|
||||
}
|
||||
case "locked":
|
||||
if cur != nil {
|
||||
cur.Locked = true
|
||||
}
|
||||
case "prunable":
|
||||
if cur != nil {
|
||||
// git omits the reason when it has none, so record the flag itself.
|
||||
cur.Prunable = val
|
||||
if cur.Prunable == "" {
|
||||
cur.Prunable = "prunable"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
flush()
|
||||
return wts
|
||||
}
|
||||
|
||||
// SanitizeBranch turns a branch name into a filesystem-safe path segment by
|
||||
// replacing separators that would otherwise create nested directories.
|
||||
func SanitizeBranch(branch string) string {
|
||||
r := strings.NewReplacer("/", "-", "\\", "-", ":", "-", " ", "-")
|
||||
return r.Replace(strings.TrimSpace(branch))
|
||||
}
|
||||
|
||||
// WorktreeDirName is the directory name (under the worktree root) for a repo's
|
||||
// branch worktree: "<repo>__<sanitized-branch>".
|
||||
func WorktreeDirName(repo, branch string) string {
|
||||
return repo + "__" + SanitizeBranch(branch)
|
||||
}
|
||||
@@ -0,0 +1,432 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSanitizeBranch(t *testing.T) {
|
||||
tests := []struct {
|
||||
in, want string
|
||||
}{
|
||||
{"benvin/agentws", "benvin-agentws"},
|
||||
{"main", "main"},
|
||||
{" feature/x ", "feature-x"},
|
||||
{"a/b/c", "a-b-c"},
|
||||
{"ns:thing", "ns-thing"},
|
||||
{"with space", "with-space"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
if got := SanitizeBranch(tt.in); got != tt.want {
|
||||
t.Errorf("SanitizeBranch(%q) = %q, want %q", tt.in, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestWorktreeDirName(t *testing.T) {
|
||||
if got := WorktreeDirName("argocd-apps", "benvin/foo"); got != "argocd-apps__benvin-foo" {
|
||||
t.Errorf("WorktreeDirName = %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseWorktreeList(t *testing.T) {
|
||||
out := `worktree /home/ben/src/prodenv/repo
|
||||
HEAD 1111111111111111111111111111111111111111
|
||||
branch refs/heads/main
|
||||
|
||||
worktree /home/ben/.cache/agentws/repo__benvin-foo
|
||||
HEAD 2222222222222222222222222222222222222222
|
||||
branch refs/heads/benvin/foo
|
||||
|
||||
worktree /home/ben/.cache/agentws/repo__detached
|
||||
HEAD 3333333333333333333333333333333333333333
|
||||
detached
|
||||
|
||||
worktree /home/ben/.cache/agentws/repo__gone
|
||||
HEAD 4444444444444444444444444444444444444444
|
||||
branch refs/heads/benvin/gone
|
||||
prunable gitdir file points to non-existent location
|
||||
|
||||
worktree /home/ben/.cache/agentws/repo__held
|
||||
HEAD 5555555555555555555555555555555555555555
|
||||
branch refs/heads/benvin/held
|
||||
locked
|
||||
`
|
||||
wts := ParseWorktreeList(out)
|
||||
if len(wts) != 5 {
|
||||
t.Fatalf("got %d worktrees, want 5: %+v", len(wts), wts)
|
||||
}
|
||||
if wts[0].Branch != "main" || wts[0].Path != "/home/ben/src/prodenv/repo" {
|
||||
t.Errorf("wt[0] = %+v", wts[0])
|
||||
}
|
||||
if wts[1].Branch != "benvin/foo" {
|
||||
t.Errorf("wt[1].Branch = %q, want benvin/foo", wts[1].Branch)
|
||||
}
|
||||
if !wts[2].Detached || wts[2].Branch != "" {
|
||||
t.Errorf("wt[2] = %+v, want detached with empty branch", wts[2])
|
||||
}
|
||||
if wts[3].Prunable != "gitdir file points to non-existent location" {
|
||||
t.Errorf("wt[3].Prunable = %q", wts[3].Prunable)
|
||||
}
|
||||
if !wts[4].Locked || wts[4].Prunable != "" {
|
||||
t.Errorf("wt[4] = %+v, want locked and not prunable", wts[4])
|
||||
}
|
||||
}
|
||||
|
||||
// A bare "prunable" with no reason still has to read as prunable.
|
||||
func TestParseWorktreeListPrunableWithoutReason(t *testing.T) {
|
||||
wts := ParseWorktreeList("worktree /tmp/wt\nHEAD 1111111111111111111111111111111111111111\ndetached\nprunable\n")
|
||||
if len(wts) != 1 || wts[0].Prunable == "" {
|
||||
t.Errorf("ParseWorktreeList = %+v, want one prunable worktree", wts)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGitInProgressOp(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
gitDir, err := GitDir(srcDir)
|
||||
if err != nil {
|
||||
t.Fatalf("GitDir: %v", err)
|
||||
}
|
||||
if op, err := GitInProgressOp(srcDir); err != nil || op != "" {
|
||||
t.Fatalf("clean checkout: op = %q, err = %v", op, err)
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
marker string
|
||||
dir bool
|
||||
want string
|
||||
}{
|
||||
{"MERGE_HEAD", false, "merge"},
|
||||
{"CHERRY_PICK_HEAD", false, "cherry-pick"},
|
||||
{"REVERT_HEAD", false, "revert"},
|
||||
{"BISECT_LOG", false, "bisect"},
|
||||
{"rebase-merge", true, "rebase"},
|
||||
{"rebase-apply", true, "rebase"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
path := filepath.Join(gitDir, tt.marker)
|
||||
if tt.dir {
|
||||
if err := os.Mkdir(path, 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
} else if err := os.WriteFile(path, []byte("x\n"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
op, err := GitInProgressOp(srcDir)
|
||||
if err != nil || op != tt.want {
|
||||
t.Errorf("%s: op = %q, err = %v; want %q", tt.marker, op, err, tt.want)
|
||||
}
|
||||
if err := os.RemoveAll(path); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Commits that reached a remote-tracking ref are not unique local work; commits
|
||||
// made after the push are.
|
||||
func TestGitCommitsNotOnRemotes(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
if n, err := GitCommitsNotOnRemotes(srcDir); err != nil || n != 0 {
|
||||
t.Fatalf("freshly cloned main: n = %d, err = %v; want 0", n, err)
|
||||
}
|
||||
|
||||
if _, err := runGit(srcDir, "checkout", "-b", "benvin/x"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
commitFile(t, srcDir, "a.txt", "a\n", "local a")
|
||||
commitFile(t, srcDir, "b.txt", "b\n", "local b")
|
||||
if n, err := GitCommitsNotOnRemotes(srcDir); err != nil || n != 2 {
|
||||
t.Fatalf("two unpushed commits: n = %d, err = %v; want 2", n, err)
|
||||
}
|
||||
|
||||
if _, err := runGit(srcDir, "push", "origin", "benvin/x"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if n, err := GitCommitsNotOnRemotes(srcDir); err != nil || n != 0 {
|
||||
t.Fatalf("after push: n = %d, err = %v; want 0", n, err)
|
||||
}
|
||||
|
||||
commitFile(t, srcDir, "c.txt", "c\n", "local c")
|
||||
if n, err := GitCommitsNotOnRemotes(srcDir); err != nil || n != 1 {
|
||||
t.Fatalf("one commit past the push: n = %d, err = %v; want 1", n, err)
|
||||
}
|
||||
}
|
||||
|
||||
func commitFile(t *testing.T, dir, name, content, msg string) {
|
||||
t.Helper()
|
||||
if err := os.WriteFile(filepath.Join(dir, name), []byte(content), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := runGit(dir, "add", "."); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := runGit(dir, "commit", "-m", msg); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
// gitSeed sets a repo-local identity so commits work without global config.
|
||||
func gitIdentity(t *testing.T, dir string) {
|
||||
t.Helper()
|
||||
if err := GitConfigSet(dir, false, "user.email", "test@example.com"); err != nil {
|
||||
t.Fatalf("set user.email: %v", err)
|
||||
}
|
||||
if err := GitConfigSet(dir, false, "user.name", "Test"); err != nil {
|
||||
t.Fatalf("set user.name: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// newTempRepos builds a bare "origin" with one commit on main and clones it into
|
||||
// srcDir (so refs/remotes/origin/HEAD is set), returning the source checkout.
|
||||
func newTempRepos(t *testing.T) string {
|
||||
t.Helper()
|
||||
root := t.TempDir()
|
||||
bare := filepath.Join(root, "origin.git")
|
||||
if _, err := runGit(root, "init", "--bare", "-b", "main", bare); err != nil {
|
||||
t.Fatalf("init bare: %v", err)
|
||||
}
|
||||
|
||||
seed := filepath.Join(root, "seed")
|
||||
if _, err := runGit(root, "init", "-b", "main", seed); err != nil {
|
||||
t.Fatalf("init seed: %v", err)
|
||||
}
|
||||
gitIdentity(t, seed)
|
||||
if err := os.WriteFile(filepath.Join(seed, "README.md"), []byte("hi\n"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := runGit(seed, "add", "."); err != nil {
|
||||
t.Fatalf("add: %v", err)
|
||||
}
|
||||
if _, err := runGit(seed, "commit", "-m", "init"); err != nil {
|
||||
t.Fatalf("commit: %v", err)
|
||||
}
|
||||
if _, err := runGit(seed, "remote", "add", "origin", bare); err != nil {
|
||||
t.Fatalf("remote add: %v", err)
|
||||
}
|
||||
if _, err := runGit(seed, "push", "-u", "origin", "main"); err != nil {
|
||||
t.Fatalf("push: %v", err)
|
||||
}
|
||||
|
||||
srcDir := filepath.Join(root, "src")
|
||||
if err := GitClone(bare, srcDir); err != nil {
|
||||
t.Fatalf("clone: %v", err)
|
||||
}
|
||||
gitIdentity(t, srcDir)
|
||||
return srcDir
|
||||
}
|
||||
|
||||
func TestGitWorktreeLifecycle(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
|
||||
def, err := GitRemoteDefaultBranch(srcDir, "origin")
|
||||
if err != nil {
|
||||
t.Fatalf("GitRemoteDefaultBranch: %v", err)
|
||||
}
|
||||
if def != "main" {
|
||||
t.Errorf("default branch = %q, want main", def)
|
||||
}
|
||||
|
||||
if err := GitFetch(srcDir, "origin"); err != nil {
|
||||
t.Fatalf("GitFetch: %v", err)
|
||||
}
|
||||
|
||||
wtPath := filepath.Join(t.TempDir(), "repo__benvin-x")
|
||||
if GitBranchExists(srcDir, "benvin/x") {
|
||||
t.Fatal("branch benvin/x should not exist yet")
|
||||
}
|
||||
if err := GitWorktreeAdd(srcDir, wtPath, "benvin/x", "origin/main"); err != nil {
|
||||
t.Fatalf("GitWorktreeAdd: %v", err)
|
||||
}
|
||||
if !GitBranchExists(srcDir, "benvin/x") {
|
||||
t.Error("branch benvin/x should exist after worktree add")
|
||||
}
|
||||
|
||||
if br, err := GitCurrentBranch(wtPath); err != nil || br != "benvin/x" {
|
||||
t.Errorf("GitCurrentBranch = %q, %v; want benvin/x", br, err)
|
||||
}
|
||||
|
||||
src2, err := SourceRepoDir(wtPath)
|
||||
if err != nil {
|
||||
t.Fatalf("SourceRepoDir: %v", err)
|
||||
}
|
||||
if resolve(t, src2) != resolve(t, srcDir) {
|
||||
t.Errorf("SourceRepoDir = %q, want %q", src2, srcDir)
|
||||
}
|
||||
|
||||
wts, err := GitWorktreeList(srcDir)
|
||||
if err != nil {
|
||||
t.Fatalf("GitWorktreeList: %v", err)
|
||||
}
|
||||
found := false
|
||||
for _, w := range wts {
|
||||
if resolve(t, w.Path) == resolve(t, wtPath) && w.Branch == "benvin/x" {
|
||||
found = true
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Errorf("worktree %s not found in list: %+v", wtPath, wts)
|
||||
}
|
||||
|
||||
// Per-worktree config must not leak into the shared checkout.
|
||||
if err := GitConfigSet(srcDir, false, "extensions.worktreeConfig", "true"); err != nil {
|
||||
t.Fatalf("enable worktreeConfig: %v", err)
|
||||
}
|
||||
if err := GitConfigSet(wtPath, true, "user.name", "unkin-agent"); err != nil {
|
||||
t.Fatalf("set worktree user.name: %v", err)
|
||||
}
|
||||
if name, _ := runGit(srcDir, "config", "user.name"); name == "unkin-agent" {
|
||||
t.Error("shared checkout user.name was polluted by worktree config")
|
||||
}
|
||||
|
||||
if err := GitWorktreeRemove(srcDir, wtPath, true); err != nil {
|
||||
t.Fatalf("GitWorktreeRemove: %v", err)
|
||||
}
|
||||
if err := GitDeleteBranch(srcDir, "benvin/x", true); err != nil {
|
||||
t.Fatalf("GitDeleteBranch: %v", err)
|
||||
}
|
||||
if GitBranchExists(srcDir, "benvin/x") {
|
||||
t.Error("branch benvin/x should be gone after delete")
|
||||
}
|
||||
if err := GitWorktreePrune(srcDir); err != nil {
|
||||
t.Fatalf("GitWorktreePrune: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// commit writes a file and commits it, returning the new HEAD sha.
|
||||
func commit(t *testing.T, dir, name, content, msg string) string {
|
||||
t.Helper()
|
||||
if err := os.WriteFile(filepath.Join(dir, name), []byte(content), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := runGit(dir, "add", "."); err != nil {
|
||||
t.Fatalf("add: %v", err)
|
||||
}
|
||||
if _, err := runGit(dir, "commit", "-m", msg); err != nil {
|
||||
t.Fatalf("commit: %v", err)
|
||||
}
|
||||
sha, err := runGit(dir, "rev-parse", "HEAD")
|
||||
if err != nil {
|
||||
t.Fatalf("rev-parse: %v", err)
|
||||
}
|
||||
return sha
|
||||
}
|
||||
|
||||
func TestGitIsAncestor(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
base, err := runGit(srcDir, "rev-parse", "HEAD")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
tip := commit(t, srcDir, "a.txt", "a\n", "add a")
|
||||
|
||||
if ok, err := GitIsAncestor(srcDir, base, tip); err != nil || !ok {
|
||||
t.Errorf("GitIsAncestor(base, tip) = %v, %v; want true", ok, err)
|
||||
}
|
||||
if ok, err := GitIsAncestor(srcDir, tip, base); err != nil || ok {
|
||||
t.Errorf("GitIsAncestor(tip, base) = %v, %v; want false with no error", ok, err)
|
||||
}
|
||||
if _, err := GitIsAncestor(srcDir, "no-such-ref", tip); err == nil {
|
||||
t.Error("GitIsAncestor with a bogus ref should error, not report false")
|
||||
}
|
||||
}
|
||||
|
||||
// These repos squash-merge, so merged work keeps its local SHA while the
|
||||
// upstream commit is a different one carrying the same patch. `git cherry` must
|
||||
// see that as merged even though the SHAs differ.
|
||||
func TestGitUnmergedCommitsIgnoresRewrittenSHAs(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
|
||||
if _, err := runGit(srcDir, "checkout", "-b", "feature"); err != nil {
|
||||
t.Fatalf("checkout: %v", err)
|
||||
}
|
||||
commit(t, srcDir, "f.txt", "hello\n", "add f")
|
||||
|
||||
n, err := GitUnmergedCommits(srcDir, "origin/main", "HEAD")
|
||||
if err != nil {
|
||||
t.Fatalf("GitUnmergedCommits: %v", err)
|
||||
}
|
||||
if n != 1 {
|
||||
t.Fatalf("unmerged before upstream landing = %d, want 1", n)
|
||||
}
|
||||
|
||||
// Land the same patch upstream under a different SHA.
|
||||
if _, err := runGit(srcDir, "checkout", "main"); err != nil {
|
||||
t.Fatalf("checkout main: %v", err)
|
||||
}
|
||||
commit(t, srcDir, "f.txt", "hello\n", "squashed f")
|
||||
if _, err := runGit(srcDir, "push", "origin", "main"); err != nil {
|
||||
t.Fatalf("push: %v", err)
|
||||
}
|
||||
if err := GitFetchPrune(srcDir, "origin"); err != nil {
|
||||
t.Fatalf("GitFetchPrune: %v", err)
|
||||
}
|
||||
|
||||
if ok, err := GitIsAncestor(srcDir, "feature", "origin/main"); err != nil || ok {
|
||||
t.Fatalf("squash-merged branch must not be an ancestor: %v, %v", ok, err)
|
||||
}
|
||||
n, err = GitUnmergedCommits(srcDir, "origin/main", "feature")
|
||||
if err != nil {
|
||||
t.Fatalf("GitUnmergedCommits: %v", err)
|
||||
}
|
||||
if n != 0 {
|
||||
t.Errorf("unmerged after upstream landing = %d, want 0", n)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGitIsDirty(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
if dirty, err := GitIsDirty(srcDir); err != nil || dirty {
|
||||
t.Fatalf("clean checkout reported dirty=%v, err=%v", dirty, err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(srcDir, "scratch.txt"), []byte("wip\n"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if dirty, err := GitIsDirty(srcDir); err != nil || !dirty {
|
||||
t.Errorf("untracked file must count as dirty: dirty=%v, err=%v", dirty, err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGitRemoteBranchExists(t *testing.T) {
|
||||
srcDir := newTempRepos(t)
|
||||
if !GitRemoteBranchExists(srcDir, "origin", "main") {
|
||||
t.Error("origin/main should exist")
|
||||
}
|
||||
if GitRemoteBranchExists(srcDir, "origin", "benvin/nope") {
|
||||
t.Error("origin/benvin/nope should not exist")
|
||||
}
|
||||
|
||||
if _, err := runGit(srcDir, "checkout", "-b", "benvin/pushed"); err != nil {
|
||||
t.Fatalf("checkout: %v", err)
|
||||
}
|
||||
commit(t, srcDir, "p.txt", "p\n", "add p")
|
||||
if _, err := runGit(srcDir, "push", "origin", "benvin/pushed"); err != nil {
|
||||
t.Fatalf("push: %v", err)
|
||||
}
|
||||
if err := GitFetchPrune(srcDir, "origin"); err != nil {
|
||||
t.Fatalf("GitFetchPrune: %v", err)
|
||||
}
|
||||
if !GitRemoteBranchExists(srcDir, "origin", "benvin/pushed") {
|
||||
t.Error("pushed branch should have a remote-tracking ref")
|
||||
}
|
||||
|
||||
if _, err := runGit(srcDir, "push", "origin", "--delete", "benvin/pushed"); err != nil {
|
||||
t.Fatalf("delete remote branch: %v", err)
|
||||
}
|
||||
if err := GitFetchPrune(srcDir, "origin"); err != nil {
|
||||
t.Fatalf("GitFetchPrune: %v", err)
|
||||
}
|
||||
if GitRemoteBranchExists(srcDir, "origin", "benvin/pushed") {
|
||||
t.Error("a pruning fetch must drop the tracking ref for a deleted remote branch")
|
||||
}
|
||||
}
|
||||
|
||||
// resolve canonicalizes a path (temp dirs may live behind symlinks like /var).
|
||||
func resolve(t *testing.T, p string) string {
|
||||
t.Helper()
|
||||
r, err := filepath.EvalSymlinks(p)
|
||||
if err != nil {
|
||||
return p
|
||||
}
|
||||
return r
|
||||
}
|
||||
+273
-9
@@ -3,40 +3,155 @@ package agent
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// APIError is a non-2xx response from the Gitea API. It carries the status code
|
||||
// so callers can react to specific failures (e.g. tolerate a 404 for a commit
|
||||
// whose branch was deleted after a merge) instead of parsing error strings.
|
||||
type APIError struct {
|
||||
Method string
|
||||
Path string
|
||||
StatusCode int
|
||||
Body string
|
||||
}
|
||||
|
||||
func (e *APIError) Error() string {
|
||||
return fmt.Sprintf("gitea %s %s: HTTP %d: %s", e.Method, e.Path, e.StatusCode, e.Body)
|
||||
}
|
||||
|
||||
// IsNotFound reports whether err is a Gitea 404. Gitea hides repositories a
|
||||
// caller may not see behind a 404 rather than a 403, so this also covers a repo
|
||||
// that was renamed, deleted, or made private.
|
||||
func IsNotFound(err error) bool {
|
||||
var apiErr *APIError
|
||||
return errors.As(err, &apiErr) && apiErr.StatusCode == http.StatusNotFound
|
||||
}
|
||||
|
||||
// IsAuthError reports whether err is a Gitea 401/403. Both end a watch: neither
|
||||
// a rejected credential nor a permission boundary clears itself on a retry.
|
||||
func IsAuthError(err error) bool {
|
||||
var apiErr *APIError
|
||||
return errors.As(err, &apiErr) &&
|
||||
(apiErr.StatusCode == http.StatusUnauthorized || apiErr.StatusCode == http.StatusForbidden)
|
||||
}
|
||||
|
||||
// ErrNoCredential marks a 401/403 on a request that carried no token at all.
|
||||
// Anonymous polling of a public repo is supported, so this is not a rejected
|
||||
// credential: the resource simply is not public and no token was available.
|
||||
var ErrNoCredential = errors.New("gitea requires authentication and no token was available")
|
||||
|
||||
// IsNoCredential reports whether err is an auth failure on an anonymous request.
|
||||
func IsNoCredential(err error) bool {
|
||||
return errors.Is(err, ErrNoCredential)
|
||||
}
|
||||
|
||||
// credentialHints are the fragments Gitea puts in a 403 body when the
|
||||
// credential itself is at fault ("token does not have at least one of required
|
||||
// scope(s)", "sign in required") rather than the identity's permissions, whose
|
||||
// body is a bare "Forbidden".
|
||||
var credentialHints = []string{"token", "sign in", "credential"}
|
||||
|
||||
// IsCredentialRejected reports whether err means the credential that was sent
|
||||
// was refused, which a freshly minted token may fix. A 401 always qualifies.
|
||||
// Gitea 403s both for a token missing a scope and for an identity that may not
|
||||
// do this at all, so for a 403 the response body decides.
|
||||
func IsCredentialRejected(err error) bool {
|
||||
var apiErr *APIError
|
||||
if !errors.As(err, &apiErr) {
|
||||
return false
|
||||
}
|
||||
switch apiErr.StatusCode {
|
||||
case http.StatusUnauthorized:
|
||||
return true
|
||||
case http.StatusForbidden:
|
||||
body := strings.ToLower(apiErr.Body)
|
||||
for _, hint := range credentialHints {
|
||||
if strings.Contains(body, hint) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// IsPermissionDenied reports a 403 that names no credential problem: the
|
||||
// identity is authenticated but not allowed, so re-minting cannot help.
|
||||
func IsPermissionDenied(err error) bool {
|
||||
var apiErr *APIError
|
||||
return errors.As(err, &apiErr) &&
|
||||
apiErr.StatusCode == http.StatusForbidden && !IsCredentialRejected(err)
|
||||
}
|
||||
|
||||
// GiteaClient talks to the Gitea REST API as the agent user.
|
||||
type GiteaClient struct {
|
||||
BaseURL string
|
||||
Token string
|
||||
HTTP *http.Client
|
||||
// Refresh mints a replacement token when the current one is rejected; Vault's
|
||||
// Gitea tokens expire in ~1h, far short of a watchpr run.
|
||||
Refresh func() (string, error)
|
||||
}
|
||||
|
||||
// NewGiteaClient builds a client from the configured base URL and a Vault-minted
|
||||
// token.
|
||||
// token, re-minting from Vault when that token expires.
|
||||
func NewGiteaClient(token string) *GiteaClient {
|
||||
return &GiteaClient{BaseURL: GiteaURL(), Token: token, HTTP: httpClient}
|
||||
return &GiteaClient{BaseURL: GiteaURL(), Token: token, HTTP: httpClient, Refresh: RefreshGiteaToken}
|
||||
}
|
||||
|
||||
// do sends the request and, if the credential it carried was rejected, re-mints
|
||||
// the token once and replays the request. Anonymous requests and permission
|
||||
// denials are returned as they are: neither is fixed by a fresh token, and
|
||||
// re-minting on them would report a stale token as the cause of something else.
|
||||
func (c *GiteaClient) do(method, path string, body any, out any) error {
|
||||
var reader io.Reader
|
||||
var payload []byte
|
||||
if body != nil {
|
||||
b, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
reader = bytes.NewReader(b)
|
||||
payload = b
|
||||
}
|
||||
anonymous := c.Token == ""
|
||||
err := c.attempt(method, path, payload, out)
|
||||
if !IsAuthError(err) {
|
||||
return err
|
||||
}
|
||||
if anonymous {
|
||||
return fmt.Errorf("%w: %w", ErrNoCredential, err)
|
||||
}
|
||||
if !IsCredentialRejected(err) || c.Refresh == nil {
|
||||
return err
|
||||
}
|
||||
token, refreshErr := c.Refresh()
|
||||
if refreshErr != nil {
|
||||
return fmt.Errorf("%w; re-minting token: %v", err, refreshErr)
|
||||
}
|
||||
if token == "" {
|
||||
return fmt.Errorf("%w; re-minting token yielded an empty token", err)
|
||||
}
|
||||
c.Token = token
|
||||
return c.attempt(method, path, payload, out)
|
||||
}
|
||||
|
||||
func (c *GiteaClient) attempt(method, path string, body []byte, out any) error {
|
||||
var reader io.Reader
|
||||
if body != nil {
|
||||
reader = bytes.NewReader(body)
|
||||
}
|
||||
url := strings.TrimRight(c.BaseURL, "/") + path
|
||||
req, err := http.NewRequest(method, url, reader)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Set("Authorization", "token "+c.Token)
|
||||
// An empty token means anonymous access, which public repos serve fine.
|
||||
if c.Token != "" {
|
||||
req.Header.Set("Authorization", "token "+c.Token)
|
||||
}
|
||||
req.Header.Set("Accept", "application/json")
|
||||
if body != nil {
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
@@ -49,7 +164,7 @@ func (c *GiteaClient) do(method, path string, body any, out any) error {
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
data, _ := io.ReadAll(resp.Body)
|
||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||
return fmt.Errorf("gitea %s %s: HTTP %d: %s", method, path, resp.StatusCode, strings.TrimSpace(string(data)))
|
||||
return &APIError{Method: method, Path: path, StatusCode: resp.StatusCode, Body: strings.TrimSpace(string(data))}
|
||||
}
|
||||
if out != nil && len(data) > 0 {
|
||||
if err := json.Unmarshal(data, out); err != nil {
|
||||
@@ -81,10 +196,68 @@ type PullRequest struct {
|
||||
Mergeable bool `json:"mergeable"`
|
||||
HTMLURL string `json:"html_url"`
|
||||
Head struct {
|
||||
Sha string `json:"sha"`
|
||||
Sha string `json:"sha"`
|
||||
Ref string `json:"ref"`
|
||||
Label string `json:"label"`
|
||||
} `json:"head"`
|
||||
}
|
||||
|
||||
// prPageSize is the per-page limit for the pulls listing; maxPRPages caps how
|
||||
// far back a listing walks.
|
||||
const (
|
||||
prPageSize = 50
|
||||
maxPRPages = 20
|
||||
)
|
||||
|
||||
// ErrPRListTruncated reports that a listing hit the page cap, so the returned
|
||||
// pull requests are only the most recent ones and older PRs went unseen.
|
||||
var ErrPRListTruncated = errors.New("pull request listing truncated at the page cap")
|
||||
|
||||
// ListPRs lists a repo's pull requests in the given state ("open", "closed" or
|
||||
// "all"), following pagination. A repo with more PRs than the page cap returns
|
||||
// the PRs it did read alongside ErrPRListTruncated.
|
||||
func (c *GiteaClient) ListPRs(repoPath, state string) ([]PullRequest, error) {
|
||||
if state == "" {
|
||||
state = "all"
|
||||
}
|
||||
var all []PullRequest
|
||||
for page := 1; page <= maxPRPages; page++ {
|
||||
var batch []PullRequest
|
||||
path := fmt.Sprintf("/api/v1/repos/%s/pulls?state=%s&limit=%d&page=%d", repoPath, state, prPageSize, page)
|
||||
if err := c.do(http.MethodGet, path, nil, &batch); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
all = append(all, batch...)
|
||||
if len(batch) < prPageSize {
|
||||
return all, nil
|
||||
}
|
||||
}
|
||||
return all, fmt.Errorf("%s: %w after %d pull requests", repoPath, ErrPRListTruncated, len(all))
|
||||
}
|
||||
|
||||
// PRHeadBranch returns the branch a PR was opened from. Gitea rewrites head.ref
|
||||
// to "refs/pull/<n>/head" once the branch is deleted (which merging does), so
|
||||
// head.label — which keeps the original name — is authoritative.
|
||||
func PRHeadBranch(pr PullRequest) string {
|
||||
if label := pr.Head.Label; label != "" && !strings.HasPrefix(label, "refs/pull/") {
|
||||
// Cross-repo PRs label as "<owner>:<branch>".
|
||||
if _, branch, ok := strings.Cut(label, ":"); ok {
|
||||
return branch
|
||||
}
|
||||
return label
|
||||
}
|
||||
ref := pr.Head.Ref
|
||||
if strings.HasPrefix(ref, "refs/pull/") {
|
||||
return ""
|
||||
}
|
||||
return strings.TrimPrefix(ref, "refs/heads/")
|
||||
}
|
||||
|
||||
// IsOpen reports whether a PR is still open (not merged, not closed).
|
||||
func (pr PullRequest) IsOpen() bool {
|
||||
return pr.State == "open" && !pr.Merged
|
||||
}
|
||||
|
||||
// CreatePROptions are the fields for opening a PR.
|
||||
type CreatePROptions struct {
|
||||
Base string `json:"base"`
|
||||
@@ -100,6 +273,25 @@ func (c *GiteaClient) CreatePR(repoPath string, opts CreatePROptions) (PullReque
|
||||
return pr, err
|
||||
}
|
||||
|
||||
// EditOptions are the fields an edit may change, for a pull request or an
|
||||
// issue alike. Pointers so an unset field is omitted from the payload
|
||||
// entirely, leaving that field as it is. The two fields are not symmetric:
|
||||
// Gitea only applies a title when it is non-empty, so Title can be set but
|
||||
// never cleared and a "" title is a silent no-op, while a pointer to "" Body
|
||||
// really does blank the body.
|
||||
type EditOptions struct {
|
||||
Title *string `json:"title,omitempty"`
|
||||
Body *string `json:"body,omitempty"`
|
||||
}
|
||||
|
||||
// EditPR updates a pull request's title and/or body
|
||||
// (PATCH /api/v1/repos/{owner}/{repo}/pulls/{index}).
|
||||
func (c *GiteaClient) EditPR(repoPath string, number int, opts EditOptions) (PullRequest, error) {
|
||||
var pr PullRequest
|
||||
err := c.do(http.MethodPatch, fmt.Sprintf("/api/v1/repos/%s/pulls/%d", repoPath, number), opts, &pr)
|
||||
return pr, err
|
||||
}
|
||||
|
||||
// GetPR fetches a single pull request.
|
||||
func (c *GiteaClient) GetPR(repoPath string, number int) (PullRequest, error) {
|
||||
var pr PullRequest
|
||||
@@ -107,6 +299,76 @@ func (c *GiteaClient) GetPR(repoPath string, number int) (PullRequest, error) {
|
||||
return pr, err
|
||||
}
|
||||
|
||||
// Issue is the subset of Gitea's issue object we track. Gitea numbers issues
|
||||
// and pull requests in one sequence, so Number is comparable to a PR number.
|
||||
type Issue struct {
|
||||
Number int `json:"number"`
|
||||
State string `json:"state"`
|
||||
Title string `json:"title"`
|
||||
HTMLURL string `json:"html_url"`
|
||||
}
|
||||
|
||||
// CreateIssueOptions are the fields for filing an issue.
|
||||
type CreateIssueOptions struct {
|
||||
Title string `json:"title"`
|
||||
Body string `json:"body"`
|
||||
}
|
||||
|
||||
// CreateIssue files an issue (POST /api/v1/repos/{owner}/{repo}/issues).
|
||||
func (c *GiteaClient) CreateIssue(repoPath string, opts CreateIssueOptions) (Issue, error) {
|
||||
var issue Issue
|
||||
err := c.do(http.MethodPost, "/api/v1/repos/"+repoPath+"/issues", opts, &issue)
|
||||
return issue, err
|
||||
}
|
||||
|
||||
// EditIssue updates an issue's title and/or body
|
||||
// (PATCH /api/v1/repos/{owner}/{repo}/issues/{index}).
|
||||
func (c *GiteaClient) EditIssue(repoPath string, number int, opts EditOptions) (Issue, error) {
|
||||
var issue Issue
|
||||
err := c.do(http.MethodPatch, fmt.Sprintf("/api/v1/repos/%s/issues/%d", repoPath, number), opts, &issue)
|
||||
return issue, err
|
||||
}
|
||||
|
||||
// Issue states Gitea accepts on a state change. Gitea has no third state: an
|
||||
// issue is open or closed.
|
||||
const (
|
||||
IssueStateOpen = "open"
|
||||
IssueStateClosed = "closed"
|
||||
)
|
||||
|
||||
// ErrIssueStateUnchanged reports a state change asked for the state the issue
|
||||
// is already in. Gitea answers such a PATCH with 200 and changes nothing, so
|
||||
// without this check closing an already-closed issue would look like it worked.
|
||||
var ErrIssueStateUnchanged = errors.New("issue is already in that state")
|
||||
|
||||
// GetIssue fetches a single issue
|
||||
// (GET /api/v1/repos/{owner}/{repo}/issues/{index}).
|
||||
func (c *GiteaClient) GetIssue(repoPath string, number int) (Issue, error) {
|
||||
var issue Issue
|
||||
err := c.do(http.MethodGet, fmt.Sprintf("/api/v1/repos/%s/issues/%d", repoPath, number), nil, &issue)
|
||||
return issue, err
|
||||
}
|
||||
|
||||
// SetIssueState closes or reopens an issue. It reads the issue first so an
|
||||
// issue already in the requested state fails with ErrIssueStateUnchanged
|
||||
// instead of reporting a change that never happened.
|
||||
func (c *GiteaClient) SetIssueState(repoPath string, number int, state string) (Issue, error) {
|
||||
if state != IssueStateOpen && state != IssueStateClosed {
|
||||
return Issue{}, fmt.Errorf("invalid issue state %q: want %q or %q", state, IssueStateOpen, IssueStateClosed)
|
||||
}
|
||||
current, err := c.GetIssue(repoPath, number)
|
||||
if err != nil {
|
||||
return Issue{}, err
|
||||
}
|
||||
if current.State == state {
|
||||
return current, fmt.Errorf("%s#%d: %w (%s)", repoPath, number, ErrIssueStateUnchanged, state)
|
||||
}
|
||||
var issue Issue
|
||||
payload := map[string]string{"state": state}
|
||||
err = c.do(http.MethodPatch, fmt.Sprintf("/api/v1/repos/%s/issues/%d", repoPath, number), payload, &issue)
|
||||
return issue, err
|
||||
}
|
||||
|
||||
// Comment is the subset of an issue comment we track.
|
||||
type Comment struct {
|
||||
ID int64 `json:"id"`
|
||||
@@ -114,8 +376,10 @@ type Comment struct {
|
||||
Body string `json:"body"`
|
||||
}
|
||||
|
||||
// CreateComment posts a comment on the PR's issue thread
|
||||
// (POST /api/v1/repos/{owner}/{repo}/issues/{n}/comments).
|
||||
// CreateComment posts a comment on an issue thread
|
||||
// (POST /api/v1/repos/{owner}/{repo}/issues/{n}/comments). Gitea backs a pull
|
||||
// request with an issue of the same number, so this is the single path for
|
||||
// both.
|
||||
func (c *GiteaClient) CreateComment(repoPath string, number int, body string) (Comment, error) {
|
||||
var cm Comment
|
||||
payload := map[string]string{"body": body}
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// PRRef identifies a single pull request by repository and number.
|
||||
@@ -48,6 +49,71 @@ func ParsePRRef(s string) (PRRef, error) {
|
||||
return PRRef{Owner: owner, Repo: repo, Number: n}, nil
|
||||
}
|
||||
|
||||
// ParseDurationFlag parses a duration flag value, accepting either a Go
|
||||
// duration string ("30s", "1h30m") or a bare integer read as seconds ("15").
|
||||
// flag names the flag so the error says which value was rejected.
|
||||
func ParseDurationFlag(flag, value string) (time.Duration, error) {
|
||||
s := strings.TrimSpace(value)
|
||||
d, err := time.ParseDuration(s)
|
||||
if err != nil {
|
||||
n, nerr := strconv.Atoi(s)
|
||||
if nerr != nil {
|
||||
return 0, fmt.Errorf("invalid --%s value %q: want a duration such as 30s, 2m or 1h30m, or a bare number of seconds such as 15", flag, value)
|
||||
}
|
||||
d = time.Duration(n) * time.Second
|
||||
}
|
||||
if d <= 0 {
|
||||
return 0, fmt.Errorf("invalid --%s value %q: must be greater than zero", flag, value)
|
||||
}
|
||||
return d, nil
|
||||
}
|
||||
|
||||
// RemoteHost returns the host a git remote URL points at, or "" for a local
|
||||
// path remote.
|
||||
func RemoteHost(remote string) string {
|
||||
s := strings.TrimSpace(remote)
|
||||
if _, after, ok := strings.Cut(s, "://"); ok {
|
||||
host, _, _ := strings.Cut(after, "/")
|
||||
if _, bare, ok := strings.Cut(host, "@"); ok {
|
||||
host = bare
|
||||
}
|
||||
return host
|
||||
}
|
||||
if strings.HasPrefix(s, "/") || strings.HasPrefix(s, ".") {
|
||||
return ""
|
||||
}
|
||||
host, _, ok := strings.Cut(s, ":")
|
||||
if !ok {
|
||||
return ""
|
||||
}
|
||||
if _, bare, ok := strings.Cut(host, "@"); ok {
|
||||
host = bare
|
||||
}
|
||||
return host
|
||||
}
|
||||
|
||||
// RepoPathFromRemoteURL extracts the "owner/repo" API path from a git remote
|
||||
// URL, accepting both https and scp-style ssh forms.
|
||||
func RepoPathFromRemoteURL(remote string) (string, error) {
|
||||
s := strings.TrimSuffix(strings.TrimSuffix(strings.TrimSpace(remote), "/"), ".git")
|
||||
switch {
|
||||
case strings.Contains(s, "://"):
|
||||
_, after, _ := strings.Cut(s, "://")
|
||||
_, path, ok := strings.Cut(after, "/")
|
||||
if !ok {
|
||||
return "", fmt.Errorf("remote URL %q has no repo path", remote)
|
||||
}
|
||||
s = path
|
||||
case strings.Contains(s, ":"):
|
||||
_, s, _ = strings.Cut(s, ":")
|
||||
}
|
||||
parts := strings.Split(strings.Trim(s, "/"), "/")
|
||||
if len(parts) < 2 || parts[len(parts)-2] == "" || parts[len(parts)-1] == "" {
|
||||
return "", fmt.Errorf("remote URL %q is not owner/repo shaped", remote)
|
||||
}
|
||||
return parts[len(parts)-2] + "/" + parts[len(parts)-1], nil
|
||||
}
|
||||
|
||||
// ParseRepo validates and splits an "owner/repo" string.
|
||||
func ParseRepo(s string) (owner, repo string, err error) {
|
||||
s = strings.TrimSpace(s)
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
package agent
|
||||
|
||||
import "testing"
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestParsePRRef(t *testing.T) {
|
||||
tests := []struct {
|
||||
@@ -77,3 +81,103 @@ func TestParseRepo(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDurationFlag(t *testing.T) {
|
||||
tests := []struct {
|
||||
in string
|
||||
want time.Duration
|
||||
wantErr bool
|
||||
}{
|
||||
{"15", 15 * time.Second, false},
|
||||
{"15s", 15 * time.Second, false},
|
||||
{"2m", 2 * time.Minute, false},
|
||||
{"1h30m", 90 * time.Minute, false},
|
||||
{"500ms", 500 * time.Millisecond, false},
|
||||
{" 45 ", 45 * time.Second, false},
|
||||
{"0", 0, true},
|
||||
{"0s", 0, true},
|
||||
{"-5", 0, true},
|
||||
{"-5s", 0, true},
|
||||
{"15x", 0, true},
|
||||
{"", 0, true},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
got, err := ParseDurationFlag("interval", tt.in)
|
||||
if tt.wantErr {
|
||||
if err == nil {
|
||||
t.Errorf("ParseDurationFlag(%q): expected error, got %v", tt.in, got)
|
||||
}
|
||||
continue
|
||||
}
|
||||
if err != nil {
|
||||
t.Errorf("ParseDurationFlag(%q): unexpected error: %v", tt.in, err)
|
||||
continue
|
||||
}
|
||||
if got != tt.want {
|
||||
t.Errorf("ParseDurationFlag(%q) = %v, want %v", tt.in, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The error must name the flag and show valid forms instead of surfacing
|
||||
// time.ParseDuration's "missing unit" wording.
|
||||
func TestParseDurationFlagErrorMessage(t *testing.T) {
|
||||
_, err := ParseDurationFlag("interval", "soon")
|
||||
if err == nil {
|
||||
t.Fatal("ParseDurationFlag(\"soon\"): expected error")
|
||||
}
|
||||
for _, want := range []string{"--interval", `"soon"`, "30s", "seconds"} {
|
||||
if !strings.Contains(err.Error(), want) {
|
||||
t.Errorf("error %q does not mention %q", err, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Not every managed repo lives under the default owner, so the API path comes
|
||||
// from origin's URL rather than the directory name.
|
||||
func TestRepoPathFromRemoteURL(t *testing.T) {
|
||||
tests := []struct {
|
||||
in string
|
||||
want string
|
||||
}{
|
||||
{"https://git.unkin.net/unkin/agent-tools.git", "unkin/agent-tools"},
|
||||
{"https://git.unkin.net/unkinben/dotfiles.git", "unkinben/dotfiles"},
|
||||
{"https://git.unkin.net/unkin/agent-tools", "unkin/agent-tools"},
|
||||
{"https://user@git.unkin.net/unkin/agent-tools.git", "unkin/agent-tools"},
|
||||
{"ssh://git@git.unkin.net:2222/unkin/agent-tools.git", "unkin/agent-tools"},
|
||||
{"git@git.unkin.net:unkin/agent-tools.git", "unkin/agent-tools"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
got, err := RepoPathFromRemoteURL(tt.in)
|
||||
if err != nil {
|
||||
t.Errorf("RepoPathFromRemoteURL(%q): %v", tt.in, err)
|
||||
continue
|
||||
}
|
||||
if got != tt.want {
|
||||
t.Errorf("RepoPathFromRemoteURL(%q) = %q, want %q", tt.in, got, tt.want)
|
||||
}
|
||||
}
|
||||
for _, bad := range []string{"", "https://git.unkin.net", "agent-tools"} {
|
||||
if got, err := RepoPathFromRemoteURL(bad); err == nil {
|
||||
t.Errorf("RepoPathFromRemoteURL(%q) = %q, want error", bad, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRemoteHost(t *testing.T) {
|
||||
tests := []struct {
|
||||
in, want string
|
||||
}{
|
||||
{"https://git.unkin.net/unkin/repo.git", "git.unkin.net"},
|
||||
{"https://user@git.unkin.net/unkin/repo.git", "git.unkin.net"},
|
||||
{"ssh://git@git.unkin.net:2222/unkin/repo.git", "git.unkin.net:2222"},
|
||||
{"git@git.unkin.net:unkin/repo.git", "git.unkin.net"},
|
||||
{"/tmp/fixture/origin.git", ""},
|
||||
{"../other/origin.git", ""},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
if got := RemoteHost(tt.in); got != tt.want {
|
||||
t.Errorf("RemoteHost(%q) = %q, want %q", tt.in, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,183 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"crypto/rand"
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"fmt"
|
||||
"sort"
|
||||
)
|
||||
|
||||
const (
|
||||
// OAuthClientIDKey, OAuthClientSecretKey and OAuthCookieSecretKey are the
|
||||
// KV fields oauth2-proxy deployments read their credentials from.
|
||||
OAuthClientIDKey = "client_id"
|
||||
OAuthClientSecretKey = "client_secret"
|
||||
OAuthCookieSecretKey = "cookie_secret"
|
||||
|
||||
// oauthSecretBytes is the raw length of generated secrets. oauth2-proxy
|
||||
// rejects a cookie secret that does not decode to exactly 32 bytes.
|
||||
oauthSecretBytes = 32
|
||||
)
|
||||
|
||||
// Per-key outcomes reported by SeedOAuth.
|
||||
const (
|
||||
ActionCreated = "created"
|
||||
ActionKept = "kept"
|
||||
ActionRotated = "rotated"
|
||||
ActionUpdated = "updated"
|
||||
ActionPreserved = "preserved"
|
||||
)
|
||||
|
||||
// SeedOAuthOptions configures SeedOAuth. The CLI supplies the defaults.
|
||||
type SeedOAuthOptions struct {
|
||||
VaultAddr string
|
||||
RoleID string
|
||||
KVMount string
|
||||
Path string
|
||||
ClientID string
|
||||
Rotate bool
|
||||
}
|
||||
|
||||
// SeedOAuthKey names a key present in the secret and what happened to it.
|
||||
type SeedOAuthKey struct {
|
||||
Name string
|
||||
Action string
|
||||
}
|
||||
|
||||
// SeedOAuthResult is the non-secret summary of a seed run. Version is zero when
|
||||
// nothing changed and no write was issued.
|
||||
type SeedOAuthResult struct {
|
||||
KVMount string
|
||||
Path string
|
||||
Keys []SeedOAuthKey
|
||||
Version int
|
||||
Changed bool
|
||||
}
|
||||
|
||||
// KeyNames returns the key names present in the secret after the run.
|
||||
func (r SeedOAuthResult) KeyNames() []string {
|
||||
names := make([]string, 0, len(r.Keys))
|
||||
for _, k := range r.Keys {
|
||||
names = append(names, k.Name)
|
||||
}
|
||||
return names
|
||||
}
|
||||
|
||||
// SeedOAuth makes a Vault KV-v2 path hold a complete oauth2-proxy credential
|
||||
// set: client_id from the caller, plus a client_secret and cookie_secret that
|
||||
// are generated only when absent (or when Rotate is set). It is a
|
||||
// read-modify-write, so keys it does not own survive untouched, and it writes
|
||||
// nothing when the secret is already correct. Secret material never leaves this
|
||||
// function: results and errors carry only key names.
|
||||
func SeedOAuth(o SeedOAuthOptions) (SeedOAuthResult, error) {
|
||||
var res SeedOAuthResult
|
||||
if o.Path == "" {
|
||||
return res, errors.New("a KV-v2 path is required")
|
||||
}
|
||||
if o.ClientID == "" {
|
||||
return res, errors.New("a client id is required")
|
||||
}
|
||||
|
||||
vc, err := NewVaultClient(o.VaultAddr, o.RoleID)
|
||||
if err != nil {
|
||||
return res, fmt.Errorf("vault approle login failed against %s (check VAULT_ADDR and AGENT_APPROLE_ROLE_ID): %w", o.VaultAddr, err)
|
||||
}
|
||||
|
||||
existing, err := vc.ReadKVOptional(o.KVMount, o.Path)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrVaultDenied) {
|
||||
return res, fmt.Errorf("reading %s/%s denied: the agent AppRole policy does not grant read on this path (apply the terraform-vault policy change): %w", o.KVMount, o.Path, err)
|
||||
}
|
||||
return res, fmt.Errorf("reading %s/%s: %w", o.KVMount, o.Path, err)
|
||||
}
|
||||
|
||||
data := make(map[string]any, len(existing)+3)
|
||||
for k, v := range existing {
|
||||
data[k] = v
|
||||
}
|
||||
|
||||
var (
|
||||
keys []SeedOAuthKey
|
||||
changed bool
|
||||
)
|
||||
|
||||
current, _ := existing[OAuthClientIDKey].(string)
|
||||
switch current {
|
||||
case o.ClientID:
|
||||
keys = append(keys, SeedOAuthKey{OAuthClientIDKey, ActionKept})
|
||||
case "":
|
||||
keys = append(keys, SeedOAuthKey{OAuthClientIDKey, ActionCreated})
|
||||
changed = true
|
||||
default:
|
||||
keys = append(keys, SeedOAuthKey{OAuthClientIDKey, ActionUpdated})
|
||||
changed = true
|
||||
}
|
||||
data[OAuthClientIDKey] = o.ClientID
|
||||
|
||||
for _, gen := range []struct {
|
||||
name string
|
||||
enc *base64.Encoding
|
||||
}{
|
||||
// oauth2-proxy accepts a standard-base64 client secret, but the cookie
|
||||
// secret goes into a cookie and must be URL-safe.
|
||||
{OAuthClientSecretKey, base64.StdEncoding},
|
||||
{OAuthCookieSecretKey, base64.RawURLEncoding},
|
||||
} {
|
||||
current, _ := existing[gen.name].(string)
|
||||
if current != "" && !o.Rotate {
|
||||
keys = append(keys, SeedOAuthKey{gen.name, ActionKept})
|
||||
continue
|
||||
}
|
||||
value, err := randomSecret(gen.enc)
|
||||
if err != nil {
|
||||
return res, fmt.Errorf("generating %s: %w", gen.name, err)
|
||||
}
|
||||
action := ActionCreated
|
||||
if current != "" {
|
||||
action = ActionRotated
|
||||
}
|
||||
data[gen.name] = value
|
||||
keys = append(keys, SeedOAuthKey{gen.name, action})
|
||||
changed = true
|
||||
}
|
||||
|
||||
var others []string
|
||||
for k := range existing {
|
||||
switch k {
|
||||
case OAuthClientIDKey, OAuthClientSecretKey, OAuthCookieSecretKey:
|
||||
default:
|
||||
others = append(others, k)
|
||||
}
|
||||
}
|
||||
sort.Strings(others)
|
||||
for _, k := range others {
|
||||
keys = append(keys, SeedOAuthKey{k, ActionPreserved})
|
||||
}
|
||||
|
||||
res = SeedOAuthResult{KVMount: o.KVMount, Path: o.Path, Keys: keys}
|
||||
if !changed {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
version, err := vc.WriteKVAny(o.KVMount, o.Path, data)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrVaultDenied) {
|
||||
return SeedOAuthResult{}, fmt.Errorf("writing %s/%s denied: the agent AppRole policy does not grant create/update on this path (apply the terraform-vault policy change): %w", o.KVMount, o.Path, err)
|
||||
}
|
||||
return SeedOAuthResult{}, fmt.Errorf("writing %s/%s: %w", o.KVMount, o.Path, err)
|
||||
}
|
||||
res.Version = version
|
||||
res.Changed = true
|
||||
return res, nil
|
||||
}
|
||||
|
||||
// randomSecret returns oauthSecretBytes of crypto/rand entropy in the given
|
||||
// base64 encoding.
|
||||
func randomSecret(enc *base64.Encoding) (string, error) {
|
||||
buf := make([]byte, oauthSecretBytes)
|
||||
if _, err := rand.Read(buf); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return enc.EncodeToString(buf), nil
|
||||
}
|
||||
@@ -0,0 +1,421 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const (
|
||||
oauthPath = "kubernetes/namespace/repospawner/default/oauth-credentials"
|
||||
oauthClientID = "mediamark-client-id"
|
||||
existingClientSec = "existing-client-secret-from-authentik"
|
||||
existingCookieSec = "existing-cookie-secret-value-abcdefghij"
|
||||
oauthExtraKeyValue = "extra-key-secret-value"
|
||||
oauthVaultClientTok = "s.vaulttoken"
|
||||
)
|
||||
|
||||
// oauthVaultStub is a KV-v2 stand-in that actually stores what is written, so
|
||||
// read-modify-write behaviour can be asserted end to end.
|
||||
type oauthVaultStub struct {
|
||||
data map[string]any
|
||||
exists bool
|
||||
version int
|
||||
readStatus int
|
||||
writeStatus int
|
||||
writes []map[string]any
|
||||
}
|
||||
|
||||
func newOAuthVaultStub() *oauthVaultStub {
|
||||
return &oauthVaultStub{readStatus: http.StatusOK, writeStatus: http.StatusOK}
|
||||
}
|
||||
|
||||
// seed makes the path exist with the given fields at version 1.
|
||||
func (v *oauthVaultStub) seed(data map[string]any) *oauthVaultStub {
|
||||
v.data = data
|
||||
v.exists = true
|
||||
v.version = 1
|
||||
return v
|
||||
}
|
||||
|
||||
func (v *oauthVaultStub) server(t *testing.T) *httptest.Server {
|
||||
t.Helper()
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
var body map[string]string
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
if _, ok := body["secret_id"]; ok {
|
||||
t.Errorf("secret_id must not be sent")
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"`+oauthVaultClientTok+`"}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/kv/data/"+oauthPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
if got := r.Header.Get("X-Vault-Token"); got != oauthVaultClientTok {
|
||||
t.Errorf("X-Vault-Token = %q, want %q", got, oauthVaultClientTok)
|
||||
}
|
||||
switch r.Method {
|
||||
case http.MethodGet:
|
||||
if v.readStatus != http.StatusOK {
|
||||
w.WriteHeader(v.readStatus)
|
||||
_, _ = io.WriteString(w, `{"errors":["permission denied"]}`)
|
||||
return
|
||||
}
|
||||
if !v.exists {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = io.WriteString(w, `{"errors":[]}`)
|
||||
return
|
||||
}
|
||||
payload, _ := json.Marshal(map[string]any{
|
||||
"data": map[string]any{"data": v.data, "metadata": map[string]any{"version": v.version}},
|
||||
})
|
||||
_, _ = w.Write(payload)
|
||||
case http.MethodPost:
|
||||
if v.writeStatus != http.StatusOK {
|
||||
w.WriteHeader(v.writeStatus)
|
||||
_, _ = io.WriteString(w, `{"errors":["permission denied"]}`)
|
||||
return
|
||||
}
|
||||
var body struct {
|
||||
Data map[string]any `json:"data"`
|
||||
}
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
v.writes = append(v.writes, body.Data)
|
||||
v.data = body.Data
|
||||
v.exists = true
|
||||
v.version++
|
||||
_, _ = io.WriteString(w, `{"data":{"version":`+strconv.Itoa(v.version)+`}}`)
|
||||
default:
|
||||
t.Errorf("unexpected method %s", r.Method)
|
||||
}
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
t.Cleanup(srv.Close)
|
||||
return srv
|
||||
}
|
||||
|
||||
func oauthOpts(vaultURL string) SeedOAuthOptions {
|
||||
return SeedOAuthOptions{
|
||||
VaultAddr: vaultURL,
|
||||
RoleID: "role-xyz",
|
||||
KVMount: DefaultKVMount,
|
||||
Path: oauthPath,
|
||||
ClientID: oauthClientID,
|
||||
}
|
||||
}
|
||||
|
||||
// actions flattens a result into key -> action for order-independent asserts.
|
||||
func actions(res SeedOAuthResult) map[string]string {
|
||||
m := make(map[string]string, len(res.Keys))
|
||||
for _, k := range res.Keys {
|
||||
m[k.Name] = k.Action
|
||||
}
|
||||
return m
|
||||
}
|
||||
|
||||
func stringField(t *testing.T, data map[string]any, key string) string {
|
||||
t.Helper()
|
||||
s, ok := data[key].(string)
|
||||
if !ok {
|
||||
t.Fatalf("written %s = %v, want a string", key, data[key])
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
// assertDecodesTo32 fails unless the value is base64 of exactly 32 bytes, which
|
||||
// is what oauth2-proxy requires of a cookie secret.
|
||||
func assertDecodesTo32(t *testing.T, enc *base64.Encoding, value, name string) {
|
||||
t.Helper()
|
||||
raw, err := enc.DecodeString(value)
|
||||
if err != nil {
|
||||
t.Fatalf("%s is not valid base64: %v", name, err)
|
||||
}
|
||||
if len(raw) != oauthSecretBytes {
|
||||
t.Errorf("%s decodes to %d bytes, want %d", name, len(raw), oauthSecretBytes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthFreshCreate(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
res, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
if !res.Changed || res.Version != 1 {
|
||||
t.Errorf("Changed=%v Version=%d, want a first write at version 1", res.Changed, res.Version)
|
||||
}
|
||||
for key, want := range map[string]string{
|
||||
OAuthClientIDKey: ActionCreated,
|
||||
OAuthClientSecretKey: ActionCreated,
|
||||
OAuthCookieSecretKey: ActionCreated,
|
||||
} {
|
||||
if got := actions(res)[key]; got != want {
|
||||
t.Errorf("%s action = %q, want %q", key, got, want)
|
||||
}
|
||||
}
|
||||
if len(v.writes) != 1 {
|
||||
t.Fatalf("%d writes, want exactly 1", len(v.writes))
|
||||
}
|
||||
w := v.writes[0]
|
||||
if got := stringField(t, w, OAuthClientIDKey); got != oauthClientID {
|
||||
t.Errorf("written client_id = %q, want %q", got, oauthClientID)
|
||||
}
|
||||
assertDecodesTo32(t, base64.StdEncoding, stringField(t, w, OAuthClientSecretKey), OAuthClientSecretKey)
|
||||
assertDecodesTo32(t, base64.RawURLEncoding, stringField(t, w, OAuthCookieSecretKey), OAuthCookieSecretKey)
|
||||
}
|
||||
|
||||
// The mediamark case: a client_secret already issued by Authentik must survive
|
||||
// while the missing keys are filled in.
|
||||
func TestSeedOAuthPreservesExistingClientSecret(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{OAuthClientSecretKey: existingClientSec})
|
||||
res, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
got := actions(res)
|
||||
for key, want := range map[string]string{
|
||||
OAuthClientIDKey: ActionCreated,
|
||||
OAuthClientSecretKey: ActionKept,
|
||||
OAuthCookieSecretKey: ActionCreated,
|
||||
} {
|
||||
if got[key] != want {
|
||||
t.Errorf("%s action = %q, want %q", key, got[key], want)
|
||||
}
|
||||
}
|
||||
if len(v.writes) != 1 {
|
||||
t.Fatalf("%d writes, want exactly 1", len(v.writes))
|
||||
}
|
||||
if s := stringField(t, v.writes[0], OAuthClientSecretKey); s != existingClientSec {
|
||||
t.Errorf("client_secret was replaced, want the existing value kept")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthPreservesOtherKeys(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{
|
||||
OAuthClientIDKey: oauthClientID,
|
||||
OAuthClientSecretKey: existingClientSec,
|
||||
"redirect_url": "https://mediamark.unkin.net/oauth2/callback",
|
||||
"extra": oauthExtraKeyValue,
|
||||
})
|
||||
res, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
got := actions(res)
|
||||
for _, key := range []string{"redirect_url", "extra"} {
|
||||
if got[key] != ActionPreserved {
|
||||
t.Errorf("%s action = %q, want %q", key, got[key], ActionPreserved)
|
||||
}
|
||||
}
|
||||
if len(v.writes) != 1 {
|
||||
t.Fatalf("%d writes, want exactly 1", len(v.writes))
|
||||
}
|
||||
w := v.writes[0]
|
||||
if stringField(t, w, "extra") != oauthExtraKeyValue {
|
||||
t.Errorf("extra key was not written back unchanged")
|
||||
}
|
||||
if stringField(t, w, "redirect_url") != "https://mediamark.unkin.net/oauth2/callback" {
|
||||
t.Errorf("redirect_url was not written back unchanged")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthRotateRegenerates(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{
|
||||
OAuthClientIDKey: oauthClientID,
|
||||
OAuthClientSecretKey: existingClientSec,
|
||||
OAuthCookieSecretKey: existingCookieSec,
|
||||
})
|
||||
o := oauthOpts(v.server(t).URL)
|
||||
o.Rotate = true
|
||||
|
||||
res, err := SeedOAuth(o)
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
got := actions(res)
|
||||
for key, want := range map[string]string{
|
||||
OAuthClientIDKey: ActionKept,
|
||||
OAuthClientSecretKey: ActionRotated,
|
||||
OAuthCookieSecretKey: ActionRotated,
|
||||
} {
|
||||
if got[key] != want {
|
||||
t.Errorf("%s action = %q, want %q", key, got[key], want)
|
||||
}
|
||||
}
|
||||
if len(v.writes) != 1 {
|
||||
t.Fatalf("%d writes, want exactly 1", len(v.writes))
|
||||
}
|
||||
w := v.writes[0]
|
||||
if stringField(t, w, OAuthClientSecretKey) == existingClientSec {
|
||||
t.Errorf("client_secret unchanged under --rotate")
|
||||
}
|
||||
if stringField(t, w, OAuthCookieSecretKey) == existingCookieSec {
|
||||
t.Errorf("cookie_secret unchanged under --rotate")
|
||||
}
|
||||
assertDecodesTo32(t, base64.RawURLEncoding, stringField(t, w, OAuthCookieSecretKey), OAuthCookieSecretKey)
|
||||
}
|
||||
|
||||
// A complete, correct secret must not produce a new KV version.
|
||||
func TestSeedOAuthIdempotentWritesNothing(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
url := v.server(t).URL
|
||||
if _, err := SeedOAuth(oauthOpts(url)); err != nil {
|
||||
t.Fatalf("first SeedOAuth: %v", err)
|
||||
}
|
||||
res, err := SeedOAuth(oauthOpts(url))
|
||||
if err != nil {
|
||||
t.Fatalf("second SeedOAuth: %v", err)
|
||||
}
|
||||
if res.Changed || res.Version != 0 {
|
||||
t.Errorf("Changed=%v Version=%d, want an unchanged result", res.Changed, res.Version)
|
||||
}
|
||||
if len(v.writes) != 1 {
|
||||
t.Errorf("%d writes, want the second run to write nothing", len(v.writes))
|
||||
}
|
||||
for _, k := range res.Keys {
|
||||
if k.Action != ActionKept {
|
||||
t.Errorf("%s action = %q, want %q", k.Name, k.Action, ActionKept)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthClientIDUpdated(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{
|
||||
OAuthClientIDKey: "stale-client-id",
|
||||
OAuthClientSecretKey: existingClientSec,
|
||||
OAuthCookieSecretKey: existingCookieSec,
|
||||
})
|
||||
res, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
if got := actions(res)[OAuthClientIDKey]; got != ActionUpdated {
|
||||
t.Errorf("client_id action = %q, want %q", got, ActionUpdated)
|
||||
}
|
||||
if len(v.writes) != 1 || stringField(t, v.writes[0], OAuthClientIDKey) != oauthClientID {
|
||||
t.Errorf("writes = %v, want the new client_id written", v.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthLoginFailure(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
_, _ = io.WriteString(w, `{"errors":["invalid role ID"]}`)
|
||||
})
|
||||
vs := httptest.NewServer(mux)
|
||||
defer vs.Close()
|
||||
|
||||
_, err := SeedOAuth(oauthOpts(vs.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOAuth() = nil, want an approle login error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "approle login failed") {
|
||||
t.Errorf("error = %v, want it to name the approle login", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthReadDenied(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
v.readStatus = http.StatusForbidden
|
||||
|
||||
_, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOAuth() = nil, want a KV read error")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, oauthPath) || !strings.Contains(msg, "policy") {
|
||||
t.Errorf("error = %v, want it to name the path and point at the policy", err)
|
||||
}
|
||||
if len(v.writes) != 0 {
|
||||
t.Errorf("wrote %v, want no write when the read is denied", v.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthWriteDenied(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
v.writeStatus = http.StatusForbidden
|
||||
|
||||
_, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOAuth() = nil, want a KV write error")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, oauthPath) || !strings.Contains(msg, "create/update") {
|
||||
t.Errorf("error = %v, want it to name the path and the missing capability", err)
|
||||
}
|
||||
}
|
||||
|
||||
// A missing path is normal (first seed), not a not-found error.
|
||||
func TestSeedOAuthMissingPathIsNotAnError(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
if _, err := SeedOAuth(oauthOpts(v.server(t).URL)); err != nil {
|
||||
t.Fatalf("SeedOAuth on a missing path: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOAuthRequiresPathAndClientID(t *testing.T) {
|
||||
v := newOAuthVaultStub()
|
||||
url := v.server(t).URL
|
||||
for name, mutate := range map[string]func(*SeedOAuthOptions){
|
||||
"no path": func(o *SeedOAuthOptions) { o.Path = "" },
|
||||
"no client id": func(o *SeedOAuthOptions) { o.ClientID = "" },
|
||||
} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
o := oauthOpts(url)
|
||||
mutate(&o)
|
||||
if _, err := SeedOAuth(o); err == nil {
|
||||
t.Fatal("SeedOAuth() = nil, want a required-input error")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// No failure path may leak stored or generated secret material.
|
||||
func TestSeedOAuthErrorsNeverLeakSecrets(t *testing.T) {
|
||||
cases := map[string]func(*oauthVaultStub){
|
||||
"read denied": func(v *oauthVaultStub) { v.readStatus = http.StatusForbidden },
|
||||
"write denied": func(v *oauthVaultStub) { v.writeStatus = http.StatusForbidden },
|
||||
"read error": func(v *oauthVaultStub) { v.readStatus = http.StatusInternalServerError },
|
||||
"write error": func(v *oauthVaultStub) { v.writeStatus = http.StatusInternalServerError },
|
||||
}
|
||||
for name, mutate := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{
|
||||
OAuthClientSecretKey: existingClientSec,
|
||||
OAuthCookieSecretKey: existingCookieSec,
|
||||
"extra": oauthExtraKeyValue,
|
||||
})
|
||||
mutate(v)
|
||||
_, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOAuth() = nil, want an error")
|
||||
}
|
||||
for _, secret := range []string{existingClientSec, existingCookieSec, oauthExtraKeyValue} {
|
||||
if strings.Contains(err.Error(), secret) {
|
||||
t.Errorf("error %q leaks a secret", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// The successful result carries key names and a version, never values.
|
||||
func TestSeedOAuthResultNeverCarriesSecrets(t *testing.T) {
|
||||
v := newOAuthVaultStub().seed(map[string]any{OAuthClientSecretKey: existingClientSec})
|
||||
res, err := SeedOAuth(oauthOpts(v.server(t).URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOAuth: %v", err)
|
||||
}
|
||||
rendered := strings.Join(append(res.KeyNames(), res.Path, res.KVMount), " ")
|
||||
written := v.writes[0]
|
||||
for _, key := range []string{OAuthClientSecretKey, OAuthCookieSecretKey} {
|
||||
if value := stringField(t, written, key); strings.Contains(rendered, value) {
|
||||
t.Errorf("result leaks the %s value", key)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
const (
|
||||
// DefaultOutpostTokenPath is the KV-v2 path holding the Authentik API token
|
||||
// the agent uses to read outpost tokens.
|
||||
DefaultOutpostTokenPath = "service/authentik/agent-api-token"
|
||||
// DefaultDestKey is the KV field the outpost token is written to.
|
||||
DefaultDestKey = "token"
|
||||
)
|
||||
|
||||
// SeedOutpostOptions configures SeedOutpost. Every field is required; the CLI
|
||||
// supplies the defaults.
|
||||
type SeedOutpostOptions struct {
|
||||
VaultAddr string
|
||||
RoleID string
|
||||
AuthentikURL string
|
||||
Outpost string
|
||||
KVMount string
|
||||
TokenPath string
|
||||
DestPath string
|
||||
DestKey string
|
||||
}
|
||||
|
||||
// SeedOutpostResult is the non-secret summary of a successful seed.
|
||||
type SeedOutpostResult struct {
|
||||
Outpost string
|
||||
TokenIdentifier string
|
||||
KVMount string
|
||||
DestPath string
|
||||
Version int
|
||||
}
|
||||
|
||||
// SeedOutpost copies an Authentik outpost's token into Vault KV-v2. It reads an
|
||||
// Authentik API token from Vault, resolves the outpost's token identifier,
|
||||
// fetches the key and writes it to the destination path. The token value never
|
||||
// leaves this function: results and errors carry only identifiers.
|
||||
func SeedOutpost(o SeedOutpostOptions) (SeedOutpostResult, error) {
|
||||
var res SeedOutpostResult
|
||||
|
||||
vc, err := NewVaultClient(o.VaultAddr, o.RoleID)
|
||||
if err != nil {
|
||||
return res, fmt.Errorf("vault approle login failed against %s (check VAULT_ADDR and AGENT_APPROLE_ROLE_ID): %w", o.VaultAddr, err)
|
||||
}
|
||||
|
||||
secret, err := vc.ReadKV(o.KVMount, o.TokenPath)
|
||||
if err != nil {
|
||||
switch {
|
||||
case errors.Is(err, ErrVaultDenied):
|
||||
return res, fmt.Errorf("reading %s/%s denied: the agent AppRole policy does not grant read on this path (apply the terraform-vault policy change): %w", o.KVMount, o.TokenPath, err)
|
||||
case errors.Is(err, ErrVaultNotFound):
|
||||
return res, fmt.Errorf("secret %s/%s does not exist: seed the Authentik API token there first: %w", o.KVMount, o.TokenPath, err)
|
||||
}
|
||||
return res, fmt.Errorf("reading %s/%s: %w", o.KVMount, o.TokenPath, err)
|
||||
}
|
||||
|
||||
apiToken := StringField(secret, "token", "api_token")
|
||||
if apiToken == "" {
|
||||
return res, fmt.Errorf("secret %s/%s has neither a 'token' nor an 'api_token' field", o.KVMount, o.TokenPath)
|
||||
}
|
||||
|
||||
ac := NewAuthentikClient(o.AuthentikURL, apiToken)
|
||||
outpost, err := ac.FindOutpost(o.Outpost)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrOutpostNotFound) {
|
||||
return res, fmt.Errorf("no outpost named %q at %s: has the terraform-authentik outpost been applied?: %w", o.Outpost, o.AuthentikURL, err)
|
||||
}
|
||||
return res, fmt.Errorf("looking up outpost %q: %w", o.Outpost, err)
|
||||
}
|
||||
if outpost.TokenIdentifier == "" {
|
||||
return res, fmt.Errorf("outpost %q has an empty token_identifier", outpost.Name)
|
||||
}
|
||||
|
||||
key, err := ac.TokenKey(outpost.TokenIdentifier)
|
||||
if err != nil {
|
||||
return res, fmt.Errorf("fetching the key for token identifier %q (the API token needs view_key on it): %w", outpost.TokenIdentifier, err)
|
||||
}
|
||||
|
||||
version, err := vc.WriteKV(o.KVMount, o.DestPath, map[string]string{o.DestKey: key})
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrVaultDenied) {
|
||||
return res, fmt.Errorf("writing %s/%s denied: the agent AppRole policy does not grant create/update on this path (apply the terraform-vault policy change): %w", o.KVMount, o.DestPath, err)
|
||||
}
|
||||
return res, fmt.Errorf("writing %s/%s: %w", o.KVMount, o.DestPath, err)
|
||||
}
|
||||
|
||||
return SeedOutpostResult{
|
||||
Outpost: outpost.Name,
|
||||
TokenIdentifier: outpost.TokenIdentifier,
|
||||
KVMount: o.KVMount,
|
||||
DestPath: o.DestPath,
|
||||
Version: version,
|
||||
}, nil
|
||||
}
|
||||
@@ -0,0 +1,369 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const (
|
||||
testAPIToken = "ak-api-token-secret"
|
||||
testOutpostKey = "outpost-key-secret"
|
||||
testTokenPath = "service/authentik/agent-api-token"
|
||||
testDestPath = "kubernetes/namespace/authentik/default/outpost-token"
|
||||
testOutpostName = "k8s-outpost"
|
||||
testTokenIdent = "ak-outpost-k8s-outpost"
|
||||
testVaultClientT = "s.vaulttoken"
|
||||
)
|
||||
|
||||
// vaultStub is a KV-v2 stand-in whose per-path behaviour tests can override.
|
||||
type vaultStub struct {
|
||||
readStatus int
|
||||
writeStatus int
|
||||
tokenField string // field name the API token is stored under
|
||||
writes []map[string]string
|
||||
writeCount int
|
||||
}
|
||||
|
||||
func newVaultStub() *vaultStub {
|
||||
return &vaultStub{readStatus: http.StatusOK, writeStatus: http.StatusOK, tokenField: "token"}
|
||||
}
|
||||
|
||||
func (v *vaultStub) server(t *testing.T) *httptest.Server {
|
||||
t.Helper()
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
var body map[string]string
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
if _, ok := body["secret_id"]; ok {
|
||||
t.Errorf("secret_id must not be sent")
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"`+testVaultClientT+`"}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/kv/data/"+testTokenPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
if got := r.Header.Get("X-Vault-Token"); got != testVaultClientT {
|
||||
t.Errorf("X-Vault-Token = %q, want %q", got, testVaultClientT)
|
||||
}
|
||||
if v.readStatus != http.StatusOK {
|
||||
w.WriteHeader(v.readStatus)
|
||||
_, _ = io.WriteString(w, `{"errors":["permission denied"]}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"data":{"data":{"`+v.tokenField+`":"`+testAPIToken+`"},"metadata":{"version":1}}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/kv/data/"+testDestPath, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodPost {
|
||||
t.Errorf("write method = %s, want POST", r.Method)
|
||||
}
|
||||
if v.writeStatus != http.StatusOK {
|
||||
w.WriteHeader(v.writeStatus)
|
||||
_, _ = io.WriteString(w, `{"errors":["permission denied"]}`)
|
||||
return
|
||||
}
|
||||
var body struct {
|
||||
Data map[string]string `json:"data"`
|
||||
}
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
v.writes = append(v.writes, body.Data)
|
||||
v.writeCount++
|
||||
_, _ = io.WriteString(w, `{"data":{"version":`+strconv.Itoa(v.writeCount+2)+`}}`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
t.Cleanup(srv.Close)
|
||||
return srv
|
||||
}
|
||||
|
||||
// authentikStub serves the outpost search and view_key endpoints.
|
||||
type authentikStub struct {
|
||||
results string // JSON array body for .results
|
||||
viewKeyStatus int
|
||||
viewKeyBody string
|
||||
sawBearer string
|
||||
sawSearchQuery string
|
||||
}
|
||||
|
||||
func newAuthentikStub() *authentikStub {
|
||||
return &authentikStub{
|
||||
results: `{"pk":"1","name":"` + testOutpostName + `","token_identifier":"` + testTokenIdent + `"}`,
|
||||
viewKeyStatus: http.StatusOK,
|
||||
viewKeyBody: `{"key":"` + testOutpostKey + `"}`,
|
||||
}
|
||||
}
|
||||
|
||||
func (a *authentikStub) server(t *testing.T) *httptest.Server {
|
||||
t.Helper()
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v3/outposts/instances/", func(w http.ResponseWriter, r *http.Request) {
|
||||
a.sawBearer = r.Header.Get("Authorization")
|
||||
a.sawSearchQuery = r.URL.Query().Get("search")
|
||||
_, _ = io.WriteString(w, `{"results":[`+a.results+`]}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v3/core/tokens/"+testTokenIdent+"/view_key/", func(w http.ResponseWriter, r *http.Request) {
|
||||
if a.viewKeyStatus != http.StatusOK {
|
||||
w.WriteHeader(a.viewKeyStatus)
|
||||
_, _ = io.WriteString(w, `{"detail":"boom"}`)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, a.viewKeyBody)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
t.Cleanup(srv.Close)
|
||||
return srv
|
||||
}
|
||||
|
||||
func opts(vaultURL, authentikURL string) SeedOutpostOptions {
|
||||
return SeedOutpostOptions{
|
||||
VaultAddr: vaultURL,
|
||||
RoleID: "role-xyz",
|
||||
AuthentikURL: authentikURL,
|
||||
Outpost: testOutpostName,
|
||||
KVMount: DefaultKVMount,
|
||||
TokenPath: testTokenPath,
|
||||
DestPath: testDestPath,
|
||||
DestKey: DefaultDestKey,
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostHappyPath(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
res, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err != nil {
|
||||
t.Fatalf("SeedOutpost: %v", err)
|
||||
}
|
||||
if res.Outpost != testOutpostName {
|
||||
t.Errorf("Outpost = %q, want %q", res.Outpost, testOutpostName)
|
||||
}
|
||||
if res.TokenIdentifier != testTokenIdent {
|
||||
t.Errorf("TokenIdentifier = %q, want %q", res.TokenIdentifier, testTokenIdent)
|
||||
}
|
||||
if res.DestPath != testDestPath || res.KVMount != DefaultKVMount {
|
||||
t.Errorf("dest = %s/%s, want kv/%s", res.KVMount, res.DestPath, testDestPath)
|
||||
}
|
||||
if res.Version != 3 {
|
||||
t.Errorf("Version = %d, want 3", res.Version)
|
||||
}
|
||||
if a.sawBearer != "Bearer "+testAPIToken {
|
||||
t.Errorf("Authorization = %q, want the API token as a bearer", a.sawBearer)
|
||||
}
|
||||
if a.sawSearchQuery != testOutpostName {
|
||||
t.Errorf("search = %q, want %q", a.sawSearchQuery, testOutpostName)
|
||||
}
|
||||
if len(v.writes) != 1 || v.writes[0][DefaultDestKey] != testOutpostKey {
|
||||
t.Fatalf("written data = %v, want {%s: outpost key}", v.writes, DefaultDestKey)
|
||||
}
|
||||
}
|
||||
|
||||
// Re-running writes a new KV version rather than failing.
|
||||
func TestSeedOutpostIdempotentNewVersion(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
first, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err != nil {
|
||||
t.Fatalf("first SeedOutpost: %v", err)
|
||||
}
|
||||
second, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err != nil {
|
||||
t.Fatalf("second SeedOutpost: %v", err)
|
||||
}
|
||||
if second.Version != first.Version+1 {
|
||||
t.Errorf("versions = %d then %d, want consecutive", first.Version, second.Version)
|
||||
}
|
||||
}
|
||||
|
||||
// The API token may be stored under api_token instead of token.
|
||||
func TestSeedOutpostAPITokenFallbackField(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
v.tokenField = "api_token"
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
if _, err := SeedOutpost(opts(vs.URL, as.URL)); err != nil {
|
||||
t.Fatalf("SeedOutpost with api_token field: %v", err)
|
||||
}
|
||||
if a.sawBearer != "Bearer "+testAPIToken {
|
||||
t.Errorf("Authorization = %q, want the api_token value", a.sawBearer)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostCustomDestKey(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
o := opts(vs.URL, as.URL)
|
||||
o.DestKey = "outpost-token"
|
||||
if _, err := SeedOutpost(o); err != nil {
|
||||
t.Fatalf("SeedOutpost: %v", err)
|
||||
}
|
||||
if len(v.writes) != 1 || v.writes[0]["outpost-token"] != testOutpostKey {
|
||||
t.Errorf("written data = %v, want the key under outpost-token", v.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostLoginFailure(t *testing.T) {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
_, _ = io.WriteString(w, `{"errors":["invalid role ID"]}`)
|
||||
})
|
||||
vs := httptest.NewServer(mux)
|
||||
defer vs.Close()
|
||||
a := newAuthentikStub()
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, a.server(t).URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want an approle login error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "approle login failed") {
|
||||
t.Errorf("error = %v, want it to name the approle login", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostKVReadDenied(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
v.readStatus = http.StatusForbidden
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want a KV read error")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, testTokenPath) || !strings.Contains(msg, "policy") {
|
||||
t.Errorf("error = %v, want it to name the token path and point at the policy", err)
|
||||
}
|
||||
if strings.Contains(msg, "does not exist") {
|
||||
t.Errorf("error = %v, denied must not be reported as missing", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostKVReadNotFound(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
v.readStatus = http.StatusNotFound
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want a missing-secret error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "does not exist") {
|
||||
t.Errorf("error = %v, want it to say the secret does not exist", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostMissingTokenField(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
v.tokenField = "password"
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want an error for a secret with no token field")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "api_token") {
|
||||
t.Errorf("error = %v, want it to name the accepted fields", err)
|
||||
}
|
||||
}
|
||||
|
||||
// A substring hit that is not the exact name must not be accepted.
|
||||
func TestSeedOutpostNotFound(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
a.results = `{"pk":"1","name":"` + testOutpostName + `-staging","token_identifier":"other"}`
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want an outpost-not-found error")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, "no outpost named") || !strings.Contains(msg, "terraform") {
|
||||
t.Errorf("error = %v, want it to report the missing outpost and mention terraform", err)
|
||||
}
|
||||
if len(v.writes) != 0 {
|
||||
t.Errorf("wrote %v, want no KV write when the outpost is missing", v.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostViewKeyFailure(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
a.viewKeyStatus = http.StatusForbidden
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want a view_key error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), testTokenIdent) {
|
||||
t.Errorf("error = %v, want it to name the token identifier", err)
|
||||
}
|
||||
if len(v.writes) != 0 {
|
||||
t.Errorf("wrote %v, want no KV write when view_key fails", v.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostViewKeyEmpty(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
a := newAuthentikStub()
|
||||
a.viewKeyBody = `{}`
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
if _, err := SeedOutpost(opts(vs.URL, as.URL)); err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want an error when view_key returns no key")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeedOutpostKVWriteDenied(t *testing.T) {
|
||||
v := newVaultStub()
|
||||
v.writeStatus = http.StatusForbidden
|
||||
a := newAuthentikStub()
|
||||
vs, as := v.server(t), a.server(t)
|
||||
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want a KV write error")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, testDestPath) || !strings.Contains(msg, "create/update") {
|
||||
t.Errorf("error = %v, want it to name the dest path and the missing capability", err)
|
||||
}
|
||||
}
|
||||
|
||||
// No failure path may leak the API token or the outpost key into the error.
|
||||
func TestSeedOutpostErrorsNeverLeakSecrets(t *testing.T) {
|
||||
cases := map[string]func(*vaultStub, *authentikStub){
|
||||
"read denied": func(v *vaultStub, a *authentikStub) { v.readStatus = http.StatusForbidden },
|
||||
"write denied": func(v *vaultStub, a *authentikStub) { v.writeStatus = http.StatusForbidden },
|
||||
"view_key fail": func(v *vaultStub, a *authentikStub) { a.viewKeyStatus = http.StatusInternalServerError },
|
||||
"outpost gone": func(v *vaultStub, a *authentikStub) { a.results = "" },
|
||||
}
|
||||
for name, mutate := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
v, a := newVaultStub(), newAuthentikStub()
|
||||
mutate(v, a)
|
||||
vs, as := v.server(t), a.server(t)
|
||||
_, err := SeedOutpost(opts(vs.URL, as.URL))
|
||||
if err == nil {
|
||||
t.Fatal("SeedOutpost() = nil, want an error")
|
||||
}
|
||||
for _, secret := range []string{testAPIToken, testOutpostKey} {
|
||||
if strings.Contains(err.Error(), secret) {
|
||||
t.Errorf("error %q leaks a secret", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
+62
-22
@@ -1,12 +1,13 @@
|
||||
// Package agent holds the plumbing shared by the agent-tools CLIs (agentpr and
|
||||
// watchpr): obtaining a Gitea token via Vault AppRole, talking to the Gitea
|
||||
// API, parsing PR references, and deciding when a watched PR changed
|
||||
// meaningfully. Both tools acquire their Gitea token the same way, so that
|
||||
// logic lives here once.
|
||||
// Package agent holds the plumbing shared by the agent-tools CLIs (agentpr,
|
||||
// watchpr, agentws and agentvault): the Vault AppRole login and its KV-v2
|
||||
// client, talking to the Gitea and Authentik APIs, parsing PR references, and
|
||||
// deciding when a watched PR changed meaningfully. Every tool authenticates to
|
||||
// Vault the same way, so that logic lives here once.
|
||||
package agent
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
)
|
||||
|
||||
@@ -16,13 +17,18 @@ const (
|
||||
// DefaultRoleID is the agent AppRole role_id used when AGENT_APPROLE_ROLE_ID
|
||||
// is unset. Login uses role_id only (no secret_id).
|
||||
DefaultRoleID = "ababbcd3-9c77-5c6a-be2d-287fce9214a6"
|
||||
// GiteaCredsPath is the Vault path that mints a scoped Gitea token.
|
||||
GiteaCredsPath = "gitea/creds/unkin-agent"
|
||||
// GiteaCredsPrefix is the Vault gitea secrets-engine creds prefix; the agent
|
||||
// login is appended to it to form the path that mints a scoped Gitea token.
|
||||
GiteaCredsPrefix = "gitea/creds/"
|
||||
// DefaultGiteaURL is the Gitea base URL used when GITEA_URL is unset.
|
||||
DefaultGiteaURL = "https://git.unkin.net"
|
||||
// DefaultAgentLogin is the Gitea login of the agent whose own comments are
|
||||
// ignored by watchpr. Overridable via AGENT_LOGIN.
|
||||
// DefaultAgentLogin is the Gitea login the tools act as: it selects the Vault
|
||||
// creds path, sets the agentws git identity and is the login whose own
|
||||
// comments watchpr ignores. Overridable via AGENT_LOGIN.
|
||||
DefaultAgentLogin = "unkin-agent"
|
||||
// DefaultAuthentikURL is the Authentik base URL used when AUTHENTIK_URL is
|
||||
// unset. identity.unkin.net has no DNS record; the k8s name is the real one.
|
||||
DefaultAuthentikURL = "https://identity.k8s.syd1.au.unkin.net"
|
||||
)
|
||||
|
||||
// VaultAddr returns the configured Vault address (env VAULT_ADDR or the default).
|
||||
@@ -50,8 +56,8 @@ func GiteaURL() string {
|
||||
return DefaultGiteaURL
|
||||
}
|
||||
|
||||
// AgentLogin returns the login whose comments watchpr ignores (env AGENT_LOGIN
|
||||
// or the default).
|
||||
// AgentLogin returns the Gitea login the tools act as (env AGENT_LOGIN or the
|
||||
// default).
|
||||
func AgentLogin() string {
|
||||
if v := os.Getenv("AGENT_LOGIN"); v != "" {
|
||||
return v
|
||||
@@ -59,28 +65,62 @@ func AgentLogin() string {
|
||||
return DefaultAgentLogin
|
||||
}
|
||||
|
||||
// GiteaCredsPath returns the Vault path that mints a scoped Gitea token:
|
||||
// GITEA_CREDS_PATH when set, otherwise gitea/creds/<AgentLogin>. So a service
|
||||
// running as its own identity only has to set AGENT_LOGIN.
|
||||
func GiteaCredsPath() string {
|
||||
// Trimmed because callers join this onto ".../v1/".
|
||||
if v := strings.Trim(strings.TrimSpace(os.Getenv("GITEA_CREDS_PATH")), "/"); v != "" {
|
||||
return v
|
||||
}
|
||||
return GiteaCredsPrefix + AgentLogin()
|
||||
}
|
||||
|
||||
// AuthentikURL returns the configured Authentik base URL (env AUTHENTIK_URL or
|
||||
// the default).
|
||||
func AuthentikURL() string {
|
||||
if v := os.Getenv("AUTHENTIK_URL"); v != "" {
|
||||
return v
|
||||
}
|
||||
return DefaultAuthentikURL
|
||||
}
|
||||
|
||||
var (
|
||||
tokenOnce sync.Once
|
||||
tokenValue string
|
||||
tokenErr error
|
||||
tokenMu sync.Mutex
|
||||
tokenMinted bool
|
||||
tokenValue string
|
||||
tokenErr error
|
||||
)
|
||||
|
||||
// GiteaToken returns a Gitea token, minting it via Vault AppRole on first call
|
||||
// and caching it in-process for the lifetime of the command.
|
||||
func GiteaToken() (string, error) {
|
||||
tokenOnce.Do(func() {
|
||||
tokenValue, tokenErr = fetchGiteaToken(VaultAddr(), RoleID())
|
||||
})
|
||||
tokenMu.Lock()
|
||||
defer tokenMu.Unlock()
|
||||
if !tokenMinted {
|
||||
tokenValue, tokenErr = fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath())
|
||||
tokenMinted = true
|
||||
}
|
||||
return tokenValue, tokenErr
|
||||
}
|
||||
|
||||
// fetchGiteaToken performs the AppRole login and reads the Gitea creds. It is
|
||||
// separated from GiteaToken so tests can exercise it directly against an
|
||||
// httptest server without touching the process-wide cache.
|
||||
func fetchGiteaToken(vaultAddr, roleID string) (string, error) {
|
||||
// RefreshGiteaToken mints a fresh Gitea token and replaces the cached one, for
|
||||
// callers that outlive the ~1h token TTL.
|
||||
func RefreshGiteaToken() (string, error) {
|
||||
tokenMu.Lock()
|
||||
defer tokenMu.Unlock()
|
||||
tokenValue, tokenErr = fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath())
|
||||
tokenMinted = true
|
||||
return tokenValue, tokenErr
|
||||
}
|
||||
|
||||
// fetchGiteaToken performs the AppRole login and reads the Gitea creds at
|
||||
// credsPath. It is separated from GiteaToken so tests can exercise it directly
|
||||
// against an httptest server without touching the process-wide cache.
|
||||
func fetchGiteaToken(vaultAddr, roleID, credsPath string) (string, error) {
|
||||
clientToken, err := approleLogin(vaultAddr, roleID)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return readGiteaCreds(vaultAddr, clientToken)
|
||||
return readGiteaCreds(vaultAddr, clientToken, credsPath)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestGiteaCredsPath(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
agentLogin string
|
||||
credsPath string
|
||||
want string
|
||||
}{
|
||||
{"no env keeps the historical path", "", "", "gitea/creds/unkin-agent"},
|
||||
{"derived from AGENT_LOGIN", "repospawner", "", "gitea/creds/repospawner"},
|
||||
{"GITEA_CREDS_PATH beats AGENT_LOGIN", "repospawner", "gitea/creds/someone-else", "gitea/creds/someone-else"},
|
||||
{"GITEA_CREDS_PATH beats the default", "", "other-gitea/creds/bot", "other-gitea/creds/bot"},
|
||||
{"override is trimmed for joining onto /v1/", "", " /gitea/creds/bot/ ", "gitea/creds/bot"},
|
||||
{"blank override falls back to the login", "repospawner", " ", "gitea/creds/repospawner"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Setenv("AGENT_LOGIN", tt.agentLogin)
|
||||
t.Setenv("GITEA_CREDS_PATH", tt.credsPath)
|
||||
if got := GiteaCredsPath(); got != tt.want {
|
||||
t.Errorf("GiteaCredsPath() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// recordingVault serves the AppRole login plus any creds path under /v1/,
|
||||
// recording which one was read so tests can assert the selected path.
|
||||
type recordingVault struct {
|
||||
mu sync.Mutex
|
||||
credsPath string
|
||||
}
|
||||
|
||||
func (v *recordingVault) path() string {
|
||||
v.mu.Lock()
|
||||
defer v.mu.Unlock()
|
||||
return v.credsPath
|
||||
}
|
||||
|
||||
// fakeEstate serves both Vault (/v1/...) and Gitea (/api/v1/...) from one
|
||||
// server, so a test can drive the whole token-then-API flow.
|
||||
func fakeEstate(t *testing.T, giteaToken, login string) (*httptest.Server, *recordingVault) {
|
||||
t.Helper()
|
||||
rec := &recordingVault{}
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/v1/auth/approle/login", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, `{"auth":{"client_token":"s.vaulttoken"}}`)
|
||||
})
|
||||
mux.HandleFunc("/v1/", func(w http.ResponseWriter, r *http.Request) {
|
||||
rec.mu.Lock()
|
||||
rec.credsPath = strings.TrimPrefix(r.URL.Path, "/v1/")
|
||||
rec.mu.Unlock()
|
||||
_, _ = io.WriteString(w, `{"data":{"token":"`+giteaToken+`"}}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/user", func(w http.ResponseWriter, r *http.Request) {
|
||||
if got := r.Header.Get("Authorization"); got != "token "+giteaToken {
|
||||
t.Errorf("whoami auth header = %q, want token %s", got, giteaToken)
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"login":"`+login+`","id":7}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls", func(w http.ResponseWriter, r *http.Request) {
|
||||
if got := r.Header.Get("Authorization"); got != "token "+giteaToken {
|
||||
t.Errorf("create PR auth header = %q, want token %s", got, giteaToken)
|
||||
}
|
||||
var body CreatePROptions
|
||||
_ = json.NewDecoder(r.Body).Decode(&body)
|
||||
_, _ = io.WriteString(w, `{"number":12,"state":"open","html_url":"`+r.Host+`/pulls/12"}`)
|
||||
})
|
||||
return httptest.NewServer(mux), rec
|
||||
}
|
||||
|
||||
// A service that sets AGENT_LOGIN must read its own creds path and act as its
|
||||
// own Gitea identity for both whoami and PR creation.
|
||||
func TestWhoamiAndPRUseSelectedCredsPath(t *testing.T) {
|
||||
srv, rec := fakeEstate(t, "gitea-repospawner", "repospawner")
|
||||
defer srv.Close()
|
||||
|
||||
t.Setenv("AGENT_LOGIN", "repospawner")
|
||||
t.Setenv("GITEA_CREDS_PATH", "")
|
||||
t.Setenv("VAULT_ADDR", srv.URL)
|
||||
t.Setenv("GITEA_URL", srv.URL)
|
||||
|
||||
tok, err := fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath())
|
||||
if err != nil {
|
||||
t.Fatalf("fetchGiteaToken: %v", err)
|
||||
}
|
||||
if got := rec.path(); got != "gitea/creds/repospawner" {
|
||||
t.Errorf("vault read path = %q, want gitea/creds/repospawner", got)
|
||||
}
|
||||
if tok != "gitea-repospawner" {
|
||||
t.Fatalf("token = %q, want gitea-repospawner", tok)
|
||||
}
|
||||
|
||||
c := NewGiteaClient(tok)
|
||||
u, err := c.Whoami()
|
||||
if err != nil {
|
||||
t.Fatalf("Whoami: %v", err)
|
||||
}
|
||||
if u.Login != "repospawner" {
|
||||
t.Errorf("whoami login = %q, want repospawner", u.Login)
|
||||
}
|
||||
|
||||
pr, err := c.CreatePR("unkin/repo", CreatePROptions{Base: "main", Head: "feature", Title: "T"})
|
||||
if err != nil {
|
||||
t.Fatalf("CreatePR: %v", err)
|
||||
}
|
||||
if pr.Number != 12 {
|
||||
t.Errorf("PR number = %d, want 12", pr.Number)
|
||||
}
|
||||
}
|
||||
|
||||
// GITEA_CREDS_PATH must win even when AGENT_LOGIN names a different identity.
|
||||
func TestCredsPathOverrideBeatsAgentLogin(t *testing.T) {
|
||||
srv, rec := fakeEstate(t, "gitea-override", "someone-else")
|
||||
defer srv.Close()
|
||||
|
||||
t.Setenv("AGENT_LOGIN", "repospawner")
|
||||
t.Setenv("GITEA_CREDS_PATH", "gitea/creds/someone-else")
|
||||
t.Setenv("VAULT_ADDR", srv.URL)
|
||||
|
||||
if _, err := fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath()); err != nil {
|
||||
t.Fatalf("fetchGiteaToken: %v", err)
|
||||
}
|
||||
if got := rec.path(); got != "gitea/creds/someone-else" {
|
||||
t.Errorf("vault read path = %q, want gitea/creds/someone-else", got)
|
||||
}
|
||||
}
|
||||
|
||||
// With no env set the tools must still read the exact path they always did.
|
||||
func TestCredsPathDefaultIsBackwardCompatible(t *testing.T) {
|
||||
srv, rec := fakeEstate(t, "gitea-abc", "unkin-agent")
|
||||
defer srv.Close()
|
||||
|
||||
t.Setenv("AGENT_LOGIN", "")
|
||||
t.Setenv("GITEA_CREDS_PATH", "")
|
||||
t.Setenv("VAULT_ADDR", srv.URL)
|
||||
|
||||
if _, err := fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath()); err != nil {
|
||||
t.Fatalf("fetchGiteaToken: %v", err)
|
||||
}
|
||||
if got := rec.path(); got != "gitea/creds/unkin-agent" {
|
||||
t.Errorf("vault read path = %q, want gitea/creds/unkin-agent", got)
|
||||
}
|
||||
}
|
||||
@@ -49,9 +49,10 @@ func approleLogin(vaultAddr, roleID string) (string, error) {
|
||||
return out.Auth.ClientToken, nil
|
||||
}
|
||||
|
||||
// readGiteaCreds reads the Gitea creds secret and returns the token field.
|
||||
func readGiteaCreds(vaultAddr, clientToken string) (string, error) {
|
||||
url := strings.TrimRight(vaultAddr, "/") + "/v1/" + GiteaCredsPath
|
||||
// readGiteaCreds reads the Gitea creds secret at credsPath and returns the
|
||||
// token field.
|
||||
func readGiteaCreds(vaultAddr, clientToken, credsPath string) (string, error) {
|
||||
url := strings.TrimRight(vaultAddr, "/") + "/v1/" + credsPath
|
||||
req, err := http.NewRequest(http.MethodGet, url, nil)
|
||||
if err != nil {
|
||||
return "", err
|
||||
@@ -60,12 +61,12 @@ func readGiteaCreds(vaultAddr, clientToken string) (string, error) {
|
||||
|
||||
resp, err := httpClient.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("vault read %s: %w", GiteaCredsPath, err)
|
||||
return "", fmt.Errorf("vault read %s: %w", credsPath, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
data, _ := io.ReadAll(resp.Body)
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("vault read %s: HTTP %d: %s", GiteaCredsPath, resp.StatusCode, strings.TrimSpace(string(data)))
|
||||
return "", fmt.Errorf("vault read %s: HTTP %d: %s", credsPath, resp.StatusCode, strings.TrimSpace(string(data)))
|
||||
}
|
||||
|
||||
var out struct {
|
||||
@@ -74,10 +75,10 @@ func readGiteaCreds(vaultAddr, clientToken string) (string, error) {
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &out); err != nil {
|
||||
return "", fmt.Errorf("vault read %s: decoding response: %w", GiteaCredsPath, err)
|
||||
return "", fmt.Errorf("vault read %s: decoding response: %w", credsPath, err)
|
||||
}
|
||||
if out.Data.Token == "" {
|
||||
return "", fmt.Errorf("vault read %s: no token field in secret", GiteaCredsPath)
|
||||
return "", fmt.Errorf("vault read %s: no token field in secret", credsPath)
|
||||
}
|
||||
return out.Data.Token, nil
|
||||
}
|
||||
|
||||
@@ -0,0 +1,166 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
// DefaultKVMount is the KV-v2 mount holding agent-facing secrets.
|
||||
DefaultKVMount = "kv"
|
||||
)
|
||||
|
||||
var (
|
||||
// ErrVaultDenied marks a 403 from Vault (the AppRole policy lacks the capability).
|
||||
ErrVaultDenied = errors.New("permission denied")
|
||||
// ErrVaultNotFound marks a 404 from Vault (mount or secret does not exist).
|
||||
ErrVaultNotFound = errors.New("not found")
|
||||
)
|
||||
|
||||
// VaultClient issues authenticated requests against Vault/OpenBao using a token
|
||||
// obtained from the agent AppRole.
|
||||
type VaultClient struct {
|
||||
Addr string
|
||||
Token string
|
||||
HTTP *http.Client
|
||||
}
|
||||
|
||||
// NewVaultClient performs the AppRole login (role_id only, no secret_id) and
|
||||
// returns a client bound to the resulting client_token.
|
||||
func NewVaultClient(addr, roleID string) (*VaultClient, error) {
|
||||
token, err := approleLogin(addr, roleID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &VaultClient{Addr: addr, Token: token, HTTP: httpClient}, nil
|
||||
}
|
||||
|
||||
func (c *VaultClient) do(method, path string, body any, out any) error {
|
||||
var reader io.Reader
|
||||
if body != nil {
|
||||
b, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
reader = bytes.NewReader(b)
|
||||
}
|
||||
url := strings.TrimRight(c.Addr, "/") + path
|
||||
req, err := http.NewRequest(method, url, reader)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Set("X-Vault-Token", c.Token)
|
||||
if body != nil {
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
}
|
||||
|
||||
resp, err := c.HTTP.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("vault %s %s: %w", method, path, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
data, _ := io.ReadAll(resp.Body)
|
||||
|
||||
switch {
|
||||
case resp.StatusCode == http.StatusForbidden:
|
||||
return fmt.Errorf("vault %s %s: %w", method, path, ErrVaultDenied)
|
||||
case resp.StatusCode == http.StatusNotFound:
|
||||
return fmt.Errorf("vault %s %s: %w", method, path, ErrVaultNotFound)
|
||||
case resp.StatusCode < 200 || resp.StatusCode >= 300:
|
||||
return fmt.Errorf("vault %s %s: HTTP %d: %s", method, path, resp.StatusCode, strings.TrimSpace(string(data)))
|
||||
}
|
||||
|
||||
if out != nil && len(data) > 0 {
|
||||
// Response bodies here carry secret material, so decode failures never
|
||||
// echo the body.
|
||||
if err := json.Unmarshal(data, out); err != nil {
|
||||
return fmt.Errorf("vault %s %s: decoding response: %w", method, path, err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// kvDataPath builds the KV-v2 data path for a mount and secret path.
|
||||
func kvDataPath(mount, path string) string {
|
||||
return "/v1/" + strings.Trim(mount, "/") + "/data/" + strings.Trim(path, "/")
|
||||
}
|
||||
|
||||
// ReadKV returns the data map of a KV-v2 secret.
|
||||
func (c *VaultClient) ReadKV(mount, path string) (map[string]any, error) {
|
||||
var out struct {
|
||||
Data struct {
|
||||
Data map[string]any `json:"data"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := c.do(http.MethodGet, kvDataPath(mount, path), nil, &out); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if out.Data.Data == nil {
|
||||
return nil, fmt.Errorf("vault read %s/%s: secret has no data", mount, path)
|
||||
}
|
||||
return out.Data.Data, nil
|
||||
}
|
||||
|
||||
// ReadKVOptional is ReadKV but treats a missing secret as empty: a 404 or a
|
||||
// deleted version (data: null) yields an empty map, not an error. Callers that
|
||||
// read-modify-write a path that may not exist yet use this.
|
||||
func (c *VaultClient) ReadKVOptional(mount, path string) (map[string]any, error) {
|
||||
var out struct {
|
||||
Data struct {
|
||||
Data map[string]any `json:"data"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := c.do(http.MethodGet, kvDataPath(mount, path), nil, &out); err != nil {
|
||||
if errors.Is(err, ErrVaultNotFound) {
|
||||
return map[string]any{}, nil
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
if out.Data.Data == nil {
|
||||
return map[string]any{}, nil
|
||||
}
|
||||
return out.Data.Data, nil
|
||||
}
|
||||
|
||||
// WriteKV writes a KV-v2 secret and returns the version it created.
|
||||
func (c *VaultClient) WriteKV(mount, path string, data map[string]string) (int, error) {
|
||||
fields := make(map[string]any, len(data))
|
||||
for k, v := range data {
|
||||
fields[k] = v
|
||||
}
|
||||
return c.WriteKVAny(mount, path, fields)
|
||||
}
|
||||
|
||||
// WriteKVAny writes a KV-v2 secret whose fields are not all strings (so a
|
||||
// read-modify-write can put back values it did not author) and returns the
|
||||
// version it created.
|
||||
func (c *VaultClient) WriteKVAny(mount, path string, data map[string]any) (int, error) {
|
||||
var out struct {
|
||||
Data struct {
|
||||
Version int `json:"version"`
|
||||
} `json:"data"`
|
||||
}
|
||||
body := map[string]any{"data": data}
|
||||
if err := c.do(http.MethodPost, kvDataPath(mount, path), body, &out); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if out.Data.Version == 0 {
|
||||
return 0, fmt.Errorf("vault write %s/%s: no version in response", mount, path)
|
||||
}
|
||||
return out.Data.Version, nil
|
||||
}
|
||||
|
||||
// StringField returns the first non-empty string value among the given keys.
|
||||
func StringField(data map[string]any, keys ...string) string {
|
||||
for _, k := range keys {
|
||||
if s, ok := data[k].(string); ok && s != "" {
|
||||
return s
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
+44
-5
@@ -1,6 +1,20 @@
|
||||
package agent
|
||||
|
||||
import "time"
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// errPRGone marks a 404 from the PR lookup itself. A 404 from any other endpoint
|
||||
// can be a proxy or ingress blip and is left to the ordinary failure cap.
|
||||
var errPRGone = errors.New("PR no longer visible")
|
||||
|
||||
// IsPRGone reports whether err is a 404 from the PR lookup, meaning the PR is no
|
||||
// longer visible rather than one endpoint being briefly unreachable.
|
||||
func IsPRGone(err error) bool {
|
||||
return errors.Is(err, errPRGone)
|
||||
}
|
||||
|
||||
// PRState is a point-in-time snapshot of the PR attributes watchpr tracks.
|
||||
type PRState struct {
|
||||
@@ -20,10 +34,16 @@ type PRState struct {
|
||||
func FetchState(c *GiteaClient, ref PRRef, agentLogin string) (PRState, error) {
|
||||
pr, err := c.GetPR(ref.RepoPath(), ref.Number)
|
||||
if err != nil {
|
||||
if IsNotFound(err) {
|
||||
return PRState{}, fmt.Errorf("%w: %w", errPRGone, err)
|
||||
}
|
||||
return PRState{}, err
|
||||
}
|
||||
// A 404 here means the head commit is gone (branch deleted after a squash/
|
||||
// rebase merge); the PR object is still authoritative, so treat CI as absent
|
||||
// rather than discarding the merge signal and hanging the watch loop.
|
||||
ci, err := c.CommitStatus(ref.RepoPath(), pr.Head.Sha)
|
||||
if err != nil {
|
||||
if err != nil && !IsNotFound(err) {
|
||||
return PRState{}, err
|
||||
}
|
||||
comments, err := c.ListComments(ref.RepoPath(), ref.Number)
|
||||
@@ -75,12 +95,22 @@ func terminalState(st PRState) (bool, string) {
|
||||
return false, ""
|
||||
}
|
||||
|
||||
// MaxPollFailures is how many consecutive failed polls of the same PR are
|
||||
// tolerated before Watch gives up. The abort fires on the 20th failed tick, so
|
||||
// at watchpr's default 60s interval a watch rides out ~19 minutes of failure.
|
||||
const MaxPollFailures = 20
|
||||
|
||||
// Watch establishes a baseline for each ref, then polls on every tick until a
|
||||
// tracked PR changes meaningfully, returning the first such change. A PR that is
|
||||
// already terminal (merged/closed) at baseline is reported immediately rather
|
||||
// than polled forever. Poll errors are handed to onError and never stop the
|
||||
// loop; only a baseline fetch error aborts. onBaseline, if set, fires once after
|
||||
// all baselines are captured and before the first tick.
|
||||
// than polled forever. Transient poll errors are handed to onError and the loop
|
||||
// continues, but never blindly: a baseline fetch error, an authentication
|
||||
// failure surviving a token re-mint, a 404 from the PR lookup itself (the repo
|
||||
// is gone, renamed, or no longer visible), and MaxPollFailures consecutive
|
||||
// failures of one PR all abort, because a watcher that sees nothing must not
|
||||
// look healthy.
|
||||
// onBaseline, if set, fires once after all baselines are captured and before the
|
||||
// first tick.
|
||||
func Watch(f StateFetcher, refs []PRRef, agentLogin string, ticks <-chan time.Time, onBaseline func(), onError func(PRRef, error)) (WatchResult, error) {
|
||||
prev := make(map[string]PRState, len(refs))
|
||||
for _, ref := range refs {
|
||||
@@ -96,16 +126,25 @@ func Watch(f StateFetcher, refs []PRRef, agentLogin string, ticks <-chan time.Ti
|
||||
if onBaseline != nil {
|
||||
onBaseline()
|
||||
}
|
||||
fails := make(map[string]int, len(refs))
|
||||
for range ticks {
|
||||
for _, ref := range refs {
|
||||
key := ref.String()
|
||||
cur, err := f.FetchState(ref, agentLogin)
|
||||
if err != nil {
|
||||
if IsAuthError(err) || IsPRGone(err) {
|
||||
return WatchResult{}, fmt.Errorf("polling %s: %w", key, err)
|
||||
}
|
||||
fails[key]++
|
||||
if onError != nil {
|
||||
onError(ref, err)
|
||||
}
|
||||
if fails[key] >= MaxPollFailures {
|
||||
return WatchResult{}, fmt.Errorf("polling %s: giving up after %d consecutive failures: %w", key, fails[key], err)
|
||||
}
|
||||
continue
|
||||
}
|
||||
fails[key] = 0
|
||||
if changed, reason := MeaningfulChange(prev[key], cur); changed {
|
||||
return WatchResult{Ref: ref, Reason: reason, State: cur}, nil
|
||||
}
|
||||
|
||||
@@ -2,6 +2,11 @@ package agent
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
@@ -273,6 +278,78 @@ func TestWatchBaselineErrorAborts(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// The production hang, end to end: a watched PR stays open across several polls,
|
||||
// then is squash-merged and its branch deleted, so the commit-status endpoint
|
||||
// 404s. Driven through a real *GiteaClient, the watch loop must still detect the
|
||||
// merge on the poll it happens. Before the fix, FetchState returned an error on
|
||||
// that poll (the 404 masked the merge), so the loop reported only poll errors
|
||||
// and never exited -- exactly the 37-minute hang seen in production.
|
||||
func TestWatchDetectsMergeWhenCommitGone(t *testing.T) {
|
||||
const sha = "cafebabecafebabe"
|
||||
var polls atomic.Int32 // number of PR fetches so far
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
n := polls.Add(1)
|
||||
if n >= 4 { // baseline + two unchanged polls, then merged
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"closed","merged":true,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
if polls.Load() >= 4 { // branch deleted post-merge: commit is gone
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = fmt.Fprint(w, `{"message":"not found"}`)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
// A real ticker so the loop advances on its own; a hang (the bug) is caught
|
||||
// by the timeout below instead of blocking the suite.
|
||||
tk := time.NewTicker(5 * time.Millisecond)
|
||||
defer tk.Stop()
|
||||
var pollErr atomic.Pointer[error]
|
||||
type outcome struct {
|
||||
res WatchResult
|
||||
err error
|
||||
}
|
||||
done := make(chan outcome, 1)
|
||||
go func() {
|
||||
res, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(_ PRRef, e error) { pollErr.Store(&e) })
|
||||
done <- outcome{res, err}
|
||||
}()
|
||||
|
||||
select {
|
||||
case o := <-done:
|
||||
if o.err != nil {
|
||||
t.Fatalf("Watch: %v", o.err)
|
||||
}
|
||||
if o.res.Reason != "PR merged" {
|
||||
t.Errorf("reason = %q, want %q", o.res.Reason, "PR merged")
|
||||
}
|
||||
if p := pollErr.Load(); p != nil {
|
||||
t.Errorf("no poll error expected once a 404 status is tolerated, got: %v", *p)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
var got error
|
||||
if p := pollErr.Load(); p != nil {
|
||||
got = *p
|
||||
}
|
||||
t.Fatalf("Watch hung: a merge with a gone head commit was never detected (last poll error: %v)", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCountNonAgentComments(t *testing.T) {
|
||||
comments := []Comment{
|
||||
{User: User{Login: "unkin-agent"}},
|
||||
@@ -284,3 +361,443 @@ func TestCountNonAgentComments(t *testing.T) {
|
||||
t.Errorf("countNonAgentComments = %d, want 2", n)
|
||||
}
|
||||
}
|
||||
|
||||
// The production failure: the Vault-minted token expired mid-watch and every
|
||||
// poll 401'd, which the loop logged as a warning and polled past forever. An
|
||||
// auth error that survived the client's re-mint must end the watch with an
|
||||
// error so watchpr exits non-zero instead of watching blind.
|
||||
func TestWatchAbortsOnAuthError(t *testing.T) {
|
||||
open := base()
|
||||
merged := base()
|
||||
merged.State = "closed"
|
||||
merged.Merged = true
|
||||
f := &fakeFetcher{
|
||||
states: []PRState{open, open, merged},
|
||||
errs: []error{nil, &APIError{Method: "GET", Path: "/p", StatusCode: 401, Body: "invalid token"}, nil},
|
||||
}
|
||||
|
||||
warned := 0
|
||||
ticks := make(chan time.Time, 2)
|
||||
ticks <- time.Now()
|
||||
ticks <- time.Now()
|
||||
_, err := Watch(f, []PRRef{open.Ref}, "unkin-agent", ticks, nil, func(PRRef, error) { warned++ })
|
||||
if err == nil {
|
||||
t.Fatal("Watch should return the auth failure, not keep polling")
|
||||
}
|
||||
if !IsAuthError(err) {
|
||||
t.Errorf("Watch error = %v, want an auth error", err)
|
||||
}
|
||||
if warned != 0 {
|
||||
t.Errorf("auth failure was logged as a warning %d time(s); it must abort", warned)
|
||||
}
|
||||
if f.calls != 2 {
|
||||
t.Errorf("fetch calls = %d, want 2 (baseline + the failing poll)", f.calls)
|
||||
}
|
||||
}
|
||||
|
||||
// A 5xx keeps its retry behaviour: warn and poll on.
|
||||
func TestWatchContinuesPastServerError(t *testing.T) {
|
||||
open := base()
|
||||
merged := base()
|
||||
merged.State = "closed"
|
||||
merged.Merged = true
|
||||
f := &fakeFetcher{
|
||||
states: []PRState{open, open, merged},
|
||||
errs: []error{nil, &APIError{Method: "GET", Path: "/p", StatusCode: 502, Body: "bad gateway"}, nil},
|
||||
}
|
||||
|
||||
warned := 0
|
||||
ticks := make(chan time.Time, 2)
|
||||
ticks <- time.Now()
|
||||
ticks <- time.Now()
|
||||
res, err := Watch(f, []PRRef{open.Ref}, "unkin-agent", ticks, nil, func(PRRef, error) { warned++ })
|
||||
if err != nil {
|
||||
t.Fatalf("Watch: %v", err)
|
||||
}
|
||||
if warned != 1 {
|
||||
t.Errorf("warnings = %d, want 1", warned)
|
||||
}
|
||||
if res.Reason != "PR merged" {
|
||||
t.Errorf("reason = %q, want %q", res.Reason, "PR merged")
|
||||
}
|
||||
}
|
||||
|
||||
// The production failure: a watched repo was renamed mid-watch, so every poll
|
||||
// 404'd (Gitea hides a repo the caller may not see rather than 403ing) and the
|
||||
// loop warned past it forever while reporting nothing. A 404 on a tracked PR
|
||||
// must end the watch with an error naming that PR.
|
||||
func TestWatchAbortsOnMidRunNotFound(t *testing.T) {
|
||||
const sha = "deadbeefdeadbeef"
|
||||
var polls atomic.Int32
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
if polls.Add(1) > 1 { // repo renamed/made private after the baseline
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = fmt.Fprint(w, `{"message":"Not Found"}`)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
tk := time.NewTicker(5 * time.Millisecond)
|
||||
defer tk.Stop()
|
||||
var warned atomic.Int32
|
||||
done := make(chan error, 1)
|
||||
go func() {
|
||||
_, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(PRRef, error) { warned.Add(1) })
|
||||
done <- err
|
||||
}()
|
||||
|
||||
select {
|
||||
case err := <-done:
|
||||
if err == nil {
|
||||
t.Fatal("Watch should abort on a mid-run 404, not keep polling")
|
||||
}
|
||||
if !IsNotFound(err) {
|
||||
t.Errorf("Watch error = %v, want a 404", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), ref.String()) {
|
||||
t.Errorf("Watch error = %v, want it to name %s", err, ref.String())
|
||||
}
|
||||
if n := warned.Load(); n != 0 {
|
||||
t.Errorf("404 was logged as a warning %d time(s); it must abort", n)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatal("Watch hung: a vanished repo was warned past instead of aborting")
|
||||
}
|
||||
}
|
||||
|
||||
// A 404 from a sub-resource is not proof the PR is gone: an ingress can serve
|
||||
// one during a Gitea rolling restart. Only the PR lookup itself is authoritative,
|
||||
// so a comments 404 must warn and keep polling like any other transient failure,
|
||||
// and still catch the merge that lands afterwards.
|
||||
func TestWatchSurvivesCommentsNotFound(t *testing.T) {
|
||||
const sha = "0badc0de0badc0de"
|
||||
var polls atomic.Int32
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
if polls.Add(1) >= 4 {
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"closed","merged":true,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
if n := polls.Load(); n == 2 || n == 3 { // proxy blip across two polls
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = fmt.Fprint(w, `{"message":"Not Found"}`)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
tk := time.NewTicker(5 * time.Millisecond)
|
||||
defer tk.Stop()
|
||||
var warned atomic.Int32
|
||||
type outcome struct {
|
||||
res WatchResult
|
||||
err error
|
||||
}
|
||||
done := make(chan outcome, 1)
|
||||
go func() {
|
||||
res, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(PRRef, error) { warned.Add(1) })
|
||||
done <- outcome{res, err}
|
||||
}()
|
||||
|
||||
select {
|
||||
case o := <-done:
|
||||
if o.err != nil {
|
||||
t.Fatalf("Watch: %v (a comments 404 must not be terminal)", o.err)
|
||||
}
|
||||
if o.res.Reason != "PR merged" {
|
||||
t.Errorf("reason = %q, want %q", o.res.Reason, "PR merged")
|
||||
}
|
||||
if n := warned.Load(); n != 2 {
|
||||
t.Errorf("warnings = %d, want 2", n)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatal("Watch hung: a comments 404 must warn and keep polling")
|
||||
}
|
||||
}
|
||||
|
||||
// A comments 404 costs a poll from the same budget as any other failure: it must
|
||||
// not be free, and a permanently 404ing sub-resource must still end the watch.
|
||||
func TestWatchCommentsNotFoundCountsTowardCap(t *testing.T) {
|
||||
const sha = "1badc0de1badc0de"
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
var comments atomic.Int32
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
if comments.Add(1) > 1 { // healthy at baseline, gone from the first poll on
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = fmt.Fprint(w, `{"message":"Not Found"}`)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
tk := time.NewTicker(time.Millisecond)
|
||||
defer tk.Stop()
|
||||
var warned atomic.Int32
|
||||
done := make(chan error, 1)
|
||||
go func() {
|
||||
_, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(PRRef, error) { warned.Add(1) })
|
||||
done <- err
|
||||
}()
|
||||
|
||||
select {
|
||||
case err := <-done:
|
||||
if err == nil {
|
||||
t.Fatal("Watch should give up once the comments 404 stops being transient")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "consecutive failures") {
|
||||
t.Errorf("Watch error = %v, want it to report the failure cap", err)
|
||||
}
|
||||
if n := warned.Load(); n != MaxPollFailures {
|
||||
t.Errorf("warnings = %d, want %d", n, MaxPollFailures)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatal("Watch hung: a permanently 404ing comments endpoint must hit the cap")
|
||||
}
|
||||
}
|
||||
|
||||
// The PR lookup is the call whose 404 means the PR is gone, so it aborts on the
|
||||
// very first occurrence rather than spending the failure budget.
|
||||
func TestWatchAbortsOnFirstPRLookupNotFound(t *testing.T) {
|
||||
const sha = "2badc0de2badc0de"
|
||||
var polls atomic.Int32
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
if polls.Add(1) > 1 {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = fmt.Fprint(w, `{"message":"Not Found"}`)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
tk := time.NewTicker(5 * time.Millisecond)
|
||||
defer tk.Stop()
|
||||
done := make(chan error, 1)
|
||||
go func() {
|
||||
_, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(PRRef, error) { t.Errorf("a PR-lookup 404 must abort, not warn") })
|
||||
done <- err
|
||||
}()
|
||||
|
||||
select {
|
||||
case err := <-done:
|
||||
if !IsNotFound(err) {
|
||||
t.Fatalf("Watch error = %v, want a 404", err)
|
||||
}
|
||||
if n := polls.Load(); n != 2 {
|
||||
t.Errorf("PR fetches = %d, want 2 (baseline + the 404 that aborts)", n)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatal("Watch hung: a vanished PR must abort")
|
||||
}
|
||||
}
|
||||
|
||||
// A 5xx blip must not kill a long watch: it warns, keeps polling, and still
|
||||
// catches the merge that lands afterwards.
|
||||
func TestWatchSurvivesTransientServerError(t *testing.T) {
|
||||
const sha = "feedfacefeedface"
|
||||
var polls atomic.Int32
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/pulls/7", func(w http.ResponseWriter, r *http.Request) {
|
||||
switch n := polls.Add(1); {
|
||||
case n == 2 || n == 3: // gateway blip across two polls
|
||||
w.WriteHeader(http.StatusBadGateway)
|
||||
_, _ = fmt.Fprint(w, `bad gateway`)
|
||||
case n >= 4:
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"closed","merged":true,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
default:
|
||||
_, _ = fmt.Fprintf(w, `{"number":7,"state":"open","merged":false,"mergeable":true,"head":{"sha":%q}}`, sha)
|
||||
}
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/commits/"+sha+"/status", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `{"state":"success"}`)
|
||||
})
|
||||
mux.HandleFunc("/api/v1/repos/unkin/repo/issues/7/comments", func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = fmt.Fprint(w, `[]`)
|
||||
})
|
||||
srv := httptest.NewServer(mux)
|
||||
defer srv.Close()
|
||||
|
||||
c := &GiteaClient{BaseURL: srv.URL, Token: "t", HTTP: srv.Client()}
|
||||
ref := PRRef{Owner: "unkin", Repo: "repo", Number: 7}
|
||||
|
||||
tk := time.NewTicker(5 * time.Millisecond)
|
||||
defer tk.Stop()
|
||||
var warned atomic.Int32
|
||||
type outcome struct {
|
||||
res WatchResult
|
||||
err error
|
||||
}
|
||||
done := make(chan outcome, 1)
|
||||
go func() {
|
||||
res, err := Watch(c, []PRRef{ref}, "unkin-agent", tk.C, nil,
|
||||
func(PRRef, error) { warned.Add(1) })
|
||||
done <- outcome{res, err}
|
||||
}()
|
||||
|
||||
select {
|
||||
case o := <-done:
|
||||
if o.err != nil {
|
||||
t.Fatalf("Watch: %v", o.err)
|
||||
}
|
||||
if o.res.Reason != "PR merged" {
|
||||
t.Errorf("reason = %q, want %q", o.res.Reason, "PR merged")
|
||||
}
|
||||
if n := warned.Load(); n != 2 {
|
||||
t.Errorf("warnings = %d, want 2", n)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatal("Watch hung: a transient 5xx must not stop the watch")
|
||||
}
|
||||
}
|
||||
|
||||
// pollFailures scripts a fetcher whose polls fail with a 502 at the given call
|
||||
// indexes (0 is the baseline); the final call returns merged.
|
||||
func pollFailures(calls int, failAt map[int]bool) *fakeFetcher {
|
||||
open, merged := base(), base()
|
||||
merged.State = "closed"
|
||||
merged.Merged = true
|
||||
f := &fakeFetcher{states: make([]PRState, calls), errs: make([]error, calls)}
|
||||
for i := range calls {
|
||||
f.states[i] = open
|
||||
if failAt[i] {
|
||||
f.errs[i] = &APIError{Method: "GET", Path: "/p", StatusCode: 502, Body: "bad gateway"}
|
||||
}
|
||||
}
|
||||
f.states[calls-1] = merged
|
||||
return f
|
||||
}
|
||||
|
||||
// A permanently wedged endpoint (5xx forever) must eventually give up instead of
|
||||
// warning on every tick for the life of the process.
|
||||
func TestWatchAbortsAfterConsecutiveFailures(t *testing.T) {
|
||||
failAt := map[int]bool{}
|
||||
for i := 1; i <= MaxPollFailures; i++ {
|
||||
failAt[i] = true
|
||||
}
|
||||
f := pollFailures(MaxPollFailures+1, failAt)
|
||||
|
||||
warned := 0
|
||||
ticks := make(chan time.Time, MaxPollFailures)
|
||||
for range MaxPollFailures {
|
||||
ticks <- time.Now()
|
||||
}
|
||||
close(ticks)
|
||||
_, err := Watch(f, []PRRef{base().Ref}, "unkin-agent", ticks, nil, func(PRRef, error) { warned++ })
|
||||
if err == nil {
|
||||
t.Fatal("Watch should give up once the failures stop being transient")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "consecutive failures") {
|
||||
t.Errorf("Watch error = %v, want it to report the failure cap", err)
|
||||
}
|
||||
if warned != MaxPollFailures {
|
||||
t.Errorf("warnings = %d, want %d", warned, MaxPollFailures)
|
||||
}
|
||||
if f.calls != MaxPollFailures+1 {
|
||||
t.Errorf("fetch calls = %d, want %d", f.calls, MaxPollFailures+1)
|
||||
}
|
||||
}
|
||||
|
||||
// The cap counts consecutive failures only: a single successful poll clears it,
|
||||
// so an intermittent endpoint is watched indefinitely and the merge is caught.
|
||||
func TestWatchFailureCountResetsOnSuccess(t *testing.T) {
|
||||
const runs = MaxPollFailures - 1
|
||||
failAt := map[int]bool{}
|
||||
for i := 1; i <= runs; i++ { // first run of failures
|
||||
failAt[i] = true
|
||||
}
|
||||
for i := runs + 2; i <= 2*runs+1; i++ { // second run, after one good poll
|
||||
failAt[i] = true
|
||||
}
|
||||
f := pollFailures(2*runs+3, failAt)
|
||||
|
||||
ticks := make(chan time.Time, 2*runs+2)
|
||||
for range 2*runs + 2 {
|
||||
ticks <- time.Now()
|
||||
}
|
||||
close(ticks)
|
||||
res, err := Watch(f, []PRRef{base().Ref}, "unkin-agent", ticks, nil, func(PRRef, error) {})
|
||||
if err != nil {
|
||||
t.Fatalf("Watch: %v (a successful poll must reset the failure count)", err)
|
||||
}
|
||||
if res.Reason != "PR merged" {
|
||||
t.Errorf("reason = %q, want %q", res.Reason, "PR merged")
|
||||
}
|
||||
}
|
||||
|
||||
// Anonymous watching of a public repo must poll on without a credential in
|
||||
// sight: no token, no mint, no exit until something actually changes.
|
||||
func TestWatchAnonymousKeepsPolling(t *testing.T) {
|
||||
open := base()
|
||||
f := &fakeFetcher{states: []PRState{open}}
|
||||
|
||||
ticks := make(chan time.Time, 2)
|
||||
ticks <- time.Now()
|
||||
ticks <- time.Now()
|
||||
close(ticks)
|
||||
res, err := Watch(f, []PRRef{open.Ref}, "unkin-agent", ticks, nil,
|
||||
func(_ PRRef, e error) { t.Errorf("unexpected poll error: %v", e) })
|
||||
if err != nil {
|
||||
t.Fatalf("Watch: %v", err)
|
||||
}
|
||||
if res.Reason != "" {
|
||||
t.Errorf("reason = %q, want no change reported", res.Reason)
|
||||
}
|
||||
if f.calls != 3 {
|
||||
t.Errorf("fetch calls = %d, want 3 (baseline + two polls)", f.calls)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -36,6 +36,18 @@ contents:
|
||||
mode: 0755
|
||||
owner: root
|
||||
group: root
|
||||
- src: dist/agentws
|
||||
dst: /usr/bin/agentws
|
||||
file_info:
|
||||
mode: 0755
|
||||
owner: root
|
||||
group: root
|
||||
- src: dist/agentvault
|
||||
dst: /usr/bin/agentvault
|
||||
file_info:
|
||||
mode: 0755
|
||||
owner: root
|
||||
group: root
|
||||
|
||||
# Shell completions (generated by scripts/build-rpm.sh before packaging).
|
||||
- src: dist/completions/agentpr.bash
|
||||
@@ -62,3 +74,27 @@ contents:
|
||||
dst: /usr/share/fish/vendor_completions.d/watchpr.fish
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/agentws.bash
|
||||
dst: /usr/share/bash-completion/completions/agentws
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/_agentws
|
||||
dst: /usr/share/zsh/site-functions/_agentws
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/agentws.fish
|
||||
dst: /usr/share/fish/vendor_completions.d/agentws.fish
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/agentvault.bash
|
||||
dst: /usr/share/bash-completion/completions/agentvault
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/_agentvault
|
||||
dst: /usr/share/zsh/site-functions/_agentvault
|
||||
file_info:
|
||||
mode: 0644
|
||||
- src: dist/completions/agentvault.fish
|
||||
dst: /usr/share/fish/vendor_completions.d/agentvault.fish
|
||||
file_info:
|
||||
mode: 0644
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Package the (already built) agentpr and watchpr binaries into an RPM with
|
||||
# nfpm, bundling generated bash/zsh/fish shell completions.
|
||||
# Package the (already built) agentpr, watchpr, agentws and agentvault binaries into an RPM
|
||||
# with nfpm, bundling generated bash/zsh/fish shell completions.
|
||||
# Usage: scripts/build-rpm.sh [version] (version defaults to $CI_COMMIT_TAG)
|
||||
#
|
||||
set -euo pipefail
|
||||
@@ -12,7 +12,7 @@ cd "${ROOT_DIR}"
|
||||
VERSION="${1:-${CI_COMMIT_TAG:-0.0.0-dev}}"
|
||||
VERSION="${VERSION#v}" # strip a leading v
|
||||
PACKAGE="agent-tools"
|
||||
BINARIES=(agentpr watchpr)
|
||||
BINARIES=(agentpr watchpr agentws agentvault)
|
||||
DIST="dist"
|
||||
|
||||
for b in "${BINARIES[@]}"; do
|
||||
@@ -37,7 +37,7 @@ export PACKAGE_VERSION="${VERSION}"
|
||||
export PACKAGE_RELEASE="1"
|
||||
export PACKAGE_ARCH="amd64"
|
||||
export PACKAGE_PLATFORM="linux"
|
||||
export PACKAGE_DESCRIPTION="CLI tools for Gitea automation as the unkin-agent user: agentpr (create PRs/comments) and watchpr (poll PRs and alert on meaningful change)"
|
||||
export PACKAGE_DESCRIPTION="CLI tools for automation as the unkin-agent user: agentpr (create PRs/comments), watchpr (poll PRs and alert on meaningful change), agentws (manage per-branch git worktrees) and agentvault (deterministic Vault flows)"
|
||||
export PACKAGE_MAINTAINER="Ben Vincent <ben@unkin.net>"
|
||||
export PACKAGE_HOMEPAGE="https://git.unkin.net/unkin/agent-tools"
|
||||
export PACKAGE_LICENSE="MIT"
|
||||
|
||||
Reference in New Issue
Block a user