Full rebrand across cosmetic branding, code identifiers, and infrastructure/data-plane naming, using the supplied Cairn OBS logo package. Cosmetic: favicon/logo swap (also closes a stale license-audit finding -- the old favicon was SvelteKit's unreplaced scaffold logo), new centered welcome landing page, larger/legible sidebar logo, page titles, CLAUDE.md/README/docs prose. Code identifiers: Go module path github.com/sentry/sentry -> github.com/cairnobs/cairnobs across all 13 modules and ~91 files (protoc regenerated); Rust crates sentry-agent/sentry-parser/sentry-search -> cairnobs-*; CLI sentryctl -> cairnobsctl; Terraform provider fully renamed (sentry_dashboard etc. -> cairnobs_dashboard, provider type, env vars); every session/auth cookie name; agent config paths and Windows service identity. Deliberately preserved: the gRPC wire protocol's protobuf packages (sentry.logs.v1, sentry.agent.v1) and their Go import directory (proto/sentry/...) -- renaming the wire-level package would break every currently-deployed agent binary (confirmed two real hosts, including mail.inbuxa.com, are actively streaming through this exact contract) until rebuilt and redeployed in lockstep with an ingest cutover. Only the Go module path wrapping the generated code changes. Infrastructure: every docker-compose container name (root and three component-level compose files); the Helm chart (directory, Chart.yaml, named-template helpers, all templates, values.yaml image repos); Kubernetes Operator (CRD group sentry.io -> cairnobs.io, both CRD YAML files, Go identifiers, RBAC markers); the coupled enterprise/tenantcrd package. Caught and fixed real path-coupling bugs along the way: the Helm chart's search/ingest volume mounts and the dev-only-credential detection constant vs. docker-compose.yml's literal values had to move together or a security warning would have silently stopped firing. Data plane: Postgres database sentry_metadata -> cairnobs_metadata and role sentry -> cairnobs; ClickHouse database sentry -> cairnobs; Kafka topic sentry.logs.raw -> cairnobs.logs.raw and its consumer groups. Source-level defaults, docker-compose.yml, and every migrate.sh/ provision script default updated together; already-applied migration files left untouched per this repo's immutable-migration convention. Verified at every layer: all 13 Go modules build/vet/test clean, both Rust workspaces (agent, search) build/clippy/test clean, npm run check/ build clean, docker compose config validates on all four compose files. Live-verified against a real docker stack multiple times through this work, including a final fresh-volume run confirming the actual renamed Postgres database/role, ClickHouse database, and Kafka topic all work end to end with a real login and query, zero console errors.
279 lines
9.7 KiB
Go
279 lines
9.7 KiB
Go
package httpapi
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/cairnobs/cairnobs/alerting/internal/notifystore"
|
|
"github.com/cairnobs/cairnobs/alerting/internal/rulestore"
|
|
)
|
|
|
|
type fakeRuleStore struct {
|
|
rules map[string]*rulestore.RuleWithState
|
|
}
|
|
|
|
func newFakeRuleStore() *fakeRuleStore {
|
|
return &fakeRuleStore{rules: map[string]*rulestore.RuleWithState{}}
|
|
}
|
|
|
|
func (f *fakeRuleStore) Create(_ context.Context, r *rulestore.Rule) error {
|
|
r.ID = "rule-1"
|
|
f.rules[r.ID] = &rulestore.RuleWithState{Rule: *r, State: rulestore.AlertState{RuleID: r.ID, State: rulestore.StateOK}}
|
|
return nil
|
|
}
|
|
|
|
func (f *fakeRuleStore) List(_ context.Context) ([]rulestore.RuleWithState, error) {
|
|
var out []rulestore.RuleWithState
|
|
for _, r := range f.rules {
|
|
out = append(out, *r)
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
func (f *fakeRuleStore) Get(_ context.Context, id string) (*rulestore.RuleWithState, error) {
|
|
r, ok := f.rules[id]
|
|
if !ok {
|
|
return nil, rulestore.ErrNotFound
|
|
}
|
|
return r, nil
|
|
}
|
|
|
|
func (f *fakeRuleStore) Delete(_ context.Context, id string) error {
|
|
if _, ok := f.rules[id]; !ok {
|
|
return rulestore.ErrNotFound
|
|
}
|
|
delete(f.rules, id)
|
|
return nil
|
|
}
|
|
|
|
type fakeTargetStore struct {
|
|
targets map[string]*notifystore.Target
|
|
}
|
|
|
|
func newFakeTargetStore() *fakeTargetStore {
|
|
return &fakeTargetStore{targets: map[string]*notifystore.Target{}}
|
|
}
|
|
|
|
func (f *fakeTargetStore) Create(_ context.Context, t *notifystore.Target) error {
|
|
t.ID = "target-1"
|
|
f.targets[t.ID] = t
|
|
return nil
|
|
}
|
|
func (f *fakeTargetStore) List(_ context.Context) ([]notifystore.Target, error) {
|
|
var out []notifystore.Target
|
|
for _, t := range f.targets {
|
|
out = append(out, *t)
|
|
}
|
|
return out, nil
|
|
}
|
|
func (f *fakeTargetStore) Get(_ context.Context, id string) (*notifystore.Target, error) {
|
|
t, ok := f.targets[id]
|
|
if !ok {
|
|
return nil, notifystore.ErrNotFound
|
|
}
|
|
return t, nil
|
|
}
|
|
func (f *fakeTargetStore) Delete(_ context.Context, id string) error {
|
|
if _, ok := f.targets[id]; !ok {
|
|
return notifystore.ErrNotFound
|
|
}
|
|
delete(f.targets, id)
|
|
return nil
|
|
}
|
|
|
|
type fakeDeliveryReader struct {
|
|
entries []rulestore.DeliveryLogEntry
|
|
}
|
|
|
|
func (f *fakeDeliveryReader) ListForRule(_ context.Context, _ string, _ int) ([]rulestore.DeliveryLogEntry, error) {
|
|
return f.entries, nil
|
|
}
|
|
|
|
func newTestMux(rules ruleStore, targets targetStore, deliveries deliveryReader) *http.ServeMux {
|
|
h := NewHandler(slog.New(slog.NewTextHandler(io.Discard, nil)), rules, targets, deliveries)
|
|
mux := http.NewServeMux()
|
|
h.RegisterRoutes(mux)
|
|
return mux
|
|
}
|
|
|
|
func doRequest(t *testing.T, mux *http.ServeMux, method, path, body string) *httptest.ResponseRecorder {
|
|
t.Helper()
|
|
var r io.Reader
|
|
if body != "" {
|
|
r = strings.NewReader(body)
|
|
}
|
|
req := httptest.NewRequest(method, path, r)
|
|
rec := httptest.NewRecorder()
|
|
mux.ServeHTTP(rec, req)
|
|
return rec
|
|
}
|
|
|
|
func TestCreateThresholdRule(t *testing.T) {
|
|
targets := newFakeTargetStore()
|
|
targets.targets["target-1"] = ¬ifystore.Target{ID: "target-1"}
|
|
mux := newTestMux(newFakeRuleStore(), targets, &fakeDeliveryReader{})
|
|
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "High error rate", "query": "service=api | where status>=500 | stats count",
|
|
"condition_type": "threshold", "comparator": "gt", "threshold_value": 100,
|
|
"eval_interval_seconds": 60, "notification_target_id": "target-1"
|
|
}`)
|
|
if rec.Code != http.StatusCreated {
|
|
t.Fatalf("status = %d, want 201; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
// TestCreateRuleDefaultsToEnabledWhenOmitted guards against a real bug
|
|
// caught by actually calling this endpoint: a plain `bool` JSON field
|
|
// can't distinguish "omitted" from "explicitly false," and Go's zero
|
|
// value for bool is false -- without createRuleRequest's *bool handling,
|
|
// a create request that simply didn't mention "enabled" silently created
|
|
// a rule the evaluator's claim query would never pick up.
|
|
func TestCreateRuleDefaultsToEnabledWhenOmitted(t *testing.T) {
|
|
rules := newFakeRuleStore()
|
|
mux := newTestMux(rules, newFakeTargetStore(), &fakeDeliveryReader{})
|
|
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "no enabled field", "query": "service=api", "condition_type": "absence",
|
|
"eval_interval_seconds": 60, "notification_target_id": "target-1"
|
|
}`)
|
|
if rec.Code != http.StatusCreated {
|
|
t.Fatalf("status = %d, want 201; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if !rules.rules["rule-1"].Enabled {
|
|
t.Fatalf("expected a rule created without an explicit \"enabled\" field to default to enabled=true")
|
|
}
|
|
}
|
|
|
|
func TestCreateRuleRespectsExplicitDisabled(t *testing.T) {
|
|
rules := newFakeRuleStore()
|
|
mux := newTestMux(rules, newFakeTargetStore(), &fakeDeliveryReader{})
|
|
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "explicitly disabled", "query": "service=api", "condition_type": "absence",
|
|
"eval_interval_seconds": 60, "notification_target_id": "target-1", "enabled": false
|
|
}`)
|
|
if rec.Code != http.StatusCreated {
|
|
t.Fatalf("status = %d, want 201; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if rules.rules["rule-1"].Enabled {
|
|
t.Fatalf("expected an explicit \"enabled\": false to be respected")
|
|
}
|
|
}
|
|
|
|
func TestCreateThresholdRuleRejectsMissingComparator(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "bad rule", "query": "service=api", "condition_type": "threshold",
|
|
"eval_interval_seconds": 60, "notification_target_id": "target-1"
|
|
}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestCreateAbsenceRuleDoesNotRequireComparator(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "no heartbeat", "query": "service=payments earliest=-5m", "condition_type": "absence",
|
|
"eval_interval_seconds": 60, "notification_target_id": "target-1"
|
|
}`)
|
|
if rec.Code != http.StatusCreated {
|
|
t.Fatalf("status = %d, want 201; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestCreateRuleRejectsShortInterval(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodPost, "/rules", `{
|
|
"name": "too fast", "query": "service=api", "condition_type": "absence",
|
|
"eval_interval_seconds": 5, "notification_target_id": "target-1"
|
|
}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestGetRuleNotFound(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodGet, "/rules/nope", "")
|
|
if rec.Code != http.StatusNotFound {
|
|
t.Fatalf("status = %d, want 404", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestDeleteRule(t *testing.T) {
|
|
rules := newFakeRuleStore()
|
|
rules.rules["rule-1"] = &rulestore.RuleWithState{Rule: rulestore.Rule{ID: "rule-1"}}
|
|
mux := newTestMux(rules, newFakeTargetStore(), &fakeDeliveryReader{})
|
|
|
|
rec := doRequest(t, mux, http.MethodDelete, "/rules/rule-1", "")
|
|
if rec.Code != http.StatusNoContent {
|
|
t.Fatalf("status = %d, want 204", rec.Code)
|
|
}
|
|
if _, ok := rules.rules["rule-1"]; ok {
|
|
t.Fatalf("expected rule to be deleted")
|
|
}
|
|
}
|
|
|
|
func TestCreateTargetRejectsInvalidKind(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodPost, "/targets", `{"name": "x", "kind": "carrier-pigeon", "webhook_url": "https://example.com"}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestCreateSlackTarget(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
// A literal public IP, not a real hostname like hooks.slack.com --
|
|
// ValidateWebhookURL (see notifystore/ssrf.go) now resolves the
|
|
// target host and rejects internal/metadata addresses, so this test
|
|
// stays deterministic without depending on live DNS; ssrf_test.go
|
|
// covers the validation logic itself in depth.
|
|
rec := doRequest(t, mux, http.MethodPost, "/targets", `{"name": "oncall", "kind": "slack", "webhook_url": "https://8.8.8.8/services/x"}`)
|
|
if rec.Code != http.StatusCreated {
|
|
t.Fatalf("status = %d, want 201; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
// TestCreateTargetRejectsSSRFWebhookURL is the regression test for the
|
|
// security-audit finding that target creation performed no URL
|
|
// validation at all -- any authenticated user could point a webhook at
|
|
// an internal or cloud-metadata address.
|
|
func TestCreateTargetRejectsSSRFWebhookURL(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodPost, "/targets", `{"name": "x", "kind": "webhook", "webhook_url": "http://169.254.169.254/latest/meta-data/"}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestListDeliveriesForRule(t *testing.T) {
|
|
deliveries := &fakeDeliveryReader{entries: []rulestore.DeliveryLogEntry{
|
|
{ID: 1, RuleID: "rule-1", EventType: "firing", Status: "sent"},
|
|
}}
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), deliveries)
|
|
|
|
rec := doRequest(t, mux, http.MethodGet, "/rules/rule-1/deliveries", "")
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if !strings.Contains(rec.Body.String(), `"status":"sent"`) {
|
|
t.Fatalf("expected delivery entry in response, got: %s", rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestHandleHealthz(t *testing.T) {
|
|
mux := newTestMux(newFakeRuleStore(), newFakeTargetStore(), &fakeDeliveryReader{})
|
|
rec := doRequest(t, mux, http.MethodGet, "/healthz", "")
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200", rec.Code)
|
|
}
|
|
}
|