certctl/internal/observability/otel_test.go

// Copyright 2026 certctl LLC. All rights reserved.
// SPDX-License-Identifier: BUSL-1.1

package observability

import (
	"context"
	"testing"
	"time"

	"go.opentelemetry.io/otel"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

// TestInit_Disabled_NoOp pins the disabled-mode contract: Init with
// Enabled=false returns a non-nil shutdown that succeeds and does
// NOT register a real tracer provider. Acquisition-audit DEPL-006
// closure (Sprint 6 ACQ, 2026-05-16).
func TestInit_Disabled_NoOp(t *testing.T) {
	// Capture the global tracer provider before Init so we can assert
	// it didn't change.
	before := otel.GetTracerProvider()

	shutdown, err := Init(context.Background(), Config{Enabled: false})
	if err != nil {
		t.Fatalf("Init(Enabled=false) = %v; want nil", err)
	}
	if shutdown == nil {
		t.Fatal("Init(Enabled=false) returned nil shutdown; want a no-op closure")
	}
	if got := otel.GetTracerProvider(); got != before {
		t.Errorf("disabled Init mutated the global tracer provider; before=%T after=%T", before, got)
	}

	// shutdown must succeed cleanly (no panic, no error, no hang).
	sctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()
	if err := shutdown(sctx); err != nil {
		t.Errorf("noop shutdown returned %v; want nil", err)
	}
}

// TestInit_Enabled_RegistersTracerProvider pins the enabled-mode
// contract: Init with Enabled=true returns a real shutdown and
// installs an SDK-backed tracer provider as the otel global. The
// OTLP exporter connects lazily so this test does NOT require a
// reachable collector — Init returns nil error even when no
// collector is running, and the shutdown drains gracefully.
// Acquisition-audit DEPL-006 closure (Sprint 6 ACQ, 2026-05-16).
func TestInit_Enabled_RegistersTracerProvider(t *testing.T) {
	// Point the exporter at a localhost dead-end so the test never
	// flakes against a real collector. Insecure mode skips the TLS
	// handshake — otherwise the gRPC client would block on TLS even
	// for the lazy connect path.
	t.Setenv("OTEL_EXPORTER_OTLP_ENDPOINT", "http://127.0.0.1:1") // unreachable port
	t.Setenv("OTEL_EXPORTER_OTLP_INSECURE", "true")

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	// Snapshot + restore the global tracer provider so this test
	// doesn't leak into other tests' state.
	before := otel.GetTracerProvider()
	t.Cleanup(func() { otel.SetTracerProvider(before) })

	shutdown, err := Init(ctx, Config{Enabled: true})
	if err != nil {
		t.Fatalf("Init(Enabled=true) = %v; want nil", err)
	}
	defer func() {
		sctx, scancel := context.WithTimeout(context.Background(), 2*time.Second)
		defer scancel()
		if err := shutdown(sctx); err != nil {
			// Shutdown may fail if the lazy gRPC connect ultimately
			// times out against the dead-end endpoint. That's a
			// noisy-but-non-fatal outcome — the surface is wired
			// correctly, only the destination is intentionally
			// unreachable in this test.
			t.Logf("shutdown returned %v (expected for unreachable endpoint)", err)
		}
	}()

	got := otel.GetTracerProvider()
	if _, ok := got.(*sdktrace.TracerProvider); !ok {
		t.Errorf("enabled Init did not install an SDK tracer provider; got %T", got)
	}
}

// TestInit_Enabled_RespectsOTEL_SERVICE_NAME pins that the standard
// OTEL_SERVICE_NAME env var overrides the certctl-server default —
// flowing through resource.WithFromEnv. No certctl-specific
// CERTCTL_OTEL_SERVICE_NAME env var exists; the OTel SDK's
// existing env-var surface is the only override path.
func TestInit_Enabled_RespectsOTEL_SERVICE_NAME(t *testing.T) {
	t.Setenv("OTEL_EXPORTER_OTLP_ENDPOINT", "http://127.0.0.1:1")
	t.Setenv("OTEL_EXPORTER_OTLP_INSECURE", "true")
	t.Setenv("OTEL_SERVICE_NAME", "certctl-override-test")

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	before := otel.GetTracerProvider()
	t.Cleanup(func() { otel.SetTracerProvider(before) })

	shutdown, err := Init(ctx, Config{Enabled: true})
	if err != nil {
		t.Fatalf("Init = %v; want nil", err)
	}
	defer shutdown(context.Background())
}