Files
archie/internal/channels/webhook/webhook_test.go
T
sam 543b657472 feat(webhookguard): shared HMAC, rate-limit, and redaction mechanics
archie-core-7d5u.3 -- storage-agnostic building blocks for vetting inbound
webhook-shaped requests, extracted rather than duplicated:

- VerifyHMAC: behavior-preserving extraction of internal/channels/webhook's
  private validateHMAC. internal/channels/webhook now calls it instead of
  keeping its own copy; all 10 of that package's existing tests still pass
  unmodified, and the one now-redundant unit test was removed with a
  comment pointing to where its coverage relocated.
- RateLimiter: per-source token bucket. Source IDs come from a registered,
  operator-controlled set, not unbounded attacker input, so the bucket map
  is not itself bounded -- documented explicitly rather than left implicit.
- RedactPayload: key-name-based redaction, matching gateway/stream.go's
  sensitiveParameterKey marker list. Deliberately does NOT reuse that
  function's actual behavior: it replaces every string value regardless of
  key, correct for a bounded chat summary and wrong here -- a captured
  payload exists to be inspected for field mapping (t2db.3), so only values
  under a sensitive-looking key are touched.

Narrowed from 7d5u.3's original scope, which bundled capture storage and an
approval state machine into this package. Both moved to the beads that own
that state (t2db.1's capture store depends on 7d5u.2's still-open NATS
storage decision; t2db.4's binding is the only consumer of approval state
today) rather than building shared abstractions ahead of a second real
consumer.

Adversarially reviewed by a fresh subagent with zero surviving findings:
token-bucket math hand-traced on two scenarios and race-clean under -race,
the redaction/gateway-stream.go behavioral divergence verified by reading
both functions side by side, both the redaction and rate-limit guards
mutation-tested by disabling each and confirming the suite catches it.

task check exit 0, golangci-lint 0 issues, gofumpt clean.
2026-08-22 01:28:58 +10:00

154 lines
4.9 KiB
Go

package webhook
import (
"context"
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"log/slog"
"net/http"
"net/http/httptest"
"os"
"strings"
"testing"
"time"
"github.com/samcharles93/archie-core/internal/gateway"
)
func TestName(t *testing.T) {
g := New("", 0, nil, slog.Default())
if g.Name() != "webhook" {
t.Errorf("Name() = %q", g.Name())
}
}
// HMAC signature verification itself is now internal/webhookguard.VerifyHMAC
// and tested there; TestWebhookHandlerValidSignature and
// TestWebhookHandlerInvalidSignature below cover this package's own
// responsibility -- that the handler actually calls it and reacts correctly
// to the result.
func TestExtractText(t *testing.T) {
body := []byte(`{"issue":{"title":"fix bug","body":"details"}}`)
if got := extractText(body, "issue.title"); got != "fix bug" {
t.Errorf("extract issue.title = %q", got)
}
if got := extractText(body, "issue.body"); got != "details" {
t.Errorf("extract issue.body = %q", got)
}
if got := extractText(body, ""); got != `{"issue":{"title":"fix bug","body":"details"}}` {
t.Errorf("empty path should return raw body: %q", got)
}
if got := extractText(body, "nonexistent"); got != "" {
t.Errorf("nonexistent path: %q", got)
}
}
func TestWebhookHandlerMethodNotAllowed(t *testing.T) {
g := New("", 0, []RouteConfig{{Path: "/hook"}}, slog.Default())
handler := g.WebhookHandler()
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/hook", nil))
if rec.Code != http.StatusMethodNotAllowed {
t.Errorf("status = %d, want 405", rec.Code)
}
}
func TestWebhookHandlerEmptyBody(t *testing.T) {
g := New("", 0, []RouteConfig{{Path: "/hook"}}, slog.Default())
handler := g.WebhookHandler()
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, httptest.NewRequestWithContext(context.Background(), http.MethodPost, "/hook", nil))
if rec.Code != http.StatusBadRequest {
t.Errorf("status = %d, want 400", rec.Code)
}
}
func TestWebhookHandlerNotStarted(t *testing.T) {
g := New("", 0, []RouteConfig{{Path: "/hook"}}, slog.Default())
handler := g.WebhookHandler()
rec := httptest.NewRecorder()
body := strings.NewReader(`{"text":"hello"}`)
handler.ServeHTTP(rec, httptest.NewRequestWithContext(context.Background(), http.MethodPost, "/hook", body))
if rec.Code != http.StatusServiceUnavailable {
t.Errorf("status = %d, want 503", rec.Code)
}
}
func TestWebhookHandlerRoute(t *testing.T) {
log := slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelWarn}))
g := New("", 0, []RouteConfig{{Path: "/hook"}}, log)
g.router = gateway.NewRouter(nil, nil, "webhook")
handler := g.WebhookHandler()
payload := `{"text":"hello from webhook"}`
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, httptest.NewRequestWithContext(context.Background(), http.MethodPost, "/hook", strings.NewReader(payload)))
if rec.Code != http.StatusAccepted {
t.Errorf("status = %d, want 202", rec.Code)
}
}
func TestWebhookHandlerInvalidSignature(t *testing.T) {
g := New("", 0, []RouteConfig{{Path: "/hook", Secret: "secret"}}, slog.Default())
g.router = gateway.NewRouter(nil, nil, "webhook")
handler := g.WebhookHandler()
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, httptest.NewRequestWithContext(context.Background(), http.MethodPost, "/hook", strings.NewReader(`{"text":"x"}`)))
if rec.Code != http.StatusUnauthorized {
t.Errorf("status = %d, want 401", rec.Code)
}
}
func TestWebhookHandlerValidSignature(t *testing.T) {
secret := "secret"
body := []byte(`{"text":"hello"}`)
mac := hmac.New(sha256.New, []byte(secret))
mac.Write(body)
sig := "sha256=" + hex.EncodeToString(mac.Sum(nil))
g := New("", 0, []RouteConfig{{Path: "/hook", Secret: secret}}, slog.Default())
g.router = gateway.NewRouter(nil, nil, "webhook")
handler := g.WebhookHandler()
req := httptest.NewRequestWithContext(context.Background(), http.MethodPost, "/hook", strings.NewReader(string(body)))
req.Header.Set("X-Hub-Signature-256", sig)
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, req)
if rec.Code != http.StatusAccepted {
t.Errorf("status = %d, want 202", rec.Code)
}
}
func TestWebhookStartStop(t *testing.T) {
log := slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelWarn}))
g := New("127.0.0.1", 18645, nil, log)
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
defer cancel()
router := gateway.NewRouter(nil, nil, "webhook")
go func() { _ = g.Start(ctx, router) }()
time.Sleep(30 * time.Millisecond)
_ = g.Stop(context.Background())
}
func TestExtractTextJSONRoundTrip(t *testing.T) {
data := []byte(`{"action":"push","repo":{"name":"archie-core"}}`)
if got := extractText(data, "action"); got != "push" {
t.Errorf("action = %q", got)
}
if got := extractText(data, "repo.name"); got != "archie-core" {
t.Errorf("repo.name = %q", got)
}
}
// Compile-time guard.
var _ gateway.Gateway = (*Gateway)(nil)