LazilyRefreshDatabase
trait LazilyRefreshDatabase
Traits
Provides per-worker database isolation for parallel testing.
Methods
The parameters that should be used when running "migrate:fresh".
Determine if views should be dropped when refreshing the database.
Determine if types should be dropped when refreshing the database.
Determine if the seed task should be run when refreshing the database.
Determine the specific seeder class that should be used when refreshing the database.
Rewrite the default connection's database name for parallel testing.
Ensure the per-worker database exists, creating it if needed.
Determine if the database should be managed for parallel testing.
Get the per-worker test database name.
Define hooks to migrate the database before and after each test.
Determine if any of the connections transacting is using in-memory databases.
Determine if a given database connection is an in-memory database.
Determine if a transacting in-memory database is missing its cached PDO.
Update locally cached in-memory PDO connections after migration.
Defer eager refresh setup to the lazy trait hook.
Defer eager refresh teardown to the lazy trait hook.
Rollback transactions on all connections.
The database connections that should have transactions.
Perform any work that should take place before the database has started refreshing.
Perform any work that should take place once the database has finished refreshing.
Register lazy database refresh hooks in the test coroutine.
Roll back a lazily started transaction in the test coroutine.
Details
in
CanConfigureMigrationCommands at line 16
protected array
migrateFreshUsing()
The parameters that should be used when running "migrate:fresh".
in
CanConfigureMigrationCommands at line 32
protected bool
shouldDropViews()
Determine if views should be dropped when refreshing the database.
in
CanConfigureMigrationCommands at line 40
protected bool
shouldDropTypes()
Determine if types should be dropped when refreshing the database.
in
CanConfigureMigrationCommands at line 48
protected bool
shouldSeed()
Determine if the seed task should be run when refreshing the database.
in
CanConfigureMigrationCommands at line 64
protected mixed
seeder()
Determine the specific seeder class that should be used when refreshing the database.
in
InteractsWithParallelDatabase at line 42
protected void
configureParallelDatabaseName(mixed $app)
Rewrite the default connection's database name for parallel testing.
Config-only — does not create connections or purge pools. Called early in CreatesApplication (after config is loaded, before defineEnvironment) so that custom connections derived from the default connection inherit the per-worker database name.
No-op when not running in parallel or when using in-memory SQLite.
in
InteractsWithParallelDatabase at line 95
protected void
ensureParallelDatabaseExists()
Ensure the per-worker database exists, creating it if needed.
Called before Testbench database requirements and from database testing traits (RefreshDatabase, DatabaseMigrations, DatabaseTruncation, DatabaseTransactions) after the app is booted and connections are available. The config has already been rewritten by configureParallelDatabaseName().
No-op when not running in parallel or when using in-memory SQLite.
in
InteractsWithParallelDatabase at line 157
protected bool
shouldManageParallelDatabase(mixed $driver, string $database)
Determine if the database should be managed for parallel testing.
in
InteractsWithParallelDatabase at line 184
protected string
parallelTestDatabase(string $database, string $token)
Get the per-worker test database name.
at line 20
void
refreshDatabase()
Define hooks to migrate the database before and after each test.
in
RefreshDatabase at line 57
protected void
restoreInMemoryDatabase()
Restore the in-memory database between tests.
in
RefreshDatabase at line 81
protected bool
usingInMemoryDatabases()
Determine if any of the connections transacting is using in-memory databases.
in
RefreshDatabase at line 95
protected bool
usingInMemoryDatabase(string|null $name = null)
Determine if a given database connection is an in-memory database.
in
RefreshDatabase at line 112
protected void
refreshTestDatabase()
Refresh a conventional test database.
Runs migrations if needed. For non-coroutine tests, also starts the wrapper transaction. For coroutine tests, transaction handling is deferred to setUpRefreshDatabaseInCoroutine().
in
RefreshDatabase at line 159
protected bool
hasMissingInMemoryDatabaseForRefresh()
Determine if a transacting in-memory database is missing its cached PDO.
in
RefreshDatabase at line 178
protected void
updateLocalCacheOfInMemoryDatabases()
Update locally cached in-memory PDO connections after migration.
in
RefreshDatabase at line 202
protected void
migrateDatabases()
Migrate the database.
at line 87
protected void
setUpRefreshDatabaseInCoroutine()
Defer eager refresh setup to the lazy trait hook.
at line 94
protected void
tearDownRefreshDatabaseInCoroutine()
Defer eager refresh teardown to the lazy trait hook.
in
RefreshDatabase at line 236
protected void
beginDatabaseTransactionWork()
Start transactions on all connections.
in
RefreshDatabase at line 270
protected void
rollbackDatabaseTransactionWork()
Rollback transactions on all connections.
in
RefreshDatabase at line 301
protected array
connectionsToTransact()
The database connections that should have transactions.
in
RefreshDatabase at line 311
protected void
beforeRefreshingDatabase()
Perform any work that should take place before the database has started refreshing.
in
RefreshDatabase at line 319
protected void
afterRefreshingDatabase()
Perform any work that should take place once the database has finished refreshing.
in
RefreshDatabase at line 327
protected string
getRefreshConnection()
Get the default database connection name.
at line 34
protected void
setUpLazilyRefreshDatabaseInCoroutine()
Register lazy database refresh hooks in the test coroutine.
at line 77
protected void
tearDownLazilyRefreshDatabaseInCoroutine()
Roll back a lazily started transaction in the test coroutine.