mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 16:01:30 +00:00
8b75e0311b
Mechanical sed across the main go.mod's module declaration, the f5-mock-icontrol
sub-module's go.mod, every Go file's import path (361 files), and a rebuild of
the checked-in f5-mock-icontrol binary so its embedded build-info reflects the
new module path. No behavior change.
Choice B from cowork/transfer-certctl-to-org.md, executed 2026-05-04. Choice A
(keep module path declared as github.com/shankar0123/certctl regardless of
repo URL) shipped on the day of the org transfer (2026-05-03) since we had no
external Go consumers; this commit closes that deferral.
Backward-compat: GitHub HTTP redirects continue to forward
github.com/shankar0123/certctl → github.com/certctl-io/certctl at the URL
level, but Go's module proxy uses the path declared in go.mod as the
canonical name. Pre-fix, anyone trying `go get github.com/certctl-io/certctl/...`
hit a "module path mismatch" error because go.mod said
github.com/shankar0123/certctl and the URL they fetched it from said
certctl-io/certctl. Post-fix, the canonical name and the URL agree, so
go get / go install / external Go consumers / Go-tooling integrations
work cleanly via either the new path (preferred) or the old path (which
redirects and Go follows the redirect for source fetch).
Anyone still importing the old path inside their own code keeps working
provided they update their go.mod's `require` line to match — the module
path declared in their consumer's go.sum / go.mod is the authoritative
import name, so a mass sed across their import statements is the migration
on the consumer side. No external consumers exist today.
Diff shape:
361 *.go files — import path replacement only
2 go.mod — module declaration replacement only
1 binary — deploy/test/f5-mock-icontrol/f5-mock-icontrol rebuilt
so embedded build-info reflects the new path (8618965 vs
8618933 bytes; 32-byte diff is the build-info change)
Total: 364 files, 730 insertions / 730 deletions, net-zero size, pure
mechanical substitution.
Verification:
gofmt: 17 files needed re-alignment after sed (the new path is one char
shorter than the old, so column-aligned import groups drifted). Applied
`gofmt -w` to fix.
go mod tidy: clean exit on both modules.
go vet ./...: clean exit.
go build ./...: clean exit.
go test -short -count=1 on representative packages: all green
(internal/domain, internal/validation, internal/crypto, internal/crypto/signer,
cmd/agent). Test output now reads `ok github.com/certctl-io/certctl/...`
confirming the module path resolves correctly.
binary: f5-mock-icontrol rebuilt; `strings | grep shankar0123` returns
nothing; `strings | grep certctl-io/certctl` shows the new module path
embedded in build-info.
Files intentionally NOT touched in this commit:
README.md / CHANGELOG.md / docs/ / etc. — already swept to certctl-io
URLs in commit 0729ee4 (the post-transfer URL refresh). This commit is
purely the Go-tooling layer.
Scarf pixels (`shankar0123.docker.scarf.sh/...`) — Scarf-account
namespace, not a Go import or GitHub repo URL. Stays.
This is a non-blocking, non-customer-impacting change. Operators pulling
container images, running `make verify`, hitting the API, or installing the
agent see no functional difference. Only Go-tooling consumers (none today)
are affected, and they're enabled — not broken — by this commit.
326 lines
10 KiB
Go
326 lines
10 KiB
Go
package service_test
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"log/slog"
|
|
"sync"
|
|
"sync/atomic"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/certctl-io/certctl/internal/connector/issuer"
|
|
localissuer "github.com/certctl-io/certctl/internal/connector/issuer/local"
|
|
"github.com/certctl-io/certctl/internal/domain"
|
|
"github.com/certctl-io/certctl/internal/repository"
|
|
"github.com/certctl-io/certctl/internal/service"
|
|
)
|
|
|
|
// fakeCRLCacheRepo is an in-memory repository for CRLCacheService
|
|
// tests. The Postgres impl is covered by the testcontainers tests in
|
|
// internal/repository/postgres/crl_cache_test.go (CI only — needs Docker).
|
|
type fakeCRLCacheRepo struct {
|
|
mu sync.Mutex
|
|
rows map[string]*domain.CRLCacheEntry
|
|
events []*domain.CRLGenerationEvent
|
|
getCount int
|
|
putCount int
|
|
}
|
|
|
|
func newFakeCRLCacheRepo() *fakeCRLCacheRepo {
|
|
return &fakeCRLCacheRepo{rows: map[string]*domain.CRLCacheEntry{}}
|
|
}
|
|
|
|
func (r *fakeCRLCacheRepo) Get(_ context.Context, issuerID string) (*domain.CRLCacheEntry, error) {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
r.getCount++
|
|
if entry, ok := r.rows[issuerID]; ok {
|
|
copy := *entry
|
|
return ©, nil
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func (r *fakeCRLCacheRepo) Put(_ context.Context, entry *domain.CRLCacheEntry) error {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
r.putCount++
|
|
copy := *entry
|
|
r.rows[entry.IssuerID] = ©
|
|
return nil
|
|
}
|
|
|
|
func (r *fakeCRLCacheRepo) NextCRLNumber(_ context.Context, issuerID string) (int64, error) {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
if entry, ok := r.rows[issuerID]; ok {
|
|
return entry.CRLNumber + 1, nil
|
|
}
|
|
return 1, nil
|
|
}
|
|
|
|
func (r *fakeCRLCacheRepo) RecordGenerationEvent(_ context.Context, evt *domain.CRLGenerationEvent) error {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
copy := *evt
|
|
r.events = append(r.events, ©)
|
|
return nil
|
|
}
|
|
|
|
func (r *fakeCRLCacheRepo) ListGenerationEvents(_ context.Context, issuerID string, limit int) ([]*domain.CRLGenerationEvent, error) {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
var out []*domain.CRLGenerationEvent
|
|
for _, evt := range r.events {
|
|
if evt.IssuerID == issuerID {
|
|
copy := *evt
|
|
out = append(out, ©)
|
|
}
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// fakeRevocationRepo is the minimal shape CAOperationsSvc needs:
|
|
// returning revocations by issuer. The cache service walks
|
|
// CAOperationsSvc.GenerateDERCRL, which calls into this.
|
|
type fakeRevocationRepo struct{}
|
|
|
|
func (fakeRevocationRepo) Create(context.Context, *domain.CertificateRevocation) error {
|
|
return nil
|
|
}
|
|
func (fakeRevocationRepo) CreateWithTx(context.Context, repository.Querier, *domain.CertificateRevocation) error {
|
|
return nil
|
|
}
|
|
func (fakeRevocationRepo) GetByIssuerAndSerial(context.Context, string, string) (*domain.CertificateRevocation, error) {
|
|
return nil, nil
|
|
}
|
|
func (fakeRevocationRepo) ListAll(context.Context) ([]*domain.CertificateRevocation, error) {
|
|
return nil, nil
|
|
}
|
|
func (fakeRevocationRepo) ListByIssuer(_ context.Context, issuerID string) ([]*domain.CertificateRevocation, error) {
|
|
// Empty list = no revoked certs; the issuer connector still
|
|
// produces a valid empty CRL (RFC 5280 allows zero entries).
|
|
return nil, nil
|
|
}
|
|
func (fakeRevocationRepo) ListByCertificate(context.Context, string) ([]*domain.CertificateRevocation, error) {
|
|
return nil, nil
|
|
}
|
|
func (fakeRevocationRepo) MarkIssuerNotified(context.Context, string) error { return nil }
|
|
|
|
// helper: spin up a CAOperationsSvc + IssuerRegistry wired with a real
|
|
// local issuer connector. The local issuer's GenerateCRL produces a
|
|
// real DER-encoded CRL that the cache service can parse + persist.
|
|
func newCacheServiceFixture(t *testing.T) (svc *service.CRLCacheService, repo *fakeCRLCacheRepo, registry *service.IssuerRegistry) {
|
|
t.Helper()
|
|
|
|
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
|
|
repo = newFakeCRLCacheRepo()
|
|
|
|
// Real local issuer — produces a real CRL on GenerateCRL.
|
|
localConn := localissuer.New(&localissuer.Config{
|
|
CACommonName: "Test Cache CA",
|
|
ValidityDays: 30,
|
|
}, logger)
|
|
|
|
registry = service.NewIssuerRegistry(logger)
|
|
registry.Set("iss-cache-test", service.NewIssuerConnectorAdapter(localConn))
|
|
|
|
caSvc := service.NewCAOperationsSvc(fakeRevocationRepo{}, nil, nil)
|
|
caSvc.SetIssuerRegistry(registry)
|
|
|
|
svc = service.NewCRLCacheService(repo, caSvc, registry, logger)
|
|
return
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Get: cache hit, miss, staleness
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func TestCRLCacheService_Get_MissTriggersGeneration(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
der, thisUpdate, err := svc.Get(ctx, "iss-cache-test")
|
|
if err != nil {
|
|
t.Fatalf("Get: %v", err)
|
|
}
|
|
if len(der) == 0 {
|
|
t.Fatal("Get returned empty DER")
|
|
}
|
|
if thisUpdate.IsZero() {
|
|
t.Fatal("ThisUpdate is zero")
|
|
}
|
|
if repo.putCount != 1 {
|
|
t.Errorf("putCount = %d, want 1 (miss should trigger one generation)", repo.putCount)
|
|
}
|
|
}
|
|
|
|
func TestCRLCacheService_Get_HitSkipsGeneration(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
// Prime the cache.
|
|
if _, _, err := svc.Get(ctx, "iss-cache-test"); err != nil {
|
|
t.Fatalf("prime: %v", err)
|
|
}
|
|
if repo.putCount != 1 {
|
|
t.Fatalf("prime: putCount = %d, want 1", repo.putCount)
|
|
}
|
|
|
|
// Second Get should be a cache hit.
|
|
if _, _, err := svc.Get(ctx, "iss-cache-test"); err != nil {
|
|
t.Fatalf("hit: %v", err)
|
|
}
|
|
if repo.putCount != 1 {
|
|
t.Errorf("putCount = %d, want 1 (hit should not regenerate)", repo.putCount)
|
|
}
|
|
}
|
|
|
|
func TestCRLCacheService_Get_StalenessTriggersRegeneration(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
// Prime the cache with a row whose next_update is in the past.
|
|
stale := &domain.CRLCacheEntry{
|
|
IssuerID: "iss-cache-test",
|
|
CRLDER: []byte("stale-der"),
|
|
CRLNumber: 1,
|
|
ThisUpdate: time.Now().Add(-48 * time.Hour),
|
|
NextUpdate: time.Now().Add(-24 * time.Hour), // expired
|
|
GeneratedAt: time.Now().Add(-48 * time.Hour),
|
|
}
|
|
if err := repo.Put(ctx, stale); err != nil {
|
|
t.Fatalf("seed stale: %v", err)
|
|
}
|
|
repo.putCount = 0
|
|
|
|
// Get should detect staleness and regenerate.
|
|
der, _, err := svc.Get(ctx, "iss-cache-test")
|
|
if err != nil {
|
|
t.Fatalf("Get on stale: %v", err)
|
|
}
|
|
if string(der) == "stale-der" {
|
|
t.Error("Get returned stale DER instead of regenerating")
|
|
}
|
|
if repo.putCount != 1 {
|
|
t.Errorf("putCount = %d, want 1 (staleness should trigger one regen)", repo.putCount)
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// RegenerateAll
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func TestCRLCacheService_RegenerateAll_PopulatesAllIssuers(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
svc.RegenerateAll(ctx)
|
|
|
|
row, _ := repo.Get(ctx, "iss-cache-test")
|
|
if row == nil {
|
|
t.Fatal("RegenerateAll did not populate iss-cache-test")
|
|
}
|
|
if row.RevokedCount != 0 {
|
|
t.Errorf("RevokedCount = %d, want 0 (fakeRevocationRepo is empty)", row.RevokedCount)
|
|
}
|
|
events, _ := repo.ListGenerationEvents(ctx, "iss-cache-test", 10)
|
|
if len(events) != 1 {
|
|
t.Fatalf("expected 1 generation event, got %d", len(events))
|
|
}
|
|
if !events[0].Succeeded {
|
|
t.Error("event.Succeeded should be true on happy path")
|
|
}
|
|
}
|
|
|
|
func TestCRLCacheService_RegenerateAll_RespectsCancelledContext(t *testing.T) {
|
|
svc, _, _ := newCacheServiceFixture(t)
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel()
|
|
|
|
// Should return without panicking. The single-issuer fixture means
|
|
// there's nothing to iterate after the cancel check, so this is
|
|
// mostly a smoke test for the ctx.Done() branch.
|
|
svc.RegenerateAll(ctx)
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Singleflight: concurrent miss requests for the same issuer collapse
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func TestCRLCacheService_Get_SingleflightCollapsesConcurrentMisses(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
// Fire 20 concurrent Get calls for the same uncached issuer. The
|
|
// in-tree singleflight gate should collapse them to a single
|
|
// underlying generation (putCount == 1).
|
|
var wg sync.WaitGroup
|
|
var errCount atomic.Int32
|
|
for i := 0; i < 20; i++ {
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
if _, _, err := svc.Get(ctx, "iss-cache-test"); err != nil {
|
|
errCount.Add(1)
|
|
t.Errorf("concurrent Get: %v", err)
|
|
}
|
|
}()
|
|
}
|
|
wg.Wait()
|
|
|
|
if errCount.Load() != 0 {
|
|
t.Fatalf("%d errors across concurrent Gets", errCount.Load())
|
|
}
|
|
if repo.putCount != 1 {
|
|
t.Errorf("singleflight failed: putCount = %d, want 1 (20 concurrent misses must collapse)", repo.putCount)
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Error paths
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func TestCRLCacheService_Get_NoIssuerInRegistry_RecordsFailureEvent(t *testing.T) {
|
|
svc, repo, _ := newCacheServiceFixture(t)
|
|
ctx := context.Background()
|
|
|
|
// Issuer ID that doesn't exist in the registry → CAOperationsSvc
|
|
// returns an error → cache service records a failure event +
|
|
// surfaces the error to the caller.
|
|
_, _, err := svc.Get(ctx, "iss-does-not-exist")
|
|
if err == nil {
|
|
t.Fatal("Get for unknown issuer should error")
|
|
}
|
|
events, _ := repo.ListGenerationEvents(ctx, "iss-does-not-exist", 10)
|
|
if len(events) != 1 {
|
|
t.Fatalf("expected 1 failure event, got %d", len(events))
|
|
}
|
|
if events[0].Succeeded {
|
|
t.Error("failure event should have Succeeded=false")
|
|
}
|
|
if events[0].Error == "" {
|
|
t.Error("failure event should carry an error message")
|
|
}
|
|
}
|
|
|
|
func TestCRLCacheService_Get_NoCacheRepo_Errors(t *testing.T) {
|
|
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
|
|
svc := service.NewCRLCacheService(nil, nil, nil, logger)
|
|
_, _, err := svc.Get(context.Background(), "any")
|
|
if err == nil {
|
|
t.Fatal("Get with nil cacheRepo should error")
|
|
}
|
|
}
|
|
|
|
// pin via interface satisfaction (compile-time check that fakeRevocationRepo
|
|
// matches what CAOperationsSvc actually calls — guards against shape drift
|
|
// in the repository.RevocationRepository interface).
|
|
var _ interface {
|
|
ListByIssuer(ctx context.Context, issuerID string) ([]*domain.CertificateRevocation, error)
|
|
} = fakeRevocationRepo{}
|
|
|
|
// _ silence the unused import warning when issuer adapter machinery moves.
|
|
var _ = issuer.IssuanceRequest{}
|