- Replaced flat `backends: [...]` list on frontends with an ordered `pools:`
list; each pool has a name and a map of backends with per-pool weights (0–100,
default 100). Pools express priority: first pool with a healthy backend wins.
- Removed global backend weight (was on the backend, now lives in the pool).
- Config validation enforces non-empty pools, non-empty pool names, weight
range, and consistent address families across all pools of a frontend.
- Added `PoolBackendInfo { name, weight }` and changed `PoolInfo.backends` from
`repeated string` to `repeated PoolBackendInfo` so weights are visible over
the API.
- Full interactive shell with readline, tab completion, and `?` inline help.
- Command tree parser (Walk) handles fixed keywords and dynamic slot nodes;
prefix matching with exact-match priority.
- Commands: `show version/frontends/frontend/backends/backend/healthchecks/
healthcheck`, `set backend <name> pause|resume`, `quit`/`exit`.
- `show frontend` output is hierarchical (pools → backends) with per-backend
weights and `[disabled]` notation; pool section uses fixed-width formatting
so ANSI color codes don't corrupt tabwriter alignment.
- `-color` flag (default true) wraps static field labels in dark-blue ANSI;
works correctly with tabwriter because all labels carry identical-length
escape sequences.
- `cmd/version.go` package holds `version`, `commit`, `date` vars set at build
time via `-ldflags -X`.
- `make build` / `make build-amd64` / `make build-arm64` all inject
`VERSION=0.1.1`, `COMMIT_HASH` (from `git rev-parse --short HEAD`), and
`DATE` (UTC ISO-8601).
- `maglevc` prints version on interactive startup and exposes `show version`.
- `maglevd` logs version/commit/date at startup; `-version` flag prints and exits.
- `doHTTPProbe` was building a `https://` target URL even though TLS was already
applied to the connection inside `inNetns`. `http.Transport` then wrapped the
connection in a second TLS layer, producing "http: server gave HTTP response
to HTTPS client". Fixed by always using `http://` in the target URL.
- Added `TestHTTPSProbe` using `httptest.NewTLSServer` to cover the full path.
- New `docs/user-guide.md`: maglevd flags/signals, maglevc commands, shell
completion, and command-tree parser walkthrough.
- New `docs/healthchecks.md`: state machine, rise/fall model, probe intervals,
all transition events with log examples.
- Updated `docs/config-guide.md`: pools design, removed global weight from
backends, updated all examples.
- Updated `README.md`: packaging table, build paths, corrected binary locations
(`/usr/sbin/maglevd`), config filename (`.yaml`).
- `debian/` directory contains `control.in`, `maglevd.service`, `default.maglev`,
`maglev.yaml` (example config), `conffiles`, `postinst`, `prerm`.
- `debian/build-deb.sh` stages a package tree and calls `dpkg-deb`; emits
`build/vpp-maglev_<version>~<commit>_<arch>.deb`.
- Cross-compiles for amd64 and arm64 in one `make pkg-deb` invocation.
- `maglevd` installed to `/usr/sbin/`, `maglevc` to `/usr/bin/`.
- Service reads `MAGLEV_CONFIG` from `/etc/default/maglev`
(default: `/etc/maglev/maglev.yaml`).
- Man pages `maglevd(8)` and `maglevc(1)` live in `docs/` and are gzip'd into
the package.
- All build output goes to `build/<arch>/`; `build/` is gitignored.
569 lines
12 KiB
Go
569 lines
12 KiB
Go
// Copyright (c) 2026, Pim van Pelt <pim@ipng.ch>
|
|
|
|
package config
|
|
|
|
import (
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
const validConfig = `
|
|
maglev:
|
|
healthchecker:
|
|
transition-history: 5
|
|
netns: dataplane
|
|
healthchecks:
|
|
http-check:
|
|
type: http
|
|
port: 80
|
|
probe-ipv4-src: 10.0.0.1
|
|
params:
|
|
path: /healthz
|
|
host: example.com
|
|
response-code: "200"
|
|
interval: 2s
|
|
timeout: 3s
|
|
rise: 2
|
|
fall: 3
|
|
icmp-check:
|
|
type: icmp
|
|
probe-ipv6-src: 2001:db8:1::1
|
|
interval: 1s
|
|
timeout: 3s
|
|
fall: 5
|
|
backends:
|
|
be-v4:
|
|
address: 192.0.2.10
|
|
healthcheck: http-check
|
|
be-v6a:
|
|
address: 2001:db8:2::1
|
|
healthcheck: icmp-check
|
|
be-v6b:
|
|
address: 2001:db8:2::2
|
|
healthcheck: icmp-check
|
|
enabled: true
|
|
frontends:
|
|
web4:
|
|
description: "IPv4 VIP"
|
|
address: 192.0.2.1
|
|
protocol: tcp
|
|
port: 80
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be-v4: {}
|
|
web6:
|
|
description: "IPv6 VIP"
|
|
address: 2001:db8::1
|
|
protocol: tcp
|
|
port: 443
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be-v6a:
|
|
weight: 100
|
|
be-v6b:
|
|
weight: 50
|
|
`
|
|
|
|
func TestValidConfig(t *testing.T) {
|
|
cfg, err := parse([]byte(validConfig))
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if cfg.HealthChecker.Netns != "dataplane" {
|
|
t.Errorf("healthchecker.netns: got %q, want dataplane", cfg.HealthChecker.Netns)
|
|
}
|
|
if cfg.HealthChecker.TransitionHistory != 5 {
|
|
t.Errorf("transition-history: got %d, want 5", cfg.HealthChecker.TransitionHistory)
|
|
}
|
|
if len(cfg.Frontends) != 2 {
|
|
t.Fatalf("frontends: got %d, want 2", len(cfg.Frontends))
|
|
}
|
|
|
|
hc := cfg.HealthChecks["http-check"]
|
|
if hc.Type != "http" {
|
|
t.Errorf("http-check type: got %q, want http", hc.Type)
|
|
}
|
|
if hc.Fall != 3 || hc.Rise != 2 {
|
|
t.Errorf("http-check fall/rise: got %d/%d, want 3/2", hc.Fall, hc.Rise)
|
|
}
|
|
if hc.ProbeIPv4Src.String() != "10.0.0.1" {
|
|
t.Errorf("http-check probe-ipv4-src: got %s, want 10.0.0.1", hc.ProbeIPv4Src)
|
|
}
|
|
if hc.HTTP == nil {
|
|
t.Fatal("http-check HTTP params should not be nil")
|
|
}
|
|
if hc.HTTP.Path != "/healthz" {
|
|
t.Errorf("http-check path: got %q, want /healthz", hc.HTTP.Path)
|
|
}
|
|
if hc.HTTP.Host != "example.com" {
|
|
t.Errorf("http-check host: got %q, want example.com", hc.HTTP.Host)
|
|
}
|
|
if hc.HTTP.ResponseCodeMin != 200 || hc.HTTP.ResponseCodeMax != 200 {
|
|
t.Errorf("http-check response-code: got %d-%d, want 200-200",
|
|
hc.HTTP.ResponseCodeMin, hc.HTTP.ResponseCodeMax)
|
|
}
|
|
|
|
icmp := cfg.HealthChecks["icmp-check"]
|
|
if icmp.Fall != 5 {
|
|
t.Errorf("icmp-check fall: got %d, want 5", icmp.Fall)
|
|
}
|
|
if icmp.ProbeIPv6Src.String() != "2001:db8:1::1" {
|
|
t.Errorf("icmp-check probe-ipv6-src: got %s, want 2001:db8:1::1", icmp.ProbeIPv6Src)
|
|
}
|
|
|
|
// Backend fields.
|
|
beV4 := cfg.Backends["be-v4"]
|
|
if beV4.Address.String() != "192.0.2.10" {
|
|
t.Errorf("be-v4 address: got %s", beV4.Address)
|
|
}
|
|
if beV4.HealthCheck != "http-check" {
|
|
t.Errorf("be-v4 healthcheck: got %q", beV4.HealthCheck)
|
|
}
|
|
if !beV4.Enabled {
|
|
t.Error("be-v4 enabled: want true (default)")
|
|
}
|
|
|
|
// Pool structure.
|
|
web4 := cfg.Frontends["web4"]
|
|
if len(web4.Pools) != 1 || web4.Pools[0].Name != "primary" {
|
|
t.Errorf("web4 pools: got %v", web4.Pools)
|
|
}
|
|
if _, ok := web4.Pools[0].Backends["be-v4"]; !ok {
|
|
t.Error("web4 primary pool missing be-v4")
|
|
}
|
|
if web4.Pools[0].Backends["be-v4"].Weight != 100 {
|
|
t.Errorf("web4 be-v4 weight: got %d, want 100 (default)", web4.Pools[0].Backends["be-v4"].Weight)
|
|
}
|
|
|
|
web6 := cfg.Frontends["web6"]
|
|
if len(web6.Pools) != 1 || len(web6.Pools[0].Backends) != 2 {
|
|
t.Errorf("web6 pools[0] backends: got %d, want 2", len(web6.Pools[0].Backends))
|
|
}
|
|
if web6.Pools[0].Backends["be-v6b"].Weight != 50 {
|
|
t.Errorf("web6 be-v6b weight: got %d, want 50", web6.Pools[0].Backends["be-v6b"].Weight)
|
|
}
|
|
}
|
|
|
|
func TestDefaults(t *testing.T) {
|
|
raw := `
|
|
maglev:
|
|
healthchecks:
|
|
icmp:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be:
|
|
address: 10.0.0.2
|
|
healthcheck: icmp
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`
|
|
cfg, err := parse([]byte(raw))
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if cfg.HealthChecker.Netns != "" {
|
|
t.Errorf("default netns: got %q, want empty", cfg.HealthChecker.Netns)
|
|
}
|
|
if cfg.HealthChecker.TransitionHistory != 5 {
|
|
t.Errorf("default transition-history: got %d, want 5", cfg.HealthChecker.TransitionHistory)
|
|
}
|
|
hc := cfg.HealthChecks["icmp"]
|
|
if hc.Rise != 2 || hc.Fall != 3 {
|
|
t.Errorf("defaults rise/fall: got %d/%d, want 2/3", hc.Rise, hc.Fall)
|
|
}
|
|
be := cfg.Backends["be"]
|
|
if !be.Enabled {
|
|
t.Errorf("backend default enabled: got false, want true")
|
|
}
|
|
// Pool backend weight defaults to 100.
|
|
v := cfg.Frontends["v"]
|
|
if v.Pools[0].Backends["be"].Weight != 100 {
|
|
t.Errorf("pool backend default weight: got %d, want 100", v.Pools[0].Backends["be"].Weight)
|
|
}
|
|
}
|
|
|
|
func TestBackendNoHealthcheck(t *testing.T) {
|
|
// A backend with no healthcheck reference is valid; probe is skipped.
|
|
raw := `
|
|
maglev:
|
|
healthchecks: {}
|
|
backends:
|
|
be:
|
|
address: 10.0.0.2
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`
|
|
cfg, err := parse([]byte(raw))
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if cfg.Backends["be"].HealthCheck != "" {
|
|
t.Error("expected empty healthcheck")
|
|
}
|
|
}
|
|
|
|
func TestOptionalIntervals(t *testing.T) {
|
|
raw := `
|
|
maglev:
|
|
healthchecks:
|
|
icmp:
|
|
type: icmp
|
|
interval: 2s
|
|
fast-interval: 500ms
|
|
down-interval: 30s
|
|
timeout: 1s
|
|
backends:
|
|
be:
|
|
address: 10.0.0.2
|
|
healthcheck: icmp
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`
|
|
cfg, err := parse([]byte(raw))
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
hc := cfg.HealthChecks["icmp"]
|
|
if hc.Interval != 2*time.Second {
|
|
t.Errorf("interval: got %v, want 2s", hc.Interval)
|
|
}
|
|
if hc.FastInterval != 500*time.Millisecond {
|
|
t.Errorf("fast-interval: got %v, want 500ms", hc.FastInterval)
|
|
}
|
|
if hc.DownInterval != 30*time.Second {
|
|
t.Errorf("down-interval: got %v, want 30s", hc.DownInterval)
|
|
}
|
|
}
|
|
|
|
func TestValidationErrors(t *testing.T) {
|
|
base := func(hcExtra, beExtra, feExtra string) string {
|
|
return `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
` + hcExtra + `
|
|
backends:
|
|
be:
|
|
address: 10.0.0.2
|
|
healthcheck: c
|
|
` + beExtra + `
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
` + feExtra
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
yaml string
|
|
errSub string
|
|
}{
|
|
{
|
|
name: "wrong family probe-ipv4-src",
|
|
yaml: base(" probe-ipv4-src: 2001:db8::1\n", "", ""),
|
|
errSub: "probe-ipv4-src",
|
|
},
|
|
{
|
|
name: "mixed backend address families in pool",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
v4: {address: 10.0.0.2, healthcheck: c}
|
|
v6: {address: 2001:db8::1, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
v4: {}
|
|
v6: {}
|
|
`,
|
|
errSub: "address family",
|
|
},
|
|
{
|
|
name: "port without protocol",
|
|
yaml: base("", "", " port: 80\n"),
|
|
errSub: "port requires protocol",
|
|
},
|
|
{
|
|
name: "protocol without port",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
protocol: tcp
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "requires port",
|
|
},
|
|
{
|
|
name: "invalid healthcheck type",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: dns
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "type must be",
|
|
},
|
|
{
|
|
name: "http missing path",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: http
|
|
port: 80
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "params.path",
|
|
},
|
|
{
|
|
name: "no error case",
|
|
yaml: base("", "", ""),
|
|
errSub: "",
|
|
},
|
|
{
|
|
name: "undefined healthcheck reference",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks: {}
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: missing}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "not defined",
|
|
},
|
|
{
|
|
name: "undefined backend reference in pool",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends: {}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
missing: {}
|
|
`,
|
|
errSub: "not defined",
|
|
},
|
|
{
|
|
name: "pool weight out of range",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be:
|
|
weight: 150
|
|
`,
|
|
errSub: "out of range",
|
|
},
|
|
{
|
|
name: "fall zero becomes default",
|
|
yaml: base(" fall: 0\n", "", ""),
|
|
errSub: "",
|
|
},
|
|
{
|
|
name: "tcp missing port",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: tcp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "requires port",
|
|
},
|
|
{
|
|
name: "http missing port",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: http
|
|
interval: 1s
|
|
timeout: 2s
|
|
params:
|
|
path: /
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- name: primary
|
|
backends:
|
|
be: {}
|
|
`,
|
|
errSub: "requires port",
|
|
},
|
|
{
|
|
name: "empty pools",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools: []
|
|
`,
|
|
errSub: "pools must not be empty",
|
|
},
|
|
{
|
|
name: "pool missing name",
|
|
yaml: `
|
|
maglev:
|
|
healthchecks:
|
|
c:
|
|
type: icmp
|
|
interval: 1s
|
|
timeout: 2s
|
|
backends:
|
|
be: {address: 10.0.0.2, healthcheck: c}
|
|
frontends:
|
|
v:
|
|
address: 192.0.2.1
|
|
pools:
|
|
- backends:
|
|
be: {}
|
|
`,
|
|
errSub: "name must not be empty",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
_, err := parse([]byte(tt.yaml))
|
|
if tt.errSub == "" {
|
|
if err != nil {
|
|
t.Fatalf("expected no error, got: %v", err)
|
|
}
|
|
return
|
|
}
|
|
if err == nil {
|
|
t.Fatalf("expected error containing %q, got nil", tt.errSub)
|
|
}
|
|
if !contains(err.Error(), tt.errSub) {
|
|
t.Errorf("error %q does not contain %q", err.Error(), tt.errSub)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func contains(s, sub string) bool {
|
|
return len(s) >= len(sub) && (s == sub || len(sub) == 0 ||
|
|
func() bool {
|
|
for i := 0; i <= len(s)-len(sub); i++ {
|
|
if s[i:i+len(sub)] == sub {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}())
|
|
}
|