Files
certctl/internal/repository/postgres/issuer.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

198 lines
5.5 KiB
Go

package postgres
import (
"github.com/shankar0123/certctl/internal/repository"
"context"
"database/sql"
"fmt"
"github.com/google/uuid"
"github.com/shankar0123/certctl/internal/domain"
)
// IssuerRepository implements repository.IssuerRepository
type IssuerRepository struct {
db *sql.DB
}
// NewIssuerRepository creates a new IssuerRepository
func NewIssuerRepository(db *sql.DB) *IssuerRepository {
return &IssuerRepository{db: db}
}
// List returns all issuers
func (r *IssuerRepository) List(ctx context.Context) ([]*domain.Issuer, error) {
rows, err := r.db.QueryContext(ctx, `
SELECT id, name, type, config, COALESCE(encrypted_config, NULL), enabled,
last_tested_at, COALESCE(test_status, 'untested'), COALESCE(source, 'database'),
created_at, updated_at
FROM issuers
ORDER BY created_at DESC
`)
if err != nil {
return nil, fmt.Errorf("failed to query issuers: %w", err)
}
defer rows.Close()
var issuers []*domain.Issuer
for rows.Next() {
var issuer domain.Issuer
if err := rows.Scan(&issuer.ID, &issuer.Name, &issuer.Type, &issuer.Config,
&issuer.EncryptedConfig, &issuer.Enabled,
&issuer.LastTestedAt, &issuer.TestStatus, &issuer.Source,
&issuer.CreatedAt, &issuer.UpdatedAt); err != nil {
return nil, fmt.Errorf("failed to scan issuer: %w", err)
}
issuers = append(issuers, &issuer)
}
if err := rows.Err(); err != nil {
return nil, fmt.Errorf("error iterating issuer rows: %w", err)
}
return issuers, nil
}
// Get retrieves an issuer by ID
func (r *IssuerRepository) Get(ctx context.Context, id string) (*domain.Issuer, error) {
var issuer domain.Issuer
err := r.db.QueryRowContext(ctx, `
SELECT id, name, type, config, COALESCE(encrypted_config, NULL), enabled,
last_tested_at, COALESCE(test_status, 'untested'), COALESCE(source, 'database'),
created_at, updated_at
FROM issuers
WHERE id = $1
`, id).Scan(&issuer.ID, &issuer.Name, &issuer.Type, &issuer.Config,
&issuer.EncryptedConfig, &issuer.Enabled,
&issuer.LastTestedAt, &issuer.TestStatus, &issuer.Source,
&issuer.CreatedAt, &issuer.UpdatedAt)
if err != nil {
if err == sql.ErrNoRows {
return nil, fmt.Errorf("issuer not found: %w", repository.ErrNotFound)
}
return nil, fmt.Errorf("failed to query issuer: %w", err)
}
return &issuer, nil
}
// Create stores a new issuer
func (r *IssuerRepository) Create(ctx context.Context, issuer *domain.Issuer) error {
if issuer.ID == "" {
issuer.ID = uuid.New().String()
}
source := issuer.Source
if source == "" {
source = "database"
}
testStatus := issuer.TestStatus
if testStatus == "" {
testStatus = "untested"
}
err := r.db.QueryRowContext(ctx, `
INSERT INTO issuers (id, name, type, config, encrypted_config, enabled,
last_tested_at, test_status, source, created_at, updated_at)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11)
RETURNING id
`, issuer.ID, issuer.Name, issuer.Type, issuer.Config, issuer.EncryptedConfig,
issuer.Enabled, issuer.LastTestedAt, testStatus, source,
issuer.CreatedAt, issuer.UpdatedAt).Scan(&issuer.ID)
if err != nil {
return fmt.Errorf("failed to create issuer: %w", err)
}
return nil
}
// CreateIfNotExists creates an issuer only if the ID doesn't already exist.
// Used for env var seeding on first boot. Returns true if created, false if already existed.
func (r *IssuerRepository) CreateIfNotExists(ctx context.Context, issuer *domain.Issuer) (bool, error) {
source := issuer.Source
if source == "" {
source = "env"
}
testStatus := issuer.TestStatus
if testStatus == "" {
testStatus = "untested"
}
var id string
err := r.db.QueryRowContext(ctx, `
INSERT INTO issuers (id, name, type, config, encrypted_config, enabled,
last_tested_at, test_status, source, created_at, updated_at)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11)
ON CONFLICT (id) DO NOTHING
RETURNING id
`, issuer.ID, issuer.Name, issuer.Type, issuer.Config, issuer.EncryptedConfig,
issuer.Enabled, issuer.LastTestedAt, testStatus, source,
issuer.CreatedAt, issuer.UpdatedAt).Scan(&id)
if err != nil {
if err == sql.ErrNoRows {
// ON CONFLICT DO NOTHING — row already existed
return false, nil
}
return false, fmt.Errorf("failed to create issuer: %w", err)
}
return true, nil
}
// Update modifies an existing issuer
func (r *IssuerRepository) Update(ctx context.Context, issuer *domain.Issuer) error {
result, err := r.db.ExecContext(ctx, `
UPDATE issuers SET
name = $1,
type = $2,
config = $3,
encrypted_config = $4,
enabled = $5,
last_tested_at = $6,
test_status = $7,
updated_at = $8
WHERE id = $9
`, issuer.Name, issuer.Type, issuer.Config, issuer.EncryptedConfig,
issuer.Enabled, issuer.LastTestedAt, issuer.TestStatus,
issuer.UpdatedAt, issuer.ID)
if err != nil {
return fmt.Errorf("failed to update issuer: %w", err)
}
rows, err := result.RowsAffected()
if err != nil {
return fmt.Errorf("failed to get rows affected: %w", err)
}
if rows == 0 {
return fmt.Errorf("issuer not found: %w", repository.ErrNotFound)
}
return nil
}
// Delete removes an issuer
func (r *IssuerRepository) Delete(ctx context.Context, id string) error {
result, err := r.db.ExecContext(ctx, "DELETE FROM issuers WHERE id = $1", id)
if err != nil {
return fmt.Errorf("failed to delete issuer: %w", err)
}
rows, err := result.RowsAffected()
if err != nil {
return fmt.Errorf("failed to get rows affected: %w", err)
}
if rows == 0 {
return fmt.Errorf("issuer not found: %w", repository.ErrNotFound)
}
return nil
}