Sweeps the references that carry no runtime coupling, and fixes one that
turned out to be a real bug rather than stale branding.
Docker network: sentry_default -> cairnobs_default across 23 runbook and
test-header `docker run` commands. Compose derives the network from the
directory name, so this lands together with renaming the working copy to
cairnobs/ -- the two are only correct as one change.
Stale references corrected: four Dockerfile "repo root (sentry/)"
headers; .env pointing at the long-renamed deploy/helm/sentry/ chart;
five Helm comments describing the topic as sentry.logs.raw when all four
code paths have defaulted to cairnobs.logs.raw for some time; an
absolute /home/john/Projects/sentry/ path in the operator's package doc,
now repo-relative; the hand-written Tenant CRD description in both of
its identical copies, whose Go source already said Cairn OBS.
Migration 0043 repoints the default tenant's data source. 0026 seeded it
with ('sentry', '/var/lib/sentry-search') to match what
api/internal/config then defaulted to; the rebrand later moved those
defaults to "cairnobs" and /var/lib/cairnobs-search without moving the
already-applied row, leaving the default tenant naming a ClickHouse
database nothing writes to. Scoped to the exact stale values so it is a
no-op on any deployment that set them deliberately. 0026's comment is
annotated as superseded; its applied SQL is untouched.
Deliberately not included: the gRPC wire packages (sentry.logs.v1,
sentry.agent.v1) and proto/sentry/ import paths, which cannot change
without a lockstep agent/server upgrade; the Helm chart's
sentry_metadata database and sentry role, which need a real Postgres
migration on existing deployments; and the compliance audit records in
docs/compliance/, which are a dated historical record.
go build, go vet, and go test pass for ingest and deploy/operator.
261 lines
9.9 KiB
Go
261 lines
9.9 KiB
Go
// Fail-closed behavior (empty/unknown tenant_id) needs no live
|
|
// ClickHouse at all -- Registry.WriteBatch returns before ever touching
|
|
// a connection for those cases, so those tests run unconditionally.
|
|
// Everything that actually writes data is a real integration test
|
|
// against a live ClickHouse (same CHWRITER_TEST_CLICKHOUSE_ADDR
|
|
// convention as enterprise/internal/chrunner's own tests), skipped
|
|
// unless that's set; run via:
|
|
//
|
|
// docker run --rm --network cairnobs_default -v $(pwd)/../../..:/src -w /src/enterprise \
|
|
// -e CHWRITER_TEST_CLICKHOUSE_ADDR=clickhouse:9000 \
|
|
// -e CHWRITER_TEST_CLICKHOUSE_PASSWORD=cairnobs-dev-only \
|
|
// golang:1.25-alpine go test ./internal/chwriter/... -v
|
|
package chwriter
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"log/slog"
|
|
"os"
|
|
"testing"
|
|
|
|
chdriver "github.com/ClickHouse/clickhouse-go/v2"
|
|
"github.com/google/uuid"
|
|
|
|
"github.com/cairnobs/cairnobs/enterprise/internal/tenantprovision"
|
|
"github.com/cairnobs/cairnobs/ingest/clickhousewriter"
|
|
"github.com/cairnobs/cairnobs/ingest/consumer"
|
|
logsv1 "github.com/cairnobs/cairnobs/proto/sentry/logs/v1"
|
|
)
|
|
|
|
func discardLogger() *slog.Logger {
|
|
return slog.New(slog.NewTextHandler(io.Discard, nil))
|
|
}
|
|
|
|
// TestWriteBatchRefusesEmptyTenantID and
|
|
// TestWriteBatchRefusesUnknownTenantWithEmptyRegistry construct a
|
|
// Registry directly (bypassing New, which would dial ClickHouse) so
|
|
// they genuinely run without Docker: WriteBatch's fail-closed checks
|
|
// happen before ever touching a real connection, purely a map lookup.
|
|
func TestWriteBatchRefusesEmptyTenantID(t *testing.T) {
|
|
reg := &Registry{writers: map[string]*clickhousewriter.Writer{}}
|
|
err := reg.WriteBatch(context.Background(), []consumer.Record{
|
|
{TenantID: "", Record: &logsv1.LogRecord{Message: "untagged"}},
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected WriteBatch to refuse a record with no tenant_id, not silently drop the tag")
|
|
}
|
|
}
|
|
|
|
func TestWriteBatchRefusesUnknownTenantWithEmptyRegistry(t *testing.T) {
|
|
reg := &Registry{writers: map[string]*clickhousewriter.Writer{}}
|
|
err := reg.WriteBatch(context.Background(), []consumer.Record{
|
|
{TenantID: "acme", Record: &logsv1.LogRecord{Message: "m"}},
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected WriteBatch to refuse a tenant with no entry in the registry")
|
|
}
|
|
}
|
|
|
|
// TestRefreshListerErrorLeavesRegistryUnchanged is Docker-free the same
|
|
// way the two tests above are: refresh's early-return on a lister error
|
|
// happens before anything touches ClickHouse, so this genuinely
|
|
// exercises the "keep last-known-good" path -- see refresh's doc
|
|
// comment on StartRefreshing.
|
|
func TestRefreshListerErrorLeavesRegistryUnchanged(t *testing.T) {
|
|
reg := &Registry{writers: map[string]*clickhousewriter.Writer{}}
|
|
lister := func(context.Context) ([]DataSource, error) {
|
|
return nil, errors.New("rbacstore unreachable")
|
|
}
|
|
|
|
reg.refresh(context.Background(), lister, discardLogger())
|
|
|
|
// Still refuses -- refresh must not have added a writer for "acme"
|
|
// (there's nothing a failed lister call could have legitimately
|
|
// learned), and must not have panicked reaching into a nil/partial
|
|
// state either.
|
|
err := reg.WriteBatch(context.Background(), []consumer.Record{
|
|
{TenantID: "acme", Record: &logsv1.LogRecord{Message: "m"}},
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected WriteBatch to still refuse tenant acme after a failed refresh")
|
|
}
|
|
}
|
|
|
|
func testAddr(t *testing.T) string {
|
|
t.Helper()
|
|
addr := os.Getenv("CHWRITER_TEST_CLICKHOUSE_ADDR")
|
|
if addr == "" {
|
|
t.Skip("CHWRITER_TEST_CLICKHOUSE_ADDR not set -- skipping live-ClickHouse integration test")
|
|
}
|
|
return addr
|
|
}
|
|
|
|
func provisionTestTenant(t *testing.T, addr string) (tenantID string, creds tenantprovision.Credentials) {
|
|
t.Helper()
|
|
admin, err := chdriver.Open(&chdriver.Options{
|
|
Addr: []string{addr},
|
|
Auth: chdriver.Auth{Database: "default", Username: "default", Password: os.Getenv("CHWRITER_TEST_CLICKHOUSE_PASSWORD")},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("opening admin connection: %v", err)
|
|
}
|
|
t.Cleanup(func() { admin.Close() })
|
|
|
|
tenantID = "cw" + uuid.NewString()[:8]
|
|
creds, err = tenantprovision.New(admin).ProvisionClickHouse(context.Background(), tenantID)
|
|
if err != nil {
|
|
t.Fatalf("provisioning tenant %s: %v", tenantID, err)
|
|
}
|
|
if err := admin.Exec(context.Background(), fmt.Sprintf(
|
|
"CREATE TABLE `%s`.logs (timestamp DateTime64(9), host String, service String, severity String, message String, attributes Map(String, String), record_id UUID) ENGINE = MergeTree ORDER BY timestamp",
|
|
tenantID)); err != nil {
|
|
t.Fatalf("creating logs table for tenant %s: %v", tenantID, err)
|
|
}
|
|
return tenantID, creds
|
|
}
|
|
|
|
// TestRegistryWritesEachTenantToItsOwnDatabase is the core adversarial
|
|
// probe for the write side, complementing chrunner's own read-side
|
|
// version: two tenants, two connections inside one Registry, one
|
|
// WriteBatch call mixing records from both, and a direct check (via an
|
|
// admin connection, not through Registry) that each tenant's row landed
|
|
// only in its own database.
|
|
func TestRegistryWritesEachTenantToItsOwnDatabase(t *testing.T) {
|
|
addr := testAddr(t)
|
|
ctx := context.Background()
|
|
tenantA, credsA := provisionTestTenant(t, addr)
|
|
tenantB, credsB := provisionTestTenant(t, addr)
|
|
|
|
reg, err := New(ctx, addr, []DataSource{
|
|
{TenantID: tenantA, Database: tenantA, Username: credsA.Username, Password: credsA.Password},
|
|
{TenantID: tenantB, Database: tenantB, Username: credsB.Username, Password: credsB.Password},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("New: %v", err)
|
|
}
|
|
defer reg.Close()
|
|
|
|
err = reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: tenantA, Record: &logsv1.LogRecord{Host: "h1", Message: "for-a", RecordId: uuid.NewString()}},
|
|
{TenantID: tenantB, Record: &logsv1.LogRecord{Host: "h1", Message: "for-b", RecordId: uuid.NewString()}},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("WriteBatch: %v", err)
|
|
}
|
|
|
|
admin, err := chdriver.Open(&chdriver.Options{
|
|
Addr: []string{addr},
|
|
Auth: chdriver.Auth{Database: "default", Username: "default", Password: os.Getenv("CHWRITER_TEST_CLICKHOUSE_PASSWORD")},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("opening admin connection: %v", err)
|
|
}
|
|
defer admin.Close()
|
|
|
|
for tenantID, wantMessage := range map[string]string{tenantA: "for-a", tenantB: "for-b"} {
|
|
row := admin.QueryRow(ctx, fmt.Sprintf("SELECT message FROM `%s`.logs", tenantID))
|
|
var got string
|
|
if err := row.Scan(&got); err != nil {
|
|
t.Fatalf("querying %s's logs: %v", tenantID, err)
|
|
}
|
|
if got != wantMessage {
|
|
t.Fatalf("tenant %s's logs.message = %q, want %q", tenantID, got, wantMessage)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRegistryRefusesUnprovisionedTenant(t *testing.T) {
|
|
addr := testAddr(t)
|
|
ctx := context.Background()
|
|
tenantA, credsA := provisionTestTenant(t, addr)
|
|
|
|
reg, err := New(ctx, addr, []DataSource{
|
|
{TenantID: tenantA, Database: tenantA, Username: credsA.Username, Password: credsA.Password},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("New: %v", err)
|
|
}
|
|
defer reg.Close()
|
|
|
|
err = reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: "some-other-tenant-never-provisioned", Record: &logsv1.LogRecord{Host: "h1", Message: "m", RecordId: uuid.NewString()}},
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected WriteBatch to refuse a tenant with no provisioned connection, not silently drop or misroute it")
|
|
}
|
|
}
|
|
|
|
// TestRefreshAddsNewlyActiveTenant is the live counterpart to
|
|
// TestRefreshListerErrorLeavesRegistryUnchanged: proves refresh actually
|
|
// opens a real, usable connection for a tenant that appears in a later
|
|
// lister call but wasn't present at New() time -- the scenario
|
|
// StartRefreshing exists to handle (a tenant provisioned after
|
|
// enterprise-ingest already started).
|
|
func TestRefreshAddsNewlyActiveTenant(t *testing.T) {
|
|
addr := testAddr(t)
|
|
ctx := context.Background()
|
|
tenantA, credsA := provisionTestTenant(t, addr)
|
|
|
|
reg, err := New(ctx, addr, nil) // starts with zero tenants, same as a cold start before any tenant exists
|
|
if err != nil {
|
|
t.Fatalf("New: %v", err)
|
|
}
|
|
defer reg.Close()
|
|
|
|
if err := reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: tenantA, Record: &logsv1.LogRecord{Message: "m", RecordId: uuid.NewString()}},
|
|
}); err == nil {
|
|
t.Fatal("expected WriteBatch to refuse tenantA before the first refresh has run")
|
|
}
|
|
|
|
lister := func(context.Context) ([]DataSource, error) {
|
|
return []DataSource{{TenantID: tenantA, Database: tenantA, Username: credsA.Username, Password: credsA.Password}}, nil
|
|
}
|
|
reg.refresh(ctx, lister, discardLogger())
|
|
|
|
if err := reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: tenantA, Record: &logsv1.LogRecord{Host: "h1", Message: "after-refresh", RecordId: uuid.NewString()}},
|
|
}); err != nil {
|
|
t.Fatalf("expected WriteBatch to succeed for tenantA after refresh added it, got: %v", err)
|
|
}
|
|
}
|
|
|
|
// TestRefreshRemovesNoLongerActiveTenant is TestRefreshAddsNewlyActiveTenant's
|
|
// mirror image: a tenant present at New() time that a later lister call
|
|
// no longer returns (deprovisioned or suspended) must lose its writer,
|
|
// not keep writing indefinitely until process restart -- the exact
|
|
// staleness gap this whole mechanism exists to close.
|
|
func TestRefreshRemovesNoLongerActiveTenant(t *testing.T) {
|
|
addr := testAddr(t)
|
|
ctx := context.Background()
|
|
tenantA, credsA := provisionTestTenant(t, addr)
|
|
|
|
reg, err := New(ctx, addr, []DataSource{
|
|
{TenantID: tenantA, Database: tenantA, Username: credsA.Username, Password: credsA.Password},
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("New: %v", err)
|
|
}
|
|
defer reg.Close()
|
|
|
|
if err := reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: tenantA, Record: &logsv1.LogRecord{Host: "h1", Message: "before-removal", RecordId: uuid.NewString()}},
|
|
}); err != nil {
|
|
t.Fatalf("expected WriteBatch to succeed for tenantA before refresh removes it, got: %v", err)
|
|
}
|
|
|
|
lister := func(context.Context) ([]DataSource, error) {
|
|
return nil, nil // tenantA no longer active/provisioned as of this refresh
|
|
}
|
|
reg.refresh(ctx, lister, discardLogger())
|
|
|
|
if err := reg.WriteBatch(ctx, []consumer.Record{
|
|
{TenantID: tenantA, Record: &logsv1.LogRecord{Message: "after-removal", RecordId: uuid.NewString()}},
|
|
}); err == nil {
|
|
t.Fatal("expected WriteBatch to refuse tenantA after refresh removed it, not keep writing with a stale connection")
|
|
}
|
|
}
|