Files
certctl/internal/api/handler/job_handler_test.go
T
shankar0123 0e29c416b1 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

557 lines
15 KiB
Go

package handler
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/shankar0123/certctl/internal/domain"
"github.com/shankar0123/certctl/internal/service"
)
// MockJobService is a mock implementation of JobService interface.
// Approve/Reject closures now take the actor string so tests can assert
// actor propagation from the auth middleware → handler → service.
type MockJobService struct {
ListJobsFn func(status, jobType string, page, perPage int) ([]domain.Job, int64, error)
GetJobFn func(id string) (*domain.Job, error)
CancelJobFn func(id string) error
ApproveJobFn func(id, actor string) error
RejectJobFn func(id, reason, actor string) error
}
func (m *MockJobService) ListJobs(_ context.Context, status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
if m.ListJobsFn != nil {
return m.ListJobsFn(status, jobType, page, perPage)
}
return nil, 0, nil
}
func (m *MockJobService) GetJob(_ context.Context, id string) (*domain.Job, error) {
if m.GetJobFn != nil {
return m.GetJobFn(id)
}
return nil, nil
}
func (m *MockJobService) CancelJob(_ context.Context, id string) error {
if m.CancelJobFn != nil {
return m.CancelJobFn(id)
}
return nil
}
func (m *MockJobService) ApproveJob(_ context.Context, id, actor string) error {
if m.ApproveJobFn != nil {
return m.ApproveJobFn(id, actor)
}
return nil
}
func (m *MockJobService) RejectJob(_ context.Context, id, reason, actor string) error {
if m.RejectJobFn != nil {
return m.RejectJobFn(id, reason, actor)
}
return nil
}
func TestListJobs_Success(t *testing.T) {
now := time.Now()
job1 := domain.Job{
ID: "job-001",
Type: domain.JobTypeRenewal,
CertificateID: "mc-prod-001",
Status: domain.JobStatusPending,
Attempts: 0,
MaxAttempts: 3,
ScheduledAt: now,
CreatedAt: now,
}
job2 := domain.Job{
ID: "job-002",
Type: domain.JobTypeDeployment,
CertificateID: "mc-prod-002",
Status: domain.JobStatusCompleted,
Attempts: 1,
MaxAttempts: 3,
ScheduledAt: now,
CreatedAt: now,
}
mock := &MockJobService{
ListJobsFn: func(status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
return []domain.Job{job1, job2}, 2, nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
var resp PagedResponse
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
t.Fatalf("failed to decode response: %v", err)
}
if resp.Total != 2 {
t.Errorf("expected total 2, got %d", resp.Total)
}
}
func TestListJobs_FilterByStatus(t *testing.T) {
var capturedStatus string
mock := &MockJobService{
ListJobsFn: func(status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
capturedStatus = status
return []domain.Job{}, 0, nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs?status=Pending", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
if capturedStatus != "Pending" {
t.Errorf("expected status filter 'Pending', got '%s'", capturedStatus)
}
}
func TestListJobs_FilterByType(t *testing.T) {
var capturedType string
mock := &MockJobService{
ListJobsFn: func(status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
capturedType = jobType
return []domain.Job{}, 0, nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs?type=Renewal", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
if capturedType != "Renewal" {
t.Errorf("expected type filter 'Renewal', got '%s'", capturedType)
}
}
func TestListJobs_ServiceError(t *testing.T) {
mock := &MockJobService{
ListJobsFn: func(status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
return nil, 0, ErrMockServiceFailed
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if w.Code != http.StatusInternalServerError {
t.Fatalf("expected status 500, got %d", w.Code)
}
}
func TestListJobs_MethodNotAllowed(t *testing.T) {
handler := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs", nil)
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected status 405, got %d", w.Code)
}
}
func TestListJobs_Pagination(t *testing.T) {
var capturedPage, capturedPerPage int
mock := &MockJobService{
ListJobsFn: func(status, jobType string, page, perPage int) ([]domain.Job, int64, error) {
capturedPage = page
capturedPerPage = perPage
return []domain.Job{}, 0, nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs?page=3&per_page=25", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.ListJobs(w, req)
if capturedPage != 3 {
t.Errorf("expected page 3, got %d", capturedPage)
}
if capturedPerPage != 25 {
t.Errorf("expected per_page 25, got %d", capturedPerPage)
}
}
func TestGetJob_Success(t *testing.T) {
now := time.Now()
mock := &MockJobService{
GetJobFn: func(id string) (*domain.Job, error) {
return &domain.Job{
ID: id,
Type: domain.JobTypeRenewal,
CertificateID: "mc-prod-001",
Status: domain.JobStatusPending,
ScheduledAt: now,
CreatedAt: now,
}, nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/job-001", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.GetJob(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
}
func TestGetJob_NotFound(t *testing.T) {
mock := &MockJobService{
GetJobFn: func(id string) (*domain.Job, error) {
return nil, ErrMockNotFound
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/nonexistent", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.GetJob(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected status 404, got %d", w.Code)
}
}
func TestGetJob_EmptyID(t *testing.T) {
handler := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.GetJob(w, req)
if w.Code != http.StatusBadRequest {
t.Fatalf("expected status 400, got %d", w.Code)
}
}
func TestCancelJob_Success(t *testing.T) {
var cancelledID string
mock := &MockJobService{
CancelJobFn: func(id string) error {
cancelledID = id
return nil
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-001/cancel", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.CancelJob(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
if cancelledID != "job-001" {
t.Errorf("expected cancelled ID 'job-001', got '%s'", cancelledID)
}
var resp map[string]string
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
t.Fatalf("failed to decode response: %v", err)
}
if resp["status"] != "job_cancelled" {
t.Errorf("expected status 'job_cancelled', got '%s'", resp["status"])
}
}
func TestCancelJob_ServiceError(t *testing.T) {
mock := &MockJobService{
CancelJobFn: func(id string) error {
return ErrMockServiceFailed
},
}
handler := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-001/cancel", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.CancelJob(w, req)
if w.Code != http.StatusInternalServerError {
t.Fatalf("expected status 500, got %d", w.Code)
}
}
func TestCancelJob_MethodNotAllowed(t *testing.T) {
handler := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/job-001/cancel", nil)
w := httptest.NewRecorder()
handler.CancelJob(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected status 405, got %d", w.Code)
}
}
func TestCancelJob_EmptyID(t *testing.T) {
handler := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs//cancel", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
handler.CancelJob(w, req)
if w.Code != http.StatusBadRequest {
t.Fatalf("expected status 400, got %d", w.Code)
}
}
func TestApproveJob_Success(t *testing.T) {
var approvedID string
mock := &MockJobService{
ApproveJobFn: func(id, actor string) error {
approvedID = id
return nil
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-001/approve", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.ApproveJob(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
if approvedID != "job-001" {
t.Errorf("expected approved ID 'job-001', got '%s'", approvedID)
}
var resp map[string]string
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
t.Fatalf("failed to decode response: %v", err)
}
if resp["status"] != "job_approved" {
t.Errorf("expected status 'job_approved', got '%s'", resp["status"])
}
}
func TestApproveJob_NotFound(t *testing.T) {
mock := &MockJobService{
ApproveJobFn: func(id, actor string) error {
return fmt.Errorf("job not found: no rows: %w", ErrMockNotFound)
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-ghost/approve", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.ApproveJob(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected status 404, got %d", w.Code)
}
}
func TestApproveJob_BadStatus(t *testing.T) {
mock := &MockJobService{
ApproveJobFn: func(id, actor string) error {
return fmt.Errorf("cannot approve job with status Running")
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-001/approve", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.ApproveJob(w, req)
if w.Code != http.StatusBadRequest {
t.Fatalf("expected status 400, got %d", w.Code)
}
}
func TestApproveJob_MethodNotAllowed(t *testing.T) {
h := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/job-001/approve", nil)
w := httptest.NewRecorder()
h.ApproveJob(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected status 405, got %d", w.Code)
}
}
// TestApproveJob_SelfApproval_Returns403 verifies the M-003 separation-of-duties
// wire: when the service returns ErrSelfApproval the handler must surface HTTP
// 403 Forbidden (NOT 500). The error sentinel crosses the service boundary via
// errors.Is so the handler can pattern-match regardless of any fmt.Errorf
// wrapping that may be added later.
func TestApproveJob_SelfApproval_Returns403(t *testing.T) {
var capturedActor string
mock := &MockJobService{
ApproveJobFn: func(id, actor string) error {
capturedActor = actor
return service.ErrSelfApproval
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-self/approve", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.ApproveJob(w, req)
if w.Code != http.StatusForbidden {
t.Fatalf("expected status 403, got %d", w.Code)
}
var resp map[string]any
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
t.Fatalf("failed to decode response: %v", err)
}
// Response body should name the self-approval condition explicitly so
// operators triaging a 403 can distinguish it from other forbid paths.
// The ErrorResponse envelope uses "error" for the status text and
// "message" for the human-readable explanation — we assert on message.
msg, _ := resp["message"].(string)
if !strings.Contains(strings.ToLower(msg), "self-approval") {
t.Errorf("expected message to mention self-approval, got %q", msg)
}
// The handler resolves the actor from the auth context; in this test the
// request has no auth context, so the propagated actor is the anonymous
// fallback ("" or "anonymous" depending on middleware wiring). We only
// assert the closure observed *some* actor string — the detailed actor
// threading is covered by resolveActor unit tests.
_ = capturedActor
}
func TestRejectJob_Success(t *testing.T) {
var rejectedID, capturedReason string
mock := &MockJobService{
RejectJobFn: func(id, reason, actor string) error {
rejectedID = id
capturedReason = reason
return nil
},
}
body := `{"reason":"Certificate no longer needed"}`
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-002/reject", strings.NewReader(body))
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.RejectJob(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
if rejectedID != "job-002" {
t.Errorf("expected rejected ID 'job-002', got '%s'", rejectedID)
}
if capturedReason != "Certificate no longer needed" {
t.Errorf("expected reason 'Certificate no longer needed', got '%s'", capturedReason)
}
}
func TestRejectJob_NoReason(t *testing.T) {
mock := &MockJobService{
RejectJobFn: func(id, reason, actor string) error {
return nil
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-002/reject", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.RejectJob(w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected status 200, got %d", w.Code)
}
}
func TestRejectJob_NotFound(t *testing.T) {
mock := &MockJobService{
RejectJobFn: func(id, reason, actor string) error {
return fmt.Errorf("job not found: no rows: %w", ErrMockNotFound)
},
}
h := NewJobHandler(mock)
req := httptest.NewRequest(http.MethodPost, "/api/v1/jobs/job-ghost/reject", nil)
req = req.WithContext(contextWithRequestID())
w := httptest.NewRecorder()
h.RejectJob(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected status 404, got %d", w.Code)
}
}
func TestRejectJob_MethodNotAllowed(t *testing.T) {
h := NewJobHandler(&MockJobService{})
req := httptest.NewRequest(http.MethodGet, "/api/v1/jobs/job-001/reject", nil)
w := httptest.NewRecorder()
h.RejectJob(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected status 405, got %d", w.Code)
}
}