Makefile:
- New install-deps umbrella target split into three sub-targets:
install-deps-apt — Debian/Trixie-packaged build deps
(nodejs, npm, protobuf-compiler, git, make,
dpkg-dev, ca-certificates, curl, tar). Uses
sudo when not already root.
install-deps-go — ensures a Go toolchain >= GO_VERSION (go.mod
floor, default 1.25.0). Short-circuits when
the system Go is already recent enough;
otherwise downloads the upstream tarball
from go.dev/dl/ into /usr/local/go. Trixie
only ships 1.24 so this step is load-bearing.
install-deps-go-tools — go install protoc-gen-go, protoc-gen-go-grpc,
and golangci-lint/v2/cmd/golangci-lint. Then
asserts the installed golangci-lint version
parses as >= GOLANGCI_LINT_VERSION (default
1.64.0, the floor that supports Go 1.25
syntax) to catch stale binaries in $GOPATH
/bin before they silently run against Go
1.25 code.
- Parser bug fixed: golangci-lint v1.x prints "has version v1.64.8" but
v2.x dropped the 'v' prefix and prints "has version 2.11.4". The
original sed regex required the 'v' and returned an empty match on
v2.x, making the assertion explode with "could not parse version
output". Fixed by switching to extended regex (sed -En) with 'v?' so
both forms parse cleanly.
- GO_VERSION and GOLANGCI_LINT_VERSION exposed as Makefile variables
so operators can override on the command line, e.g.
make install-deps GO_VERSION=1.25.5 GOLANGCI_LINT_VERSION=2.0.0
- .PHONY extended with the four new target names.
Docs:
- README.md: capability note rewritten to cover CAP_NET_RAW (ICMP) and
the new CAP_SYS_ADMIN requirement when healthchecker.netns is set,
plus a paragraph explaining that the Debian systemd unit grants both
automatically. Docker example gained a second variant that shows the
additional --cap-add SYS_ADMIN and /var/run/netns bind mount for
netns-scoped deployments. Also notes that maglevd-frontend ignores
SIGHUP so controlling-terminal disconnects don't kill it.
- docs/user-guide.md: Capabilities section rewritten as a bulleted
list covering both caps, with the EPERM error string and three
different ways to grant them (systemd unit, setcap, systemd-run);
'show vpp lb counters' command description updated to explain that
per-backend packet counts are no longer shown (LB plugin's
forwarding node bypasses ip{4,6}_lookup_inline, so /net/route/to at
the backend's FIB entry never ticks for LB-forwarded traffic); new
~75-line "What the SPA shows" subsection covering the scope
selector + maglev_scope cookie, the per-maglevd frontend cards, the
health-cascade icon table (ok / bug-buckets / primary-drained /
degraded / unknown), the lb buckets column semantics, the
maglev_zippy_open cookie, the admin-mode lifecycle dialogs with
their plain-English consequence text, and the debug panel.
- docs/config-guide.md: healthchecker.netns field gains a capability-
requirement note spelling out setns(CLONE_NEWNET), the EPERM
symptom string, and the /var/run/netns/ readability requirement.
- docs/healthchecks.md: new "Jitter" subsection explaining the +/-10%
scaling on every computed interval, and a "Probe timing while a
probe is in flight" subsection that explains why fast-interval alone
doesn't give fast fault detection against hanging backends (the
probe loop is synchronous, so each iteration is timeout +
fast-interval; the advice is to lower timeout, not fast-interval).
- docs/maglevd.8: description paragraph corrected (dropped the
per-backend stats claim and added a short note pointing at the LB
plugin forwarding-path bypass); new CAPABILITIES section between
SIGNALS and FILES covering both CAP_NET_RAW and CAP_SYS_ADMIN with
the drop-in-override hint.
- docs/maglevd-frontend.8: new SIGNALS section documenting the
explicit SIGHUP ignore (so a controlling-terminal disconnect doesn't
kill the daemon); description extended with paragraphs on the two
persistence cookies (maglev_scope, maglev_zippy_open) and on the
health-cascade icon + lb buckets column.
- docs/maglevc.1: left untouched — intentionally minimal and delegates
to docs/user-guide.md.
Lint (26 issues across 12 files, all errcheck / ineffassign / S1021):
- cmd/frontend/handlers.go: _, _ = fmt.Fprintf(...) for the SSE retry
hint and resync control-event writes.
- cmd/maglevc/commands.go: bulk-prefix every fmt.Fprintf(w, ...) with
_, _ =; also merged 'var watchEventsOptSlot *Node; ... = &Node{...}'
into a single := declaration (staticcheck S1021) — the self-
referencing pattern still works because the Children back-ref is
assigned on the next statement, not inside the struct literal.
- cmd/maglevc/complete.go: _, _ = fmt.Fprintf(ql.rl.Stderr(), ...)
for the banner and help writes; removed the ineffectual
'partial = ""' assignment (nothing downstream reads partial after
that branch, so setting it was dead code flagged by ineffassign).
- cmd/maglevc/shell.go: defer func() { _ = rl.Close() }() for the
readline instance; _, _ = fmt.Fprintf(rl.Stderr(), ...) for error
display in the REPL loop.
- cmd/maglevc/main.go: defer func() { _ = conn.Close() }() for the
gRPC client connection.
- internal/grpcapi/server_test.go: _ = conn.Close() in the test
teardown closure.
- internal/prober/http.go: _ = c.Close() in the TLS-handshake-failed
path; defer func() { _ = conn.Close() }() and defer func() { _ =
resp.Body.Close() }() for the two deferred cleanups.
- internal/prober/http_test.go: defer func() { _ = resp.Body.Close()
}() plus three _, _ = fmt.Fprint(w, ...) in the httptest.Server
handlers and _, _ = fmt.Sscanf(...) when parsing the test listener's
port.
- internal/prober/icmp.go: defer func() { _ = pc.Close() }() for the
ICMP packet conn.
- internal/prober/netns.go: defer func() { _ = origNs.Close() }(),
defer func() { _ = netns.Set(origNs) }(), defer func() { _ =
targetNs.Close() }() — also dropped a stray //nolint:errcheck that
was no longer needed once the closure wrapping handled the discard.
- internal/prober/tcp.go: _ = conn.Close() in the L4-only path,
_ = tlsConn.Close() in the failed and succeeded handshake branches,
_ = tlsConn.SetDeadline(...) (also dropped a //nolint:errcheck
previously covering it).
Iterative 'make lint' runs were needed because golangci-lint v2.x
caps same-linter reports per pass, so the first pass reported 21,
then 4, then 3, then 1, then 0. Final pass: 0 issues. make test is
green across every package, and make build produces all three
binaries cleanly.
184 lines
6.0 KiB
Go
184 lines
6.0 KiB
Go
// Copyright (c) 2026, Pim van Pelt <pim@ipng.ch>
|
|
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/chzyer/readline"
|
|
|
|
"git.ipng.ch/ipng/vpp-maglev/internal/grpcapi"
|
|
)
|
|
|
|
const completeTimeout = 1 * time.Second
|
|
|
|
// Completer implements readline.AutoCompleter for the command tree.
|
|
type Completer struct {
|
|
root *Node
|
|
client grpcapi.MaglevClient
|
|
}
|
|
|
|
// Do implements readline.AutoCompleter.
|
|
// line is the full current line; pos is the cursor position.
|
|
// Returns (newLine [][]rune, length int) where length is how many rune bytes
|
|
// before pos should be replaced by each candidate in newLine.
|
|
func (co *Completer) Do(line []rune, pos int) (newLine [][]rune, length int) {
|
|
before := string(line[:pos])
|
|
tokens := splitTokens(before)
|
|
|
|
// Determine the partial token being completed.
|
|
var partial string
|
|
var prefix []string
|
|
if len(tokens) == 0 || (len(before) > 0 && before[len(before)-1] == ' ') {
|
|
// Cursor is after a space — completing a new token.
|
|
prefix = tokens
|
|
partial = ""
|
|
} else {
|
|
// Cursor is within the last token.
|
|
prefix = tokens[:len(tokens)-1]
|
|
partial = tokens[len(tokens)-1]
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), completeTimeout)
|
|
defer cancel()
|
|
|
|
candidates := Candidates(co.root, prefix, partial, ctx, co.client)
|
|
|
|
var suffixes [][]rune
|
|
for _, c := range candidates {
|
|
suffix := c.Word[len(partial):]
|
|
suffixes = append(suffixes, []rune(suffix+" "))
|
|
}
|
|
return suffixes, len([]rune(partial))
|
|
}
|
|
|
|
// questionListener intercepts the '?' key and prints inline help.
|
|
type questionListener struct {
|
|
root *Node
|
|
client grpcapi.MaglevClient
|
|
rl *readline.Instance
|
|
}
|
|
|
|
func (ql *questionListener) OnChange(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool) {
|
|
if key != '?' {
|
|
return line, pos, false
|
|
}
|
|
|
|
// Strip the '?' that was just appended to line[:pos].
|
|
before := string(line[:pos])
|
|
if len(before) > 0 && before[len(before)-1] == '?' {
|
|
before = before[:len(before)-1]
|
|
}
|
|
tokens := splitTokens(before)
|
|
|
|
// Split into confirmed prefix tokens and the partial token being typed.
|
|
var prefix []string
|
|
var partial string
|
|
if len(before) == 0 || before[len(before)-1] == ' ' {
|
|
prefix = tokens
|
|
partial = ""
|
|
} else if len(tokens) > 0 {
|
|
prefix = tokens[:len(tokens)-1]
|
|
partial = tokens[len(tokens)-1]
|
|
}
|
|
|
|
// Walk the confirmed prefix to the current node, then try to advance one
|
|
// more step using the partial token (via prefix-match or slot fallback).
|
|
// This mirrors birdc: "sh?" expands "sh" to "show" and shows show's subtree.
|
|
node, _, remaining := Walk(ql.root, prefix)
|
|
displayPrefix := strings.Join(prefix, " ")
|
|
var unknownMsg string
|
|
if len(remaining) > 0 {
|
|
// One of the confirmed prefix tokens was unknown. Show an
|
|
// "unknown" banner, then list what's available at the deepest
|
|
// node we *did* reach so the operator can see what they could
|
|
// have typed instead. The partial at the cursor is irrelevant
|
|
// once the left context is already broken — no downstream
|
|
// branch reads it after we enter this branch, so we don't
|
|
// bother clearing it.
|
|
consumed := prefix[:len(prefix)-len(remaining)]
|
|
bad := remaining[0]
|
|
if len(consumed) == 0 {
|
|
unknownMsg = fmt.Sprintf("unknown command: %s", bad)
|
|
} else {
|
|
unknownMsg = fmt.Sprintf("unknown subcommand %q after %q", bad, strings.Join(consumed, " "))
|
|
}
|
|
displayPrefix = strings.Join(consumed, " ")
|
|
} else if partial != "" {
|
|
if next := matchFixedChild(node.Children, partial); next != nil {
|
|
// Partial uniquely matched a fixed child — descend into it.
|
|
node = next
|
|
displayPrefix = strings.Join(tokens, " ")
|
|
} else if slot := findSlotChild(node.Children); slot != nil {
|
|
// Partial is filling a slot node.
|
|
node = slot
|
|
displayPrefix = strings.Join(tokens, " ")
|
|
}
|
|
// If partial matched nothing (ambiguous or dead end), stay at the
|
|
// current node and show its subcommands with the confirmed prefix.
|
|
}
|
|
|
|
// Expand all leaf paths reachable from the current node.
|
|
lines := expandPaths(node, displayPrefix, make(map[*Node]bool))
|
|
|
|
// If the cursor is at a position where the next input is a dynamic slot,
|
|
// fetch live values now and show them below the syntax lines.
|
|
ctx, cancel := context.WithTimeout(context.Background(), completeTimeout)
|
|
defer cancel()
|
|
var dynValues []string
|
|
var dynWord string
|
|
if slot := findSlotChild(node.Children); slot != nil && slot.Dynamic != nil {
|
|
dynValues = slot.Dynamic(ctx, ql.client)
|
|
dynWord = slot.Word
|
|
}
|
|
|
|
// Right-align the help column at the width of the longest path + 2.
|
|
maxLen := 0
|
|
for _, l := range lines {
|
|
if len(l.path) > maxLen {
|
|
maxLen = len(l.path)
|
|
}
|
|
}
|
|
|
|
// Emit output. Raw terminal mode requires \r\n.
|
|
//
|
|
// readline's wrapWriter wraps every Write in a clean-write-print
|
|
// cycle: it erases the current input line, runs our closure, and
|
|
// redraws the prompt+buffer afterwards. That means starting the
|
|
// output with a bare "\r\n" leaves the original row blank, so the
|
|
// operator loses sight of what they typed. Instead we echo the
|
|
// full "maglev> show vpp lb ?" ourselves as the first write —
|
|
// that lands on the just-cleaned row, birdc-style, and the
|
|
// subsequent Fprintfs each redraw a fresh prompt below the help.
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), "%s%s\r\n", ql.rl.Config.Prompt, string(line))
|
|
if unknownMsg != "" {
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), " %s\r\n", unknownMsg)
|
|
}
|
|
if len(lines) == 0 {
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), " <no completions>\r\n")
|
|
} else {
|
|
for _, l := range lines {
|
|
if l.help != "" {
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), "%-*s %s\r\n", maxLen+2, l.path, l.help)
|
|
} else {
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), "%s\r\n", l.path)
|
|
}
|
|
}
|
|
if len(dynValues) > 0 {
|
|
_, _ = fmt.Fprintf(ql.rl.Stderr(), " %s: %s\r\n", dynWord, strings.Join(dynValues, " "))
|
|
}
|
|
}
|
|
|
|
// Remove the '?' from the line and step cursor back one position.
|
|
newLine = append(append([]rune{}, line[:pos-1]...), line[pos:]...)
|
|
return newLine, pos - 1, true
|
|
}
|
|
|
|
// splitTokens splits a string into whitespace-separated tokens.
|
|
func splitTokens(s string) []string {
|
|
return strings.Fields(s)
|
|
}
|