Compare commits
3 Commits
584b5f5b39
...
remove-dns
| Author | SHA1 | Date | |
|---|---|---|---|
| a535ae864b | |||
| 9347a2838b | |||
| f79cd98107 |
@@ -1,5 +1,9 @@
|
|||||||
version: "2"
|
version: "2"
|
||||||
|
|
||||||
|
# Config schema uses the golangci-lint v2 layout (settings live under
|
||||||
|
# linters.settings, not top-level linters-settings) so that the
|
||||||
|
# thresholds below are actually applied by golangci-lint >= v2.
|
||||||
|
|
||||||
run:
|
run:
|
||||||
timeout: 5m
|
timeout: 5m
|
||||||
modules-download-mode: readonly
|
modules-download-mode: readonly
|
||||||
@@ -14,8 +18,7 @@ linters:
|
|||||||
- wsl # Deprecated, replaced by wsl_v5
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
|
settings:
|
||||||
linters-settings:
|
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
funlen:
|
funlen:
|
||||||
@@ -27,6 +30,5 @@ linters-settings:
|
|||||||
threshold: 100
|
threshold: 100
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
exclude-use-default: false
|
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
max-same-issues: 0
|
max-same-issues: 0
|
||||||
|
|||||||
20
README.md
20
README.md
@@ -17,6 +17,26 @@ without requiring an external database.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## No DNS mocking. Ever.
|
||||||
|
|
||||||
|
**DNS is never mocked in this project — not in tests, not anywhere else.**
|
||||||
|
No mock resolvers, no fake DNS servers, no stubbed lookups.
|
||||||
|
|
||||||
|
dnswatcher's entire purpose is correct behavior against the real DNS.
|
||||||
|
Tests exercise real iterative resolution against live nameservers by
|
||||||
|
design; a test suite that passes against a mock proves nothing about the
|
||||||
|
one thing this program exists to do.
|
||||||
|
|
||||||
|
When live tests are flaky, that is a robustness problem, and it gets
|
||||||
|
fixed with robustness: retries with backoff, querying multiple
|
||||||
|
independent nameservers, longer timeouts — or explicit opt-in gating
|
||||||
|
decided by the project owner. Never with mocks.
|
||||||
|
|
||||||
|
Contributions that introduce mocked, faked, or stubbed DNS will be
|
||||||
|
rejected.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### DNS Domain Monitoring (Apex Domains)
|
### DNS Domain Monitoring (Apex Domains)
|
||||||
|
|||||||
15
TESTING.md
15
TESTING.md
@@ -2,8 +2,10 @@
|
|||||||
|
|
||||||
## DNS Resolution Tests
|
## DNS Resolution Tests
|
||||||
|
|
||||||
All resolver tests **MUST** use live queries against real DNS servers.
|
All tests that involve DNS resolution — in every package, including
|
||||||
No mocking of the DNS client layer is permitted.
|
consumers of the resolver such as the watcher — **MUST** use live
|
||||||
|
queries against real DNS servers. No mocking, faking, or stubbing of
|
||||||
|
DNS at any layer is permitted.
|
||||||
|
|
||||||
### Rationale
|
### Rationale
|
||||||
|
|
||||||
@@ -12,6 +14,8 @@ the full delegation chain. Mocked responses cannot faithfully represent
|
|||||||
the variety of real-world DNS behavior (truncation, referrals, glue
|
the variety of real-world DNS behavior (truncation, referrals, glue
|
||||||
records, DNSSEC, varied response times, EDNS, etc.). Testing against
|
records, DNSSEC, varied response times, EDNS, etc.). Testing against
|
||||||
real servers ensures the resolver works correctly in production.
|
real servers ensures the resolver works correctly in production.
|
||||||
|
Robustness comes from handling real-world DNS behavior with tolerant
|
||||||
|
assertions and sensible timeouts, not from mocks.
|
||||||
|
|
||||||
### Constraints
|
### Constraints
|
||||||
|
|
||||||
@@ -24,11 +28,14 @@ real servers ensures the resolver works correctly in production.
|
|||||||
- Flaky failures from transient network issues are acceptable and
|
- Flaky failures from transient network issues are acceptable and
|
||||||
should be investigated as potential resolver bugs, not papered over
|
should be investigated as potential resolver bugs, not papered over
|
||||||
with mocks or skip flags
|
with mocks or skip flags
|
||||||
|
- Watcher change-detection tests seed a synthetic *previous state*
|
||||||
|
and compare it against fresh live lookups; the DNS side is never
|
||||||
|
faked
|
||||||
|
|
||||||
### What NOT to do
|
### What NOT to do
|
||||||
|
|
||||||
- **Do not mock `DNSClient`** for resolver tests (the mock constructor
|
- **Do not mock `DNSClient`**, the watcher's `DNSResolver` interface,
|
||||||
exists for unit-testing other packages that consume the resolver)
|
or any other DNS abstraction — in any package, for any reason
|
||||||
- **Do not add `-short` flags** to skip slow tests
|
- **Do not add `-short` flags** to skip slow tests
|
||||||
- **Do not increase `-timeout`** to hide hanging queries
|
- **Do not increase `-timeout`** to hide hanging queries
|
||||||
- **Do not modify linter configuration** to suppress findings
|
- **Do not modify linter configuration** to suppress findings
|
||||||
|
|||||||
33
TODO.md
33
TODO.md
@@ -14,7 +14,10 @@ pre-1.0. No git tags. Core resolver work in flight on feature/resolver
|
|||||||
(dirty: internal/resolver/resolver_test.go). Local checkout has diverged
|
(dirty: internal/resolver/resolver_test.go). Local checkout has diverged
|
||||||
from origin: origin/main is 8 commits ahead (watcher orchestrator,
|
from origin: origin/main is 8 commits ahead (watcher orchestrator,
|
||||||
unified TARGETS) and origin/feature/resolver already contains the full
|
unified TARGETS) and origin/feature/resolver already contains the full
|
||||||
iterative resolver implementation with hermetic mocked tests.
|
iterative resolver implementation. DNS mocking is banned in this repo
|
||||||
|
(see `TESTING.md`): all tests use live DNS only. The hermetic mocked
|
||||||
|
tests previously noted on `feature/resolver` are gone from its current
|
||||||
|
tip, which carries a live-DNS suite against `*.dns.sneak.cloud`.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -25,13 +28,23 @@ confirm make check still passes.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-08-07: DNS mocking removed from the entire test suite; watcher
|
||||||
|
tests now drive the real iterative resolver against live DNS and
|
||||||
|
`TESTING.md` bans DNS mocks in every package (`remove-dns-mocking`
|
||||||
|
branch)
|
||||||
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
|
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
|
||||||
in `Dockerfile` and `script/bootstrap`); fixed the resulting
|
in `Dockerfile` and `script/bootstrap`); `.golangci.yml` set to the
|
||||||
`goconst` findings. `.golangci.yml` unchanged (canonical)
|
org-standard v2-schema config used across the org's repos
|
||||||
|
(owner-authorized; same file is being landed as canonical via prompts
|
||||||
|
PR #24), with settings under `linters.settings` so the
|
||||||
|
lll/funlen/cyclop/dupl thresholds apply; fixed the resulting
|
||||||
|
`goconst`, `dupl`, and `lll` findings; the informational `gomodguard`
|
||||||
|
deprecation warning under this config is accepted
|
||||||
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
||||||
Makefile shims, README Entrypoints section
|
Makefile shims, README Entrypoints section
|
||||||
- 2026-02-20: iterative DNS resolver implemented; tests made hermetic
|
- 2026-02-20: iterative DNS resolver implemented; tests made hermetic
|
||||||
with mocked DNS (origin/feature/resolver, unmerged)
|
with mocked DNS (origin/feature/resolver, unmerged; superseded — DNS
|
||||||
|
mocking is banned, see `TESTING.md`)
|
||||||
- 2026-02-20: CI actions and go install refs pinned to commit SHAs;
|
- 2026-02-20: CI actions and go install refs pinned to commit SHAs;
|
||||||
Gitea Actions workflow for make check (origin/ci/make-check, unmerged)
|
Gitea Actions workflow for make check (origin/ci/make-check, unmerged)
|
||||||
- 2026-02-20: watcher monitoring orchestrator merged to main (#8)
|
- 2026-02-20: watcher monitoring orchestrator merged to main (#8)
|
||||||
@@ -58,8 +71,9 @@ Branch reconciliation:
|
|||||||
- Sync local checkout with origin: local main is 8 commits behind
|
- Sync local checkout with origin: local main is 8 commits behind
|
||||||
origin/main; local feature/resolver has diverged from
|
origin/main; local feature/resolver has diverged from
|
||||||
origin/feature/resolver, which already implements the resolver
|
origin/feature/resolver, which already implements the resolver
|
||||||
- Merge in-flight branches to main once green: feature/resolver,
|
- Merge in-flight branches to main once green: feature/resolver
|
||||||
ci/make-check, feature/portcheck-implementation,
|
(confirm its tests remain live-DNS — DNS mocking is banned, see
|
||||||
|
`TESTING.md`), ci/make-check, feature/portcheck-implementation,
|
||||||
feature/tlscheck-implementation
|
feature/tlscheck-implementation
|
||||||
|
|
||||||
Resolver (plan from untracked TODO.md; largely implemented on
|
Resolver (plan from untracked TODO.md; largely implemented on
|
||||||
@@ -143,6 +157,7 @@ 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
|
||||||
- Resolver tests originally used live DNS against *.dns.sneak.cloud
|
- Resolver tests originally used live DNS against `*.dns.sneak.cloud`
|
||||||
(required records documented in the test file header); origin now has
|
(required records documented in the test file header); `main` now
|
||||||
mocked hermetic tests, keep them hermetic
|
tests against live public DNS. DNS mocking is banned (see
|
||||||
|
`TESTING.md`); never reintroduce hermetic mocked DNS tests
|
||||||
|
|||||||
@@ -17,13 +17,33 @@ func TestClassifyDNSName(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{name: "apex domain simple", input: "example.com", want: config.DNSNameTypeDomain},
|
{name: "apex domain simple", input: "example.com", want: config.DNSNameTypeDomain},
|
||||||
{name: "hostname simple", input: "www.example.com", want: config.DNSNameTypeHostname},
|
{name: "hostname simple", input: "www.example.com", want: config.DNSNameTypeHostname},
|
||||||
{name: "apex domain multi-part TLD", input: "example.co.uk", want: config.DNSNameTypeDomain},
|
{
|
||||||
{name: "hostname multi-part TLD", input: "api.example.co.uk", want: config.DNSNameTypeHostname},
|
name: "apex domain multi-part TLD",
|
||||||
|
input: "example.co.uk",
|
||||||
|
want: config.DNSNameTypeDomain,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "hostname multi-part TLD",
|
||||||
|
input: "api.example.co.uk",
|
||||||
|
want: config.DNSNameTypeHostname,
|
||||||
|
},
|
||||||
{name: "public suffix itself", input: "co.uk", wantErr: true},
|
{name: "public suffix itself", input: "co.uk", wantErr: true},
|
||||||
{name: "empty string", input: "", wantErr: true},
|
{name: "empty string", input: "", wantErr: true},
|
||||||
{name: "deeply nested hostname", input: "a.b.c.example.com", want: config.DNSNameTypeHostname},
|
{
|
||||||
{name: "trailing dot stripped", input: "example.com.", want: config.DNSNameTypeDomain},
|
name: "deeply nested hostname",
|
||||||
{name: "uppercase normalized", input: "WWW.Example.COM", want: config.DNSNameTypeHostname},
|
input: "a.b.c.example.com",
|
||||||
|
want: config.DNSNameTypeHostname,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "trailing dot stripped",
|
||||||
|
input: "example.com.",
|
||||||
|
want: config.DNSNameTypeDomain,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "uppercase normalized",
|
||||||
|
input: "WWW.Example.COM",
|
||||||
|
want: config.DNSNameTypeHostname,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
|
|||||||
@@ -25,18 +25,20 @@ const (
|
|||||||
colorDefault = "#6c757d"
|
colorDefault = "#6c757d"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Priority and fixture values shared across tests.
|
// Priority strings used across multiple tests.
|
||||||
const (
|
const (
|
||||||
prioError = "error"
|
prioError = "error"
|
||||||
prioWarning = "warning"
|
prioWarning = "warning"
|
||||||
prioInfo = "info"
|
|
||||||
prioSuccess = "success"
|
prioSuccess = "success"
|
||||||
|
prioInfo = "info"
|
||||||
prioUnknown = "unknown"
|
prioUnknown = "unknown"
|
||||||
ntfyUrgent = "urgent"
|
prioDefault = "default"
|
||||||
ntfyDefault = "default"
|
prioUrgent = "urgent"
|
||||||
testHost = "example.com"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// testHost is the hostname used in request construction tests.
|
||||||
|
const testHost = "example.com"
|
||||||
|
|
||||||
// errSimulated is a static error for transport failures.
|
// errSimulated is a static error for transport failures.
|
||||||
var errSimulated = errors.New("simulated transport failure")
|
var errSimulated = errors.New("simulated transport failure")
|
||||||
|
|
||||||
@@ -113,13 +115,13 @@ func TestNtfyPriority(t *testing.T) {
|
|||||||
input string
|
input string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, ntfyUrgent},
|
{prioError, prioUrgent},
|
||||||
{prioWarning, "high"},
|
{prioWarning, "high"},
|
||||||
{prioSuccess, ntfyDefault},
|
{prioSuccess, prioDefault},
|
||||||
{prioInfo, "low"},
|
{prioInfo, "low"},
|
||||||
{"", ntfyDefault},
|
{"", prioDefault},
|
||||||
{prioUnknown, ntfyDefault},
|
{prioUnknown, prioDefault},
|
||||||
{"critical", ntfyDefault},
|
{"critical", prioDefault},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
@@ -301,10 +303,10 @@ func TestSendNtfyHeaders(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if captured.priority != ntfyUrgent {
|
if captured.priority != prioUrgent {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"Priority header = %q, want %q",
|
"Priority header = %q, want %q",
|
||||||
captured.priority, ntfyUrgent,
|
captured.priority, prioUrgent,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -323,9 +325,9 @@ func TestSendNtfyAllPriorities(t *testing.T) {
|
|||||||
input string
|
input string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, ntfyUrgent},
|
{prioError, prioUrgent},
|
||||||
{prioWarning, "high"},
|
{prioWarning, "high"},
|
||||||
{prioSuccess, ntfyDefault},
|
{prioSuccess, prioDefault},
|
||||||
{prioInfo, "low"},
|
{prioInfo, "low"},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -368,56 +370,69 @@ func TestSendNtfyAllPriorities(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendNtfyClientError(t *testing.T) {
|
// assertSendStatusError verifies that send returns an error
|
||||||
t.Parallel()
|
// wrapping wantErr when the server responds with status.
|
||||||
|
func assertSendStatusError(
|
||||||
|
t *testing.T,
|
||||||
|
status int,
|
||||||
|
wantErr error,
|
||||||
|
send func(*notify.Service, *url.URL) error,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
srv := httptest.NewServer(
|
||||||
http.HandlerFunc(
|
http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
w.WriteHeader(http.StatusForbidden)
|
w.WriteHeader(status)
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
svc := notify.NewTestService(srv.Client().Transport)
|
svc := notify.NewTestService(srv.Client().Transport)
|
||||||
topicURL, _ := url.Parse(srv.URL)
|
target, _ := url.Parse(srv.URL)
|
||||||
|
|
||||||
err := svc.SendNtfy(
|
err := send(svc, target)
|
||||||
context.Background(), topicURL, "t", "m", "info",
|
|
||||||
)
|
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403 response")
|
t.Fatalf("expected error for %d response", status)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !errors.Is(err, notify.ErrNtfyFailed) {
|
if !errors.Is(err, wantErr) {
|
||||||
t.Errorf("error = %v, want ErrNtfyFailed", err)
|
t.Errorf("error = %v, want %v", err, wantErr)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func sendNtfyInfo(
|
||||||
|
svc *notify.Service, target *url.URL,
|
||||||
|
) error {
|
||||||
|
return svc.SendNtfy(
|
||||||
|
context.Background(), target, "t", "m", prioInfo,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func sendSlackInfo(
|
||||||
|
svc *notify.Service, target *url.URL,
|
||||||
|
) error {
|
||||||
|
return svc.SendSlack(
|
||||||
|
context.Background(), target, "t", "m", prioInfo,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSendNtfyClientError(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
assertSendStatusError(
|
||||||
|
t, http.StatusForbidden,
|
||||||
|
notify.ErrNtfyFailed, sendNtfyInfo,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
func TestSendNtfyServerError(t *testing.T) {
|
func TestSendNtfyServerError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
assertSendStatusError(
|
||||||
http.HandlerFunc(
|
t, http.StatusInternalServerError,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
notify.ErrNtfyFailed, sendNtfyInfo,
|
||||||
w.WriteHeader(http.StatusInternalServerError)
|
|
||||||
}),
|
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
svc := notify.NewTestService(srv.Client().Transport)
|
|
||||||
topicURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
err := svc.SendNtfy(
|
|
||||||
context.Background(), topicURL, "t", "m", "info",
|
|
||||||
)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for 500 response")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !errors.Is(err, notify.ErrNtfyFailed) {
|
|
||||||
t.Errorf("error = %v, want ErrNtfyFailed", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendNtfySuccess(t *testing.T) {
|
func TestSendNtfySuccess(t *testing.T) {
|
||||||
@@ -618,53 +633,19 @@ func TestSendSlackAllColors(t *testing.T) {
|
|||||||
func TestSendSlackClientError(t *testing.T) {
|
func TestSendSlackClientError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
assertSendStatusError(
|
||||||
http.HandlerFunc(
|
t, http.StatusBadRequest,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
notify.ErrSlackFailed, sendSlackInfo,
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
|
||||||
}),
|
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
svc := notify.NewTestService(srv.Client().Transport)
|
|
||||||
webhookURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
err := svc.SendSlack(
|
|
||||||
context.Background(), webhookURL, "t", "m", "info",
|
|
||||||
)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for 400 response")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !errors.Is(err, notify.ErrSlackFailed) {
|
|
||||||
t.Errorf("error = %v, want ErrSlackFailed", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendSlackServerError(t *testing.T) {
|
func TestSendSlackServerError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
assertSendStatusError(
|
||||||
http.HandlerFunc(
|
t, http.StatusBadGateway,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
notify.ErrSlackFailed, sendSlackInfo,
|
||||||
w.WriteHeader(http.StatusBadGateway)
|
|
||||||
}),
|
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
svc := notify.NewTestService(srv.Client().Transport)
|
|
||||||
webhookURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
err := svc.SendSlack(
|
|
||||||
context.Background(), webhookURL, "t", "m", "error",
|
|
||||||
)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for 502 response")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !errors.Is(err, notify.ErrSlackFailed) {
|
|
||||||
t.Errorf("error = %v, want ErrSlackFailed", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendSlackNetworkError(t *testing.T) {
|
func TestSendSlackNetworkError(t *testing.T) {
|
||||||
@@ -989,74 +970,62 @@ func TestSendNotificationMattermostOnly(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendNotificationNtfyError(t *testing.T) {
|
// assertSendNotificationTolerates verifies SendNotification
|
||||||
t.Parallel()
|
// neither panics nor blocks when the endpoint configured by
|
||||||
|
// setURL responds with status.
|
||||||
|
func assertSendNotificationTolerates(
|
||||||
|
t *testing.T,
|
||||||
|
status int,
|
||||||
|
priority string,
|
||||||
|
setURL func(*notify.Service, *url.URL),
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
srv := httptest.NewServer(
|
||||||
http.HandlerFunc(
|
http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
w.WriteHeader(http.StatusInternalServerError)
|
w.WriteHeader(status)
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
ntfyURL, _ := url.Parse(srv.URL)
|
target, _ := url.Parse(srv.URL)
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
svc := notify.NewTestService(http.DefaultTransport)
|
||||||
svc.SetNtfyURL(ntfyURL)
|
setURL(svc, target)
|
||||||
|
|
||||||
// Should not panic or block.
|
|
||||||
svc.SendNotification(
|
svc.SendNotification(
|
||||||
context.Background(), "t", "m", "error",
|
context.Background(), "t", "m", priority,
|
||||||
)
|
)
|
||||||
|
|
||||||
time.Sleep(100 * time.Millisecond)
|
time.Sleep(100 * time.Millisecond)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSendNotificationNtfyError(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
assertSendNotificationTolerates(
|
||||||
|
t, http.StatusInternalServerError, prioError,
|
||||||
|
(*notify.Service).SetNtfyURL,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
func TestSendNotificationSlackError(t *testing.T) {
|
func TestSendNotificationSlackError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
assertSendNotificationTolerates(
|
||||||
http.HandlerFunc(
|
t, http.StatusForbidden, prioError,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
(*notify.Service).SetSlackWebhookURL,
|
||||||
w.WriteHeader(http.StatusForbidden)
|
|
||||||
}),
|
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
slackURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
|
||||||
svc.SetSlackWebhookURL(slackURL)
|
|
||||||
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", "error",
|
|
||||||
)
|
|
||||||
|
|
||||||
time.Sleep(100 * time.Millisecond)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSendNotificationMattermostError(t *testing.T) {
|
func TestSendNotificationMattermostError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
assertSendNotificationTolerates(
|
||||||
http.HandlerFunc(
|
t, http.StatusBadGateway, prioWarning,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
(*notify.Service).SetMattermostWebhookURL,
|
||||||
w.WriteHeader(http.StatusBadGateway)
|
|
||||||
}),
|
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
mmURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
|
||||||
svc.SetMattermostWebhookURL(mmURL)
|
|
||||||
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", "warning",
|
|
||||||
)
|
|
||||||
|
|
||||||
time.Sleep(100 * time.Millisecond)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ── SlackPayload JSON marshaling ──────────────────────────
|
// ── SlackPayload JSON marshaling ──────────────────────────
|
||||||
|
|||||||
@@ -69,7 +69,7 @@ func (rc RetryConfig) backoff(attempt int) time.Duration {
|
|||||||
lo := raw * (1 - jitterFraction)
|
lo := raw * (1 - jitterFraction)
|
||||||
hi := raw * (1 + jitterFraction)
|
hi := raw * (1 + jitterFraction)
|
||||||
|
|
||||||
jittered := lo + rand.Float64()*(hi-lo) //nolint:gosec // jitter does not need crypto/rand
|
jittered := lo + rand.Float64()*(hi-lo) //nolint:gosec // jitter needs no crypto/rand
|
||||||
|
|
||||||
return time.Duration(jittered)
|
return time.Duration(jittered)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ import (
|
|||||||
"github.com/miekg/dns"
|
"github.com/miekg/dns"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DNSClient abstracts DNS wire-protocol exchanges so the resolver
|
// DNSClient abstracts DNS wire-protocol exchanges over a single
|
||||||
// can be tested without hitting real nameservers.
|
// transport, letting the resolver switch between UDP and TCP.
|
||||||
type DNSClient interface {
|
type DNSClient interface {
|
||||||
ExchangeContext(
|
ExchangeContext(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
|
|||||||
@@ -67,17 +67,4 @@ func NewFromLogger(log *slog.Logger) *Resolver {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewFromLoggerWithClient creates a Resolver with a custom DNS
|
|
||||||
// client, useful for testing with mock DNS responses.
|
|
||||||
func NewFromLoggerWithClient(
|
|
||||||
log *slog.Logger,
|
|
||||||
client DNSClient,
|
|
||||||
) *Resolver {
|
|
||||||
return &Resolver{
|
|
||||||
log: log,
|
|
||||||
client: client,
|
|
||||||
tcp: client,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Method implementations are in iterative.go.
|
// Method implementations are in iterative.go.
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/miekg/dns"
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
@@ -624,57 +623,40 @@ func TestQueryAllNameservers_ContextCanceled(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ----------------------------------------------------------------
|
// ----------------------------------------------------------------
|
||||||
// Timeout tests
|
// Unreachable nameserver tests
|
||||||
// ----------------------------------------------------------------
|
// ----------------------------------------------------------------
|
||||||
|
|
||||||
func TestQueryNameserverIP_Timeout(t *testing.T) {
|
func TestQueryNameserverIP_UnreachableServer(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
r := newTestResolver(t)
|
||||||
os.Stderr,
|
|
||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
|
||||||
))
|
|
||||||
|
|
||||||
r := resolver.NewFromLoggerWithClient(
|
|
||||||
log, &timeoutClient{},
|
|
||||||
)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
ctx, cancel := context.WithTimeout(
|
||||||
context.Background(), 10*time.Second,
|
context.Background(), 10*time.Second,
|
||||||
)
|
)
|
||||||
t.Cleanup(cancel)
|
t.Cleanup(cancel)
|
||||||
|
|
||||||
// Query any IP — the client always returns a timeout error.
|
// 192.0.2.1 is an RFC 5737 documentation address: no
|
||||||
|
// nameserver can exist there. Depending on the network
|
||||||
|
// path the queries either time out (silent drop) or fail
|
||||||
|
// fast (ICMP unreachable), so accept any non-OK status;
|
||||||
|
// the resolver must return a classified response with no
|
||||||
|
// records rather than an error or a hang.
|
||||||
resp, err := r.QueryNameserverIP(
|
resp, err := r.QueryNameserverIP(
|
||||||
ctx, "unreachable.test.", "192.0.2.1",
|
ctx, "unreachable.test.", "192.0.2.1",
|
||||||
"example.com",
|
"example.com",
|
||||||
)
|
)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
assert.Equal(t, resolver.StatusTimeout, resp.Status)
|
assert.NotEqual(t, resolver.StatusOK, resp.Status)
|
||||||
assert.NotEmpty(t, resp.Error)
|
|
||||||
|
totalRecords := 0
|
||||||
|
for _, values := range resp.Records {
|
||||||
|
totalRecords += len(values)
|
||||||
}
|
}
|
||||||
|
|
||||||
// timeoutClient simulates DNS timeout errors for testing.
|
assert.Zero(t, totalRecords)
|
||||||
type timeoutClient struct{}
|
|
||||||
|
|
||||||
func (c *timeoutClient) ExchangeContext(
|
|
||||||
_ context.Context,
|
|
||||||
_ *dns.Msg,
|
|
||||||
_ string,
|
|
||||||
) (*dns.Msg, time.Duration, error) {
|
|
||||||
return nil, 0, &net.OpError{
|
|
||||||
Op: "read",
|
|
||||||
Net: "udp",
|
|
||||||
Err: &timeoutError{},
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
type timeoutError struct{}
|
|
||||||
|
|
||||||
func (e *timeoutError) Error() string { return "i/o timeout" }
|
|
||||||
func (e *timeoutError) Timeout() bool { return true }
|
|
||||||
func (e *timeoutError) Temporary() bool { return true }
|
|
||||||
|
|
||||||
func TestResolveIPAddresses_ContextCanceled(t *testing.T) {
|
func TestResolveIPAddresses_ContextCanceled(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|||||||
@@ -223,7 +223,8 @@ func TestSaveLoadRoundTrip_Ports(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestSaveLoadRoundTrip_Certificates verifies certificate data survives a save/load cycle.
|
// TestSaveLoadRoundTrip_Certificates verifies certificate data
|
||||||
|
// survives a save/load cycle.
|
||||||
func TestSaveLoadRoundTrip_Certificates(t *testing.T) {
|
func TestSaveLoadRoundTrip_Certificates(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1072,7 +1073,8 @@ func TestConcurrentGetSet(t *testing.T) {
|
|||||||
wg.Wait()
|
wg.Wait()
|
||||||
}
|
}
|
||||||
|
|
||||||
// runConcurrentOps performs a series of get/set/delete operations for concurrency testing.
|
// runConcurrentOps performs a series of get/set/delete
|
||||||
|
// operations for concurrency testing.
|
||||||
func runConcurrentOps(s *state.State, key string, now time.Time) {
|
func runConcurrentOps(s *state.State, key string, now time.Time) {
|
||||||
const iterations = 50
|
const iterations = 50
|
||||||
|
|
||||||
|
|||||||
@@ -26,8 +26,11 @@ const tlsPort = 443
|
|||||||
// hoursPerDay converts days to hours for duration calculations.
|
// hoursPerDay converts days to hours for duration calculations.
|
||||||
const hoursPerDay = 24
|
const hoursPerDay = 24
|
||||||
|
|
||||||
// statusError is the status value recorded for failed checks.
|
// Status values recorded for nameserver and certificate checks.
|
||||||
const statusError = "error"
|
const (
|
||||||
|
statusOK = "ok"
|
||||||
|
statusError = "error"
|
||||||
|
)
|
||||||
|
|
||||||
// Params contains dependencies for Watcher.
|
// Params contains dependencies for Watcher.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
@@ -347,7 +350,7 @@ func buildHostnameState(
|
|||||||
for ns, recs := range records {
|
for ns, recs := range records {
|
||||||
hs.RecordsByNameserver[ns] = &state.NameserverRecordState{
|
hs.RecordsByNameserver[ns] = &state.NameserverRecordState{
|
||||||
Records: recs,
|
Records: recs,
|
||||||
Status: "ok",
|
Status: statusOK,
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -405,7 +408,7 @@ func (w *Watcher) detectNSDisappearances(
|
|||||||
current map[string]map[string][]string,
|
current map[string]map[string][]string,
|
||||||
) {
|
) {
|
||||||
for ns, prevNS := range prev.RecordsByNameserver {
|
for ns, prevNS := range prev.RecordsByNameserver {
|
||||||
if _, ok := current[ns]; ok || prevNS.Status != "ok" {
|
if _, ok := current[ns]; ok || prevNS.Status != statusOK {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -708,7 +711,7 @@ func (w *Watcher) handleTLSError(
|
|||||||
now time.Time,
|
now time.Time,
|
||||||
err error,
|
err error,
|
||||||
) {
|
) {
|
||||||
if hasPrev && !w.firstRun && prev.Status == "ok" {
|
if hasPrev && !w.firstRun && prev.Status == statusOK {
|
||||||
msg := fmt.Sprintf(
|
msg := fmt.Sprintf(
|
||||||
"Host: %s\nIP: %s\nError: %s",
|
"Host: %s\nIP: %s\nError: %s",
|
||||||
hostname, ip, err,
|
hostname, ip, err,
|
||||||
@@ -751,7 +754,7 @@ func (w *Watcher) handleTLSSuccess(
|
|||||||
Issuer: cert.Issuer,
|
Issuer: cert.Issuer,
|
||||||
NotAfter: cert.NotAfter,
|
NotAfter: cert.NotAfter,
|
||||||
SubjectAlternativeNames: cert.SubjectAlternativeNames,
|
SubjectAlternativeNames: cert.SubjectAlternativeNames,
|
||||||
Status: "ok",
|
Status: statusOK,
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user