Skip to content

Expose TestSchemaOpts.DisableReuse for test schema creation #1195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandur wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −10
Open

Expose TestSchemaOpts.DisableReuse for test schema creation #1195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions riverdbtest/riverdbtest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ var (
// TestSchemaOpts are options for TestSchema. Most of the time these can be left
// as nil.
type TestSchemaOpts struct {
// DisableReuse specifies that schema will not be checked in for reuse at
// the end of tests. This is desirable in certain like cases like where a
// test case is making modifications to schema.
//
// Not being able to reuse the schema introduces overhead to tests because
// it means more schemas will need to be generated to replace one not
// reused, so don't set this option unless necessary.
DisableReuse bool

// LineTargetVersions specify target versions for migration lines being
// migrated. By default all lines are migrated all the way up, but this lets
// tests migrate to an only partially applied version. This option is rarely
Expand Down Expand Up @@ -81,11 +90,6 @@ type TestSchemaOpts struct {
// instead of `schema.river_job`).
ProcurePool func(ctx context.Context, schema string) (any, string)

// disableReuse specifies that schema will not be checked in for reuse at
// the end of tests. This is desirable in certain like cases like where a
// test case is making modifications to schema.
disableReuse bool

// skipPackageNameCheck skips the check that package name doesn't resolve to
// `riverdbtest`. Normally we want this to make sure that we're skipping
// the right number of frames back to the caller package, but it needs to be
Expand Down Expand Up @@ -279,7 +283,7 @@ func TestSchema[TTx any](ctx context.Context, tb testutil.TestingTB, driver rive
}

if withCleanup, ok := tb.(testingTBWithCleanup); ok {
if !opts.disableReuse {
if !opts.DisableReuse {
withCleanup.Cleanup(func() {
idleSchemasMu.Lock()
defer idleSchemasMu.Unlock()
Expand Down Expand Up @@ -638,15 +642,15 @@ func testTxSchemaForDatabaseAndMigrationLines[TTx any](ctx context.Context, tb t
}

schema = TestSchema(ctx, tb, driver, &TestSchemaOpts{
Lines: lines,
ProcurePool: opts.ProcurePool,

// If test transactions are being shared (opts.DisableSharing = false)
// then reserve the shared schemas exclusively for TestTx. Otherwise,
// allow them to be put back in the pool for use by other test
// transactions with opts.DisableSharing = true or other TestSchema
// invocations.
disableReuse: !opts.DisableSchemaSharing,
DisableReuse: !opts.DisableSchemaSharing,

Lines: lines,
ProcurePool: opts.ProcurePool,

skipExtraFrames: skipExtraFrames,
skipPackageNameCheck: opts.skipPackageNameCheck,
Expand Down
Loading