Compare commits
1 Commits
fix/106-no
...
3959aedb6a
| Author | SHA1 | Date | |
|---|---|---|---|
| 3959aedb6a |
@@ -1,9 +1,5 @@
|
|||||||
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
|
||||||
@@ -18,7 +14,8 @@ 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:
|
||||||
@@ -30,5 +27,6 @@ linters:
|
|||||||
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
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ FROM golang@sha256:f6751d823c26342f9506c03797d2527668d095b0a15f1862cddb4d927a7a4
|
|||||||
|
|
||||||
RUN apk add --no-cache git make gcc musl-dev binutils-gold
|
RUN apk add --no-cache git make gcc musl-dev binutils-gold
|
||||||
|
|
||||||
# golangci-lint v2.12.2, 2026-08-07
|
# golangci-lint v2.10.1
|
||||||
RUN go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@c0d3ddc9cf3faa61a4e378e879ece580256d76e5
|
RUN go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@5d1e709b7be35cb2025444e19de266b056b7b7ee
|
||||||
# goimports v0.42.0
|
# goimports v0.42.0
|
||||||
RUN go install golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0
|
RUN go install golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0
|
||||||
|
|
||||||
|
|||||||
33
README.md
33
README.md
@@ -17,26 +17,6 @@ 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)
|
||||||
@@ -218,8 +198,7 @@ internal/
|
|||||||
- **Structured logging**: All logs use `log/slog` with JSON output in
|
- **Structured logging**: All logs use `log/slog` with JSON output in
|
||||||
production (TTY detection for development).
|
production (TTY detection for development).
|
||||||
- **Graceful shutdown**: All background goroutines respect context
|
- **Graceful shutdown**: All background goroutines respect context
|
||||||
cancellation and the fx lifecycle. In-flight notification deliveries
|
cancellation and the fx lifecycle.
|
||||||
are drained on shutdown, bounded by the shutdown timeout.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -453,14 +432,8 @@ docker run -d \
|
|||||||
from a previous cycle.
|
from a previous cycle.
|
||||||
4. **On change detection**: Send notifications to all configured
|
4. **On change detection**: Send notifications to all configured
|
||||||
endpoints, update in-memory state, persist to disk.
|
endpoints, update in-memory state, persist to disk.
|
||||||
5. **Shutdown**: Persist final state to disk, wait for in-flight
|
5. **Shutdown**: Persist final state to disk, complete in-flight
|
||||||
notification deliveries to complete, stop gracefully. The wait is
|
notifications, stop gracefully.
|
||||||
bounded by the fx shutdown timeout (15s by default): deliveries still
|
|
||||||
retrying against an unreachable endpoint when that expires are
|
|
||||||
abandoned, and the number abandoned is logged at warn level rather
|
|
||||||
than dropped silently. Notifications generated after shutdown has
|
|
||||||
begun are refused and logged, so a late burst cannot extend the
|
|
||||||
shutdown.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
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
|
||||||
|
|||||||
41
TODO.md
41
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,27 +28,15 @@ confirm make check still passes.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-09: in-flight notification deliveries are now drained at
|
- 2026-08-07: DNS mocking removed from the entire test suite; watcher
|
||||||
shutdown (#106): `notify.New` registers an fx `OnStop` hook that waits
|
tests now drive the real iterative resolver against live DNS and
|
||||||
on a `sync.WaitGroup` of tracked delivery goroutines, bounded by the
|
`TESTING.md` bans DNS mocks in every package (`remove-dns-mocking`
|
||||||
`OnStop` context; on expiry the outstanding count is logged at warn
|
branch)
|
||||||
level and parked retry backoffs are released instead of being dropped
|
|
||||||
silently, and deliveries submitted after the drain begins are refused
|
|
||||||
so shutdown cannot be extended indefinitely; an `OnStop` context that
|
|
||||||
is already expired on entry with nothing outstanding drains quietly
|
|
||||||
rather than warning about deliveries that were never abandoned
|
|
||||||
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
|
|
||||||
in `Dockerfile` and `script/bootstrap`); `.golangci.yml` set to the
|
|
||||||
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)
|
||||||
@@ -72,8 +63,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
|
||||||
@@ -157,6 +149,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,33 +17,13 @@ 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: "apex domain multi-part TLD",
|
{name: "hostname multi-part TLD", input: "api.example.co.uk", want: config.DNSNameTypeHostname},
|
||||||
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: "deeply nested hostname",
|
{name: "trailing dot stripped", input: "example.com.", want: config.DNSNameTypeDomain},
|
||||||
input: "a.b.c.example.com",
|
{name: "uppercase normalized", input: "WWW.Example.COM", want: config.DNSNameTypeHostname},
|
||||||
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,20 +25,6 @@ const (
|
|||||||
colorDefault = "#6c757d"
|
colorDefault = "#6c757d"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Priority strings used across multiple tests.
|
|
||||||
const (
|
|
||||||
prioError = "error"
|
|
||||||
prioWarning = "warning"
|
|
||||||
prioSuccess = "success"
|
|
||||||
prioInfo = "info"
|
|
||||||
prioUnknown = "unknown"
|
|
||||||
prioDefault = "default"
|
|
||||||
prioUrgent = "urgent"
|
|
||||||
)
|
|
||||||
|
|
||||||
// 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")
|
||||||
|
|
||||||
@@ -115,13 +101,13 @@ func TestNtfyPriority(t *testing.T) {
|
|||||||
input string
|
input string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, prioUrgent},
|
{"error", "urgent"},
|
||||||
{prioWarning, "high"},
|
{"warning", "high"},
|
||||||
{prioSuccess, prioDefault},
|
{"success", "default"},
|
||||||
{prioInfo, "low"},
|
{"info", "low"},
|
||||||
{"", prioDefault},
|
{"", "default"},
|
||||||
{prioUnknown, prioDefault},
|
{"unknown", "default"},
|
||||||
{"critical", prioDefault},
|
{"critical", "default"},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
@@ -148,12 +134,12 @@ func TestSlackColor(t *testing.T) {
|
|||||||
input string
|
input string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, colorError},
|
{"error", colorError},
|
||||||
{prioWarning, colorWarning},
|
{"warning", colorWarning},
|
||||||
{prioSuccess, colorSuccess},
|
{"success", colorSuccess},
|
||||||
{prioInfo, colorInfo},
|
{"info", colorInfo},
|
||||||
{"", colorDefault},
|
{"", colorDefault},
|
||||||
{prioUnknown, colorDefault},
|
{"unknown", colorDefault},
|
||||||
{"critical", colorDefault},
|
{"critical", colorDefault},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -179,7 +165,7 @@ func TestNewRequest(t *testing.T) {
|
|||||||
|
|
||||||
target := &url.URL{
|
target := &url.URL{
|
||||||
Scheme: "https",
|
Scheme: "https",
|
||||||
Host: testHost,
|
Host: "example.com",
|
||||||
Path: "/webhook",
|
Path: "/webhook",
|
||||||
}
|
}
|
||||||
body := bytes.NewBufferString("hello")
|
body := bytes.NewBufferString("hello")
|
||||||
@@ -201,9 +187,9 @@ func TestNewRequest(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if req.Host != testHost {
|
if req.Host != "example.com" {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"Host = %q, want %q", req.Host, testHost,
|
"Host = %q, want %q", req.Host, "example.com",
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -231,7 +217,7 @@ func TestNewRequestPreservesContext(t *testing.T) {
|
|||||||
ctxKey("k"),
|
ctxKey("k"),
|
||||||
"v",
|
"v",
|
||||||
)
|
)
|
||||||
target := &url.URL{Scheme: "https", Host: testHost}
|
target := &url.URL{Scheme: "https", Host: "example.com"}
|
||||||
|
|
||||||
req := notify.NewRequestForTest(
|
req := notify.NewRequestForTest(
|
||||||
ctx, http.MethodGet, target, http.NoBody,
|
ctx, http.MethodGet, target, http.NoBody,
|
||||||
@@ -303,10 +289,10 @@ func TestSendNtfyHeaders(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if captured.priority != prioUrgent {
|
if captured.priority != "urgent" {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"Priority header = %q, want %q",
|
"Priority header = %q, want %q",
|
||||||
captured.priority, prioUrgent,
|
captured.priority, "urgent",
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -325,10 +311,10 @@ func TestSendNtfyAllPriorities(t *testing.T) {
|
|||||||
input string
|
input string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, prioUrgent},
|
{"error", "urgent"},
|
||||||
{prioWarning, "high"},
|
{"warning", "high"},
|
||||||
{prioSuccess, prioDefault},
|
{"success", "default"},
|
||||||
{prioInfo, "low"},
|
{"info", "low"},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range priorities {
|
for _, tc := range priorities {
|
||||||
@@ -370,69 +356,56 @@ func TestSendNtfyAllPriorities(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// assertSendStatusError verifies that send returns an error
|
func TestSendNtfyClientError(t *testing.T) {
|
||||||
// wrapping wantErr when the server responds with status.
|
t.Parallel()
|
||||||
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(status)
|
w.WriteHeader(http.StatusForbidden)
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
svc := notify.NewTestService(srv.Client().Transport)
|
svc := notify.NewTestService(srv.Client().Transport)
|
||||||
target, _ := url.Parse(srv.URL)
|
topicURL, _ := url.Parse(srv.URL)
|
||||||
|
|
||||||
err := send(svc, target)
|
err := svc.SendNtfy(
|
||||||
|
context.Background(), topicURL, "t", "m", "info",
|
||||||
|
)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatalf("expected error for %d response", status)
|
t.Fatal("expected error for 403 response")
|
||||||
}
|
}
|
||||||
|
|
||||||
if !errors.Is(err, wantErr) {
|
if !errors.Is(err, notify.ErrNtfyFailed) {
|
||||||
t.Errorf("error = %v, want %v", err, wantErr)
|
t.Errorf("error = %v, want ErrNtfyFailed", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
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()
|
||||||
|
|
||||||
assertSendStatusError(
|
srv := httptest.NewServer(
|
||||||
t, http.StatusInternalServerError,
|
http.HandlerFunc(
|
||||||
notify.ErrNtfyFailed, sendNtfyInfo,
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
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) {
|
||||||
@@ -577,11 +550,11 @@ func TestSendSlackAllColors(t *testing.T) {
|
|||||||
priority string
|
priority string
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{prioError, colorError},
|
{"error", colorError},
|
||||||
{prioWarning, colorWarning},
|
{"warning", colorWarning},
|
||||||
{prioSuccess, colorSuccess},
|
{"success", colorSuccess},
|
||||||
{prioInfo, colorInfo},
|
{"info", colorInfo},
|
||||||
{prioUnknown, colorDefault},
|
{"unknown", colorDefault},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range colors {
|
for _, tc := range colors {
|
||||||
@@ -633,19 +606,53 @@ func TestSendSlackAllColors(t *testing.T) {
|
|||||||
func TestSendSlackClientError(t *testing.T) {
|
func TestSendSlackClientError(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
assertSendStatusError(
|
srv := httptest.NewServer(
|
||||||
t, http.StatusBadRequest,
|
http.HandlerFunc(
|
||||||
notify.ErrSlackFailed, sendSlackInfo,
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
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()
|
||||||
|
|
||||||
assertSendStatusError(
|
srv := httptest.NewServer(
|
||||||
t, http.StatusBadGateway,
|
http.HandlerFunc(
|
||||||
notify.ErrSlackFailed, sendSlackInfo,
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
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) {
|
||||||
@@ -970,62 +977,74 @@ func TestSendNotificationMattermostOnly(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// assertSendNotificationTolerates verifies SendNotification
|
func TestSendNotificationNtfyError(t *testing.T) {
|
||||||
// neither panics nor blocks when the endpoint configured by
|
t.Parallel()
|
||||||
// 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(status)
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
target, _ := url.Parse(srv.URL)
|
ntfyURL, _ := url.Parse(srv.URL)
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
svc := notify.NewTestService(http.DefaultTransport)
|
||||||
setURL(svc, target)
|
svc.SetNtfyURL(ntfyURL)
|
||||||
|
|
||||||
|
// Should not panic or block.
|
||||||
svc.SendNotification(
|
svc.SendNotification(
|
||||||
context.Background(), "t", "m", priority,
|
context.Background(), "t", "m", "error",
|
||||||
)
|
)
|
||||||
|
|
||||||
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()
|
||||||
|
|
||||||
assertSendNotificationTolerates(
|
srv := httptest.NewServer(
|
||||||
t, http.StatusForbidden, prioError,
|
http.HandlerFunc(
|
||||||
(*notify.Service).SetSlackWebhookURL,
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
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()
|
||||||
|
|
||||||
assertSendNotificationTolerates(
|
srv := httptest.NewServer(
|
||||||
t, http.StatusBadGateway, prioWarning,
|
http.HandlerFunc(
|
||||||
(*notify.Service).SetMattermostWebhookURL,
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
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 ──────────────────────────
|
||||||
|
|||||||
@@ -32,27 +32,11 @@ func NewRequestForTest(
|
|||||||
// NewTestService creates a Service suitable for unit testing.
|
// NewTestService creates a Service suitable for unit testing.
|
||||||
// It discards log output and uses the given transport.
|
// It discards log output and uses the given transport.
|
||||||
func NewTestService(transport http.RoundTripper) *Service {
|
func NewTestService(transport http.RoundTripper) *Service {
|
||||||
return newService(slog.New(slog.DiscardHandler), transport)
|
return &Service{
|
||||||
|
log: slog.New(slog.DiscardHandler),
|
||||||
|
transport: transport,
|
||||||
|
history: NewAlertHistory(),
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTestServiceWithLogger creates a Service that writes to the
|
|
||||||
// given handler, so tests can assert on emitted log records.
|
|
||||||
func NewTestServiceWithLogger(
|
|
||||||
transport http.RoundTripper,
|
|
||||||
handler slog.Handler,
|
|
||||||
) *Service {
|
|
||||||
return newService(slog.New(handler), transport)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Drain exports drain for testing.
|
|
||||||
func (svc *Service) Drain(ctx context.Context) {
|
|
||||||
svc.drain(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// OutstandingDeliveries reports how many delivery goroutines
|
|
||||||
// are currently tracked as in flight.
|
|
||||||
func (svc *Service) OutstandingDeliveries() int64 {
|
|
||||||
return svc.outstanding.Load()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetNtfyURL sets the ntfy URL on a Service for testing.
|
// SetNtfyURL sets the ntfy URL on a Service for testing.
|
||||||
|
|||||||
@@ -29,14 +29,14 @@ func TestAlertHistoryAddAndRecent(t *testing.T) {
|
|||||||
Timestamp: now.Add(-2 * time.Minute),
|
Timestamp: now.Add(-2 * time.Minute),
|
||||||
Title: "first",
|
Title: "first",
|
||||||
Message: "msg1",
|
Message: "msg1",
|
||||||
Priority: prioInfo,
|
Priority: "info",
|
||||||
})
|
})
|
||||||
|
|
||||||
h.Add(notify.AlertEntry{
|
h.Add(notify.AlertEntry{
|
||||||
Timestamp: now.Add(-1 * time.Minute),
|
Timestamp: now.Add(-1 * time.Minute),
|
||||||
Title: "second",
|
Title: "second",
|
||||||
Message: "msg2",
|
Message: "msg2",
|
||||||
Priority: prioWarning,
|
Priority: "warning",
|
||||||
})
|
})
|
||||||
|
|
||||||
entries := h.Recent()
|
entries := h.Recent()
|
||||||
|
|||||||
@@ -12,8 +12,6 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -117,41 +115,19 @@ type Service struct {
|
|||||||
history *AlertHistory
|
history *AlertHistory
|
||||||
retryConfig RetryConfig
|
retryConfig RetryConfig
|
||||||
sleepFn func(time.Duration) <-chan time.Time
|
sleepFn func(time.Duration) <-chan time.Time
|
||||||
|
|
||||||
// Shutdown draining state. drainMu guards draining and
|
|
||||||
// serialises it against the counter increment in
|
|
||||||
// startDelivery; inFlight tracks the delivery goroutines
|
|
||||||
// themselves and outstanding mirrors its count so a timed
|
|
||||||
// out drain can report how many were abandoned.
|
|
||||||
drainMu sync.Mutex
|
|
||||||
draining bool
|
|
||||||
inFlight sync.WaitGroup
|
|
||||||
outstanding atomic.Int64
|
|
||||||
abandon chan struct{}
|
|
||||||
abandonOnce sync.Once
|
|
||||||
}
|
|
||||||
|
|
||||||
// newService builds a Service with the fields every Service
|
|
||||||
// needs regardless of how it was constructed.
|
|
||||||
func newService(
|
|
||||||
log *slog.Logger,
|
|
||||||
transport http.RoundTripper,
|
|
||||||
) *Service {
|
|
||||||
return &Service{
|
|
||||||
log: log,
|
|
||||||
transport: transport,
|
|
||||||
history: NewAlertHistory(),
|
|
||||||
abandon: make(chan struct{}),
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new notify Service.
|
// New creates a new notify Service.
|
||||||
func New(
|
func New(
|
||||||
lifecycle fx.Lifecycle,
|
_ fx.Lifecycle,
|
||||||
params Params,
|
params Params,
|
||||||
) (*Service, error) {
|
) (*Service, error) {
|
||||||
svc := newService(params.Logger.Get(), http.DefaultTransport)
|
svc := &Service{
|
||||||
svc.config = params.Config
|
log: params.Logger.Get(),
|
||||||
|
transport: http.DefaultTransport,
|
||||||
|
config: params.Config,
|
||||||
|
history: NewAlertHistory(),
|
||||||
|
}
|
||||||
|
|
||||||
if params.Config.NtfyTopic != "" {
|
if params.Config.NtfyTopic != "" {
|
||||||
u, err := ValidateWebhookURL(
|
u, err := ValidateWebhookURL(
|
||||||
@@ -192,14 +168,6 @@ func New(
|
|||||||
svc.mattermostWebhookURL = u
|
svc.mattermostWebhookURL = u
|
||||||
}
|
}
|
||||||
|
|
||||||
lifecycle.Append(fx.Hook{
|
|
||||||
OnStop: func(ctx context.Context) error {
|
|
||||||
svc.drain(ctx)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
return svc, nil
|
return svc, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -226,32 +194,6 @@ func (svc *Service) SendNotification(
|
|||||||
svc.dispatchMattermost(ctx, title, message, priority)
|
svc.dispatchMattermost(ctx, title, message, priority)
|
||||||
}
|
}
|
||||||
|
|
||||||
// dispatch delivers a notification to one endpoint on a
|
|
||||||
// tracked background goroutine.
|
|
||||||
//
|
|
||||||
// The delivery context is detached from ctx with
|
|
||||||
// context.WithoutCancel so that a cancelled caller does not
|
|
||||||
// kill a delivery already under way; the shutdown drain, not
|
|
||||||
// the caller, decides how long deliveries may keep running.
|
|
||||||
func (svc *Service) dispatch(
|
|
||||||
ctx context.Context,
|
|
||||||
endpoint string,
|
|
||||||
send func(context.Context) error,
|
|
||||||
) {
|
|
||||||
notifyCtx := context.WithoutCancel(ctx)
|
|
||||||
|
|
||||||
svc.startDelivery(endpoint, func() {
|
|
||||||
err := svc.deliverWithRetry(notifyCtx, endpoint, send)
|
|
||||||
if err != nil {
|
|
||||||
svc.log.Error(
|
|
||||||
"failed to send notification after retries",
|
|
||||||
"endpoint", endpoint,
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func (svc *Service) dispatchNtfy(
|
func (svc *Service) dispatchNtfy(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
title, message, priority string,
|
title, message, priority string,
|
||||||
@@ -260,11 +202,26 @@ func (svc *Service) dispatchNtfy(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.dispatch(ctx, "ntfy", func(c context.Context) error {
|
go func() {
|
||||||
|
notifyCtx := context.WithoutCancel(ctx)
|
||||||
|
|
||||||
|
err := svc.deliverWithRetry(
|
||||||
|
notifyCtx, "ntfy",
|
||||||
|
func(c context.Context) error {
|
||||||
return svc.sendNtfy(
|
return svc.sendNtfy(
|
||||||
c, svc.ntfyURL, title, message, priority,
|
c, svc.ntfyURL,
|
||||||
|
title, message, priority,
|
||||||
)
|
)
|
||||||
})
|
},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
svc.log.Error(
|
||||||
|
"failed to send ntfy notification "+
|
||||||
|
"after retries",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (svc *Service) dispatchSlack(
|
func (svc *Service) dispatchSlack(
|
||||||
@@ -275,11 +232,26 @@ func (svc *Service) dispatchSlack(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.dispatch(ctx, "slack", func(c context.Context) error {
|
go func() {
|
||||||
|
notifyCtx := context.WithoutCancel(ctx)
|
||||||
|
|
||||||
|
err := svc.deliverWithRetry(
|
||||||
|
notifyCtx, "slack",
|
||||||
|
func(c context.Context) error {
|
||||||
return svc.sendSlack(
|
return svc.sendSlack(
|
||||||
c, svc.slackWebhookURL, title, message, priority,
|
c, svc.slackWebhookURL,
|
||||||
|
title, message, priority,
|
||||||
)
|
)
|
||||||
})
|
},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
svc.log.Error(
|
||||||
|
"failed to send slack notification "+
|
||||||
|
"after retries",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (svc *Service) dispatchMattermost(
|
func (svc *Service) dispatchMattermost(
|
||||||
@@ -290,8 +262,11 @@ func (svc *Service) dispatchMattermost(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.dispatch(
|
go func() {
|
||||||
ctx, "mattermost",
|
notifyCtx := context.WithoutCancel(ctx)
|
||||||
|
|
||||||
|
err := svc.deliverWithRetry(
|
||||||
|
notifyCtx, "mattermost",
|
||||||
func(c context.Context) error {
|
func(c context.Context) error {
|
||||||
return svc.sendSlack(
|
return svc.sendSlack(
|
||||||
c, svc.mattermostWebhookURL,
|
c, svc.mattermostWebhookURL,
|
||||||
@@ -299,6 +274,14 @@ func (svc *Service) dispatchMattermost(
|
|||||||
)
|
)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
if err != nil {
|
||||||
|
svc.log.Error(
|
||||||
|
"failed to send mattermost notification "+
|
||||||
|
"after retries",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (svc *Service) sendNtfy(
|
func (svc *Service) sendNtfy(
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package notify
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"math"
|
"math"
|
||||||
"math/rand/v2"
|
"math/rand/v2"
|
||||||
"time"
|
"time"
|
||||||
@@ -70,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 needs no crypto/rand
|
jittered := lo + rand.Float64()*(hi-lo) //nolint:gosec // jitter does not need crypto/rand
|
||||||
|
|
||||||
return time.Duration(jittered)
|
return time.Duration(jittered)
|
||||||
}
|
}
|
||||||
@@ -122,14 +121,6 @@ func (svc *Service) deliverWithRetry(
|
|||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return ctx.Err()
|
return ctx.Err()
|
||||||
case <-svc.abandon:
|
|
||||||
// Shutdown drained past its deadline; stop
|
|
||||||
// sleeping rather than outlive the process.
|
|
||||||
// A nil channel (Service built without a
|
|
||||||
// constructor) simply never fires.
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: %s", ErrDeliveryAbandoned, endpoint,
|
|
||||||
)
|
|
||||||
case <-svc.sleepFunc(delay):
|
case <-svc.sleepFunc(delay):
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,119 +0,0 @@
|
|||||||
package notify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrDeliveryAbandoned is returned by a retry loop that was
|
|
||||||
// cut short because shutdown drained past its deadline.
|
|
||||||
var ErrDeliveryAbandoned = errors.New(
|
|
||||||
"notification delivery abandoned at shutdown",
|
|
||||||
)
|
|
||||||
|
|
||||||
// startDelivery runs fn on its own goroutine while tracking it,
|
|
||||||
// so that drain can wait for it during shutdown.
|
|
||||||
//
|
|
||||||
// The WaitGroup counter is incremented here, on the caller's
|
|
||||||
// goroutine, before the worker exists: incrementing it inside
|
|
||||||
// the worker would race with drain's Wait and could let
|
|
||||||
// shutdown sail past a delivery that had not started yet.
|
|
||||||
//
|
|
||||||
// Once draining has begun the delivery is refused outright
|
|
||||||
// rather than queued, so a steady stream of newly submitted
|
|
||||||
// notifications cannot keep extending the drain.
|
|
||||||
func (svc *Service) startDelivery(endpoint string, fn func()) {
|
|
||||||
svc.drainMu.Lock()
|
|
||||||
|
|
||||||
if svc.draining {
|
|
||||||
svc.drainMu.Unlock()
|
|
||||||
|
|
||||||
svc.log.Warn(
|
|
||||||
"notification not dispatched: shutdown in progress",
|
|
||||||
"endpoint", endpoint,
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
svc.outstanding.Add(1)
|
|
||||||
|
|
||||||
// WaitGroup.Go increments the counter synchronously, here,
|
|
||||||
// and only then starts the goroutine.
|
|
||||||
svc.inFlight.Go(func() {
|
|
||||||
// Runs before the WaitGroup counter is decremented, so
|
|
||||||
// a drain that times out reports an accurate count.
|
|
||||||
defer svc.outstanding.Add(-1)
|
|
||||||
|
|
||||||
fn()
|
|
||||||
})
|
|
||||||
|
|
||||||
svc.drainMu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// drain waits for in-flight notification deliveries to finish.
|
|
||||||
//
|
|
||||||
// It first stops accepting new deliveries, then waits until
|
|
||||||
// either every outstanding delivery has completed or ctx
|
|
||||||
// expires — whichever comes first. ctx is the context fx
|
|
||||||
// passes to the OnStop hook, so a permanently dead webhook
|
|
||||||
// cannot hang shutdown indefinitely.
|
|
||||||
//
|
|
||||||
// When the deadline arrives with deliveries still outstanding,
|
|
||||||
// the count is logged at warn level and the abandon channel is
|
|
||||||
// closed, which releases any retry loop sleeping in backoff.
|
|
||||||
// Deliveries already inside an HTTP round trip are bounded by
|
|
||||||
// the existing httpClientTimeout instead.
|
|
||||||
//
|
|
||||||
// A ctx that is already expired on entry is not by itself cause
|
|
||||||
// for alarm: if nothing is outstanding there is nothing to
|
|
||||||
// abandon, and the drain says so at debug level rather than
|
|
||||||
// warning about deliveries that do not exist.
|
|
||||||
func (svc *Service) drain(ctx context.Context) {
|
|
||||||
svc.drainMu.Lock()
|
|
||||||
svc.draining = true
|
|
||||||
svc.drainMu.Unlock()
|
|
||||||
|
|
||||||
done := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
svc.inFlight.Wait()
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
svc.log.Debug(
|
|
||||||
"all in-flight notifications completed",
|
|
||||||
)
|
|
||||||
case <-ctx.Done():
|
|
||||||
// outstanding is decremented before the WaitGroup
|
|
||||||
// counter, and startDelivery can no longer add to it
|
|
||||||
// now that draining is set, so a zero here means every
|
|
||||||
// delivery really did finish. ctx expiring in that
|
|
||||||
// state (an OnStop context that was already cancelled
|
|
||||||
// on entry is the usual way) abandons nothing, so it
|
|
||||||
// must not close abandon or warn about it.
|
|
||||||
abandoned := svc.outstanding.Load()
|
|
||||||
if abandoned == 0 {
|
|
||||||
svc.log.Debug(
|
|
||||||
"all in-flight notifications completed",
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
svc.abandonOnce.Do(func() {
|
|
||||||
if svc.abandon != nil {
|
|
||||||
close(svc.abandon)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
svc.log.Warn(
|
|
||||||
"shutdown deadline reached with notifications "+
|
|
||||||
"still in flight; abandoning them",
|
|
||||||
"abandoned", abandoned,
|
|
||||||
"error", ctx.Err(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,531 +0,0 @@
|
|||||||
package notify_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"go.uber.org/fx"
|
|
||||||
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/config"
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/globals"
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/logger"
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/notify"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Timings used by the drain tests. They stay in the same
|
|
||||||
// 10-100ms band as the retry tests so the suite never waits on
|
|
||||||
// a real backoff delay.
|
|
||||||
const (
|
|
||||||
// inFlightHold is how long a delivery is kept mid-request
|
|
||||||
// before the handler is released.
|
|
||||||
inFlightHold = 30 * time.Millisecond
|
|
||||||
|
|
||||||
// drainDeadline bounds a drain that is expected to time
|
|
||||||
// out.
|
|
||||||
drainDeadline = 50 * time.Millisecond
|
|
||||||
|
|
||||||
// drainSlack is the upper bound on how long a bounded
|
|
||||||
// drain may take; generous enough for a loaded CI box,
|
|
||||||
// still far below the 20s test ceiling.
|
|
||||||
drainSlack = 2 * time.Second
|
|
||||||
|
|
||||||
// settleDelay is how long to wait before asserting that
|
|
||||||
// something did *not* happen.
|
|
||||||
settleDelay = 50 * time.Millisecond
|
|
||||||
|
|
||||||
// idleDrainBound is the upper bound on a drain that has
|
|
||||||
// nothing in flight. It is deliberately far above the cost
|
|
||||||
// of the goroutine hop through inFlight.Wait() — which
|
|
||||||
// reached 57ms on a loaded box under -race with the package's
|
|
||||||
// parallel tests — and far below drainSlack, the deadline
|
|
||||||
// such a drain is given. A drain that blocked until its
|
|
||||||
// deadline instead of returning on the WaitGroup therefore
|
|
||||||
// still fails this bound, but scheduling delay alone cannot.
|
|
||||||
idleDrainBound = 500 * time.Millisecond
|
|
||||||
)
|
|
||||||
|
|
||||||
// syncBuffer is an io.Writer safe for concurrent use, so log
|
|
||||||
// output written from delivery goroutines can be inspected.
|
|
||||||
type syncBuffer struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
buf bytes.Buffer
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sb *syncBuffer) Write(p []byte) (int, error) {
|
|
||||||
sb.mu.Lock()
|
|
||||||
defer sb.mu.Unlock()
|
|
||||||
|
|
||||||
return sb.buf.Write(p) //nolint:wrapcheck // test helper
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sb *syncBuffer) String() string {
|
|
||||||
sb.mu.Lock()
|
|
||||||
defer sb.mu.Unlock()
|
|
||||||
|
|
||||||
return sb.buf.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// newLoggingService returns a Service writing JSON logs into
|
|
||||||
// the returned buffer.
|
|
||||||
func newLoggingService(
|
|
||||||
transport http.RoundTripper,
|
|
||||||
) (*notify.Service, *syncBuffer) {
|
|
||||||
logs := &syncBuffer{}
|
|
||||||
handler := slog.NewJSONHandler(logs, nil)
|
|
||||||
|
|
||||||
return notify.NewTestServiceWithLogger(transport, handler),
|
|
||||||
logs
|
|
||||||
}
|
|
||||||
|
|
||||||
// blockingNtfyServer returns a server whose handler signals on
|
|
||||||
// entered, waits for release, and then responds 200.
|
|
||||||
func blockingNtfyServer(
|
|
||||||
entered chan<- struct{},
|
|
||||||
release <-chan struct{},
|
|
||||||
served *atomic.Bool,
|
|
||||||
) *httptest.Server {
|
|
||||||
var once sync.Once
|
|
||||||
|
|
||||||
return httptest.NewServer(
|
|
||||||
http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
once.Do(func() { close(entered) })
|
|
||||||
<-release
|
|
||||||
|
|
||||||
served.Store(true)
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDrainWaitsForInFlightDelivery verifies that a delivery
|
|
||||||
// already under way when shutdown starts is allowed to finish.
|
|
||||||
func TestDrainWaitsForInFlightDelivery(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var served atomic.Bool
|
|
||||||
|
|
||||||
entered := make(chan struct{})
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
srv := blockingNtfyServer(entered, release, &served)
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
topicURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
|
||||||
svc.SetNtfyURL(topicURL)
|
|
||||||
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", prioInfo,
|
|
||||||
)
|
|
||||||
|
|
||||||
// Make sure the delivery really is mid-request before the
|
|
||||||
// drain begins.
|
|
||||||
select {
|
|
||||||
case <-entered:
|
|
||||||
case <-time.After(drainSlack):
|
|
||||||
t.Fatal("delivery never reached the endpoint")
|
|
||||||
}
|
|
||||||
|
|
||||||
// As in TestDrainBoundedByContextDeadline: start is captured
|
|
||||||
// before the clock it is compared against, here the timer
|
|
||||||
// holding the delivery open, so elapsed covers the whole hold
|
|
||||||
// and the lower bound cannot come out short from scheduling
|
|
||||||
// delay alone.
|
|
||||||
start := time.Now()
|
|
||||||
|
|
||||||
timer := time.AfterFunc(inFlightHold, func() {
|
|
||||||
close(release)
|
|
||||||
})
|
|
||||||
defer timer.Stop()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), drainSlack,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
svc.Drain(ctx)
|
|
||||||
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
|
|
||||||
if !served.Load() {
|
|
||||||
t.Error(
|
|
||||||
"drain returned before the in-flight delivery " +
|
|
||||||
"completed",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if elapsed < inFlightHold {
|
|
||||||
t.Errorf(
|
|
||||||
"drain took %v, want at least %v",
|
|
||||||
elapsed, inFlightHold,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := svc.OutstandingDeliveries(); got != 0 {
|
|
||||||
t.Errorf("outstanding deliveries = %d, want 0", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// neverFires returns a channel that never delivers, standing in
|
|
||||||
// for a long backoff sleep without actually sleeping.
|
|
||||||
func neverFires(_ time.Duration) <-chan time.Time {
|
|
||||||
return make(chan time.Time)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDrainBoundedByContextDeadline verifies that a delivery
|
|
||||||
// stuck retrying against a dead endpoint does not hold shutdown
|
|
||||||
// past the OnStop context deadline, and that the abandoned
|
|
||||||
// deliveries are logged at warn level rather than dropped
|
|
||||||
// silently.
|
|
||||||
func TestDrainBoundedByContextDeadline(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var requests atomic.Int64
|
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
|
||||||
http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
requests.Add(1)
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusInternalServerError)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
topicURL, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
svc, logs := newLoggingService(http.DefaultTransport)
|
|
||||||
svc.SetNtfyURL(topicURL)
|
|
||||||
// Never let the backoff sleep complete: the delivery is
|
|
||||||
// parked in its retry wait until shutdown releases it.
|
|
||||||
svc.SetSleepFunc(neverFires)
|
|
||||||
svc.SetRetryConfig(notify.RetryConfig{
|
|
||||||
MaxRetries: 5,
|
|
||||||
BaseDelay: time.Hour,
|
|
||||||
MaxDelay: time.Hour,
|
|
||||||
})
|
|
||||||
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", prioError,
|
|
||||||
)
|
|
||||||
|
|
||||||
waitForCondition(t, func() bool {
|
|
||||||
return requests.Load() >= 1 &&
|
|
||||||
svc.OutstandingDeliveries() == 1
|
|
||||||
})
|
|
||||||
|
|
||||||
// start must be captured *before* the deadline clock starts,
|
|
||||||
// so that the measured interval is a superset of the deadline
|
|
||||||
// interval. Capturing it after context.WithTimeout would
|
|
||||||
// make elapsed structurally smaller than drainDeadline and
|
|
||||||
// the lower bound below unfalsifiable-by-luck: it would fail
|
|
||||||
// whenever the two statements were separated by any
|
|
||||||
// scheduling delay, and pass otherwise, regardless of what
|
|
||||||
// the drain did.
|
|
||||||
start := time.Now()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), drainDeadline,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
// The upper bound is enforced by a watchdog rather than by
|
|
||||||
// measuring after the fact: a drain that is not bounded at
|
|
||||||
// all never returns here (the delivery is parked in a backoff
|
|
||||||
// that never fires), so an unbounded drain must fail this
|
|
||||||
// test promptly instead of hanging the package until the test
|
|
||||||
// binary's 30s timeout.
|
|
||||||
returned := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
defer close(returned)
|
|
||||||
|
|
||||||
svc.Drain(ctx)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-returned:
|
|
||||||
case <-time.After(drainSlack):
|
|
||||||
t.Fatalf(
|
|
||||||
"drain did not return within %v; its %v deadline "+
|
|
||||||
"did not bound it",
|
|
||||||
drainSlack, drainDeadline,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The lower bound is the real assertion: the drain must have
|
|
||||||
// waited for its whole deadline rather than giving up on the
|
|
||||||
// outstanding delivery early. With start captured above, an
|
|
||||||
// early return is the only thing that can make it fail.
|
|
||||||
if elapsed := time.Since(start); elapsed < drainDeadline {
|
|
||||||
t.Errorf(
|
|
||||||
"drain returned after %v, before its %v deadline",
|
|
||||||
elapsed, drainDeadline,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertAbandonLogged(t, logs.String())
|
|
||||||
|
|
||||||
// The abandoned delivery must stop retrying rather than
|
|
||||||
// outlive the drain.
|
|
||||||
waitForCondition(t, func() bool {
|
|
||||||
return svc.OutstandingDeliveries() == 0
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertAbandonLogged checks that the drain logged the
|
|
||||||
// abandoned deliveries at warn level with a count.
|
|
||||||
func assertAbandonLogged(t *testing.T, output string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
if !strings.Contains(output, `"level":"WARN"`) {
|
|
||||||
t.Errorf(
|
|
||||||
"abandoned deliveries not logged at warn level; "+
|
|
||||||
"log output: %s",
|
|
||||||
output,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(output, `"abandoned":1`) {
|
|
||||||
t.Errorf(
|
|
||||||
"abandoned delivery count not logged; "+
|
|
||||||
"log output: %s",
|
|
||||||
output,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDrainRefusesNewDeliveries verifies that notifications
|
|
||||||
// submitted after the drain has begun are refused and logged,
|
|
||||||
// so a stream of new work cannot extend shutdown indefinitely.
|
|
||||||
func TestDrainRefusesNewDeliveries(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var requests atomic.Int64
|
|
||||||
|
|
||||||
srv := httptest.NewServer(
|
|
||||||
http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
requests.Add(1)
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
target, _ := url.Parse(srv.URL)
|
|
||||||
|
|
||||||
svc, logs := newLoggingService(http.DefaultTransport)
|
|
||||||
svc.SetNtfyURL(target)
|
|
||||||
svc.SetSlackWebhookURL(target)
|
|
||||||
svc.SetMattermostWebhookURL(target)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), drainSlack,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
// Nothing is in flight, so this returns immediately and
|
|
||||||
// leaves the service refusing further deliveries.
|
|
||||||
svc.Drain(ctx)
|
|
||||||
|
|
||||||
for range 3 {
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", prioInfo,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(settleDelay)
|
|
||||||
|
|
||||||
if got := requests.Load(); got != 0 {
|
|
||||||
t.Errorf(
|
|
||||||
"%d requests reached the endpoint after drain, "+
|
|
||||||
"want 0",
|
|
||||||
got,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := svc.OutstandingDeliveries(); got != 0 {
|
|
||||||
t.Errorf("outstanding deliveries = %d, want 0", got)
|
|
||||||
}
|
|
||||||
|
|
||||||
output := logs.String()
|
|
||||||
if !strings.Contains(output, "shutdown in progress") {
|
|
||||||
t.Errorf(
|
|
||||||
"refused deliveries not logged; log output: %s",
|
|
||||||
output,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// recordingLifecycle is a minimal fx.Lifecycle that records the
|
|
||||||
// hooks appended to it, so the wiring done by notify.New can be
|
|
||||||
// inspected without standing up a whole fx application.
|
|
||||||
type recordingLifecycle struct {
|
|
||||||
hooks []fx.Hook
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l *recordingLifecycle) Append(hook fx.Hook) {
|
|
||||||
l.hooks = append(l.hooks, hook)
|
|
||||||
}
|
|
||||||
|
|
||||||
// newNotifyService builds a Service through the real
|
|
||||||
// constructor, wired to the given lifecycle.
|
|
||||||
func newNotifyService(
|
|
||||||
t *testing.T,
|
|
||||||
lifecycle fx.Lifecycle,
|
|
||||||
ntfyTopic string,
|
|
||||||
) *notify.Service {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
g, err := globals.New(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("globals.New: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
log, err := logger.New(nil, logger.Params{Globals: g})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("logger.New: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
svc, err := notify.New(lifecycle, notify.Params{
|
|
||||||
Logger: log,
|
|
||||||
Config: &config.Config{NtfyTopic: ntfyTopic},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("notify.New: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return svc
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewRegistersDrainingStopHook verifies that notify.New
|
|
||||||
// wires an OnStop hook into the fx lifecycle and that the hook
|
|
||||||
// waits for in-flight deliveries.
|
|
||||||
func TestNewRegistersDrainingStopHook(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var served atomic.Bool
|
|
||||||
|
|
||||||
entered := make(chan struct{})
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
srv := blockingNtfyServer(entered, release, &served)
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
lifecycle := &recordingLifecycle{}
|
|
||||||
svc := newNotifyService(t, lifecycle, srv.URL)
|
|
||||||
|
|
||||||
if len(lifecycle.hooks) != 1 {
|
|
||||||
t.Fatalf(
|
|
||||||
"appended %d lifecycle hooks, want 1",
|
|
||||||
len(lifecycle.hooks),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
stop := lifecycle.hooks[0].OnStop
|
|
||||||
if stop == nil {
|
|
||||||
t.Fatal("lifecycle hook has no OnStop function")
|
|
||||||
}
|
|
||||||
|
|
||||||
svc.SendNotification(
|
|
||||||
context.Background(), "t", "m", prioInfo,
|
|
||||||
)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-entered:
|
|
||||||
case <-time.After(drainSlack):
|
|
||||||
t.Fatal("delivery never reached the endpoint")
|
|
||||||
}
|
|
||||||
|
|
||||||
timer := time.AfterFunc(inFlightHold, func() {
|
|
||||||
close(release)
|
|
||||||
})
|
|
||||||
defer timer.Stop()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), drainSlack,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
err := stop(ctx)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("OnStop returned error: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !served.Load() {
|
|
||||||
t.Error(
|
|
||||||
"OnStop returned before the in-flight delivery " +
|
|
||||||
"completed",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDrainWithoutDeliveriesReturnsImmediately verifies the
|
|
||||||
// common case: nothing in flight, shutdown is not delayed.
|
|
||||||
func TestDrainWithoutDeliveriesReturnsImmediately(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
svc := notify.NewTestService(http.DefaultTransport)
|
|
||||||
|
|
||||||
// Captured before the deadline clock, as elsewhere in this
|
|
||||||
// file; for an upper bound that is the conservative
|
|
||||||
// direction, since the measured interval can then only be
|
|
||||||
// longer than the drain itself.
|
|
||||||
start := time.Now()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), drainSlack,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
svc.Drain(ctx)
|
|
||||||
|
|
||||||
if elapsed := time.Since(start); elapsed > idleDrainBound {
|
|
||||||
t.Errorf(
|
|
||||||
"drain of an idle service took %v, want well "+
|
|
||||||
"under its %v deadline",
|
|
||||||
elapsed, drainSlack,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDrainWithCancelledContextDoesNotWarn verifies that an
|
|
||||||
// OnStop context that is already dead on entry does not produce
|
|
||||||
// an "abandoning them" warning when there was nothing in flight
|
|
||||||
// to abandon. The expired context wins the select immediately,
|
|
||||||
// so only the outstanding count can tell the difference between
|
|
||||||
// a genuine timeout and a shutdown that had simply already run
|
|
||||||
// out of time with no work left.
|
|
||||||
func TestDrainWithCancelledContextDoesNotWarn(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
svc, logs := newLoggingService(http.DefaultTransport)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
svc.Drain(ctx)
|
|
||||||
|
|
||||||
if output := logs.String(); strings.Contains(
|
|
||||||
output, `"level":"WARN"`,
|
|
||||||
) {
|
|
||||||
t.Errorf(
|
|
||||||
"drain with nothing in flight warned about "+
|
|
||||||
"abandoned deliveries; log output: %s",
|
|
||||||
output,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -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()
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ import (
|
|||||||
|
|
||||||
const testHostname = "www.example.com"
|
const testHostname = "www.example.com"
|
||||||
|
|
||||||
// Shared fixture values used across tests.
|
|
||||||
const (
|
|
||||||
testNS1 = "ns1.example.com."
|
|
||||||
testNS2 = "ns2.example.com."
|
|
||||||
testAltNS1 = "ns1.test.com."
|
|
||||||
testIPv4 = "93.184.216.34"
|
|
||||||
testIP = "1.2.3.4"
|
|
||||||
statusError = "error"
|
|
||||||
)
|
|
||||||
|
|
||||||
// populateState fills a State with representative test data across all categories.
|
// populateState fills a State with representative test data across all categories.
|
||||||
func populateState(t *testing.T, s *state.State) {
|
func populateState(t *testing.T, s *state.State) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
@@ -30,7 +20,7 @@ func populateState(t *testing.T, s *state.State) {
|
|||||||
now := time.Now().UTC().Truncate(time.Second)
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
|
|
||||||
s.SetDomainState("example.com", &state.DomainState{
|
s.SetDomainState("example.com", &state.DomainState{
|
||||||
Nameservers: []string{testNS1, testNS2},
|
Nameservers: []string{"ns1.example.com.", "ns2.example.com."},
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -41,17 +31,17 @@ func populateState(t *testing.T, s *state.State) {
|
|||||||
|
|
||||||
s.SetHostnameState(testHostname, &state.HostnameState{
|
s.SetHostnameState(testHostname, &state.HostnameState{
|
||||||
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
||||||
testNS1: {
|
"ns1.example.com.": {
|
||||||
Records: map[string][]string{
|
Records: map[string][]string{
|
||||||
"A": {testIPv4},
|
"A": {"93.184.216.34"},
|
||||||
"AAAA": {"2606:2800:220:1:248:1893:25c8:1946"},
|
"AAAA": {"2606:2800:220:1:248:1893:25c8:1946"},
|
||||||
},
|
},
|
||||||
Status: "ok",
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
testNS2: {
|
"ns2.example.com.": {
|
||||||
Records: map[string][]string{
|
Records: map[string][]string{
|
||||||
"A": {testIPv4},
|
"A": {"93.184.216.34"},
|
||||||
},
|
},
|
||||||
Status: "ok",
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
@@ -162,13 +152,13 @@ func TestSaveLoadRoundTrip_Hostnames(t *testing.T) {
|
|||||||
func verifyNS1Records(t *testing.T, hn *state.HostnameState) {
|
func verifyNS1Records(t *testing.T, hn *state.HostnameState) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
ns1, ok := hn.RecordsByNameserver[testNS1]
|
ns1, ok := hn.RecordsByNameserver["ns1.example.com."]
|
||||||
if !ok {
|
if !ok {
|
||||||
t.Fatal("missing nameserver ns1.example.com.")
|
t.Fatal("missing nameserver ns1.example.com.")
|
||||||
}
|
}
|
||||||
|
|
||||||
aRecords := ns1.Records["A"]
|
aRecords := ns1.Records["A"]
|
||||||
if len(aRecords) != 1 || aRecords[0] != testIPv4 {
|
if len(aRecords) != 1 || aRecords[0] != "93.184.216.34" {
|
||||||
t.Errorf("ns1 A records: got %v", aRecords)
|
t.Errorf("ns1 A records: got %v", aRecords)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -223,8 +213,7 @@ func TestSaveLoadRoundTrip_Ports(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestSaveLoadRoundTrip_Certificates verifies certificate data
|
// TestSaveLoadRoundTrip_Certificates verifies certificate data survives a save/load cycle.
|
||||||
// survives a save/load cycle.
|
|
||||||
func TestSaveLoadRoundTrip_Certificates(t *testing.T) {
|
func TestSaveLoadRoundTrip_Certificates(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -664,7 +653,7 @@ func TestDomainState_GetSet(t *testing.T) {
|
|||||||
|
|
||||||
now := time.Now().UTC().Truncate(time.Second)
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
ds := &state.DomainState{
|
ds := &state.DomainState{
|
||||||
Nameservers: []string{testAltNS1},
|
Nameservers: []string{"ns1.test.com."},
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -675,7 +664,7 @@ func TestDomainState_GetSet(t *testing.T) {
|
|||||||
t.Fatal("expected true for existing domain")
|
t.Fatal("expected true for existing domain")
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(got.Nameservers) != 1 || got.Nameservers[0] != testAltNS1 {
|
if len(got.Nameservers) != 1 || got.Nameservers[0] != "ns1.test.com." {
|
||||||
t.Errorf("nameservers: got %v", got.Nameservers)
|
t.Errorf("nameservers: got %v", got.Nameservers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -685,7 +674,7 @@ func TestDomainState_GetSet(t *testing.T) {
|
|||||||
|
|
||||||
// Overwrite.
|
// Overwrite.
|
||||||
ds2 := &state.DomainState{
|
ds2 := &state.DomainState{
|
||||||
Nameservers: []string{testAltNS1, "ns2.test.com."},
|
Nameservers: []string{"ns1.test.com.", "ns2.test.com."},
|
||||||
LastChecked: now.Add(time.Hour),
|
LastChecked: now.Add(time.Hour),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -715,8 +704,8 @@ func TestHostnameState_GetSet(t *testing.T) {
|
|||||||
now := time.Now().UTC().Truncate(time.Second)
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
hs := &state.HostnameState{
|
hs := &state.HostnameState{
|
||||||
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
||||||
testNS1: {
|
"ns1.example.com.": {
|
||||||
Records: map[string][]string{"A": {testIP}},
|
Records: map[string][]string{"A": {"1.2.3.4"}},
|
||||||
Status: "ok",
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
@@ -731,7 +720,7 @@ func TestHostnameState_GetSet(t *testing.T) {
|
|||||||
t.Fatal("expected true for existing hostname")
|
t.Fatal("expected true for existing hostname")
|
||||||
}
|
}
|
||||||
|
|
||||||
nsState, ok := got.RecordsByNameserver[testNS1]
|
nsState, ok := got.RecordsByNameserver["ns1.example.com."]
|
||||||
if !ok {
|
if !ok {
|
||||||
t.Fatal("missing nameserver entry")
|
t.Fatal("missing nameserver entry")
|
||||||
}
|
}
|
||||||
@@ -741,7 +730,7 @@ func TestHostnameState_GetSet(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
aRecords := nsState.Records["A"]
|
aRecords := nsState.Records["A"]
|
||||||
if len(aRecords) != 1 || aRecords[0] != testIP {
|
if len(aRecords) != 1 || aRecords[0] != "1.2.3.4" {
|
||||||
t.Errorf("A records: got %v", aRecords)
|
t.Errorf("A records: got %v", aRecords)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -880,7 +869,7 @@ func TestCertificateState_ErrorField(t *testing.T) {
|
|||||||
|
|
||||||
now := time.Now().UTC().Truncate(time.Second)
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
cs := &state.CertificateState{
|
cs := &state.CertificateState{
|
||||||
Status: statusError,
|
Status: "error",
|
||||||
Error: "connection refused",
|
Error: "connection refused",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
}
|
}
|
||||||
@@ -904,8 +893,8 @@ func TestCertificateState_ErrorField(t *testing.T) {
|
|||||||
t.Fatal("missing certificate after load")
|
t.Fatal("missing certificate after load")
|
||||||
}
|
}
|
||||||
|
|
||||||
if got.Status != statusError {
|
if got.Status != "error" {
|
||||||
t.Errorf("status: got %q, want %q", got.Status, statusError)
|
t.Errorf("status: got %q, want %q", got.Status, "error")
|
||||||
}
|
}
|
||||||
|
|
||||||
if got.Error != "connection refused" {
|
if got.Error != "connection refused" {
|
||||||
@@ -923,9 +912,9 @@ func TestHostnameState_ErrorField(t *testing.T) {
|
|||||||
now := time.Now().UTC().Truncate(time.Second)
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
hs := &state.HostnameState{
|
hs := &state.HostnameState{
|
||||||
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
||||||
testNS1: {
|
"ns1.example.com.": {
|
||||||
Records: nil,
|
Records: nil,
|
||||||
Status: statusError,
|
Status: "error",
|
||||||
Error: "SERVFAIL",
|
Error: "SERVFAIL",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
@@ -952,9 +941,9 @@ func TestHostnameState_ErrorField(t *testing.T) {
|
|||||||
t.Fatal("missing hostname after load")
|
t.Fatal("missing hostname after load")
|
||||||
}
|
}
|
||||||
|
|
||||||
nsState := got.RecordsByNameserver[testNS1]
|
nsState := got.RecordsByNameserver["ns1.example.com."]
|
||||||
if nsState.Status != statusError {
|
if nsState.Status != "error" {
|
||||||
t.Errorf("status: got %q, want %q", nsState.Status, statusError)
|
t.Errorf("status: got %q, want %q", nsState.Status, "error")
|
||||||
}
|
}
|
||||||
|
|
||||||
if nsState.Error != "SERVFAIL" {
|
if nsState.Error != "SERVFAIL" {
|
||||||
@@ -1073,8 +1062,7 @@ func TestConcurrentGetSet(t *testing.T) {
|
|||||||
wg.Wait()
|
wg.Wait()
|
||||||
}
|
}
|
||||||
|
|
||||||
// runConcurrentOps performs a series of get/set/delete
|
// runConcurrentOps performs a series of get/set/delete operations for concurrency testing.
|
||||||
// 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
|
||||||
|
|
||||||
@@ -1097,7 +1085,7 @@ func runConcurrentOps(s *state.State, key string, now time.Time) {
|
|||||||
s.SetHostnameState(key+".example.com", &state.HostnameState{
|
s.SetHostnameState(key+".example.com", &state.HostnameState{
|
||||||
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
RecordsByNameserver: map[string]*state.NameserverRecordState{
|
||||||
"ns1.test.": {
|
"ns1.test.": {
|
||||||
Records: map[string][]string{"A": {testIP}},
|
Records: map[string][]string{"A": {"1.2.3.4"}},
|
||||||
Status: "ok",
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -26,12 +26,6 @@ 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
|
||||||
|
|
||||||
// Status values recorded for nameserver and certificate checks.
|
|
||||||
const (
|
|
||||||
statusOK = "ok"
|
|
||||||
statusError = "error"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Params contains dependencies for Watcher.
|
// Params contains dependencies for Watcher.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -350,7 +344,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: statusOK,
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -408,7 +402,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 != statusOK {
|
if _, ok := current[ns]; ok || prevNS.Status != "ok" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -427,7 +421,7 @@ func (w *Watcher) detectNSDisappearances(
|
|||||||
|
|
||||||
for ns := range current {
|
for ns := range current {
|
||||||
prevNS, ok := prev.RecordsByNameserver[ns]
|
prevNS, ok := prev.RecordsByNameserver[ns]
|
||||||
if !ok || prevNS.Status != statusError {
|
if !ok || prevNS.Status != "error" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -711,7 +705,7 @@ func (w *Watcher) handleTLSError(
|
|||||||
now time.Time,
|
now time.Time,
|
||||||
err error,
|
err error,
|
||||||
) {
|
) {
|
||||||
if hasPrev && !w.firstRun && prev.Status == statusOK {
|
if hasPrev && !w.firstRun && prev.Status == "ok" {
|
||||||
msg := fmt.Sprintf(
|
msg := fmt.Sprintf(
|
||||||
"Host: %s\nIP: %s\nError: %s",
|
"Host: %s\nIP: %s\nError: %s",
|
||||||
hostname, ip, err,
|
hostname, ip, err,
|
||||||
@@ -727,7 +721,7 @@ func (w *Watcher) handleTLSError(
|
|||||||
|
|
||||||
w.state.SetCertificateState(
|
w.state.SetCertificateState(
|
||||||
certKey, &state.CertificateState{
|
certKey, &state.CertificateState{
|
||||||
Status: statusError,
|
Status: "error",
|
||||||
Error: err.Error(),
|
Error: err.Error(),
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
@@ -754,7 +748,7 @@ func (w *Watcher) handleTLSSuccess(
|
|||||||
Issuer: cert.Issuer,
|
Issuer: cert.Issuer,
|
||||||
NotAfter: cert.NotAfter,
|
NotAfter: cert.NotAfter,
|
||||||
SubjectAlternativeNames: cert.SubjectAlternativeNames,
|
SubjectAlternativeNames: cert.SubjectAlternativeNames,
|
||||||
Status: statusOK,
|
Status: "ok",
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
@@ -766,7 +760,7 @@ func (w *Watcher) detectTLSChanges(
|
|||||||
prev *state.CertificateState,
|
prev *state.CertificateState,
|
||||||
cert *tlscheck.CertificateInfo,
|
cert *tlscheck.CertificateInfo,
|
||||||
) {
|
) {
|
||||||
if prev.Status == statusError {
|
if prev.Status == "error" {
|
||||||
msg := fmt.Sprintf(
|
msg := fmt.Sprintf(
|
||||||
"Host: %s\nIP: %s\nTLS recovered",
|
"Host: %s\nIP: %s\nTLS recovered",
|
||||||
hostname, ip,
|
hostname, ip,
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -9,9 +9,9 @@ set -eu
|
|||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
# Pinned versions, 2026-08-07 (same pins as the Dockerfile)
|
# Pinned versions, 2026-07-07 (same pins as the Dockerfile)
|
||||||
# golangci-lint v2.12.2
|
# golangci-lint v2.10.1
|
||||||
GOLANGCI_LINT_REF="github.com/golangci/golangci-lint/v2/cmd/golangci-lint@c0d3ddc9cf3faa61a4e378e879ece580256d76e5"
|
GOLANGCI_LINT_REF="github.com/golangci/golangci-lint/v2/cmd/golangci-lint@5d1e709b7be35cb2025444e19de266b056b7b7ee"
|
||||||
# goimports v0.42.0
|
# goimports v0.42.0
|
||||||
GOIMPORTS_REF="golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0"
|
GOIMPORTS_REF="golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0"
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user