1. trait
  2. Hypervel
  3. \
  4. Testbench
  5. \
  6. Concerns
  7. \
  8. Database
  9. \
  10. InteractsWithSqliteDatabaseFile

InteractsWithSqliteDatabaseFile

trait InteractsWithSqliteDatabaseFile

Traits

InteractsWithPublishedFiles

Provides assertion helpers and cleanup utilities for testing file publishing.

Properties

protected bool $interactsWithPublishedFilesTeardownRegistered

Determine if trait teardown has been registered.

 from  InteractsWithPublishedFiles
protected null|array<int, string> $cachedExistingMigrationsFiles

List of existing migration files.

 from  InteractsWithPublishedFiles
protected array<int, string> $files

List of generated files.

Methods

void
setUpInteractsWithPublishedFiles()

Setup Interacts with Published Files environment.

from  InteractsWithPublishedFiles
void
tearDownInteractsWithPublishedFiles()

Teardown Interacts with Published Files environment.

from  InteractsWithPublishedFiles
void
cacheExistingMigrationsFiles()

Cache existing migration files.

from  InteractsWithPublishedFiles
void
assertFileContains(array $contains, string $file, string $message = '')

Assert file contains the given strings.

from  InteractsWithPublishedFiles
void
assertFileDoesNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

from  InteractsWithPublishedFiles
void
assertFileNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

from  InteractsWithPublishedFiles
void
assertMigrationFileContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file contains the given strings.

from  InteractsWithPublishedFiles
void
assertMigrationFileDoesNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

from  InteractsWithPublishedFiles
void
assertMigrationFileNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

from  InteractsWithPublishedFiles
void
assertFilenameExists(string $file)

Assert filename exists.

from  InteractsWithPublishedFiles
void
assertFilenameDoesNotExists(string $file)

Assert filename does not exist.

from  InteractsWithPublishedFiles
void
assertFilenameNotExists(string $file)

Assert filename does not exist.

from  InteractsWithPublishedFiles
void
assertMigrationFileExists(string $file, string|null $directory = null)

Assert migration filename exists.

from  InteractsWithPublishedFiles
void
assertMigrationFileDoesNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

from  InteractsWithPublishedFiles
void
assertMigrationFileNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

from  InteractsWithPublishedFiles
void
cleanUpPublishedFiles()

Removes generated files.

from  InteractsWithPublishedFiles
string|null
findFirstPublishedMigrationFile(string $filename, string|null $directory = null)

Find the first published migration file matching the filename.

from  InteractsWithPublishedFiles
void
cleanUpPublishedMigrationFiles()

Removes generated migration files.

from  InteractsWithPublishedFiles
string
publishedFilePath(string|SplFileInfo $file)

Normalize a published file entry into a filesystem path.

from  InteractsWithPublishedFiles
void
purgeSqliteConnection()

Purge the sqlite connection before swapping the runtime database file.

string
baseSqliteDatabasePath()

Get the base sqlite database path before any parallel suffix is applied.

string
activeSqliteDatabasePath()

Get the sqlite database path used by remote CLI commands in parallel.

void
useActiveSqliteDatabasePath(callable $callback)

Temporarily point the sqlite connection at the active runtime database file.

void
withoutSqliteDatabase(callable $callback)

Drop Sqlite database.

void
withSqliteDatabase(callable $callback)

Drop and create a new Sqlite database.

static void
cleanupBackupSqliteDatabaseFilesOnFailed()

Clean up backup Sqlite database files after class teardown.

Details

in InteractsWithPublishedFiles at line 36
protected void setUpInteractsWithPublishedFiles()

internal  
 

Setup Interacts with Published Files environment.

Return Value

void

in InteractsWithPublishedFiles at line 49
protected void tearDownInteractsWithPublishedFiles()

internal  
 

Teardown Interacts with Published Files environment.

Return Value

void

in InteractsWithPublishedFiles at line 64
protected void cacheExistingMigrationsFiles()

internal  
 

Cache existing migration files.

Return Value

void

in InteractsWithPublishedFiles at line 78
protected void assertFileContains(array $contains, string $file, string $message = '')

Assert file contains the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

in InteractsWithPublishedFiles at line 96
protected void assertFileDoesNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

in InteractsWithPublishedFiles at line 114
protected void assertFileNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

in InteractsWithPublishedFiles at line 124
protected void assertMigrationFileContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file contains the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 142
protected void assertMigrationFileDoesNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 160
protected void assertMigrationFileNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 168
protected void assertFilenameExists(string $file)

Assert filename exists.

Parameters

string $file

Return Value

void

in InteractsWithPublishedFiles at line 178
protected void assertFilenameDoesNotExists(string $file)

Assert filename does not exist.

Parameters

string $file

Return Value

void

in InteractsWithPublishedFiles at line 188
protected void assertFilenameNotExists(string $file)

Assert filename does not exist.

Parameters

string $file

Return Value

void

in InteractsWithPublishedFiles at line 196
protected void assertMigrationFileExists(string $file, string|null $directory = null)

Assert migration filename exists.

Parameters

string $file
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 206
protected void assertMigrationFileDoesNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

Parameters

string $file
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 216
protected void assertMigrationFileNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

Parameters

string $file
string|null $directory

Return Value

void

in InteractsWithPublishedFiles at line 226
protected void cleanUpPublishedFiles()

internal  
 

Removes generated files.

Return Value

void

in InteractsWithPublishedFiles at line 242
protected string|null findFirstPublishedMigrationFile(string $filename, string|null $directory = null)

Find the first published migration file matching the filename.

Parameters

string $filename
string|null $directory

Return Value

string|null

in InteractsWithPublishedFiles at line 256
protected void cleanUpPublishedMigrationFiles()

internal  
 

Removes generated migration files.

Return Value

void

in InteractsWithPublishedFiles at line 270
protected string publishedFilePath(string|SplFileInfo $file)

Normalize a published file entry into a filesystem path.

Parameters

string|SplFileInfo $file

Return Value

string

at line 33
protected void purgeSqliteConnection()

Purge the sqlite connection before swapping the runtime database file.

These helpers replace database.sqlite on disk while the parent test process and remote CLI commands share the same runtime base path. The testing resolver caches sqlite connections per worker, so the parent process must drop its cached PDO handle before reading a newly swapped file.

Return Value

void

at line 41
protected string baseSqliteDatabasePath()

Get the base sqlite database path before any parallel suffix is applied.

Return Value

string

at line 65
protected string activeSqliteDatabasePath()

Get the sqlite database path used by remote CLI commands in parallel.

The commander subprocess boots a fresh Testbench application. When DB_CONNECTION=sqlite and ParaTest sets TEST_TOKEN, Testbench rewrites the sqlite database path to a token-suffixed file. The parent test process must point its sqlite connection at that same file before asserting on it.

Return Value

string

at line 80
protected void useActiveSqliteDatabasePath(callable $callback)

Temporarily point the sqlite connection at the active runtime database file.

Parameters

callable $callback

Return Value

void

at line 108
protected void withoutSqliteDatabase(callable $callback)

Drop Sqlite database.

Parameters

callable $callback

Return Value

void

at line 160
protected void withSqliteDatabase(callable $callback)

Drop and create a new Sqlite database.

Parameters

callable $callback

Return Value

void

at line 200
static void cleanupBackupSqliteDatabaseFilesOnFailed()

Clean up backup Sqlite database files after class teardown.

Return Value

void