Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c41349fd94 | ||
|
|
adc8131191 | ||
|
|
06ae357165 | ||
|
|
f6b7aefcbf | ||
|
|
db3b09c5d8 | ||
|
|
caa3aa3c12 | ||
|
|
dee69c4780 | ||
|
|
5e2c456e85 |
@@ -286,7 +286,7 @@ includes:
|
||||
|
||||
Each endpoint is sent each notification on its own, in the background. A
|
||||
delivery that fails (a network error, no reply within 10 seconds, or an HTTP
|
||||
status of 400 or more) is retried up to 5 times: the first retry after about 1
|
||||
status other than 2xx) is retried up to 5 times: the first retry after about 1
|
||||
second, each wait after that twice as long up to 60 seconds, every wait varied
|
||||
at random by up to 25%. A delivery still failing after that is logged and
|
||||
dropped.
|
||||
@@ -561,6 +561,18 @@ This approach ensures:
|
||||
- Ability to detect split-horizon or inconsistent responses across authoritative
|
||||
servers.
|
||||
|
||||
A root server never offers recursion, so a reply marked "recursion available"
|
||||
from a root server's address came from a recursive resolver on the network
|
||||
answering in its place, as on a network where a router rule, a VPN or a DNS
|
||||
filter sends all DNS to one resolver. The first such reply from a root server's
|
||||
address stops the lookup at once with the error "this network intercepts DNS
|
||||
queries", and no other root server is asked. A lookup that every root server
|
||||
refuses fails with the same error. Every lookup starts at the root servers, so
|
||||
on such a network every lookup fails with that error, whether or not that
|
||||
resolver has the name cached, and dnswatcher's tests fail there too. That is by
|
||||
design: nothing asks again another way or otherwise works around the
|
||||
interception.
|
||||
|
||||
A watched name's records are stored as its nameservers return them, CNAME
|
||||
included. When they return a CNAME and no address, the chain of every CNAME
|
||||
target they gave is followed (with a depth limit to prevent loops) to the A and
|
||||
@@ -910,6 +922,7 @@ internal/
|
||||
templates/dashboard.html Dashboard template (embedded)
|
||||
status.go /api/v1/status
|
||||
healthcheck.go Health check handler
|
||||
static.go Static assets under /s/
|
||||
server/
|
||||
server.go HTTP server lifecycle
|
||||
routes.go Route definitions
|
||||
|
||||
+9
-7
@@ -19,16 +19,18 @@ works correctly in production.
|
||||
### Constraints
|
||||
|
||||
- Tests hit real DNS infrastructure and require network access
|
||||
- Test duration depends on network conditions; timeout tuning keeps the suite
|
||||
within the 60-second target
|
||||
- Query timeout is calibrated to 3× maximum antipodal RTT (~300ms) plus
|
||||
processing margin
|
||||
- Root server fan-out is limited to reduce parallel query load
|
||||
- Test duration depends on network conditions. `make test` must finish in under
|
||||
60 seconds, the hard cap in `REPO_POLICIES.md`; under 20 seconds is the target
|
||||
- Each query to a nameserver has a 2-second timeout, and a query over UDP that
|
||||
gets no reply is sent once more (`queryTimeoutDuration` and `maxRetries` in
|
||||
`internal/resolver/iterative.go`)
|
||||
- In the walk to a name's nameservers, the servers of each zone are asked one at
|
||||
a time in a random order, as the README's DNS Resolution Strategy describes
|
||||
- Live lookups that expect an answer go through `internal/livednstest`, which
|
||||
limits how many run at once in a test binary and retries a lookup that got
|
||||
none
|
||||
- Flaky failures from transient network issues are acceptable and should be
|
||||
investigated as potential resolver bugs, not papered over with mocks or skip
|
||||
- A flaky live test is a robustness problem, fixed with retries with backoff,
|
||||
several independent nameservers or longer timeouts, never with mocks or skip
|
||||
flags
|
||||
|
||||
### What NOT to do
|
||||
|
||||
@@ -19,8 +19,29 @@ milestone: https://git.eeqj.de/sneak/dnswatcher/milestone/7
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-10-16: the first reply marked "recursion available" from a root server's
|
||||
address stops the lookup with "this network intercepts DNS queries", so on a
|
||||
network that sends DNS to a resolver dnswatcher and its tests fail, by design
|
||||
(closes #300).
|
||||
- 2026-10-15: a query its caller's context ends before it is sent records no
|
||||
reason about the nameserver, and a try the context's deadline cuts short is a
|
||||
timeout, so a nameserver whose only failures were timeouts is `timeout`, not a
|
||||
network error or `ok` (closes #298).
|
||||
- 2026-10-15: the resolver no longer says its query timeout grows on each try;
|
||||
every try waits the same 2 seconds, and the unused `timeoutMultiplier` is gone
|
||||
(closes #296).
|
||||
- 2026-10-15: `TESTING.md` Constraints give the resolver's 2-second query
|
||||
timeout and second try, say a zone's servers are asked one at a time in a
|
||||
random order, give the 60-second cap and 20-second target for `make test`, and
|
||||
say a flaky live test is fixed with robustness, not with mocks (closes #289).
|
||||
- 2026-10-15: a request under `/s/` that names a directory, such as `/s/` or
|
||||
`/s/css`, answers 404 instead of a listing of its files (closes #286).
|
||||
- 2026-10-15: a notification endpoint that answers with a redirect, or any
|
||||
status other than 2xx, is a failed delivery, retried and logged (closes #287).
|
||||
- 2026-10-15: a nameserver is asked at each of its IPv4 addresses in turn, so it
|
||||
has failed only when none of them gives a usable reply (closes #285).
|
||||
- 2026-10-15: the log names a notification endpoint (`slack`, `mattermost`,
|
||||
`ntfy`) and never shows its URL's path or query (closes #288).
|
||||
- 2026-10-13: a hostname or a domain whose zone's nameservers all stop answering
|
||||
gets an NS Failure for each, then an NS Recovery (closes #284).
|
||||
- 2026-10-13: an IPv6 address is written in brackets before its port, as in
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"sneak.berlin/go/dnswatcher/static"
|
||||
)
|
||||
|
||||
// HandleStatic returns the handler for the embedded static assets. It
|
||||
// is mounted under /s, with that prefix stripped from the path. A
|
||||
// request that names a directory answers 404: http.FileServer would
|
||||
// answer it with a listing of the directory, or with a redirect to
|
||||
// that listing when the trailing slash is missing.
|
||||
func (h *Handlers) HandleStatic() http.HandlerFunc {
|
||||
files := http.FileServer(http.FS(static.Static))
|
||||
|
||||
return func(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
) {
|
||||
// fs.Stat refuses a name that is empty or ends in a slash,
|
||||
// so /s/ and /s/css/ answer 404 here along with /s/css.
|
||||
name := strings.TrimPrefix(request.URL.Path, "/")
|
||||
|
||||
info, err := fs.Stat(static.Static, name)
|
||||
if err != nil || info.IsDir() {
|
||||
http.NotFound(writer, request)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
files.ServeHTTP(writer, request)
|
||||
}
|
||||
}
|
||||
@@ -6,10 +6,12 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"slices"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
@@ -38,6 +40,13 @@ const (
|
||||
prioUrgent = "urgent"
|
||||
)
|
||||
|
||||
// Endpoint names, as the log gives them, used across multiple tests.
|
||||
const (
|
||||
endpointNtfy = "ntfy"
|
||||
endpointSlack = "slack"
|
||||
endpointMattermost = "mattermost"
|
||||
)
|
||||
|
||||
// testHost is the hostname used in request construction tests.
|
||||
const testHost = "example.com"
|
||||
|
||||
@@ -1094,6 +1103,182 @@ func TestSendNotificationErrorNamesEndpoint(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// ── webhook URLs kept out of the log ──────────────────────
|
||||
|
||||
// webhookPathAndQuery follows the server's address in every
|
||||
// endpoint's URL in the tests below. A webhook URL's path or query
|
||||
// lets anyone post to the channel or topic, so neither word marked
|
||||
// secret in it may reach the log.
|
||||
const webhookPathAndQuery = "/hooks/secret-in-path?token=secret-in-query"
|
||||
|
||||
// assertNoWebhookSecret fails the test if text holds either word
|
||||
// marked secret in webhookPathAndQuery.
|
||||
func assertNoWebhookSecret(t *testing.T, text string) {
|
||||
t.Helper()
|
||||
|
||||
for _, secret := range []string{"secret-in-path", "secret-in-query"} {
|
||||
if strings.Contains(text, secret) {
|
||||
t.Errorf("%q from the webhook URL is in:\n%s", secret, text)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// logRecord is the part of a JSON log line the tests below read.
|
||||
type logRecord struct {
|
||||
Level string `json:"level"`
|
||||
Msg string `json:"msg"`
|
||||
Endpoint string `json:"endpoint"`
|
||||
Title string `json:"title"`
|
||||
Error string `json:"error"`
|
||||
}
|
||||
|
||||
// parseLog decodes each line of a JSON log.
|
||||
func parseLog(t *testing.T, logs string) []logRecord {
|
||||
t.Helper()
|
||||
|
||||
var records []logRecord
|
||||
|
||||
for line := range strings.Lines(logs) {
|
||||
var record logRecord
|
||||
|
||||
err := json.Unmarshal([]byte(line), &record)
|
||||
if err != nil {
|
||||
t.Fatalf("decoding log line %q: %v", line, err)
|
||||
}
|
||||
|
||||
records = append(records, record)
|
||||
}
|
||||
|
||||
return records
|
||||
}
|
||||
|
||||
// sendToEachEndpoint sends one notification with the given title to
|
||||
// ntfy, Slack and Mattermost, each at baseURL followed by
|
||||
// webhookPathAndQuery, and retries a failed delivery once. When
|
||||
// every delivery has finished it returns the JSON log written,
|
||||
// debug lines included.
|
||||
func sendToEachEndpoint(t *testing.T, baseURL, title string) string {
|
||||
t.Helper()
|
||||
|
||||
target, err := url.Parse(baseURL + webhookPathAndQuery)
|
||||
if err != nil {
|
||||
t.Fatalf("parsing webhook URL: %v", err)
|
||||
}
|
||||
|
||||
svc, logs := newLoggingService(http.DefaultTransport)
|
||||
svc.SetNtfyURL(target)
|
||||
svc.SetSlackWebhookURL(target)
|
||||
svc.SetMattermostWebhookURL(target)
|
||||
svc.SetSleepFunc(instantSleep)
|
||||
svc.SetRetryConfig(notify.RetryConfig{
|
||||
MaxRetries: 1,
|
||||
BaseDelay: time.Millisecond,
|
||||
MaxDelay: time.Millisecond,
|
||||
})
|
||||
|
||||
svc.SendNotification(context.Background(), title, "m", prioInfo)
|
||||
|
||||
waitForCondition(t, func() bool {
|
||||
return svc.OutstandingDeliveries() == 0
|
||||
})
|
||||
|
||||
return logs.String()
|
||||
}
|
||||
|
||||
// assertEachEndpointRetriedThenFailed fails the test unless, for each
|
||||
// of ntfy, Slack and Mattermost, the lines of logs whose error
|
||||
// contains reason are the retry line and then the final failure line.
|
||||
func assertEachEndpointRetriedThenFailed(
|
||||
t *testing.T, logs, reason string,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
// For each endpoint, the messages of its lines whose error
|
||||
// contains reason, in the order they were logged.
|
||||
got := map[string][]string{}
|
||||
|
||||
for _, record := range parseLog(t, logs) {
|
||||
if strings.Contains(record.Error, reason) {
|
||||
got[record.Endpoint] = append(
|
||||
got[record.Endpoint], record.Msg,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
lines := []string{
|
||||
"notification delivery failed, retrying",
|
||||
"failed to send notification after retries",
|
||||
}
|
||||
want := map[string][]string{
|
||||
endpointNtfy: lines,
|
||||
endpointSlack: lines,
|
||||
endpointMattermost: lines,
|
||||
}
|
||||
|
||||
if !maps.EqualFunc(got, want, slices.Equal) {
|
||||
t.Errorf("lines whose error contains %q = %v, want %v",
|
||||
reason, got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSendNotificationDebugLogOmitsWebhookURL checks that, with debug
|
||||
// logging on, a delivery to each endpoint logs the endpoint's name and
|
||||
// the title, and no part of the URL's path or query.
|
||||
func TestSendNotificationDebugLogOmitsWebhookURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const title = "Port Change"
|
||||
|
||||
srv := httptest.NewServer(
|
||||
http.HandlerFunc(
|
||||
func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}),
|
||||
)
|
||||
defer srv.Close()
|
||||
|
||||
logs := sendToEachEndpoint(t, srv.URL, title)
|
||||
|
||||
assertNoWebhookSecret(t, logs)
|
||||
|
||||
got := map[string]string{}
|
||||
|
||||
for _, record := range parseLog(t, logs) {
|
||||
if record.Level == slog.LevelDebug.String() {
|
||||
got[record.Endpoint] = record.Title
|
||||
}
|
||||
}
|
||||
|
||||
want := map[string]string{
|
||||
endpointNtfy: title,
|
||||
endpointSlack: title,
|
||||
endpointMattermost: title,
|
||||
}
|
||||
|
||||
if !maps.Equal(got, want) {
|
||||
t.Errorf("debug lines' endpoint and title = %v, want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSendNotificationErrorLogOmitsWebhookURL checks that a delivery
|
||||
// to each endpoint that cannot connect logs the transport's error,
|
||||
// which names the refused connection, on its retry line and on its
|
||||
// final failure line, and that no line holds any part of the URL's
|
||||
// path or query.
|
||||
func TestSendNotificationErrorLogOmitsWebhookURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Closed before anything is sent, so every attempt fails to
|
||||
// connect.
|
||||
srv := httptest.NewServer(http.NotFoundHandler())
|
||||
srv.Close()
|
||||
|
||||
logs := sendToEachEndpoint(t, srv.URL, "t")
|
||||
|
||||
assertNoWebhookSecret(t, logs)
|
||||
assertEachEndpointRetriedThenFailed(t, logs, "connection refused")
|
||||
}
|
||||
|
||||
// ── SlackPayload JSON marshaling ──────────────────────────
|
||||
|
||||
func TestSlackPayloadJSON(t *testing.T) {
|
||||
|
||||
@@ -81,7 +81,8 @@ func (svc *Service) SendNtfy(
|
||||
return svc.sendNtfy(ctx, topicURL, title, message, priority)
|
||||
}
|
||||
|
||||
// SendSlack exports sendSlack for testing.
|
||||
// SendSlack exports sendSlack for testing. It sends as the
|
||||
// "slack" endpoint.
|
||||
func (svc *Service) SendSlack(
|
||||
ctx context.Context,
|
||||
webhookURL *url.URL,
|
||||
@@ -89,7 +90,7 @@ func (svc *Service) SendSlack(
|
||||
title, message, priority string,
|
||||
) error {
|
||||
return svc.sendSlack(
|
||||
ctx, webhookURL, failed, title, message, priority,
|
||||
ctx, webhookURL, "slack", failed, title, message, priority,
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
+30
-13
@@ -25,9 +25,6 @@ import (
|
||||
// HTTP client timeout.
|
||||
const httpClientTimeout = 10 * time.Second
|
||||
|
||||
// HTTP status code thresholds.
|
||||
const httpStatusClientError = 400
|
||||
|
||||
// Sentinel errors for notification failures.
|
||||
var (
|
||||
// ErrNtfyFailed indicates the ntfy request failed.
|
||||
@@ -56,6 +53,15 @@ func IsAllowedScheme(scheme string) bool {
|
||||
func ValidateWebhookURL(raw string) (*url.URL, error) {
|
||||
u, err := url.ParseRequestURI(raw)
|
||||
if err != nil {
|
||||
// A *url.Error quotes the whole URL, and this error is
|
||||
// logged at startup. A webhook URL's path or query lets
|
||||
// anyone post to the channel or topic, so keep only the
|
||||
// reason.
|
||||
var urlErr *url.Error
|
||||
if errors.As(err, &urlErr) {
|
||||
err = urlErr.Err
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("invalid URL: %w", err)
|
||||
}
|
||||
|
||||
@@ -277,7 +283,7 @@ func (svc *Service) dispatchSlack(
|
||||
|
||||
svc.dispatch(ctx, "slack", func(c context.Context) error {
|
||||
return svc.sendSlack(
|
||||
c, svc.slackWebhookURL, ErrSlackFailed,
|
||||
c, svc.slackWebhookURL, "slack", ErrSlackFailed,
|
||||
title, message, priority,
|
||||
)
|
||||
})
|
||||
@@ -295,8 +301,8 @@ func (svc *Service) dispatchMattermost(
|
||||
ctx, "mattermost",
|
||||
func(c context.Context) error {
|
||||
return svc.sendSlack(
|
||||
c, svc.mattermostWebhookURL, ErrMattermostFailed,
|
||||
title, message, priority,
|
||||
c, svc.mattermostWebhookURL, "mattermost",
|
||||
ErrMattermostFailed, title, message, priority,
|
||||
)
|
||||
},
|
||||
)
|
||||
@@ -307,9 +313,11 @@ func (svc *Service) sendNtfy(
|
||||
topicURL *url.URL,
|
||||
title, message, priority string,
|
||||
) error {
|
||||
// The topic URL is left out of the log: it lets anyone who has
|
||||
// it read and post to the topic.
|
||||
svc.log.Debug(
|
||||
"sending ntfy notification",
|
||||
"topic", topicURL.String(),
|
||||
"endpoint", "ntfy",
|
||||
"title", title,
|
||||
)
|
||||
|
||||
@@ -333,7 +341,10 @@ func (svc *Service) sendNtfy(
|
||||
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode >= httpStatusClientError {
|
||||
// Only a 2xx reply means ntfy took the notification. A
|
||||
// redirect is not followed, so it is a failure too.
|
||||
if resp.StatusCode < http.StatusOK ||
|
||||
resp.StatusCode >= http.StatusMultipleChoices {
|
||||
return fmt.Errorf(
|
||||
"%w: status %d",
|
||||
ErrNtfyFailed, resp.StatusCode,
|
||||
@@ -372,12 +383,15 @@ type SlackAttachment struct {
|
||||
}
|
||||
|
||||
// sendSlack posts to a Slack or Mattermost incoming webhook, which
|
||||
// take the same payload. An HTTP error status is returned wrapped in
|
||||
// failed, ErrSlackFailed or ErrMattermostFailed, so the error names
|
||||
// the endpoint.
|
||||
// take the same payload. endpoint, "slack" or "mattermost", names
|
||||
// the webhook in the log in place of its URL, which lets anyone who
|
||||
// has it post to the channel. A reply status other than 2xx is
|
||||
// returned wrapped in failed, ErrSlackFailed or ErrMattermostFailed,
|
||||
// so the error names the endpoint.
|
||||
func (svc *Service) sendSlack(
|
||||
ctx context.Context,
|
||||
webhookURL *url.URL,
|
||||
endpoint string,
|
||||
failed error,
|
||||
title, message, priority string,
|
||||
) error {
|
||||
@@ -388,7 +402,7 @@ func (svc *Service) sendSlack(
|
||||
|
||||
svc.log.Debug(
|
||||
"sending webhook notification",
|
||||
"url", webhookURL.String(),
|
||||
"endpoint", endpoint,
|
||||
"title", title,
|
||||
)
|
||||
|
||||
@@ -423,7 +437,10 @@ func (svc *Service) sendSlack(
|
||||
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode >= httpStatusClientError {
|
||||
// Only a 2xx reply means the webhook took the notification. A
|
||||
// redirect is not followed, so it is a failure too.
|
||||
if resp.StatusCode < http.StatusOK ||
|
||||
resp.StatusCode >= http.StatusMultipleChoices {
|
||||
return fmt.Errorf(
|
||||
"%w: status %d",
|
||||
failed, resp.StatusCode,
|
||||
|
||||
@@ -79,6 +79,23 @@ func TestValidateWebhookURLInvalid(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateWebhookURLErrorOmitsURL checks that the error for a
|
||||
// webhook URL that does not parse, here because a carriage return
|
||||
// was left at its end, leaves out the URL's path and query: the
|
||||
// error is logged at startup.
|
||||
func TestValidateWebhookURLErrorOmitsURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
_, err := notify.ValidateWebhookURL(
|
||||
"https://hooks.example.com" + webhookPathAndQuery + "\r",
|
||||
)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error for a URL ending in a carriage return")
|
||||
}
|
||||
|
||||
assertNoWebhookSecret(t, err.Error())
|
||||
}
|
||||
|
||||
func TestIsAllowedScheme(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
||||
@@ -536,3 +536,33 @@ func TestSendNotificationPermanentFailureLogsError(
|
||||
return attempts >= 3
|
||||
})
|
||||
}
|
||||
|
||||
// TestSendNotificationRedirectFails checks that a 302 reply is a
|
||||
// failed delivery at each endpoint: the server is sent the first
|
||||
// attempt and the retry, and each endpoint logs a retry line and
|
||||
// then the final failure line, both naming the 302.
|
||||
func TestSendNotificationRedirectFails(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var requests atomic.Int64
|
||||
|
||||
srv := httptest.NewServer(
|
||||
http.HandlerFunc(
|
||||
func(w http.ResponseWriter, r *http.Request) {
|
||||
requests.Add(1)
|
||||
http.Redirect(w, r, "/moved", http.StatusFound)
|
||||
}),
|
||||
)
|
||||
defer srv.Close()
|
||||
|
||||
logs := sendToEachEndpoint(t, srv.URL, "t")
|
||||
|
||||
// ntfy, Slack and Mattermost each send once and retry once.
|
||||
const wantRequests = 3 * 2
|
||||
|
||||
if sent := requests.Load(); sent != wantRequests {
|
||||
t.Errorf("server got %d requests, want %d", sent, wantRequests)
|
||||
}
|
||||
|
||||
assertEachEndpointRetriedThenFailed(t, logs, "status 302")
|
||||
}
|
||||
|
||||
@@ -36,6 +36,10 @@ var (
|
||||
// so whether the name has addresses is unknown.
|
||||
ErrNoNameserverAnswered = errors.New("no nameserver answered")
|
||||
|
||||
// ErrNoNameserverAddress is returned when a nameserver is to be
|
||||
// asked and no address for it was given.
|
||||
ErrNoNameserverAddress = errors.New("nameserver has no address")
|
||||
|
||||
// ErrUnusableReply is returned when a server replied with an
|
||||
// error such as SERVFAIL, or with a referral that leads no
|
||||
// closer to the name asked about.
|
||||
@@ -49,9 +53,12 @@ var (
|
||||
"reply truncated and its retry over TCP failed",
|
||||
)
|
||||
|
||||
// ErrIntercepted is returned when every root server refused a
|
||||
// query. Root servers refuse no query, so the refusals came from
|
||||
// something on the network answering in their place.
|
||||
// ErrIntercepted is returned when a root server's address gave a
|
||||
// reply marked recursion available, which ends the lookup at once,
|
||||
// or when every root server refused a query. Root servers do
|
||||
// neither, so those replies came from something on the network
|
||||
// answering in their place. On such a network dnswatcher fails with
|
||||
// it, by design: nothing works around the interception.
|
||||
ErrIntercepted = errors.New("this network intercepts DNS queries")
|
||||
|
||||
// ErrCNAMEDepthExceeded is returned when a CNAME chain
|
||||
|
||||
@@ -19,7 +19,6 @@ const (
|
||||
queryTimeoutDuration = 2 * time.Second
|
||||
maxRetries = 2
|
||||
maxDelegation = 20
|
||||
timeoutMultiplier = 2
|
||||
|
||||
// maxLookupDepth is how many lookups of nameserver addresses may be
|
||||
// under way one inside another. Looking up a nameserver's address
|
||||
@@ -62,19 +61,11 @@ func checkCtx(ctx context.Context) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *Resolver) exchangeWithTimeout(
|
||||
ctx context.Context,
|
||||
msg *dns.Msg,
|
||||
addr string,
|
||||
attempt int,
|
||||
) (*dns.Msg, error) {
|
||||
_ = attempt // timeout escalation handled by client config
|
||||
|
||||
resp, _, err := r.client.ExchangeContext(ctx, msg, addr)
|
||||
|
||||
return resp, err
|
||||
}
|
||||
|
||||
// tryExchange sends msg to addr over UDP, up to maxRetries times, until
|
||||
// a reply comes. Every try waits the same queryTimeoutDuration, or less
|
||||
// when ctx's deadline comes first. When ctx has ended before a further
|
||||
// try, it returns the error of the try already made, such as a timeout,
|
||||
// or ErrContextCanceled when none was made.
|
||||
func (r *Resolver) tryExchange(
|
||||
ctx context.Context,
|
||||
msg *dns.Msg,
|
||||
@@ -84,14 +75,16 @@ func (r *Resolver) tryExchange(
|
||||
|
||||
var err error
|
||||
|
||||
for attempt := range maxRetries {
|
||||
for range maxRetries {
|
||||
if checkCtx(ctx) != nil {
|
||||
return nil, ErrContextCanceled
|
||||
if err == nil {
|
||||
return nil, ErrContextCanceled
|
||||
}
|
||||
|
||||
return nil, err
|
||||
}
|
||||
|
||||
resp, err = r.exchangeWithTimeout(
|
||||
ctx, msg, addr, attempt,
|
||||
)
|
||||
resp, _, err = r.client.ExchangeContext(ctx, msg, addr)
|
||||
if err == nil {
|
||||
break
|
||||
}
|
||||
@@ -294,7 +287,11 @@ func shuffled(
|
||||
// order until one gives a usable reply. A server that times out, refuses
|
||||
// or gives a reply that is not usable is passed over for the next. When
|
||||
// every server refused, the error says so, and when they are the root
|
||||
// servers it is ErrIntercepted.
|
||||
// servers it is ErrIntercepted. When they are the root servers, the
|
||||
// first reply marked recursion available also ends the lookup with
|
||||
// ErrIntercepted, naming the address it came from, and no other root
|
||||
// server is asked: root servers offer no recursion, so that reply came
|
||||
// from something on the network answering in their place.
|
||||
func (r *Resolver) queryServers(
|
||||
ctx context.Context,
|
||||
servers []string,
|
||||
@@ -312,6 +309,14 @@ func (r *Resolver) queryServers(
|
||||
}
|
||||
|
||||
resp, err := r.queryDNS(ctx, ip, name, qtype)
|
||||
if err == nil && zone == "." && resp.RecursionAvailable {
|
||||
return nil, fmt.Errorf(
|
||||
"query %s @%s: reply marked recursion available, "+
|
||||
"so not from a root server: %w",
|
||||
name, ip, ErrIntercepted,
|
||||
)
|
||||
}
|
||||
|
||||
if err == nil && !usableReply(resp, zone, name) {
|
||||
err = fmt.Errorf(
|
||||
"query %s @%s: %w", name, ip, ErrUnusableReply,
|
||||
@@ -752,7 +757,8 @@ func (r *Resolver) QueryNameserverIP(
|
||||
|
||||
// queryTypes asks the nameserver nsHostname, at its addresses nsIPs,
|
||||
// about hostname's records of each type in qtypes and builds a
|
||||
// NameserverResponse.
|
||||
// NameserverResponse. With no address there is nothing to ask, and it
|
||||
// returns ErrNoNameserverAddress.
|
||||
func (r *Resolver) queryTypes(
|
||||
ctx context.Context,
|
||||
nsHostname string,
|
||||
@@ -760,6 +766,10 @@ func (r *Resolver) queryTypes(
|
||||
hostname string,
|
||||
qtypes []uint16,
|
||||
) (*NameserverResponse, error) {
|
||||
if len(nsIPs) == 0 {
|
||||
return nil, fmt.Errorf("%w: %s", ErrNoNameserverAddress, nsHostname)
|
||||
}
|
||||
|
||||
resp := &NameserverResponse{
|
||||
Nameserver: nsHostname,
|
||||
Records: make(map[string][]string),
|
||||
@@ -849,10 +859,10 @@ func (r *Resolver) queryEachType(
|
||||
}
|
||||
|
||||
// querySingleType asks the nameserver about hostname's records of type
|
||||
// qtype at its addresses nsIPs, one at a time, until one answers: with
|
||||
// records, with none, or with NXDOMAIN. It returns the index in nsIPs of
|
||||
// the address that answered; when none did, it returns why each did not,
|
||||
// each reason naming its address.
|
||||
// qtype at its addresses nsIPs, of which there is at least one, one at a
|
||||
// time, until one answers: with records, with none, or with NXDOMAIN.
|
||||
// It returns the index in nsIPs of the address that answered; when none
|
||||
// did, it returns why each did not, each reason naming its address.
|
||||
func (r *Resolver) querySingleType(
|
||||
ctx context.Context,
|
||||
nsIPs []string,
|
||||
@@ -861,10 +871,6 @@ func (r *Resolver) querySingleType(
|
||||
resp *NameserverResponse,
|
||||
state *queryState,
|
||||
) (int, error) {
|
||||
if len(nsIPs) == 0 {
|
||||
return 0, ErrNoNameserverAnswered
|
||||
}
|
||||
|
||||
var errs []error
|
||||
|
||||
for i, nsIP := range nsIPs {
|
||||
@@ -876,6 +882,10 @@ func (r *Resolver) querySingleType(
|
||||
if err != nil {
|
||||
err = fmt.Errorf("query %s @%s: %w", hostname, nsIP, err)
|
||||
}
|
||||
case errors.Is(err, ErrContextCanceled):
|
||||
// The caller's context ended before the query was sent.
|
||||
// That says nothing about the nameserver, so no reason is
|
||||
// recorded.
|
||||
case isTimeout(err):
|
||||
state.gotTimeout = true
|
||||
case errors.Is(err, ErrRefused):
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
package resolver
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"strconv"
|
||||
"syscall"
|
||||
"testing"
|
||||
@@ -15,8 +17,10 @@ import (
|
||||
// that answered some record types, even with no records, has not failed
|
||||
// when its query for another type got no usable reply, whatever the
|
||||
// reason, and is ok, not nodata: that type may have records. One whose
|
||||
// every query got none has failed. Only one whose every type answered
|
||||
// with no records is nodata.
|
||||
// every query got none has failed, and its error says all queries timed
|
||||
// out only when every one did: a reply such as a refusal, or a network
|
||||
// error, at one of its addresses is given instead. Only one whose every
|
||||
// type answered with no records is nodata.
|
||||
func TestClassifyResponse(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -27,63 +31,46 @@ func TestClassifyResponse(t *testing.T) {
|
||||
wantStatus string
|
||||
wantError string
|
||||
}{
|
||||
{
|
||||
"every type answered with no records",
|
||||
{"every type answered with no records",
|
||||
queryState{answered: true},
|
||||
nil,
|
||||
StatusNoData, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another timed out",
|
||||
nil, StatusNoData, ""},
|
||||
{"some types answered with no records, another timed out",
|
||||
queryState{answered: true, gotTimeout: true},
|
||||
[]string{"A"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another got SERVFAIL",
|
||||
queryState{
|
||||
answered: true, gotErrorReply: true, errorReply: "SERVFAIL",
|
||||
},
|
||||
[]string{"A"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another was refused",
|
||||
[]string{"A"}, StatusOK, ""},
|
||||
{"some types answered with no records, another got SERVFAIL",
|
||||
queryState{answered: true, gotErrorReply: true, errorReply: "SERVFAIL"},
|
||||
[]string{"A"}, StatusOK, ""},
|
||||
{"some types answered with no records, another was refused",
|
||||
queryState{answered: true, gotRefused: true},
|
||||
[]string{"A"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another got a network error",
|
||||
[]string{"A"}, StatusOK, ""},
|
||||
{"some types answered with no records, another got a network error",
|
||||
queryState{answered: true, netErr: syscall.ECONNREFUSED},
|
||||
[]string{"A"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another's reply was " +
|
||||
"truncated and its retry over TCP failed",
|
||||
[]string{"A"}, StatusOK, ""},
|
||||
{"some types answered with no records, another's reply was " +
|
||||
"truncated and its retry over TCP failed",
|
||||
queryState{answered: true, netErr: ErrTruncated},
|
||||
[]string{"TXT"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"some types answered with no records, another got a referral",
|
||||
[]string{"TXT"}, StatusOK, ""},
|
||||
{"some types answered with no records, another got a referral",
|
||||
queryState{answered: true, gotReferral: true},
|
||||
[]string{"A"},
|
||||
StatusOK, "",
|
||||
},
|
||||
{
|
||||
"every query timed out",
|
||||
[]string{"A"}, StatusOK, ""},
|
||||
{"every query timed out",
|
||||
queryState{gotTimeout: true},
|
||||
[]string{"A", "AAAA", "CNAME"},
|
||||
StatusTimeout, "all queries timed out",
|
||||
},
|
||||
{
|
||||
"every query got NOTIMP",
|
||||
[]string{"A", "AAAA", "CNAME"}, StatusTimeout, "all queries timed out"},
|
||||
{"every query got NOTIMP",
|
||||
queryState{gotErrorReply: true, errorReply: "NOTIMP"},
|
||||
[]string{"A", "AAAA", "CNAME"},
|
||||
StatusError, "server returned NOTIMP",
|
||||
},
|
||||
[]string{"A", "AAAA", "CNAME"}, StatusError, "server returned NOTIMP"},
|
||||
{"every query got SERVFAIL at one address, timed out at another",
|
||||
queryState{gotErrorReply: true, errorReply: "SERVFAIL", gotTimeout: true},
|
||||
[]string{"A"}, StatusError, "server returned SERVFAIL"},
|
||||
{"every query was refused at one address, timed out at another",
|
||||
queryState{gotRefused: true, gotTimeout: true},
|
||||
[]string{"A"}, StatusError, "server returned REFUSED"},
|
||||
{"every query got a network error at one address, timed out at another",
|
||||
queryState{netErr: syscall.ECONNREFUSED, gotTimeout: true},
|
||||
[]string{"A"}, StatusError, "network error: connection refused"},
|
||||
{"every query got a referral at one address, timed out at another",
|
||||
queryState{gotReferral: true, gotTimeout: true},
|
||||
[]string{"A"}, StatusError, "server returned a referral"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
@@ -100,20 +87,6 @@ func TestClassifyResponse(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestClassifyResponse_RefusedAndTimedOut sets the status of a
|
||||
// nameserver one of whose addresses refused every query while another
|
||||
// never replied. It has failed with the refusal: not every query timed
|
||||
// out.
|
||||
func TestClassifyResponse_RefusedAndTimedOut(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
resp := &NameserverResponse{Status: StatusOK, FailedTypes: []string{"A"}}
|
||||
classifyResponse(resp, queryState{gotRefused: true, gotTimeout: true})
|
||||
|
||||
assert.Equal(t, StatusError, resp.Status)
|
||||
assert.Equal(t, "server returned REFUSED", resp.Error)
|
||||
}
|
||||
|
||||
// TestReadReply checks which replies to a query about one record type,
|
||||
// built here, are an answer: one with the code NOERROR or NXDOMAIN. A
|
||||
// reply with any other code is not, and the type's query has failed; a
|
||||
@@ -161,3 +134,33 @@ func TestReadReply(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestQuerySingleType_ContextEnded asks a nameserver about one record
|
||||
// type with a context that has already ended, so no query is sent. A
|
||||
// query the context ended before it was sent says nothing about the
|
||||
// nameserver and records no reason: a nameserver whose earlier query
|
||||
// timed out is still reported as timed out, not as a network error.
|
||||
func TestQuerySingleType_ContextEnded(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
r := NewFromLogger(slog.New(slog.DiscardHandler))
|
||||
|
||||
ctx, cancel := context.WithCancel(t.Context())
|
||||
cancel()
|
||||
|
||||
resp := &NameserverResponse{Records: map[string][]string{}, Status: StatusOK}
|
||||
|
||||
// The query for an earlier record type timed out.
|
||||
state := queryState{gotTimeout: true}
|
||||
|
||||
_, err := r.querySingleType(
|
||||
ctx, []string{"192.0.2.1"}, "example.com.", dns.TypeA, resp, &state,
|
||||
)
|
||||
require.ErrorIs(t, err, ErrContextCanceled)
|
||||
assert.Equal(t, queryState{gotTimeout: true}, state)
|
||||
|
||||
classifyResponse(resp, state)
|
||||
|
||||
assert.Equal(t, StatusTimeout, resp.Status)
|
||||
assert.Equal(t, "all queries timed out", resp.Error)
|
||||
}
|
||||
|
||||
@@ -464,6 +464,20 @@ func TestQueryTypes_EveryAddressFails(t *testing.T) {
|
||||
assert.Contains(t, logs.String(), "@"+nsIPs[1]+": ")
|
||||
}
|
||||
|
||||
// TestQueryTypes_NoAddress asks a nameserver given no address. There is
|
||||
// nothing to ask it at, so it has failed, with an error that says it has
|
||||
// no address; it is not ok.
|
||||
func TestQueryTypes_NoAddress(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
resp, err := newTestResolver(t).QueryTypes(
|
||||
t.Context(), "ns1.example.net.", nil, "www.example.net.",
|
||||
[]uint16{dns.TypeA},
|
||||
)
|
||||
require.ErrorIs(t, err, resolver.ErrNoNameserverAddress)
|
||||
assert.Nil(t, resp)
|
||||
}
|
||||
|
||||
func TestQueryNameserver_AAAA(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -528,8 +542,9 @@ func TestQueryNameserver_TXT(t *testing.T) {
|
||||
// nameserver about google.com with a resolver whose retries over TCP
|
||||
// fail. google.com's TXT records do not fit in a reply over UDP, so TXT
|
||||
// is reported as failed, holding none of the records that fit, and
|
||||
// logged with the reason, while the nameserver, which answered the other
|
||||
// types, is ok.
|
||||
// logged with the reason, which names the address whose reply was
|
||||
// truncated, while the nameserver, which answered the other types, is
|
||||
// ok.
|
||||
func TestQueryNameserver_TruncatedReplyWhoseTCPRetryFails(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -546,6 +561,13 @@ func TestQueryNameserver_TruncatedReplyWhoseTCPRetryFails(t *testing.T) {
|
||||
assert.Contains(t, logs.String(),
|
||||
"hostname=google.com. nameserver="+ns+" type=TXT error=",
|
||||
)
|
||||
|
||||
nsIPs := liveResolveNSIPs(t, newTestResolver(t), []string{ns}, 1)
|
||||
for _, ip := range nsIPs {
|
||||
assert.Contains(t, logs.String(),
|
||||
"@"+ip+": "+resolver.ErrTruncated.Error(),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
func TestQueryNameserver_NXDomain(t *testing.T) {
|
||||
@@ -599,6 +621,57 @@ func TestQueryNameserver_Refused(t *testing.T) {
|
||||
assert.Equal(t, "server returned REFUSED", resp.Error)
|
||||
}
|
||||
|
||||
// TestQueryNameserver_EveryAddressRefuses asks ada.ns.cloudflare.com,
|
||||
// whose name has several IPv4 addresses, about google.com, a zone it
|
||||
// does not serve, which it refuses. A record type is asked at each of
|
||||
// the nameserver's addresses before it fails, so the warning about it
|
||||
// names every one.
|
||||
func TestQueryNameserver_EveryAddressRefuses(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const ns = "ada.ns.cloudflare.com."
|
||||
|
||||
var logs bytes.Buffer
|
||||
|
||||
r := resolver.NewFromLogger(slog.New(slog.NewTextHandler(&logs, nil)))
|
||||
nsIPs := liveResolveNSIPs(t, r, []string{ns}, 2)
|
||||
|
||||
var resp *resolver.NameserverResponse
|
||||
|
||||
livednstest.Retry(
|
||||
t,
|
||||
"QueryNameserver("+ns+", google.com)",
|
||||
func(ctx context.Context) error {
|
||||
logs.Reset()
|
||||
|
||||
var err error
|
||||
|
||||
resp, err = r.QueryNameserver(ctx, ns, "google.com")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// A timeout or a network error at every address is no
|
||||
// reply at all.
|
||||
if resp.Status == resolver.StatusTimeout ||
|
||||
strings.HasPrefix(resp.Error, "network error") {
|
||||
return fmt.Errorf(
|
||||
"%w: %s: %s", livednstest.ErrNoAnswer, ns, resp.Error,
|
||||
)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
|
||||
assert.Equal(t, resolver.StatusError, resp.Status)
|
||||
assert.Equal(t, "server returned REFUSED", resp.Error)
|
||||
|
||||
for _, ip := range nsIPs {
|
||||
assert.Contains(t, logs.String(), "@"+ip+": ")
|
||||
}
|
||||
}
|
||||
|
||||
// TestQueryServers_RecursiveResolverRefused passes a public recursive
|
||||
// resolver to QueryServers as the server of google.com. These resolvers
|
||||
// refuse a query that does not ask for recursion and answer one that
|
||||
@@ -777,6 +850,63 @@ func TestQueryServers_NotEveryRootServerRefused(t *testing.T) {
|
||||
require.NotContains(t, err.Error(), "refused a query for")
|
||||
}
|
||||
|
||||
// TestQueryServers_RecursiveResolversAsRootServers passes public
|
||||
// recursive resolvers of four operators to QueryServers as the servers
|
||||
// of the root zone, as a network that sends every DNS query to a
|
||||
// resolver would. Their replies are marked recursion available, which
|
||||
// no root server's is: SERVFAIL, or an answer from a resolver's cache,
|
||||
// as 1.1.1.1 gives for com., which would be used if a root server gave
|
||||
// it. The first such reply ends the lookup with ErrIntercepted, naming
|
||||
// the resolver that gave it. A resolver that refuses or gives no reply
|
||||
// is passed over for the next, so one of them answering is enough.
|
||||
func TestQueryServers_RecursiveResolversAsRootServers(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
r := newTestResolver(t)
|
||||
resolvers := []string{
|
||||
"1.1.1.1", "8.8.8.8", "9.9.9.9", "208.67.222.222",
|
||||
}
|
||||
|
||||
for _, name := range []string{"com.", "desec.io."} {
|
||||
var err error
|
||||
|
||||
livednstest.Retry(
|
||||
t,
|
||||
"QueryServers(public recursive resolvers as root servers, "+
|
||||
name+")",
|
||||
func(ctx context.Context) error {
|
||||
_, err = r.QueryServers(ctx, resolvers, ".", name, dns.TypeNS)
|
||||
|
||||
// When no resolver gave a reply marked recursion
|
||||
// available, each refused or gave no reply at all, so
|
||||
// the attempt is tried again.
|
||||
if err != nil &&
|
||||
!strings.Contains(err.Error(), "marked recursion available") {
|
||||
return fmt.Errorf(
|
||||
"%w: %w", livednstest.ErrNoAnswer, err,
|
||||
)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
|
||||
require.ErrorIs(t, err, resolver.ErrIntercepted)
|
||||
|
||||
// The error names the resolver whose reply ended the lookup.
|
||||
messages := make([]string, 0, len(resolvers))
|
||||
for _, ip := range resolvers {
|
||||
messages = append(messages,
|
||||
"query "+name+" @"+ip+": reply marked recursion "+
|
||||
"available, so not from a root server: "+
|
||||
"this network intercepts DNS queries",
|
||||
)
|
||||
}
|
||||
|
||||
require.Contains(t, messages, err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestQueryNameserver_RecordsSorted(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -1307,10 +1437,10 @@ func TestQueryNameserverIP_Timeout(t *testing.T) {
|
||||
r := newTestResolver(t)
|
||||
|
||||
// Nothing answers at 192.0.2.1, a documentation address. The
|
||||
// resolver tries each query twice, and the first try gives up
|
||||
// after two seconds. A deadline that ends during the first try
|
||||
// makes the status vary from run to run between error and
|
||||
// timeout, so the deadline must outlast the first try.
|
||||
// resolver tries each query twice, and each try gives up after two
|
||||
// seconds. This deadline ends during the second try of the first
|
||||
// record type; TestQueryNameserverIP_DeadlineDuringFirstTry covers
|
||||
// one that ends during the first.
|
||||
ctx, cancel := context.WithTimeout(
|
||||
context.Background(), 3*time.Second,
|
||||
)
|
||||
@@ -1326,6 +1456,62 @@ func TestQueryNameserverIP_Timeout(t *testing.T) {
|
||||
assert.NotEmpty(t, resp.Error)
|
||||
}
|
||||
|
||||
// TestQueryNameserverIP_DeadlineDuringFirstTry gives a query to
|
||||
// 192.0.2.1, where nothing answers, a deadline that ends during its
|
||||
// first try. That try ends at the deadline as a timeout, so the
|
||||
// nameserver is reported as timed out, not as answering.
|
||||
func TestQueryNameserverIP_DeadlineDuringFirstTry(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
r := newTestResolver(t)
|
||||
|
||||
// Well under the two seconds one try waits.
|
||||
ctx, cancel := context.WithTimeout(
|
||||
context.Background(), 500*time.Millisecond,
|
||||
)
|
||||
t.Cleanup(cancel)
|
||||
|
||||
resp, err := r.QueryNameserverIP(
|
||||
ctx, "unreachable.test.", "192.0.2.1",
|
||||
"example.com",
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, resolver.StatusTimeout, resp.Status)
|
||||
assert.NotEmpty(t, resp.Error)
|
||||
}
|
||||
|
||||
// TestQueryNameserverIP_CancelDuringFirstTry cancels the context while
|
||||
// the first try of a query to 192.0.2.1, where nothing answers, waits
|
||||
// for a reply. That try's timeout is all that is learned about the
|
||||
// nameserver, so it is reported as timed out, not as answering.
|
||||
func TestQueryNameserverIP_CancelDuringFirstTry(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
r := newTestResolver(t)
|
||||
|
||||
// The first try starts at once and waits two seconds for a reply;
|
||||
// the cancel comes a second in. The DNS client cuts a try short at
|
||||
// the context's deadline but not at a cancel, so the try still
|
||||
// waits its full two seconds and ends as a timeout a second after
|
||||
// the cancel. By then the context has certainly ended, so no second
|
||||
// try is made. With a deadline instead, the try ends at the moment
|
||||
// the context does, and whether a second try is made depends on
|
||||
// which the resolver sees first.
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
time.AfterFunc(time.Second, cancel)
|
||||
|
||||
resp, err := r.QueryNameserverIP(
|
||||
ctx, "unreachable.test.", "192.0.2.1",
|
||||
"example.com",
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, resolver.StatusTimeout, resp.Status)
|
||||
assert.NotEmpty(t, resp.Error)
|
||||
}
|
||||
|
||||
// TestQueryNameserverIP_CancelledLogsNothing cancels the context while
|
||||
// a query to 192.0.2.1, where nothing answers, is waiting for a reply,
|
||||
// as shutdown does. The query was cut short, not failed, so nothing is
|
||||
|
||||
@@ -8,8 +8,6 @@ import (
|
||||
"github.com/go-chi/chi/v5"
|
||||
chimw "github.com/go-chi/chi/v5/middleware"
|
||||
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||
|
||||
"sneak.berlin/go/dnswatcher/static"
|
||||
)
|
||||
|
||||
// requestTimeout is the maximum duration for handling a request.
|
||||
@@ -47,13 +45,7 @@ func (s *Server) SetupRoutes() {
|
||||
public.Get("/", s.handlers.HandleDashboard())
|
||||
|
||||
// Static assets (embedded CSS/JS)
|
||||
public.Mount(
|
||||
"/s",
|
||||
http.StripPrefix(
|
||||
"/s",
|
||||
http.FileServer(http.FS(static.Static)),
|
||||
),
|
||||
)
|
||||
public.Mount("/s", http.StripPrefix("/s", s.handlers.HandleStatic()))
|
||||
|
||||
// Health check (standard well-known path)
|
||||
public.Get(
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package server_test
|
||||
|
||||
import (
|
||||
"mime"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
@@ -288,3 +289,42 @@ func TestMetricsRateLimitComesBeforeAuth(t *testing.T) {
|
||||
t.Errorf("another address: status = %d, want 200", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
// TestStaticDirectoriesAnswerNotFound checks that a request naming a
|
||||
// directory of the static assets, with or without the trailing slash,
|
||||
// answers 404 rather than a listing of it or a redirect to one, and
|
||||
// that the stylesheet is still served as CSS.
|
||||
func TestStaticDirectoriesAnswerNotFound(t *testing.T) {
|
||||
viper.Reset()
|
||||
t.Setenv("DNSWATCHER_TARGETS", "example.com")
|
||||
|
||||
srv := routedServer(t)
|
||||
|
||||
for _, path := range []string{"/s", "/s/", "/s/css", "/s/css/"} {
|
||||
rec := serve(srv, httptest.NewRequestWithContext(
|
||||
t.Context(), http.MethodGet, path, nil,
|
||||
))
|
||||
|
||||
if rec.Code != http.StatusNotFound {
|
||||
t.Errorf("GET %s: status = %d, want 404", path, rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
rec := serve(srv, httptest.NewRequestWithContext(
|
||||
t.Context(), http.MethodGet, "/s/css/tailwind.min.css", nil,
|
||||
))
|
||||
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Errorf("GET stylesheet: status = %d, want 200", rec.Code)
|
||||
}
|
||||
|
||||
contentType := rec.Header().Get("Content-Type")
|
||||
|
||||
mediaType, _, err := mime.ParseMediaType(contentType)
|
||||
if err != nil || mediaType != "text/css" {
|
||||
t.Errorf(
|
||||
"GET stylesheet: Content-Type = %q, want text/css",
|
||||
contentType,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user