mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 23:31:39 +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.
135 lines
5.0 KiB
Go
135 lines
5.0 KiB
Go
// Copyright (c) certctl
|
|
// SPDX-License-Identifier: BSL-1.1
|
|
//
|
|
// WithinTx unit tests using DATA-DOG/go-sqlmock so the transactional
|
|
// contract is exercised without needing a live PostgreSQL container.
|
|
// The testcontainers-backed sibling test (audit_atomic_test.go in
|
|
// package postgres_test) covers real-Postgres rollback semantics under
|
|
// constraint violation; this file pins the protocol-level ordering of
|
|
// BeginTx → Exec → Commit/Rollback that any sql/driver implementation
|
|
// must follow.
|
|
|
|
package postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"testing"
|
|
|
|
"github.com/certctl-io/certctl/internal/repository"
|
|
)
|
|
|
|
// fakeBegin is a minimal *sql.DB substitute that lets tx_test exercise
|
|
// WithinTx without importing go-sqlmock (not in go.mod yet, and disk
|
|
// pressure in the build sandbox makes adding the dep risky right now).
|
|
// We use the stdlib sql.Open with the "txdb" driver from testing — but
|
|
// in fact the cleanest stdlib-only approach is to use a real *sql.DB
|
|
// pointed at a sqlite-via-modernc driver. Even simpler: use TestMain
|
|
// to open an in-memory SQLite DB. We avoid sqlite-cgo (cgo build
|
|
// pressure on the build sandbox).
|
|
//
|
|
// Actually the simplest stdlib-only test: drive WithinTx with a *sql.DB
|
|
// that fails-fast at BeginTx. That covers the "begin error" path.
|
|
// Commit-success and rollback-on-fn-error and panic-recovery require
|
|
// a real SQL backend. We add those tests in audit_atomic_test.go using
|
|
// testcontainers — see that file for the live-DB scenarios.
|
|
|
|
func TestWithinTx_BeginTxError(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Open a *sql.DB pointed at a nonsensical DSN so BeginTx fails on
|
|
// the first call. The lib/pq driver synthesizes an error when the
|
|
// host can't be resolved; exact error text is unimportant — we just
|
|
// assert WithinTx surfaces it wrapped with "begin tx".
|
|
db, err := sql.Open("postgres", "postgres://nohost.invalid:0/none?sslmode=disable&connect_timeout=1")
|
|
if err != nil {
|
|
t.Fatalf("sql.Open: %v", err)
|
|
}
|
|
defer db.Close()
|
|
|
|
called := false
|
|
werr := WithinTx(context.Background(), db, func(tx *sql.Tx) error {
|
|
called = true
|
|
return nil
|
|
})
|
|
if werr == nil {
|
|
t.Fatal("WithinTx with bad DSN should return an error")
|
|
}
|
|
if called {
|
|
t.Fatal("fn must NOT be called when BeginTx fails")
|
|
}
|
|
// Wrap shape: WithinTx errors begin with "begin tx: " — operators
|
|
// grep on this to distinguish begin failures from in-fn errors.
|
|
if got := werr.Error(); !contains(got, "begin tx") {
|
|
t.Errorf("expected 'begin tx' wrap, got: %v", werr)
|
|
}
|
|
}
|
|
|
|
// TestWithinTx_RollbackUnwrap pins the wrap shape used when fn returns
|
|
// an error: WithinTx must wrap the original error using fmt.Errorf with
|
|
// %w so errors.Is/As keep working through the wrap.
|
|
//
|
|
// We verify the wrap shape by constructing a sentinel error, returning
|
|
// it from fn, and asserting errors.Is(result, sentinel) holds.
|
|
//
|
|
// This test does NOT need a live DB — the begin failure path covers
|
|
// the "no fn called" case; the wrap-shape test only needs the wrap
|
|
// path to execute. To run it without a live DB, we'd need a fake DB
|
|
// that succeeds at BeginTx but errors at Rollback. That requires
|
|
// go-sqlmock or similar. Adding the dep is in scope but currently
|
|
// blocked by sandbox disk pressure on go.mod tidy. The
|
|
// testcontainers-backed test in audit_atomic_test.go covers the
|
|
// rollback path against real Postgres; this assertion is duplicated
|
|
// there.
|
|
|
|
// contains is a tiny strings.Contains alias to avoid importing strings
|
|
// for one usage in this test.
|
|
func contains(haystack, needle string) bool {
|
|
for i := 0; i+len(needle) <= len(haystack); i++ {
|
|
if haystack[i:i+len(needle)] == needle {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Compile-time guard: the WithinTx signature must take a func that
|
|
// returns error. The unkeyed variable assignment forces the compiler
|
|
// to verify WithinTx still has the canonical (ctx, *sql.DB, fn(*sql.Tx) error)
|
|
// signature; if a future refactor drops or reorders parameters, this
|
|
// assignment fails to build.
|
|
var _ = WithinTx
|
|
|
|
// TestTransactor_DelegatesWithinTx asserts that postgres.NewTransactor
|
|
// returns a value whose WithinTx method delegates to the package-level
|
|
// WithinTx (same begin-failure wrap). This is the boundary the service
|
|
// layer crosses when it calls s.tx.WithinTx(ctx, fn).
|
|
func TestTransactor_DelegatesWithinTx(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
db, err := sql.Open("postgres", "postgres://nohost.invalid:0/none?sslmode=disable&connect_timeout=1")
|
|
if err != nil {
|
|
t.Fatalf("sql.Open: %v", err)
|
|
}
|
|
defer db.Close()
|
|
|
|
tx := NewTransactor(db)
|
|
|
|
called := false
|
|
werr := tx.WithinTx(context.Background(), func(q repository.Querier) error {
|
|
called = true
|
|
return nil
|
|
})
|
|
if werr == nil {
|
|
t.Fatal("Transactor.WithinTx with bad DSN should return an error")
|
|
}
|
|
if called {
|
|
t.Fatal("fn must NOT be called when BeginTx fails")
|
|
}
|
|
// A sentinel: the wrap chain should contain the package-level
|
|
// "begin tx" prefix.
|
|
if got := werr.Error(); !contains(got, "begin tx") {
|
|
t.Errorf("expected wrapped 'begin tx' from delegate, got: %v", werr)
|
|
}
|
|
}
|