Centralize Postgres test fixture in internal/test
Each package that exercises the database against a real Postgres carried its own copy of the connection bootstrap and schema setup. Those copies had already drifted: some keyed off PROBO_TEST_PG_ADDR with hardcoded defaults, others off PROBO_TEST_PG_URL, and the agentrun/coredata suites hand-applied individual agent_runs migrations to ensure the table existed. Introduce a single test.PGClient helper that parses PROBO_TEST_PG_URL (falling back to the local compose database), runs the full coredata migration set once per process, and skips when no database is reachable so make test stays a pure unit-test run. Migrate the agentrun, coredata, cookiebanner, iam, and thirdparty suites onto it and delete the duplicated helpers so the bootstrap can no longer diverge. Signed-off-by: Bryan Frimin <bryan@probo.com>
This commit is contained in:
151
internal/test/pg.go
Normal file
151
internal/test/pg.go
Normal file
@@ -0,0 +1,151 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
// Package test provides shared Postgres test fixtures for packages that
|
||||
// exercise the database layer against a real Postgres instance. Centralizing
|
||||
// the connection bootstrap and agent_runs schema setup here keeps a single
|
||||
// copy of that logic so it cannot drift between the coredata and agentrun
|
||||
// test suites.
|
||||
package test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/url"
|
||||
"os"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.gearno.de/kit/log"
|
||||
"go.gearno.de/kit/migrator"
|
||||
"go.gearno.de/kit/pg"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
)
|
||||
|
||||
const (
|
||||
// pgURLEnvVar points the integration tests at a migrated test database.
|
||||
pgURLEnvVar = "PROBO_TEST_PG_URL"
|
||||
|
||||
// defaultPGURL targets the local compose Postgres so tests run with zero
|
||||
// configuration against a developer's stack. When the database is not
|
||||
// reachable (e.g. in CI, where `make test` runs without Postgres) the
|
||||
// connection check fails and the test is skipped.
|
||||
defaultPGURL = "postgres://probod:probod@localhost:5432/probod_test"
|
||||
)
|
||||
|
||||
var (
|
||||
sharedPGClient *pg.Client
|
||||
pgOnce sync.Once
|
||||
pgInitErr error
|
||||
migrateOnce sync.Once
|
||||
migrateErr error
|
||||
)
|
||||
|
||||
// PGClient returns a process-wide shared pg.Client connected to the test
|
||||
// database described by the PROBO_TEST_PG_URL environment variable (falling
|
||||
// back to a local compose Postgres), applying the agent_runs migrations on
|
||||
// first use. The test is skipped when no database is reachable so `make test`
|
||||
// stays a pure unit-test run.
|
||||
func PGClient(t *testing.T) *pg.Client {
|
||||
t.Helper()
|
||||
|
||||
pgOnce.Do(
|
||||
func() {
|
||||
dsn := os.Getenv(pgURLEnvVar)
|
||||
if dsn == "" {
|
||||
dsn = defaultPGURL
|
||||
}
|
||||
|
||||
u, err := url.Parse(dsn)
|
||||
if err != nil {
|
||||
pgInitErr = fmt.Errorf("cannot parse %s: %w", pgURLEnvVar, err)
|
||||
return
|
||||
}
|
||||
|
||||
opts := []pg.Option{pg.WithPoolSize(25)}
|
||||
|
||||
if u.Host != "" {
|
||||
host := u.Host
|
||||
if u.Port() == "" {
|
||||
host = net.JoinHostPort(u.Hostname(), "5432")
|
||||
}
|
||||
|
||||
opts = append(opts, pg.WithAddr(host))
|
||||
}
|
||||
|
||||
if u.User != nil {
|
||||
opts = append(opts, pg.WithUser(u.User.Username()))
|
||||
if password, ok := u.User.Password(); ok {
|
||||
opts = append(opts, pg.WithPassword(password))
|
||||
}
|
||||
}
|
||||
|
||||
if len(u.Path) > 1 {
|
||||
opts = append(opts, pg.WithDatabase(u.Path[1:]))
|
||||
}
|
||||
|
||||
sharedPGClient, pgInitErr = pg.NewClient(opts...)
|
||||
if pgInitErr != nil {
|
||||
return
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
pgInitErr = sharedPGClient.WithConn(
|
||||
ctx,
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
_, err := conn.Exec(ctx, "SELECT 1")
|
||||
return err
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
|
||||
if pgInitErr != nil {
|
||||
t.Skipf("cannot connect to test database: %v", pgInitErr)
|
||||
}
|
||||
|
||||
migrateSchema(t, sharedPGClient)
|
||||
|
||||
return sharedPGClient
|
||||
}
|
||||
|
||||
// migrateSchema applies the full coredata migration set to the shared test
|
||||
// database. The migrator is idempotent (it records applied versions in
|
||||
// schema_versions and serializes through an advisory lock), so running it
|
||||
// once per process brings any reachable database up to date regardless of
|
||||
// its starting state.
|
||||
func migrateSchema(t *testing.T, client *pg.Client) {
|
||||
t.Helper()
|
||||
|
||||
migrateOnce.Do(
|
||||
func() {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
||||
defer cancel()
|
||||
|
||||
logger := log.NewLogger(log.WithOutput(io.Discard))
|
||||
|
||||
migrateErr = migrator.
|
||||
NewMigrator(client, coredata.Migrations, logger).
|
||||
Run(ctx, "migrations")
|
||||
},
|
||||
)
|
||||
|
||||
require.NoError(t, migrateErr, "cannot migrate test database schema")
|
||||
}
|
||||
Reference in New Issue
Block a user