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.
343 lines
11 KiB
Go
343 lines
11 KiB
Go
package queryapi
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/cairnobs/cairnobs/api/authz"
|
|
"github.com/cairnobs/cairnobs/api/querylang/executor"
|
|
)
|
|
|
|
type fakeSQLRunner struct {
|
|
result *executor.Result
|
|
err error
|
|
gotSQL string
|
|
}
|
|
|
|
func (f *fakeSQLRunner) RunSQL(_ context.Context, sql string) (*executor.Result, error) {
|
|
f.gotSQL = sql
|
|
if f.err != nil {
|
|
return nil, f.err
|
|
}
|
|
if f.result != nil {
|
|
return f.result, nil
|
|
}
|
|
return &executor.Result{Columns: []string{}, Rows: [][]any{}}, nil
|
|
}
|
|
|
|
type fakeSearchClient struct {
|
|
recordIDs []string
|
|
err error
|
|
gotQuery string
|
|
}
|
|
|
|
func (f *fakeSearchClient) Search(_ context.Context, query string, _ uint32) ([]string, error) {
|
|
f.gotQuery = query
|
|
if f.err != nil {
|
|
return nil, f.err
|
|
}
|
|
return f.recordIDs, nil
|
|
}
|
|
|
|
func newTestHandler(sqlRunner *fakeSQLRunner, search *fakeSearchClient) *Handler {
|
|
if search == nil {
|
|
search = &fakeSearchClient{}
|
|
}
|
|
return NewHandler(slog.New(slog.NewTextHandler(io.Discard, nil)), sqlRunner, search, time.Second, nil, nil)
|
|
}
|
|
|
|
type fakeAuditLogger struct {
|
|
entries []QueryAuditEntry
|
|
err error
|
|
}
|
|
|
|
func (f *fakeAuditLogger) LogQuery(_ context.Context, entry QueryAuditEntry) error {
|
|
f.entries = append(f.entries, entry)
|
|
return f.err
|
|
}
|
|
|
|
func newTestHandlerWithAudit(sqlRunner *fakeSQLRunner, audit *fakeAuditLogger) *Handler {
|
|
return NewHandler(slog.New(slog.NewTextHandler(io.Discard, nil)), sqlRunner, &fakeSearchClient{}, time.Second, audit, nil)
|
|
}
|
|
|
|
func newTestMux(h *Handler) *http.ServeMux {
|
|
mux := http.NewServeMux()
|
|
h.RegisterRoutes(mux)
|
|
return mux
|
|
}
|
|
|
|
func postQuery(t *testing.T, h *Handler, body string) *httptest.ResponseRecorder {
|
|
t.Helper()
|
|
req := httptest.NewRequest(http.MethodPost, "/query", strings.NewReader(body))
|
|
rec := httptest.NewRecorder()
|
|
newTestMux(h).ServeHTTP(rec, req)
|
|
return rec
|
|
}
|
|
|
|
func TestHandleQuerySQLSuccess(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{
|
|
Columns: []string{"host", "count"},
|
|
Rows: [][]any{{"h1", 3}},
|
|
}}
|
|
h := newTestHandler(sr, nil)
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT host, count(*) FROM logs GROUP BY host"}`)
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
var got queryResponse
|
|
if err := json.Unmarshal(rec.Body.Bytes(), &got); err != nil {
|
|
t.Fatalf("decoding response: %v", err)
|
|
}
|
|
if len(got.Columns) != 2 || len(got.Rows) != 1 {
|
|
t.Fatalf("unexpected result: %+v", got)
|
|
}
|
|
if sr.gotSQL != "SELECT host, count(*) FROM logs GROUP BY host" {
|
|
t.Fatalf("unexpected SQL passed through: %q", sr.gotSQL)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryPipeSyntaxSuccess(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{
|
|
Columns: []string{"host"},
|
|
Rows: [][]any{{"api"}},
|
|
}}
|
|
h := newTestHandler(sr, nil)
|
|
|
|
rec := postQuery(t, h, `{"query": "service=api"}`)
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if !strings.Contains(sr.gotSQL, "`service` = 'api'") {
|
|
t.Fatalf("expected compiled SQL to filter on service, got: %s", sr.gotSQL)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryTextSearchRoutesThroughSearchClient(t *testing.T) {
|
|
sr := &fakeSQLRunner{}
|
|
fs := &fakeSearchClient{recordIDs: []string{"id-1"}}
|
|
h := newTestHandler(sr, fs)
|
|
|
|
rec := postQuery(t, h, `{"query": "message:\"connection refused\""}`)
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if fs.gotQuery != `"connection refused"` {
|
|
t.Fatalf("search query = %q", fs.gotQuery)
|
|
}
|
|
if !strings.Contains(sr.gotSQL, "record_id IN ('id-1')") {
|
|
t.Fatalf("expected the search prefilter in the generated SQL, got: %s", sr.gotSQL)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryRejectsEmptyQuery(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
rec := postQuery(t, h, `{"query": " "}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryRejectsInvalidJSON(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
rec := postQuery(t, h, `not json`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryRejectsCompileError(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
rec := postQuery(t, h, `{"query": "service=api | bogus"}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryRejectsNonSelectSQL(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
rec := postQuery(t, h, `{"query": "DELETE FROM logs", "language": "sql"}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryRejectsInvalidLanguage(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
rec := postQuery(t, h, `{"query": "service=api", "language": "cobol"}`)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryExplicitLanguageOverridesAutoDetect(t *testing.T) {
|
|
sr := &fakeSQLRunner{}
|
|
fs := &fakeSearchClient{recordIDs: []string{"id-1"}}
|
|
h := newTestHandler(sr, fs)
|
|
|
|
// "select" alone would auto-detect as (nonsensical but
|
|
// syntactically-valid-looking) SQL without the override -- the
|
|
// override forces pipe-syntax parsing instead, where a bare word
|
|
// with no comparator is a free-text search term.
|
|
rec := postQuery(t, h, `{"query": "select", "language": "spl"}`)
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
if fs.gotQuery != "select" {
|
|
t.Fatalf("expected 'select' to be treated as a free-text search term, got query=%q", fs.gotQuery)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryExecutorErrorReturnsBadGateway(t *testing.T) {
|
|
sr := &fakeSQLRunner{err: errors.New("boom")}
|
|
h := newTestHandler(sr, nil)
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
|
|
if rec.Code != http.StatusBadGateway {
|
|
t.Fatalf("status = %d, want 502", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleHealthz(t *testing.T) {
|
|
h := newTestHandler(&fakeSQLRunner{}, nil)
|
|
req := httptest.NewRequest(http.MethodGet, "/healthz", nil)
|
|
rec := httptest.NewRecorder()
|
|
|
|
newTestMux(h).ServeHTTP(rec, req)
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryLogsAuditEntryOnSuccess(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{"host"}, Rows: [][]any{{"h1"}, {"h2"}}}}
|
|
audit := &fakeAuditLogger{}
|
|
h := newTestHandlerWithAudit(sr, audit)
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT host FROM logs"}`)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
|
|
if len(audit.entries) != 1 {
|
|
t.Fatalf("expected 1 audit entry, got %d", len(audit.entries))
|
|
}
|
|
entry := audit.entries[0]
|
|
if entry.Query != "SELECT host FROM logs" || !entry.Success || entry.RowCount != 2 || entry.Error != "" {
|
|
t.Fatalf("unexpected audit entry: %+v", entry)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryLogsAuditEntryOnFailure(t *testing.T) {
|
|
sr := &fakeSQLRunner{err: errors.New("boom")}
|
|
audit := &fakeAuditLogger{}
|
|
h := newTestHandlerWithAudit(sr, audit)
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusBadGateway {
|
|
t.Fatalf("status = %d, want 502", rec.Code)
|
|
}
|
|
|
|
if len(audit.entries) != 1 {
|
|
t.Fatalf("expected 1 audit entry even on failure, got %d", len(audit.entries))
|
|
}
|
|
entry := audit.entries[0]
|
|
if entry.Success || entry.Error == "" {
|
|
t.Fatalf("expected a failed audit entry with an error message, got %+v", entry)
|
|
}
|
|
}
|
|
|
|
// TestHandleQueryAuditWriteFailureDoesNotFailRequest proves the
|
|
// fail-open design: a request still succeeds even when the audit
|
|
// logger itself errors -- per queryapi.AuditLogger's doc comment and
|
|
// /docs/phase-4-isolation-design.md's audit fail-open/fail-closed policy.
|
|
func TestHandleQueryAuditWriteFailureDoesNotFailRequest(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{}, Rows: [][]any{}}}
|
|
audit := &fakeAuditLogger{err: errors.New("audit backend unreachable")}
|
|
h := newTestHandlerWithAudit(sr, audit)
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 -- an audit write failure must not fail the request", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryNilAuditLoggerIsNoOp(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{}, Rows: [][]any{}}}
|
|
h := newTestHandler(sr, nil) // audit is nil here
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200", rec.Code)
|
|
}
|
|
}
|
|
|
|
// fakeAuthorizer resolves every request to a fixed identity/error --
|
|
// task 5 wired authz.RequireRoleOrService into RegisterRoutes but every
|
|
// existing test above passes a nil authorizer (a deliberate no-op), so
|
|
// none of them actually exercise the wiring with a real authorizer
|
|
// present. Phase 4 task 8 (adversarial tests) closes that gap: these
|
|
// prove /query's authz boundary holds when a real Authorizer is wired
|
|
// in, not just that the middleware function works in isolation
|
|
// (authz/middleware_test.go already covers that).
|
|
type fakeAuthorizer struct {
|
|
identity authz.Identity
|
|
err error
|
|
}
|
|
|
|
func (f *fakeAuthorizer) Authorize(*http.Request) (authz.Identity, error) {
|
|
return f.identity, f.err
|
|
}
|
|
|
|
func newTestHandlerWithAuthorizer(sqlRunner *fakeSQLRunner, authorizer authz.Authorizer) *Handler {
|
|
return NewHandler(slog.New(slog.NewTextHandler(io.Discard, nil)), sqlRunner, &fakeSearchClient{}, time.Second, nil, authorizer)
|
|
}
|
|
|
|
func TestHandleQueryRejectsUnauthenticatedWhenAuthorizerConfigured(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{}, Rows: [][]any{}}}
|
|
h := newTestHandlerWithAuthorizer(sr, &fakeAuthorizer{err: errors.New("no session")})
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusUnauthorized {
|
|
t.Fatalf("status = %d, want 401", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestHandleQueryAllowsViewer(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{}, Rows: [][]any{}}}
|
|
h := newTestHandlerWithAuthorizer(sr, &fakeAuthorizer{identity: authz.Identity{TenantID: "acme", Role: authz.RoleViewer}})
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
// TestHandleQueryAllowsServiceIdentity is the other half of the
|
|
// alerting<->api gap's fix (/docs/phase-4-isolation-design.md) --
|
|
// /alerting's evaluator must be able to call POST /query with its
|
|
// RoleService credential even though it's not a human session.
|
|
func TestHandleQueryAllowsServiceIdentity(t *testing.T) {
|
|
sr := &fakeSQLRunner{result: &executor.Result{Columns: []string{}, Rows: [][]any{}}}
|
|
h := newTestHandlerWithAuthorizer(sr, &fakeAuthorizer{identity: authz.Identity{Role: authz.RoleService}})
|
|
|
|
rec := postQuery(t, h, `{"query": "SELECT 1"}`)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 -- RoleService must be allowed on /query; body=%s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|