Function TestTx

riverdbtest/riverdbtest.go:536–591

TestTx starts a test transaction that's rolled back automatically as the test case is cleaning itself up. The function invokes TestSchema to create a single schema where this test transaction and all future test transactions for this package test run will run. `search_path` is set to the name of t

(ctx context.Context, tb testing.TB, driver riverdriver.Driver[TTx], opts *TestTxOpts)

// The included driver determines what migrations are run to prepare the test
// transaction schema.
func TestTx[TTx any](ctx context.Context, tb testing.TB, driver riverdriver.Driver[TTx], opts *TestTxOpts) (TTx, string) {
	tb.Helper()

	schema := testTxSchemaForDatabaseAndMigrationLines(ctx, tb, driver, opts)
	tb.Logf("TestTx using %s schema: %s", driver.DatabaseName(), schema)

	execTx, err := driver.GetExecutor().Begin(ctx)
	require.NoError(tb, err)

	tb.Cleanup(func() {
		// Tests may inerit context from `t.Context()` which is cancelled after
		// tests run and before calling clean up. We need a non-cancelled
		// context to issue rollback here, so use a bit of a bludgeon to do so
		// with `context.WithoutCancel()`.
		ctx := context.WithoutCancel(ctx)

		err := execTx.Rollback(ctx)

		if err == nil {
			return
		}

		// Try to look for an error on rollback because it does occasionally
		// reveal a real problem in the way a test is written. However, allow
		// tests to roll back their transaction early if they like, so ignore
		// `ErrTxClosed`.
		if errors.Is(err, pgx.ErrTxClosed) {
			return
		}

		// In case of a cancelled context during a database operation, which
		// happens in many tests, pgx seems to not only roll back the
		// transaction, but closes the connection, and returns this error on
		// rollback. Allow this error since it's hard to prevent it in our flows
		// that use contexts heavily.
		if err.Error() == "conn closed" {
			return
		}

		// Cancelled context again, but this one from libpq.
		if err.Error() == "driver: bad connection" {
			return
		}

		// Similar to the above, but a newly appeared error that wraps the
		// above. As far as I can tell, no error variables are available to use
		// with `errors.Is`.
		if err.Error() == "failed to deallocate cached statement(s): conn closed" {
			return
		}

		require.NoError(tb, err)
	})

	return driver.UnwrapTx(execTx), schema
}

var (