Files
certctl/internal/api/handler/export_handler_test.go
T
certctl-bot a86816451a refactor(handler,repo): replace strings.Contains error dispatch with typed sentinels (S-2)
Closes one 2026-04-24 audit finding (P2):

  - cat-s6-efc7f6f6bd50: 30 strings.Contains(err.Error(), ...) sites
    in internal/api/handler/ — brittle to repository-layer message
    changes, untyped against the actual failure mode.

Approach (Option B from prompt design notes):
  - New typed sentinels in internal/repository/errors.go:
      ErrNotFound, ErrForeignKeyConstraint
      IsForeignKeyError(err) helper (the only place substring
      matching at the lib/pq boundary is allowed; isolates the
      DB-driver string knowledge to one function).
  - New typed sentinel in internal/domain/errors.go:
      ErrValidation (reserved for future per-entity validation
      wrappers; not yet used by all handlers).
  - 49 sites in internal/repository/postgres/*.go updated to wrap
    sql.ErrNoRows-derived errors via fmt.Errorf("...: %w",
    repository.ErrNotFound).
  - 18 not-found handler sites + 2 FK-constraint handler sites
    refactored to errors.Is(err, repository.ErrNotFound) /
    repository.IsForeignKeyError(err).
  - 23 inline `fmt.Errorf("X not found")` test fixtures across
    handler tests rewrapped to wrap repository.ErrNotFound.
  - test_utils.go::ErrMockNotFound rewrapped to wrap
    repository.ErrNotFound; renewal_policy.go closure docblock
    updated to reflect the new convention.
  - integration test mockJobRepository.Get wraps repository.ErrNotFound.

CI regression guardrail:
- .github/workflows/ci.yml::"Forbidden strings.Contains(err.Error())
  regression guard (S-2)" greps for the three patterns ("not found",
  "violates foreign key", "RESTRICT") under internal/api/handler/
  and fails the build on regression.

Verification:
- go build ./... — clean
- go vet ./... — clean
- go test ./... -short -count=1 — all packages pass (handler +
  repository + service + integration)
- golangci-lint v2.11.4 run ./... — 0 issues
- S-2 guardrail dry-run on post-fix tree → empty (good)
- All sibling guardrails (S-1, G-3, D-1+D-2, B-1, L-1, H-1, C-1, F-1, P-1) pass

Audit findings closed:
- cat-s6-efc7f6f6bd50 (P2)

Deferred follow-ups:
- 6 domain-specific substring patterns still inline in handlers
  ("cannot approve", "cannot reject", "cannot be parsed",
  "no certificates found", "challenge password", "invalid"/
  "required" validation chains in profiles + agent_groups). Each
  needs its own typed sentinel, scoped per service. Documented
  by the S-2 CI guardrail's allowlist for closure-comments only.
- Per-entity not-found sentinels (Option A — ErrCertificateNotFound,
  ErrAgentNotFound, etc.) deferred. Generic ErrNotFound covers the
  current dispatch needs; per-entity precision would let handlers
  return entity-aware error bodies without a domain.Type field,
  but not blocking.
2026-04-25 17:54:14 +00:00

320 lines
9.2 KiB
Go

package handler
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/shankar0123/certctl/internal/service"
)
// Add context import was already there — verify import is present above
// MockExportService is a mock implementation of ExportService interface.
type MockExportService struct {
ExportPEMFn func(ctx context.Context, certID string) (*service.ExportPEMResult, error)
ExportPKCS12Fn func(ctx context.Context, certID string, password string) ([]byte, error)
}
func (m *MockExportService) ExportPEM(ctx context.Context, certID string) (*service.ExportPEMResult, error) {
if m.ExportPEMFn != nil {
return m.ExportPEMFn(ctx, certID)
}
return nil, nil
}
func (m *MockExportService) ExportPKCS12(ctx context.Context, certID string, password string) ([]byte, error) {
if m.ExportPKCS12Fn != nil {
return m.ExportPKCS12Fn(ctx, certID, password)
}
return nil, nil
}
func TestExportPEM_Success(t *testing.T) {
mockSvc := &MockExportService{
ExportPEMFn: func(_ context.Context, certID string) (*service.ExportPEMResult, error) {
if certID != "mc-test-1" {
t.Errorf("expected certID mc-test-1, got %s", certID)
}
return &service.ExportPEMResult{
CertPEM: "-----BEGIN CERTIFICATE-----\nAAA\n-----END CERTIFICATE-----\n",
ChainPEM: "-----BEGIN CERTIFICATE-----\nBBB\n-----END CERTIFICATE-----\n",
FullPEM: "-----BEGIN CERTIFICATE-----\nAAA\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nBBB\n-----END CERTIFICATE-----\n",
}, nil
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodGet, "/api/v1/certificates/mc-test-1/export/pem", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w.Code)
}
if ct := w.Header().Get("Content-Type"); ct != "application/json" {
t.Errorf("expected application/json content type, got %s", ct)
}
var result service.ExportPEMResult
if err := json.NewDecoder(w.Body).Decode(&result); err != nil {
t.Fatalf("failed to decode response: %v", err)
}
if result.CertPEM == "" {
t.Error("expected non-empty CertPEM")
}
if result.ChainPEM == "" {
t.Error("expected non-empty ChainPEM")
}
if result.FullPEM == "" {
t.Error("expected non-empty FullPEM")
}
}
func TestExportPEM_Download(t *testing.T) {
mockSvc := &MockExportService{
ExportPEMFn: func(_ context.Context, _ string) (*service.ExportPEMResult, error) {
return &service.ExportPEMResult{
CertPEM: "cert",
ChainPEM: "chain",
FullPEM: "full-pem-content",
}, nil
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodGet, "/api/v1/certificates/mc-test-1/export/pem?download=true", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w.Code)
}
if ct := w.Header().Get("Content-Type"); ct != "application/x-pem-file" {
t.Errorf("expected application/x-pem-file, got %s", ct)
}
if cd := w.Header().Get("Content-Disposition"); cd != `attachment; filename="certificate.pem"` {
t.Errorf("expected Content-Disposition attachment, got %s", cd)
}
if w.Body.String() != "full-pem-content" {
t.Errorf("expected full-pem-content body, got %s", w.Body.String())
}
}
func TestExportPEM_NotFound(t *testing.T) {
mockSvc := &MockExportService{
ExportPEMFn: func(_ context.Context, _ string) (*service.ExportPEMResult, error) {
return nil, fmt.Errorf("certificate not found: %w", ErrMockNotFound)
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodGet, "/api/v1/certificates/nonexistent/export/pem", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected 404, got %d", w.Code)
}
}
func TestExportPEM_ServiceError(t *testing.T) {
mockSvc := &MockExportService{
ExportPEMFn: func(_ context.Context, _ string) (*service.ExportPEMResult, error) {
return nil, fmt.Errorf("internal error")
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodGet, "/api/v1/certificates/mc-test-1/export/pem", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusInternalServerError {
t.Fatalf("expected 500, got %d", w.Code)
}
}
func TestExportPEM_MethodNotAllowed(t *testing.T) {
h := NewExportHandler(&MockExportService{})
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/mc-test-1/export/pem", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}
func TestExportPKCS12_Success(t *testing.T) {
pfxData := []byte{0x30, 0x82, 0x01, 0x00} // mock PKCS#12 data
mockSvc := &MockExportService{
ExportPKCS12Fn: func(_ context.Context, certID string, password string) ([]byte, error) {
if certID != "mc-test-1" {
t.Errorf("expected certID mc-test-1, got %s", certID)
}
if password != "mysecret" {
t.Errorf("expected password mysecret, got %s", password)
}
return pfxData, nil
},
}
h := NewExportHandler(mockSvc)
body := strings.NewReader(`{"password":"mysecret"}`)
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/mc-test-1/export/pkcs12", body)
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w.Code)
}
if ct := w.Header().Get("Content-Type"); ct != "application/x-pkcs12" {
t.Errorf("expected application/x-pkcs12, got %s", ct)
}
if cd := w.Header().Get("Content-Disposition"); cd != `attachment; filename="certificate.p12"` {
t.Errorf("expected Content-Disposition attachment, got %s", cd)
}
if len(w.Body.Bytes()) != len(pfxData) {
t.Errorf("expected %d bytes, got %d", len(pfxData), len(w.Body.Bytes()))
}
}
func TestExportPKCS12_EmptyPassword(t *testing.T) {
mockSvc := &MockExportService{
ExportPKCS12Fn: func(_ context.Context, _ string, password string) ([]byte, error) {
if password != "" {
t.Errorf("expected empty password, got %s", password)
}
return []byte{0x30}, nil
},
}
h := NewExportHandler(mockSvc)
// Empty body — password defaults to ""
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/mc-test-1/export/pkcs12", nil)
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w.Code)
}
}
func TestExportPKCS12_NotFound(t *testing.T) {
mockSvc := &MockExportService{
ExportPKCS12Fn: func(_ context.Context, _ string, _ string) ([]byte, error) {
return nil, fmt.Errorf("certificate not found: %w", ErrMockNotFound)
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/nonexistent/export/pkcs12", nil)
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected 404, got %d", w.Code)
}
}
func TestExportPKCS12_ServiceError(t *testing.T) {
mockSvc := &MockExportService{
ExportPKCS12Fn: func(_ context.Context, _ string, _ string) ([]byte, error) {
return nil, fmt.Errorf("encoding error")
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/mc-test-1/export/pkcs12", nil)
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusInternalServerError {
t.Fatalf("expected 500, got %d", w.Code)
}
}
func TestExportPKCS12_MethodNotAllowed(t *testing.T) {
h := NewExportHandler(&MockExportService{})
req := httptest.NewRequest(http.MethodGet, "/api/v1/certificates/mc-test-1/export/pkcs12", nil)
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}
func TestExtractCertIDFromExportPath(t *testing.T) {
tests := []struct {
path string
expected string
}{
{"/api/v1/certificates/mc-test-1/export/pem", "mc-test-1"},
{"/api/v1/certificates/mc-api-prod/export/pkcs12", "mc-api-prod"},
{"/api/v1/certificates//export/pem", ""},
{"/api/v1/other/mc-test-1/export/pem", ""},
{"/api/v1/certificates/mc-test-1", ""},
{"", ""},
}
for _, tt := range tests {
got := extractCertIDFromExportPath(tt.path)
if got != tt.expected {
t.Errorf("extractCertIDFromExportPath(%q) = %q, want %q", tt.path, got, tt.expected)
}
}
}
func TestExportPKCS12_InvalidJSON(t *testing.T) {
mockSvc := &MockExportService{
ExportPKCS12Fn: func(_ context.Context, _ string, password string) ([]byte, error) {
// Invalid JSON is silently ignored, defaults to empty password
if password != "" {
t.Errorf("expected empty password (invalid JSON ignored), got %s", password)
}
return []byte{0x30}, nil
},
}
h := NewExportHandler(mockSvc)
req := httptest.NewRequest(http.MethodPost, "/api/v1/certificates/mc-test-1/export/pkcs12", strings.NewReader(`{"invalid json`))
w := httptest.NewRecorder()
h.ExportPKCS12(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200 (invalid JSON ignored), got %d", w.Code)
}
}
func TestExportPEM_MethodNotAllowedDelete(t *testing.T) {
h := NewExportHandler(&MockExportService{})
req := httptest.NewRequest(http.MethodDelete, "/api/v1/certificates/mc-test-1/export/pem", nil)
w := httptest.NewRecorder()
h.ExportPEM(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}