Files
node-lookup/cmd/pblastreport/report.go
T
unkinben f296056360
ci/woodpecker/tag/release Pipeline failed
Add pburl and pblastreport companion tools to the RPM (#15)
## Why

`node-lookup` output is handy for pivoting to Puppetboard, but there was no quick way to turn a list of hosts into Puppetboard node-page URLs, or to see when each host last ran Puppet. These two small tools close that gap and ship in the **same RPM** so they're available wherever `node-lookup` is.

## Changes

- Add **`pburl`**: reads hostnames from args or piped `node-lookup` output (first field of each line, de-duped) and prints `<host> <puppetboard-node-page-url>`.
- Add **`pblastreport`**: prints `<host>\t<last-report-time>\t<url>` using `report_timestamp` from the PuppetDB v4 `nodes` endpoint. Supports `--relative`/`-r` (relative age) and `--timezone`/`-z <IANA>` (default: local timezone).
- Add **`internal/puppet`** package shared by both tools: config load, PuppetDB `nodes` query, Puppetboard URL construction (`<base>/node/<certname>`), and no-TTY-safe stdin host reading.
- Add **`puppetboard_url`** config key (env `NODE_LOOKUP_PUPPETBOARD_URL`, default `https://puppetboard.k8s.syd1.au.unkin.net`) to the shared config so `config init`/`config show` scaffold it for the whole tool family. `node-lookup`'s own query behaviour is unchanged.
- Build all three binaries individually (each is its own `main` package — a single `go build ./...` can't emit multiple mains) and generate per-binary bash/zsh/fish completions in the Makefile, `build-rpm.sh`, and nfpm spec.
- Cross-compile and attach all three tools per os/arch in the release pipeline; extend `.gitignore`; `go mod tidy` promotes cobra/yaml to direct deps.
- Document the tools, config key, and env var in `AGENTS.md`.

## Testing

- `go test -race ./...` passes (new tests cover config precedence, `nodes` endpoint derivation, host-page URLs, `LookupNode`, stdin host parsing, and the report-time formatting incl. timezone/relative/edge cases).
- Built the RPM locally and confirmed it installs all 3 binaries + 9 completion files.
- Smoke-tested both tools end-to-end against a mock PuppetDB (timezone conversion, relative time, and error handling all correct).

No cross-repo changes needed: the release reuses the existing `default` ServiceAccount and the artifactapi `rpm-internal` upload.

Reviewed-on: #15
Co-authored-by: Ben Vincent <ben@unkin.net>
Co-committed-by: Ben Vincent <ben@unkin.net>
2026-07-16 22:37:26 +10:00

54 lines
1.4 KiB
Go

package main
import (
"fmt"
"time"
"node-lookup/internal/puppet"
)
// formatWhen renders the "last report" column for a node lookup result. It
// handles the lookup error, the unknown-node, and the never-reported cases so
// the output always has a value in every column.
func formatWhen(node *puppet.Node, lookupErr error, relative bool, loc *time.Location, now time.Time) string {
if lookupErr != nil {
return "error: " + lookupErr.Error()
}
if node == nil {
return "unknown node"
}
if node.ReportTimestamp == "" {
return "no report"
}
ts, err := time.Parse(time.RFC3339Nano, node.ReportTimestamp)
if err != nil {
return node.ReportTimestamp // fall back to the raw value
}
if relative {
return humanizeSince(now, ts)
}
return ts.In(loc).Format("2006-01-02 15:04:05 MST")
}
// humanizeSince renders the gap between now and ts as a coarse relative string
// ("42s ago", "9m ago", "3h ago", "5d ago"). Future timestamps (clock skew)
// render as "in <d>".
func humanizeSince(now, ts time.Time) string {
d := now.Sub(ts)
suffix := "ago"
if d < 0 {
d = -d
suffix = "from now"
}
switch {
case d < time.Minute:
return fmt.Sprintf("%ds %s", int(d.Seconds()), suffix)
case d < time.Hour:
return fmt.Sprintf("%dm %s", int(d.Minutes()), suffix)
case d < 24*time.Hour:
return fmt.Sprintf("%dh %s", int(d.Hours()), suffix)
default:
return fmt.Sprintf("%dd %s", int(d.Hours()/24), suffix)
}
}