Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
48275d598e |
@@ -10,7 +10,11 @@
|
|||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags.
|
pre-1.0. No git tags. Core resolver work in flight on feature/resolver
|
||||||
|
(dirty: internal/resolver/resolver_test.go). Local checkout has diverged
|
||||||
|
from origin: origin/main is 8 commits ahead (watcher orchestrator,
|
||||||
|
unified TARGETS) and origin/feature/resolver already contains the full
|
||||||
|
iterative resolver implementation with hermetic mocked tests.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -19,13 +23,13 @@ Rationale, Design, TODO, License, Author) if any are still missing.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-09-29: nothing stands in for DNS any more. Watcher tests that look
|
- 2026-09-29: nothing stands in for DNS any more. The watcher tests use the
|
||||||
something up in DNS use the real resolver against live DNS servers and test
|
real resolver against live DNS and test changes by preparing the saved
|
||||||
record and nameserver changes by preparing the saved state a check starts
|
state a check starts from; the resolver timeout test queries an address
|
||||||
from; the resolver timeout test queries an address that never answers, and
|
that never answers, and `NewFromLoggerWithClient`, used only by its
|
||||||
`NewFromLoggerWithClient`, used only by its stand-in client, is gone. The
|
stand-in client, is gone. The live-DNS retry and concurrency limit moved
|
||||||
live-DNS retry and concurrency limit moved to `internal/livedns`, which both
|
to `internal/livedns`, which both test packages use. `TESTING.md` states
|
||||||
test packages use. `TESTING.md` states the README's rule (closes #159).
|
the README's rule (closes #159).
|
||||||
- 2026-09-28: the inconsistency alert is sent once, on the check where two
|
- 2026-09-28: the inconsistency alert is sent once, on the check where two
|
||||||
nameservers start to disagree or where a nameserver that disagrees first
|
nameservers start to disagree or where a nameserver that disagrees first
|
||||||
appears, instead of on every check while they disagree, and not again after
|
appears, instead of on every check while they disagree, and not again after
|
||||||
@@ -264,5 +268,4 @@ Infrastructure notes (from untracked TODO.md):
|
|||||||
- Module path sneak.berlin/go/dnswatcher differs from the git.eeqj.de
|
- Module path sneak.berlin/go/dnswatcher differs from the git.eeqj.de
|
||||||
remote intentionally; do not "fix" it
|
remote intentionally; do not "fix" it
|
||||||
- Dependencies: github.com/miekg/dns, golang.org/x/net/publicsuffix
|
- Dependencies: github.com/miekg/dns, golang.org/x/net/publicsuffix
|
||||||
- DNS is never mocked; tests that look something up in DNS query live DNS
|
- Tests use live DNS and never mock it (README, "No DNS mocking. Ever.")
|
||||||
servers (README, "No DNS mocking. Ever.")
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
// Package livedns runs the live DNS operations of tests. Tests that
|
// Package livedns runs the live DNS operations of tests. Every test in
|
||||||
// look something up in DNS query live DNS servers, never a stand-in —
|
// this project that needs DNS resolves against the real, live DNS —
|
||||||
// see TESTING.md. Nothing here mocks, fakes, stubs, records or replays
|
// see TESTING.md. Nothing here mocks, fakes, stubs, records or replays
|
||||||
// DNS, and nothing here skips a test: it only changes *how* the live
|
// DNS, and nothing here skips a test: it only changes *how* the live
|
||||||
// queries are issued, so that a single dropped UDP packet or one slow
|
// queries are issued, so that a single dropped UDP packet or one slow
|
||||||
|
|||||||
@@ -17,12 +17,11 @@ import (
|
|||||||
// Live DNS test support
|
// Live DNS test support
|
||||||
// ----------------------------------------------------------------
|
// ----------------------------------------------------------------
|
||||||
//
|
//
|
||||||
// Tests that look something up in DNS query live DNS servers, never a
|
// Every test in this package resolves against the real, live DNS —
|
||||||
// stand-in; logic that works on record data may be tested on that
|
// see TESTING.md. Each live operation below goes through
|
||||||
// data with no lookup (see TESTING.md). Each live operation below goes
|
// livedns.Retry, which bounds how many resolutions are in flight at
|
||||||
// through livedns.Retry, which bounds how many resolutions are in
|
// once and retries an operation that got no answer (see package
|
||||||
// flight at once and retries an operation that got no answer (see
|
// livedns).
|
||||||
// package livedns).
|
|
||||||
//
|
//
|
||||||
// Where an assertion spans several independent nameservers, a quorum
|
// Where an assertion spans several independent nameservers, a quorum
|
||||||
// is enough: a strict majority answering as expected. A server that
|
// is enough: a strict majority answering as expected. A server that
|
||||||
|
|||||||
@@ -32,8 +32,8 @@ func newTestResolver(t *testing.T) *resolver.Resolver {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// findOneNSForDomain picks one authoritative nameserver to aim a
|
// findOneNSForDomain picks one authoritative nameserver to aim a
|
||||||
// test at. Quorum handling lives in livedns_test.go, and the live-DNS
|
// test at. Live-DNS retry, concurrency and quorum handling live in
|
||||||
// retry and concurrency limit in package livedns.
|
// livedns_test.go.
|
||||||
func findOneNSForDomain(
|
func findOneNSForDomain(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
r *resolver.Resolver,
|
r *resolver.Resolver,
|
||||||
|
|||||||
@@ -19,10 +19,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// The watcher looks these names up in live DNS with the real resolver,
|
// The watcher looks these names up in live DNS with the real resolver,
|
||||||
// so tests assert on what the watcher does with the answers, never on
|
// so tests assert on notifications and saved state, never on the
|
||||||
// the records these zones publish. testHost's nameservers and addresses
|
// records these zones publish. testHost's addresses stay the same from
|
||||||
// stay the same from one check to the next, which the tests that check
|
// one check to the next, which the tests that check it twice rely on.
|
||||||
// it twice rely on.
|
|
||||||
const (
|
const (
|
||||||
testDomain = "google.com"
|
testDomain = "google.com"
|
||||||
testHost = "cloudflare.com"
|
testHost = "cloudflare.com"
|
||||||
@@ -39,8 +38,7 @@ const (
|
|||||||
|
|
||||||
// --- Stand-ins for the port checker, TLS checker and notifier ---
|
// --- Stand-ins for the port checker, TLS checker and notifier ---
|
||||||
//
|
//
|
||||||
// DNS has none: the watchers built here use the real resolver (see
|
// DNS has none: the watcher uses the real resolver (see TESTING.md).
|
||||||
// TESTING.md).
|
|
||||||
|
|
||||||
// mockPortChecker reports every port open until closed is set.
|
// mockPortChecker reports every port open until closed is set.
|
||||||
type mockPortChecker struct {
|
type mockPortChecker struct {
|
||||||
@@ -175,8 +173,9 @@ func defaultTestConfig(t *testing.T) *config.Config {
|
|||||||
|
|
||||||
// checkOnce runs the watcher's checks once and returns an error when a
|
// checkOnce runs the watcher's checks once and returns an error when a
|
||||||
// configured name has no hostname state saved by this check, or that
|
// configured name has no hostname state saved by this check, or that
|
||||||
// state holds no address. Either live DNS gave no answer for the name,
|
// state holds no address. The watcher saves a name's hostname state
|
||||||
// or the watcher saved no fresh result for it.
|
// only when all of the name's lookups succeed, so this means either
|
||||||
|
// live DNS did not answer or the watcher did not save what it got.
|
||||||
func checkOnce(
|
func checkOnce(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
w *watcher.Watcher,
|
w *watcher.Watcher,
|
||||||
@@ -203,42 +202,46 @@ func checkOnce(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// runChecks builds a watcher, lets prepare set up the saved state and
|
// runFirstCheck builds a watcher, lets prepare set up the saved state
|
||||||
// stand-ins it starts from, and runs its checks once against live DNS.
|
// and stand-ins it starts from, and runs its checks once against live
|
||||||
// If change is not nil, change then alters the saved state or stand-ins
|
// DNS. When live DNS does not answer, the watcher is thrown away and
|
||||||
// and the checks run a second time. When either check finds no fresh
|
// built again, so a failed attempt leaves nothing behind in the state
|
||||||
// address for a name (see checkOnce), the watcher is thrown away and
|
// or the notifications.
|
||||||
// all of this runs again on a new one, so a failed attempt leaves
|
func runFirstCheck(
|
||||||
// nothing behind in the saved state, the stand-ins or the notifications.
|
|
||||||
func runChecks(
|
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
cfg *config.Config,
|
cfg *config.Config,
|
||||||
prepare, change func(deps *testDeps),
|
prepare func(deps *testDeps),
|
||||||
) *testDeps {
|
) (*watcher.Watcher, *testDeps) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
var deps *testDeps
|
var (
|
||||||
|
w *watcher.Watcher
|
||||||
livedns.Retry(t, "watcher checks", func(ctx context.Context) error {
|
deps *testDeps
|
||||||
var w *watcher.Watcher
|
)
|
||||||
|
|
||||||
|
livedns.Retry(t, "first check", func(ctx context.Context) error {
|
||||||
w, deps = newTestWatcher(t, cfg)
|
w, deps = newTestWatcher(t, cfg)
|
||||||
|
|
||||||
if prepare != nil {
|
if prepare != nil {
|
||||||
prepare(deps)
|
prepare(deps)
|
||||||
}
|
}
|
||||||
|
|
||||||
err := checkOnce(ctx, w, deps)
|
|
||||||
if err != nil || change == nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
change(deps)
|
|
||||||
|
|
||||||
return checkOnce(ctx, w, deps)
|
return checkOnce(ctx, w, deps)
|
||||||
})
|
})
|
||||||
|
|
||||||
return deps
|
return w, deps
|
||||||
|
}
|
||||||
|
|
||||||
|
// runCheck runs the watcher's checks once more against live DNS,
|
||||||
|
// repeating them while live DNS does not answer. A failed lookup keeps
|
||||||
|
// the name's saved records, so a repeat compares against the same
|
||||||
|
// saved state.
|
||||||
|
func runCheck(t *testing.T, w *watcher.Watcher, deps *testDeps) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
livedns.Retry(t, "check", func(ctx context.Context) error {
|
||||||
|
return checkOnce(ctx, w, deps)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// addresses returns the A and AAAA values saved for a hostname.
|
// addresses returns the A and AAAA values saved for a hostname.
|
||||||
@@ -296,7 +299,7 @@ func TestFirstRunBaseline(t *testing.T) {
|
|||||||
cfg.Domains = []string{testDomain}
|
cfg.Domains = []string{testDomain}
|
||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
deps := runChecks(t, cfg, nil, nil)
|
_, deps := runFirstCheck(t, cfg, nil)
|
||||||
|
|
||||||
assertNoNotifications(t, deps)
|
assertNoNotifications(t, deps)
|
||||||
assertStatePopulated(t, deps)
|
assertStatePopulated(t, deps)
|
||||||
@@ -348,7 +351,7 @@ func TestDomainPortAndTLSChecks(t *testing.T) {
|
|||||||
cfg := defaultTestConfig(t)
|
cfg := defaultTestConfig(t)
|
||||||
cfg.Domains = []string{testDomain}
|
cfg.Domains = []string{testDomain}
|
||||||
|
|
||||||
deps := runChecks(t, cfg, nil, nil)
|
_, deps := runFirstCheck(t, cfg, nil)
|
||||||
|
|
||||||
snap := deps.state.GetSnapshot()
|
snap := deps.state.GetSnapshot()
|
||||||
|
|
||||||
@@ -388,11 +391,11 @@ func TestNSChangeDetection(t *testing.T) {
|
|||||||
cfg.Domains = []string{testDomain}
|
cfg.Domains = []string{testDomain}
|
||||||
|
|
||||||
// The saved state lists nameservers that live DNS does not.
|
// The saved state lists nameservers that live DNS does not.
|
||||||
deps := runChecks(t, cfg, func(deps *testDeps) {
|
_, deps := runFirstCheck(t, cfg, func(deps *testDeps) {
|
||||||
deps.state.SetDomainState(testDomain, &state.DomainState{
|
deps.state.SetDomainState(testDomain, &state.DomainState{
|
||||||
Nameservers: []string{oldNS1, oldNS2},
|
Nameservers: []string{oldNS1, oldNS2},
|
||||||
})
|
})
|
||||||
}, nil)
|
})
|
||||||
|
|
||||||
assertNotified(t, deps, "NS Change: "+testDomain, "warning")
|
assertNotified(t, deps, "NS Change: "+testDomain, "warning")
|
||||||
|
|
||||||
@@ -408,16 +411,17 @@ func TestRecordChangeDetection(t *testing.T) {
|
|||||||
cfg := defaultTestConfig(t)
|
cfg := defaultTestConfig(t)
|
||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
// Between the checks, save for every nameserver an address live DNS
|
w, deps := runFirstCheck(t, cfg, nil)
|
||||||
// never returns.
|
|
||||||
deps := runChecks(t, cfg, nil, func(deps *testDeps) {
|
|
||||||
hs, _ := deps.state.GetHostnameState(testHost)
|
|
||||||
for _, nsState := range hs.RecordsByNameserver {
|
|
||||||
nsState.Records = map[string][]string{"A": {oldIP}}
|
|
||||||
}
|
|
||||||
|
|
||||||
deps.state.SetHostnameState(testHost, hs)
|
// Save, for every nameserver, an address live DNS never returns.
|
||||||
})
|
hs, _ := deps.state.GetHostnameState(testHost)
|
||||||
|
for _, nsState := range hs.RecordsByNameserver {
|
||||||
|
nsState.Records = map[string][]string{"A": {oldIP}}
|
||||||
|
}
|
||||||
|
|
||||||
|
deps.state.SetHostnameState(testHost, hs)
|
||||||
|
|
||||||
|
runCheck(t, w, deps)
|
||||||
|
|
||||||
assertNotified(t, deps, "Record Change: "+testHost, "warning")
|
assertNotified(t, deps, "Record Change: "+testHost, "warning")
|
||||||
}
|
}
|
||||||
@@ -428,12 +432,13 @@ func TestPortStateChange(t *testing.T) {
|
|||||||
cfg := defaultTestConfig(t)
|
cfg := defaultTestConfig(t)
|
||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
// Between the checks, every port closes.
|
w, deps := runFirstCheck(t, cfg, nil)
|
||||||
deps := runChecks(t, cfg, nil, func(deps *testDeps) {
|
|
||||||
deps.portChecker.mu.Lock()
|
deps.portChecker.mu.Lock()
|
||||||
deps.portChecker.closed = true
|
deps.portChecker.closed = true
|
||||||
deps.portChecker.mu.Unlock()
|
deps.portChecker.mu.Unlock()
|
||||||
})
|
|
||||||
|
runCheck(t, w, deps)
|
||||||
|
|
||||||
hs, _ := deps.state.GetHostnameState(testHost)
|
hs, _ := deps.state.GetHostnameState(testHost)
|
||||||
assertNotified(
|
assertNotified(
|
||||||
@@ -453,7 +458,7 @@ func TestTLSExpiryWarning(t *testing.T) {
|
|||||||
cfg := defaultTestConfig(t)
|
cfg := defaultTestConfig(t)
|
||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
deps := runChecks(t, cfg, expiresInThreeDays, nil)
|
_, deps := runFirstCheck(t, cfg, expiresInThreeDays)
|
||||||
|
|
||||||
assertNotified(t, deps, "TLS Expiry Warning: "+testHost, "warning")
|
assertNotified(t, deps, "TLS Expiry Warning: "+testHost, "warning")
|
||||||
}
|
}
|
||||||
@@ -465,20 +470,19 @@ func TestTLSExpiryWarningDedup(t *testing.T) {
|
|||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
cfg.TLSInterval = 24 * time.Hour
|
cfg.TLSInterval = 24 * time.Hour
|
||||||
|
|
||||||
|
w, deps := runFirstCheck(t, cfg, expiresInThreeDays)
|
||||||
|
|
||||||
title := "TLS Expiry Warning: " + testHost
|
title := "TLS Expiry Warning: " + testHost
|
||||||
|
|
||||||
// The second check comes within the TLS interval of the first,
|
warnings := countNotifications(deps, title)
|
||||||
// so it must not warn again.
|
|
||||||
var warnings int
|
|
||||||
|
|
||||||
deps := runChecks(t, cfg, expiresInThreeDays, func(deps *testDeps) {
|
|
||||||
warnings = countNotifications(deps, title)
|
|
||||||
})
|
|
||||||
|
|
||||||
if warnings == 0 {
|
if warnings == 0 {
|
||||||
t.Fatal("expected expiry warnings from the first check")
|
t.Fatal("expected expiry warnings from the first check")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The second check comes within the TLS interval of the first,
|
||||||
|
// so it must not warn again.
|
||||||
|
runCheck(t, w, deps)
|
||||||
|
|
||||||
got := countNotifications(deps, title)
|
got := countNotifications(deps, title)
|
||||||
if got != warnings {
|
if got != warnings {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
@@ -525,7 +529,7 @@ func TestDNSRunsBeforePortAndTLSChecks(t *testing.T) {
|
|||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
// The saved state says the last check found testHost at oldIP.
|
// The saved state says the last check found testHost at oldIP.
|
||||||
deps := runChecks(t, cfg, func(deps *testDeps) {
|
_, deps := runFirstCheck(t, cfg, func(deps *testDeps) {
|
||||||
deps.state.SetHostnameState(testHost, &state.HostnameState{
|
deps.state.SetHostnameState(testHost, &state.HostnameState{
|
||||||
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
||||||
oldNS1: {
|
oldNS1: {
|
||||||
@@ -534,7 +538,7 @@ func TestDNSRunsBeforePortAndTLSChecks(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
}, nil)
|
})
|
||||||
|
|
||||||
snap := deps.state.GetSnapshot()
|
snap := deps.state.GetSnapshot()
|
||||||
|
|
||||||
@@ -665,21 +669,23 @@ func TestNSFailureAndRecovery(t *testing.T) {
|
|||||||
cfg := defaultTestConfig(t)
|
cfg := defaultTestConfig(t)
|
||||||
cfg.Hostnames = []string{testHost}
|
cfg.Hostnames = []string{testHost}
|
||||||
|
|
||||||
// Between the checks, save every nameserver the first check found
|
w, deps := runFirstCheck(t, cfg, nil)
|
||||||
// as failed, and add, as answering, one that live DNS does not list.
|
|
||||||
deps := runChecks(t, cfg, nil, func(deps *testDeps) {
|
|
||||||
hs, _ := deps.state.GetHostnameState(testHost)
|
|
||||||
for _, nsState := range hs.RecordsByNameserver {
|
|
||||||
nsState.Status = "error"
|
|
||||||
}
|
|
||||||
|
|
||||||
hs.RecordsByNameserver[oldNS1] = &state.NameserverRecordState{
|
// Save every nameserver the first check found as failed, and add
|
||||||
Records: map[string][]string{"A": {oldIP}},
|
// one that live DNS does not list as having answered.
|
||||||
Status: "ok",
|
hs, _ := deps.state.GetHostnameState(testHost)
|
||||||
}
|
for _, nsState := range hs.RecordsByNameserver {
|
||||||
|
nsState.Status = "error"
|
||||||
|
}
|
||||||
|
|
||||||
deps.state.SetHostnameState(testHost, hs)
|
hs.RecordsByNameserver[oldNS1] = &state.NameserverRecordState{
|
||||||
})
|
Records: map[string][]string{"A": {oldIP}},
|
||||||
|
Status: "ok",
|
||||||
|
}
|
||||||
|
|
||||||
|
deps.state.SetHostnameState(testHost, hs)
|
||||||
|
|
||||||
|
runCheck(t, w, deps)
|
||||||
|
|
||||||
assertNotified(t, deps, "NS Failure: "+testHost, "error")
|
assertNotified(t, deps, "NS Failure: "+testHost, "error")
|
||||||
assertNotified(t, deps, "NS Recovery: "+testHost, "success")
|
assertNotified(t, deps, "NS Recovery: "+testHost, "success")
|
||||||
|
|||||||
Reference in New Issue
Block a user