Archived
Give the unheld log test its own writer and memory, so it passes on a repeat (issue 486) #246
+25
-10
@@ -7,6 +7,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"slices"
|
"slices"
|
||||||
"sort"
|
"sort"
|
||||||
@@ -1691,17 +1692,27 @@ func providerModuleOf(resolved catalogue.Resolution, open *stores, ctx context.C
|
|||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// unheldLogged is what was last logged about each node's unmet seat dependencies, so the log says
|
// unheldLogger remembers what was last logged about each node's unmet seat dependencies, so the
|
||||||
// each change once (novox/hq ADR 0207), on stderr so `status --json` stays a document.
|
// log says each change once (novox/hq ADR 0207), on stderr so `status --json` stays a document.
|
||||||
|
// A test gives its own writer and memory, and no longer shares the process's (novox/hq issue 486).
|
||||||
//
|
//
|
||||||
// **The serving controller's log only.** planFor runs for every node on every push, assignment and
|
// **The serving controller's log only.** planFor runs for every node on every push, assignment and
|
||||||
// status — `blockedElsewhere` alone resolves the whole mesh — and a one-shot command starts with an
|
// status — `blockedElsewhere` alone resolves the whole mesh — and a one-shot command starts with an
|
||||||
// empty memory, so every node's report was "a change" and a push printed the whole mesh's list,
|
// empty memory, so every node's report was "a change" and a push printed the whole mesh's list,
|
||||||
// burying the line about the node it acted on. A command says what concerns its own act instead
|
// burying the line about the node it acted on. A command says what concerns its own act instead
|
||||||
// (unheldChange, reportUnheldPushed); the full list is `status`'s.
|
// (unheldChange, reportUnheldPushed); the full list is `status`'s.
|
||||||
|
type unheldLogger struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
logged map[string]string
|
||||||
|
out io.Writer
|
||||||
|
}
|
||||||
|
|
||||||
|
func newUnheldLogger(out io.Writer) *unheldLogger {
|
||||||
|
return &unheldLogger{logged: map[string]string{}, out: out}
|
||||||
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
unheldLogged = map[string]string{}
|
unheldLog = newUnheldLogger(os.Stderr)
|
||||||
unheldLoggedMu sync.Mutex
|
|
||||||
logUnheldChanges bool
|
logUnheldChanges bool
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -1711,23 +1722,27 @@ func logUnheld(node string, unheld []catalogue.Unheld) {
|
|||||||
if !logUnheldChanges {
|
if !logUnheldChanges {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
unheldLog.log(node, unheld)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *unheldLogger) log(node string, unheld []catalogue.Unheld) {
|
||||||
lines := make([]string, 0, len(unheld))
|
lines := make([]string, 0, len(unheld))
|
||||||
for _, u := range unheld {
|
for _, u := range unheld {
|
||||||
lines = append(lines, u.String())
|
lines = append(lines, u.String())
|
||||||
}
|
}
|
||||||
now := strings.Join(lines, "\n")
|
now := strings.Join(lines, "\n")
|
||||||
unheldLoggedMu.Lock()
|
l.mu.Lock()
|
||||||
before, seen := unheldLogged[node]
|
defer l.mu.Unlock()
|
||||||
unheldLogged[node] = now
|
before, seen := l.logged[node]
|
||||||
unheldLoggedMu.Unlock()
|
l.logged[node] = now
|
||||||
if (seen && before == now) || (!seen && now == "") {
|
if (seen && before == now) || (!seen && now == "") {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if now == "" {
|
if now == "" {
|
||||||
fmt.Fprintf(os.Stderr, "%s: every seat its modules depend on is held (novox/hq ADR 0207)\n", node)
|
fmt.Fprintf(l.out, "%s: every seat its modules depend on is held (novox/hq ADR 0207)\n", node)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
fmt.Fprintf(os.Stderr, "%s: %d unmet seat dependenc(ies), reported and not refused (novox/hq ADR 0207):\n %s\n",
|
fmt.Fprintf(l.out, "%s: %d unmet seat dependenc(ies), reported and not refused (novox/hq ADR 0207):\n %s\n",
|
||||||
node, len(lines), strings.Join(lines, "\n "))
|
node, len(lines), strings.Join(lines, "\n "))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"os"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -81,28 +80,30 @@ func TestAPushSaysANamedNodesDependenciesAndCountsTheRest(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The test gives logUnheld its own writer and memory, so a repeat in one process and the
|
||||||
|
// package's other tests see neither the last run's memory nor a swapped os.Stderr (novox/hq issue 486).
|
||||||
func TestOnlyTheServingControllerLogsEachChange(t *testing.T) {
|
func TestOnlyTheServingControllerLogsEachChange(t *testing.T) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
saved, savedOn := unheldLog, logUnheldChanges
|
||||||
|
unheldLog, logUnheldChanges = newUnheldLogger(&out), false
|
||||||
|
t.Cleanup(func() { unheldLog, logUnheldChanges = saved, savedOn })
|
||||||
read := func(f func()) string {
|
read := func(f func()) string {
|
||||||
old := os.Stderr
|
out.Reset()
|
||||||
r, w, _ := os.Pipe()
|
|
||||||
os.Stderr = w
|
|
||||||
f()
|
f()
|
||||||
_ = w.Close()
|
return out.String()
|
||||||
os.Stderr = old
|
|
||||||
var b bytes.Buffer
|
|
||||||
_, _ = b.ReadFrom(r)
|
|
||||||
return b.String()
|
|
||||||
}
|
}
|
||||||
u := []catalogue.Unheld{{Node: "n1", Module: "web", Seat: catalogue.ContainerRuntimeSeat}}
|
u := []catalogue.Unheld{{Node: "n1", Module: "web", Seat: catalogue.ContainerRuntimeSeat}}
|
||||||
if got := read(func() { logUnheld("n1", u) }); got != "" {
|
if got := read(func() { logUnheld("n1", u) }); got != "" {
|
||||||
t.Errorf("a command logged:\n%s", got)
|
t.Errorf("a command logged:\n%s", got)
|
||||||
}
|
}
|
||||||
logUnheldChanges = true
|
logUnheldChanges = true
|
||||||
defer func() { logUnheldChanges = false }()
|
|
||||||
if got := read(func() { logUnheld("n1", u) }); !strings.Contains(got, "web on n1") {
|
if got := read(func() { logUnheld("n1", u) }); !strings.Contains(got, "web on n1") {
|
||||||
t.Errorf("the serving controller did not log a change:\n%s", got)
|
t.Errorf("the serving controller did not log a change:\n%s", got)
|
||||||
}
|
}
|
||||||
if got := read(func() { logUnheld("n1", u) }); got != "" {
|
if got := read(func() { logUnheld("n1", u) }); got != "" {
|
||||||
t.Errorf("an unchanged report was logged again:\n%s", got)
|
t.Errorf("an unchanged report was logged again:\n%s", got)
|
||||||
}
|
}
|
||||||
|
if got := read(func() { logUnheld("n1", nil) }); !strings.Contains(got, "every seat its modules depend on is held") {
|
||||||
|
t.Errorf("a report that became none was not logged:\n%s", got)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user