Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5c0eb1e899 | |||
| d04c5aa58d | |||
| 7c6ec361ae | |||
| 46dfe48adc | |||
| 71e42811fb | |||
| 985b58c406 | |||
| 7ef0e28e96 | |||
| d9645ec5e4 | |||
| 155392a809 |
@@ -31,7 +31,7 @@ parsing, watch-state comparison, git worktree helpers).
|
||||
cmd/agentpr/main.go # agentpr CLI (pr create / pr comment / whoami)
|
||||
cmd/watchpr/main.go # watchpr CLI (poll + meaningful-change exit)
|
||||
cmd/agentws/main.go # agentws CLI (new / list / rm / clean / token / credential)
|
||||
cmd/agentvault/main.go # agentvault CLI (seed-outpost)
|
||||
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 the gitea creds path
|
||||
@@ -42,6 +42,7 @@ internal/agent/ # shared plumbing:
|
||||
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 (all binaries)
|
||||
@@ -148,12 +149,42 @@ 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 on a
|
||||
401/403 and replays the request. If the fresh token is rejected too, `watchpr`
|
||||
exits non-zero rather than polling blind.
|
||||
- `watchpr` polls anonymously when no token can be minted (public repos work
|
||||
fine); only a real 401/403 reaches for Vault.
|
||||
- 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.
|
||||
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.
|
||||
- CI "combined status" comes from `/commits/{sha}/status`; an empty head SHA
|
||||
yields an empty state without an API call.
|
||||
|
||||
@@ -70,6 +70,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
|
||||
@@ -162,6 +165,42 @@ 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
|
||||
|
||||
+45
-1
@@ -3,11 +3,13 @@
|
||||
// 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"
|
||||
|
||||
@@ -33,7 +35,7 @@ func newRootCmd() *cobra.Command {
|
||||
SilenceUsage: true,
|
||||
}
|
||||
root.SetVersionTemplate("{{.Version}}\n")
|
||||
root.AddCommand(newSeedOutpostCmd(), newVersionCmd())
|
||||
root.AddCommand(newSeedOutpostCmd(), newSeedOAuthCmd(), newVersionCmd())
|
||||
return root
|
||||
}
|
||||
|
||||
@@ -73,6 +75,48 @@ func newSeedOutpostCmd() *cobra.Command {
|
||||
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",
|
||||
|
||||
@@ -2,6 +2,7 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
@@ -78,6 +79,89 @@ func TestSeedOutpostOutputHasNoSecrets(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
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},
|
||||
|
||||
+21
-9
@@ -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.
|
||||
@@ -131,6 +137,12 @@ 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 {
|
||||
if agent.IsAuthError(err) {
|
||||
return fmt.Errorf("gitea authentication failed after re-minting the token, watch aborted: %w", err)
|
||||
}
|
||||
if agent.IsPRGone(err) {
|
||||
return fmt.Errorf("PR no longer visible (repo deleted, renamed, or made private), watch aborted: %w", err)
|
||||
}
|
||||
return err
|
||||
}
|
||||
report(res.Ref.String(), res.Reason, res.State, jsonMode)
|
||||
|
||||
@@ -2,6 +2,9 @@ package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@@ -28,3 +31,77 @@ 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)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,9 +2,11 @@ package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@@ -231,3 +233,219 @@ 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)
|
||||
}
|
||||
}
|
||||
|
||||
+42
-7
@@ -24,40 +24,75 @@ 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.
|
||||
func isNotFound(err error) bool {
|
||||
// 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: the token is expired or
|
||||
// unauthorised, which retrying the same request cannot fix.
|
||||
func IsAuthError(err error) bool {
|
||||
var apiErr *APIError
|
||||
return errors.As(err, &apiErr) &&
|
||||
(apiErr.StatusCode == http.StatusUnauthorized || apiErr.StatusCode == http.StatusForbidden)
|
||||
}
|
||||
|
||||
// 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 token was rejected, re-mints it once and
|
||||
// replays the request with the fresh token.
|
||||
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
|
||||
}
|
||||
err := c.attempt(method, path, payload, out)
|
||||
if !IsAuthError(err) || c.Refresh == nil {
|
||||
return err
|
||||
}
|
||||
token, refreshErr := c.Refresh()
|
||||
if refreshErr != nil {
|
||||
return fmt.Errorf("%w; re-minting token: %v", err, refreshErr)
|
||||
}
|
||||
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")
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// PRRef identifies a single pull request by repository and number.
|
||||
@@ -48,6 +49,25 @@ 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
|
||||
}
|
||||
|
||||
// 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,54 @@ 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)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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)
|
||||
}
|
||||
}
|
||||
}
|
||||
+19
-5
@@ -86,17 +86,31 @@ func AuthentikURL() string {
|
||||
}
|
||||
|
||||
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() {
|
||||
tokenMu.Lock()
|
||||
defer tokenMu.Unlock()
|
||||
if !tokenMinted {
|
||||
tokenValue, tokenErr = fetchGiteaToken(VaultAddr(), RoleID(), GiteaCredsPath())
|
||||
})
|
||||
tokenMinted = true
|
||||
}
|
||||
return tokenValue, tokenErr
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
|
||||
|
||||
@@ -106,8 +106,40 @@ func (c *VaultClient) ReadKV(mount, path string) (map[string]any, error) {
|
||||
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"`
|
||||
|
||||
+41
-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,13 +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 && !isNotFound(err) {
|
||||
if err != nil && !IsNotFound(err) {
|
||||
return PRState{}, err
|
||||
}
|
||||
comments, err := c.ListComments(ref.RepoPath(), ref.Number)
|
||||
@@ -78,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 {
|
||||
@@ -99,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
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
@@ -360,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)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user