Testing
trait Testing
Composes the Testbench testing concerns into a single upstream-facing trait.
Hypervel's base testing lifecycle already owns application refresh and callback execution, so this trait primarily restores the upstream public surface and concern grouping.
Traits
Creates and bootstraps the application for testbench tests.
Provides assertion helpers for test cases.
Handles parsing and executing test method attributes.
Provides per-worker database isolation for parallel testing.
Properties
| static protected array<class-string, array<class-string, class-string>> | $cachedTestCaseUses | Cached traits used by each test case class. |
from InteractsWithTestCase |
| static protected array<int, array{key: class-string, instance: object}> | $testCaseTestingFeatures | Programmatically added class-level testing features. |
from InteractsWithTestCase |
| static protected array<int, array{key: class-string, instance: object}> | $testCaseMethodTestingFeatures | Programmatically added method-level testing features. |
from InteractsWithTestCase |
| protected null|Closure): void | $testCaseSetUpCallback | The cached test case setUp resolver. |
from InteractsWithPHPUnit |
| protected null|Closure): void | $testCaseTearDownCallback | The cached test case tearDown resolver. |
from InteractsWithPHPUnit |
| static protected array<string, array<int, array{key: class-string, instance: object}>> | $cachedTestCaseClassAttributes | Cached class attributes by class name. |
from InteractsWithPHPUnit |
| static protected array<string, array<int, array{key: class-string, instance: object}>> | $cachedTestCaseMethodAttributes | Cached method attributes by "class:method" key. |
from InteractsWithPHPUnit |
| null|Application | $app | from InteractsWithPHPUnit | |
| protected string|false|null | $applicationBootstrapFile | The resolved application bootstrap file. |
from WithHypervelBootstrapFile |
| protected bool | $syncTestbenchRoutesHasRun | Whether Testbench routes have been synchronized for this test. |
from HandlesRoutes |
| protected bool | $testbenchRouteCleanupRegistered | Whether route file cleanup has been registered for this test. |
from HandlesRoutes |
| protected bool | $reloadingApplicationForCachedRoutes | Whether defineCacheRoutes() is reloading the application to load cached routes. |
from HandlesRoutes |
| protected array<int, string> | $testbenchRouteFiles | Route files written by this test instance. |
from HandlesRoutes |
| protected MigrateProcessor> | $cachedTestMigratorProcessors | from InteractsWithMigrations |
Methods
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.
Check if the test case uses a specific trait.
Determine if the test case uses refresh-database testing concerns.
Cache and return traits used by test case.
Programmatically add a testing feature attribute.
Resolve PHPUnit method attributes for specific method.
Execute BeforeEach lifecycle attributes.
Execute AfterEach lifecycle attributes.
Execute BeforeAll lifecycle attributes.
Execute AfterAll lifecycle attributes and clear caches.
Determine if the object is running as a PHPUnit test case.
Resolve the PHPUnit test class name.
Resolve the PHPUnit test method name.
Resolve and cache PHPUnit attributes for current test.
Cache uses for test case before class runs.
Clear PHPUnit caches after class teardown.
Determine if the trait is used within testing using Pest.
Determine if the object implements Pest test runner.
Get Application's base path.
Ignore package discovery from.
Get package bootstrapper.
Get package providers.
Resolve application Console Kernel implementation.
Get application HTTP Kernel implementation using Workbench.
Get application HTTP exception handler using Workbench.
Define or get the cached uses for test case.
Get application bootstrap file path (if exists).
Determine if application is using a custom application kernels.
Determine if application is bootstrapped using Testbench's default skeleton.
Mask inherited framework APP_ENV for Testbench applications that opt out of loading env files.
Determine if the current test explicitly configured an environment variable.
Resolve application console kernel implementation.
Load configuration and register package providers/aliases.
Run bootstrappers individually with defineEnvironment() inserted.
Refresh route name lookups now and whenever the URL generator is resolved.
Configure worker-specific cache paths for parallel testing.
Get the current ParaTest worker token before the application exists.
Terminate and flush an application, preserving the first cleanup failure.
Mark the test as skipped when condition is not equivalent to true.
Mark the test as skipped when condition is equivalent to true.
Parse and execute test method attributes of a specific type.
Determine if using in-memory SQLite database connection.
Define database migrations after database refreshed.
Register cleanup for route files and route cache written by this test.
Get a route file path owned by this test instance.
Determine whether migration paths should be registered for an upcoming migration.
No description
Migrate Hypervel's default migrations.
Migrate all Hypervel migrations.
No description
Run and retain a migration processor for teardown.
Determine whether the active database concerns retain in-memory state.
Reload the application instance.
Details
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.
in
InteractsWithTestCase at line 51
static bool
usesTestingConcern(string|null $trait = null)
Check if the test case uses a specific trait.
in
InteractsWithTestCase at line 59
static bool
usesRefreshDatabaseTestingConcern()
Determine if the test case uses refresh-database testing concerns.
in
InteractsWithTestCase at line 70
static array
cachedUsesForTestCase()
Cache and return traits used by test case.
in
InteractsWithTestCase at line 82
static void
usesTestingFeature(object $attribute, int $flag = Attribute::TARGET_CLASS)
Programmatically add a testing feature attribute.
in
InteractsWithTestCase at line 113
abstract static protected Collection
resolvePhpUnitAttributesForMethod(string $className, string|null $methodName = null)
Resolve PHPUnit method attributes for specific method.
in
InteractsWithTestCase at line 118
protected void
setUpTheTestEnvironmentUsingTestCase()
Execute BeforeEach lifecycle attributes.
in
InteractsWithTestCase at line 131
protected void
tearDownTheTestEnvironmentUsingTestCase()
Execute AfterEach lifecycle attributes.
in
InteractsWithTestCase at line 165
static void
setUpBeforeClassUsingTestCase()
Execute BeforeAll lifecycle attributes.
in
InteractsWithTestCase at line 176
static void
tearDownAfterClassUsingTestCase()
Execute AfterAll lifecycle attributes and clear caches.
in
InteractsWithPHPUnit at line 55
bool
isRunningTestCase()
Determine if the object is running as a PHPUnit test case.
in
InteractsWithPHPUnit at line 65
string|null
resolvePhpUnitTestClassName()
Resolve the PHPUnit test class name.
in
InteractsWithPHPUnit at line 79
string|null
resolvePhpUnitTestMethodName()
Resolve the PHPUnit test method name.
in
InteractsWithPHPUnit at line 93
protected Collection
resolvePhpUnitAttributes()
Resolve and cache PHPUnit attributes for current test.
in
InteractsWithPHPUnit at line 135
void
setUpTheEnvironmentUsing(Closure $setUp)
Define the setUp environment using callback.
in
InteractsWithPHPUnit at line 145
void
tearDownTheEnvironmentUsing(Closure $tearDown)
Define the tearDown environment using callback.
in
InteractsWithPHPUnit at line 153
static void
setUpBeforeClassUsingPHPUnit()
Cache uses for test case before class runs.
in
InteractsWithPHPUnit at line 161
static void
tearDownAfterClassUsingPHPUnit()
Clear PHPUnit caches after class teardown.
in
InteractsWithPest at line 17
bool
isRunningTestCaseUsingPest()
Determine if the trait is used within testing using Pest.
in
InteractsWithPest at line 25
static protected bool
isRunningViaPestPrinter(object|string $object)
Determine if the object implements Pest test runner.
in
InteractsWithWorkbench at line 26
static string|null
applicationBasePathUsingWorkbench()
| internal |
Get Application's base path.
in
InteractsWithWorkbench at line 38
array|null
ignorePackageDiscoveriesFromUsingWorkbench()
| internal |
Ignore package discovery from.
in
InteractsWithWorkbench at line 56
protected array|null
getPackageBootstrappersUsingWorkbench(object $app)
| internal |
Get package bootstrapper.
in
InteractsWithWorkbench at line 74
protected array|null
getPackageProvidersUsingWorkbench(object $app)
| internal |
Get package providers.
in
InteractsWithWorkbench at line 101
protected string
applicationConsoleKernelUsingWorkbench(object $app)
| internal |
Resolve application Console Kernel implementation.
in
InteractsWithWorkbench at line 115
protected string
applicationHttpKernelUsingWorkbench(object $app)
| internal |
Get application HTTP Kernel implementation using Workbench.
in
InteractsWithWorkbench at line 129
protected string
applicationExceptionHandlerUsingWorkbench(object $app)
| internal |
Get application HTTP exception handler using Workbench.
in
InteractsWithWorkbench at line 141
static Config|null
cachedConfigurationForWorkbench()
Define or get the cached uses for test case.
in
WithHypervelBootstrapFile at line 27
protected string|false
getApplicationBootstrapFile(string $filename)
| internal |
Get application bootstrap file path (if exists).
in
WithHypervelBootstrapFile at line 47
protected bool
hasCustomApplicationKernels()
| internal |
Determine if application is using a custom application kernels.
in
WithHypervelBootstrapFile at line 56
protected bool
usesTestbenchDefaultSkeleton()
Determine if application is bootstrapped using Testbench's default skeleton.
in
WithHypervelBootstrapFile at line 68
abstract protected string
getApplicationBasePath()
Get the application's base path.
in
CreatesApplication at line 68
static string
applicationBasePath()
Get the base path for the application.
in
CreatesApplication at line 78
array
ignorePackageDiscoveriesFrom()
Ignore package discovery from.
in
CreatesApplication at line 96
protected array
getPackageProviders(Application $app)
Get package providers.
in
CreatesApplication at line 106
protected array
getPackageBootstrappers(Application $app)
Get package bootstrappers.
in
CreatesApplication at line 119
protected array
getApplicationProviders(Application $app)
Get application providers.
Override in test classes to filter the default provider list before registration. For example, to remove SessionServiceProvider.
in
CreatesApplication at line 127
protected string|null
getApplicationTimezone(Application $app)
Get the application timezone.
in
CreatesApplication at line 140
protected array
overrideApplicationProviders(Application $app)
Override application providers.
Return a map of provider class names to replacements. Set a provider
to false to remove it entirely, or to another class name to replace it.
in
CreatesApplication at line 150
protected array
getPackageAliases(Application $app)
Get package aliases.
in
CreatesApplication at line 160
protected array
overrideApplicationBindings(Application $app)
Override application bindings.
in
CreatesApplication at line 171
protected void
defineEnvironment(Application $app)
Define environment setup.
Override in subclasses to modify config before providers boot. This is where test classes set database drivers, cache stores, etc.
in
CreatesApplication at line 184
Application
createApplication()
Create the application instance.
Bootstraps the application manually step-by-step (like Orchestral Testbench's createApplication), rather than via kernel->bootstrap(), so defineEnvironment() can be called between RegisterProviders and BootProviders.
in
CreatesApplication at line 236
protected Application
resolveApplication()
Resolve the application instance.
in
CreatesApplication at line 258
protected void
resolveApplicationBindings(Application $app)
Resolve application bindings.
in
CreatesApplication at line 268
protected void
resolveApplicationExceptionHandler(Application $app)
Resolve application HTTP exception handler.
in
CreatesApplication at line 276
protected void
resolveApplicationCore(Application $app)
Resolve application core environment.
in
CreatesApplication at line 286
protected void
resolveApplicationEnvironmentVariables(Application $app)
Resolve application environment variables.
in
CreatesApplication at line 327
protected Closure
maskInheritedApplicationEnvironment()
Mask inherited framework APP_ENV for Testbench applications that opt out of loading env files.
The framework suite forces APP_ENV=testing globally via phpunit.xml.dist. Tests that disable environment loading should instead use the configuration defaults unless they explicitly provided APP_ENV or package-tester mode is enabled.
in
CreatesApplication at line 368
protected bool
hasConfiguredApplicationEnvironmentVariable(string $key)
Determine if the current test explicitly configured an environment variable.
in
CreatesApplication at line 380
protected void
resolveApplicationHttpKernel(Application $app)
Resolve application HTTP kernel implementation.
in
CreatesApplication at line 388
protected void
resolveApplicationHttpMiddlewares(Application $app)
Resolve application HTTP default middlewares.
in
CreatesApplication at line 419
protected void
resolveApplicationConsoleKernel(Application $app)
Resolve application console kernel implementation.
in
CreatesApplication at line 433
protected void
resolveApplicationConfiguration(Application $app)
Load configuration and register package providers/aliases.
Equivalent to Orchestral's resolveApplicationConfiguration(): loads config files, then sets app.providers and app.aliases in config BEFORE RegisterProviders reads them.
in
CreatesApplication at line 481
protected void
resolveApplicationProviders(Application $app)
Resolve the final application provider list.
Merges package providers, then applies overrides (replacements/removals) before writing the final list to config for RegisterProviders to use.
in
CreatesApplication at line 511
protected void
resolveApplicationBootstrappers(Application $app)
Run bootstrappers individually with defineEnvironment() inserted.
Equivalent to Orchestral's resolveApplicationBootstrappers().
in
CreatesApplication at line 571
protected void
refreshApplicationRouteNameLookups(Application $app)
Refresh route name lookups now and whenever the URL generator is resolved.
Route names set via fluent ->name() after RouteCollection::add() are not indexed until refreshNameLookups() rebuilds the lookup table. This method ensures names are refreshed both immediately and lazily — the after_resolving callback catches routes defined inside test methods (after boot) by firing whenever app('url') is resolved.
in
CreatesApplication at line 586
protected void
registerPackageAliases(Application $app)
Register package aliases into config.
in
CreatesApplication at line 607
protected void
configureParallelCachePaths()
Configure worker-specific cache paths for parallel testing.
When running under ParaTest, each worker gets a unique route cache path to prevent filesystem races. Without this, one worker's defineCacheRoutes() writes a shared cache file that causes other workers' routesAreCached() to return true, skipping route setup.
in
CreatesApplication at line 625
protected string|null
paraTestWorkerToken()
Get the current ParaTest worker token before the application exists.
This reads the raw runtime arrays because cached route setup may run before parent::setUp(), when no application or ParallelTesting service has been created yet.
in
CreatesApplication at line 633
static protected Throwable|null
terminateAndFlushApplication(Application $app)
Terminate and flush an application, preserving the first cleanup failure.
in
HandlesAssertions at line 19
protected void
markTestSkippedUnless(bool|Closure|null $condition, string $message)
Mark the test as skipped when condition is not equivalent to true.
in
HandlesAssertions at line 32
protected void
markTestSkippedWhen(bool|Closure|null $condition, string $message)
Mark the test as skipped when condition is equivalent to true.
in
HandlesAttributes at line 28
protected FeaturesCollection
parseTestMethodAttributes(Application $app, string $attribute)
| internal |
Parse and execute test method attributes of a specific type.
Note: Attributes are already executed automatically via setUpTheTestEnvironmentUsingTestCase(). This method is for internal use by the testing infrastructure.
in
HandlesDatabases at line 28
protected void
setUpDatabaseRequirements(Closure $callback)
Setup database requirements.
in
HandlesDatabases at line 72
protected bool
usesSqliteInMemoryDatabaseConnection(string|null $connection = null)
Determine if using in-memory SQLite database connection.
in
HandlesDatabases at line 90
protected void
defineDatabaseMigrations()
Define database migrations.
in
HandlesDatabases at line 98
protected void
defineDatabaseMigrationsAfterDatabaseRefreshed()
Define database migrations after database refreshed.
in
HandlesDatabases at line 106
protected void
destroyDatabaseMigrations()
Destroy database migrations.
in
HandlesDatabases at line 114
protected void
defineDatabaseSeeders()
Define database seeders.
in
HandlesRoutes at line 57
protected void
setUpApplicationRoutes(Application $app)
Setup application routes.
in
HandlesRoutes at line 82
protected void
defineRoutes(Router $router)
Define routes setup.
in
HandlesRoutes at line 90
protected void
defineWebRoutes(Router $router)
Define web routes setup.
in
HandlesRoutes at line 98
protected void
defineStashRoutes(Closure|string $route)
Define stash routes setup.
in
HandlesRoutes at line 106
protected void
defineCacheRoutes(Closure|string $route, bool $cached = true)
Define cache routes setup.
in
HandlesRoutes at line 182
protected void
syncTestbenchRoutes()
| internal |
Synchronize Testbench routes.
in
HandlesRoutes at line 201
protected void
registerTestbenchRouteCleanup(Filesystem $files, string $cachedRoutesPath)
Register cleanup for route files and route cache written by this test.
in
HandlesRoutes at line 254
protected string
testbenchRouteFilePath(string $basePath)
Get a route file path owned by this test instance.
in
InteractsWithMigrations at line 33
protected void
setUpInteractsWithMigrations()
No description
in
InteractsWithMigrations at line 41
protected void
tearDownInteractsWithMigrations()
No description
in
InteractsWithMigrations at line 83
protected void
loadMigrationsFrom(array|string $paths)
No description
in
InteractsWithMigrations at line 105
protected bool
shouldRegisterMigrationPaths()
Determine whether migration paths should be registered for an upcoming migration.
in
InteractsWithMigrations at line 137
protected array
resolvePackageMigrationsOptions(array|string $paths = [])
| internal |
No description
in
InteractsWithMigrations at line 157
protected void
loadHypervelMigrations(array|string $database = [])
Migrate Hypervel's default migrations.
in
InteractsWithMigrations at line 176
protected void
runHypervelMigrations(array|string $database = [])
Migrate all Hypervel migrations.
in
InteractsWithMigrations at line 190
protected array
resolveHypervelMigrationsOptions(array|string $database = [])
| internal |
No description
in
InteractsWithMigrations at line 200
protected void
runMigrationProcessor(Application $app, array $options)
Run and retain a migration processor for teardown.
in
InteractsWithMigrations at line 228
protected bool
usesInMemoryDatabaseForMigrationState()
Determine whether the active database concerns retain in-memory state.
in
InteractsWithMigrations at line 245
protected void
resetApplicationArtisanCommands(Application $app)
No description
at line 28
protected void
reloadApplication()
Reload the application instance.