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

183 lines
6.2 KiB
Go

package postgres
import (
"github.com/shankar0123/certctl/internal/repository"
"context"
"database/sql"
"fmt"
"time"
"github.com/lib/pq"
"github.com/shankar0123/certctl/internal/domain"
)
// NetworkScanRepository implements repository.NetworkScanRepository using PostgreSQL.
type NetworkScanRepository struct {
db *sql.DB
}
// NewNetworkScanRepository creates a new PostgreSQL-backed network scan repository.
func NewNetworkScanRepository(db *sql.DB) *NetworkScanRepository {
return &NetworkScanRepository{db: db}
}
// List returns all network scan targets.
func (r *NetworkScanRepository) List(ctx context.Context) ([]*domain.NetworkScanTarget, error) {
rows, err := r.db.QueryContext(ctx, `
SELECT id, name, cidrs, ports, enabled, scan_interval_hours, timeout_ms,
last_scan_at, last_scan_duration_ms, last_scan_certs_found,
created_at, updated_at
FROM network_scan_targets
ORDER BY created_at DESC`)
if err != nil {
return nil, fmt.Errorf("list network scan targets: %w", err)
}
defer rows.Close()
return r.scanRows(rows)
}
// ListEnabled returns only enabled scan targets.
func (r *NetworkScanRepository) ListEnabled(ctx context.Context) ([]*domain.NetworkScanTarget, error) {
rows, err := r.db.QueryContext(ctx, `
SELECT id, name, cidrs, ports, enabled, scan_interval_hours, timeout_ms,
last_scan_at, last_scan_duration_ms, last_scan_certs_found,
created_at, updated_at
FROM network_scan_targets
WHERE enabled = TRUE
ORDER BY created_at DESC`)
if err != nil {
return nil, fmt.Errorf("list enabled network scan targets: %w", err)
}
defer rows.Close()
return r.scanRows(rows)
}
// Get retrieves a network scan target by ID.
func (r *NetworkScanRepository) Get(ctx context.Context, id string) (*domain.NetworkScanTarget, error) {
target := &domain.NetworkScanTarget{}
var lastScanAt sql.NullTime
var lastScanDurationMs, lastScanCertsFound sql.NullInt64
err := r.db.QueryRowContext(ctx, `
SELECT id, name, cidrs, ports, enabled, scan_interval_hours, timeout_ms,
last_scan_at, last_scan_duration_ms, last_scan_certs_found,
created_at, updated_at
FROM network_scan_targets
WHERE id = $1`, id).Scan(
&target.ID, &target.Name, pq.Array(&target.CIDRs), pq.Array(&target.Ports),
&target.Enabled, &target.ScanIntervalHours, &target.TimeoutMs,
&lastScanAt, &lastScanDurationMs, &lastScanCertsFound,
&target.CreatedAt, &target.UpdatedAt,
)
if err == sql.ErrNoRows {
return nil, fmt.Errorf("network scan target not found: %w", repository.ErrNotFound)
}
if err != nil {
return nil, fmt.Errorf("get network scan target: %w", err)
}
if lastScanAt.Valid {
target.LastScanAt = &lastScanAt.Time
}
if lastScanDurationMs.Valid {
v := int(lastScanDurationMs.Int64)
target.LastScanDurationMs = &v
}
if lastScanCertsFound.Valid {
v := int(lastScanCertsFound.Int64)
target.LastScanCertsFound = &v
}
return target, nil
}
// Create stores a new network scan target.
func (r *NetworkScanRepository) Create(ctx context.Context, target *domain.NetworkScanTarget) error {
_, err := r.db.ExecContext(ctx, `
INSERT INTO network_scan_targets (id, name, cidrs, ports, enabled, scan_interval_hours, timeout_ms, created_at, updated_at)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)`,
target.ID, target.Name, pq.Array(target.CIDRs), pq.Array(target.Ports),
target.Enabled, target.ScanIntervalHours, target.TimeoutMs,
target.CreatedAt, target.UpdatedAt,
)
if err != nil {
return fmt.Errorf("create network scan target: %w", err)
}
return nil
}
// Update modifies an existing network scan target.
func (r *NetworkScanRepository) Update(ctx context.Context, target *domain.NetworkScanTarget) error {
result, err := r.db.ExecContext(ctx, `
UPDATE network_scan_targets
SET name = $1, cidrs = $2, ports = $3, enabled = $4, scan_interval_hours = $5, timeout_ms = $6, updated_at = $7
WHERE id = $8`,
target.Name, pq.Array(target.CIDRs), pq.Array(target.Ports),
target.Enabled, target.ScanIntervalHours, target.TimeoutMs,
time.Now(), target.ID,
)
if err != nil {
return fmt.Errorf("update network scan target: %w", err)
}
rows, _ := result.RowsAffected()
if rows == 0 {
return fmt.Errorf("network scan target not found: %w", repository.ErrNotFound)
}
return nil
}
// Delete removes a network scan target.
func (r *NetworkScanRepository) Delete(ctx context.Context, id string) error {
result, err := r.db.ExecContext(ctx, `DELETE FROM network_scan_targets WHERE id = $1`, id)
if err != nil {
return fmt.Errorf("delete network scan target: %w", err)
}
rows, _ := result.RowsAffected()
if rows == 0 {
return fmt.Errorf("network scan target not found: %w", repository.ErrNotFound)
}
return nil
}
// UpdateScanResults records the outcome of the last scan for a target.
func (r *NetworkScanRepository) UpdateScanResults(ctx context.Context, id string, scanAt time.Time, durationMs int, certsFound int) error {
_, err := r.db.ExecContext(ctx, `
UPDATE network_scan_targets
SET last_scan_at = $1, last_scan_duration_ms = $2, last_scan_certs_found = $3, updated_at = $4
WHERE id = $5`,
scanAt, durationMs, certsFound, time.Now(), id,
)
if err != nil {
return fmt.Errorf("update scan results: %w", err)
}
return nil
}
// scanRows scans multiple rows from a query result.
func (r *NetworkScanRepository) scanRows(rows *sql.Rows) ([]*domain.NetworkScanTarget, error) {
var targets []*domain.NetworkScanTarget
for rows.Next() {
target := &domain.NetworkScanTarget{}
var lastScanAt sql.NullTime
var lastScanDurationMs, lastScanCertsFound sql.NullInt64
if err := rows.Scan(
&target.ID, &target.Name, pq.Array(&target.CIDRs), pq.Array(&target.Ports),
&target.Enabled, &target.ScanIntervalHours, &target.TimeoutMs,
&lastScanAt, &lastScanDurationMs, &lastScanCertsFound,
&target.CreatedAt, &target.UpdatedAt,
); err != nil {
return nil, fmt.Errorf("scan network scan target row: %w", err)
}
if lastScanAt.Valid {
target.LastScanAt = &lastScanAt.Time
}
if lastScanDurationMs.Valid {
v := int(lastScanDurationMs.Int64)
target.LastScanDurationMs = &v
}
if lastScanCertsFound.Valid {
v := int(lastScanCertsFound.Int64)
target.LastScanCertsFound = &v
}
targets = append(targets, target)
}
return targets, rows.Err()
}