TestSessionEnvironment
class TestSessionEnvironment (View source)
Responsible for starting and finalizing test sessions.
Since these session span across multiple requests, session information is persisted in a file. This file is stored in the webroot by default, and the test session is considered "in progress" as long as this file exists.
This allows for cross-request, cross-client sharing of the same testsession, for example: Behat CLI starts a testsession, then opens a web browser which makes a separate request picking up the same testsession.
An environment can have an optional identifier (id), which allows multiple environments to exist at the same time in the same webroot. This enables parallel testing with (mostly) isolated state.
For a valid test session to exist, this needs to contain at least:
- database: The alternate database name that is being used for this test session (e.g. ss_tmpdb_1234567) It can optionally contain other details that should be passed through many separate requests:
- datetime: Mocked SS_DateTime ({\SilverStripe\TestSession\TestSessionRequestFilter})
- mailer: Mocked Email sender ({\SilverStripe\TestSession\TestSessionRequestFilter})
- stubfile: Path to PHP stub file for setup ({\SilverStripe\TestSession\TestSessionRequestFilter}) Extensions of TestSessionEnvironment can add extra fields in here to be saved and restored on each request.
See $state for default information stored in the test session.
Traits
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to have extensions applied to it.
Allows an object to declare a set of custom methods
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| test_state_file | string | ||
| test_state_id_file |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom public methods. |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | int | $id |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Determines if a custom method with this name is defined.
Get meta-data details on a named method
Return the names of all the methods available on this object
Get all public built in methods for this class
Find all methods on the given object.
Add all the methods from an object property.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
Creates a temp database, sets up any extra requirements, and writes the state file. The database will be connected to as part of TestSessionEnvironment::applyState(), so if you're continuing script execution after calling this method, be aware that the database will be different - so various things may break (e.g. administrator logins using the SS_DEFAULT_USERNAME / SS_DEFAULT_PASSWORD constants).
Recursively move files from one directory to another
Assumes the database has already been created in startTestSession(), as this method can be called from _config.php where we don't yet have a DB connection.
Build the database with default records, see DataObject->requireDefaultRecords().
Sliented as if the file already exists by another process, we don't want to modify.
Cleans up the test session state by restoring the normal database connect (for the rest of this request, if any) and removes the TestSessionEnvironment::$test_state_file so that future requests don't use this test state.
Loads a YAML fixture into the database as part of the TestSessionController.
Wait for pending requests
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
protected bool
hasCustomMethod($method)
Determines if a custom method with this name is defined.
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
static protected array
findBuiltInMethods(string|object $class = null)
Get all public built in methods for this class
protected array
findMethodsFrom(object $object)
Find all methods on the given object.
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed ...$arguments)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed ...$arguments)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
__construct($id = null)
No description
init(HTTPRequest $request)
No description
string
getFilePath()
No description
isRunningTests()
Tests for the existence of the file specified by $this->test_state_file
setId(string $id)
No description
string
getId()
No description
startTestSession(array $state = null, mixed $id = null)
Creates a temp database, sets up any extra requirements, and writes the state file. The database will be connected to as part of TestSessionEnvironment::applyState(), so if you're continuing script execution after calling this method, be aware that the database will be different - so various things may break (e.g. administrator logins using the SS_DEFAULT_USERNAME / SS_DEFAULT_PASSWORD constants).
If something isn't explicitly handled here, and needs special handling, then it should be taken care of by an extension to TestSessionEnvironment. You can either extend onBeforeStartTestSession() or onAfterStartTestSession(). Alternatively, for more fine-grained control, you can also extend onBeforeApplyState() and onAfterApplyState(). See the TestSessionEnvironment::applyState() method for more.
updateTestSession($state)
No description
protected
backupAssets()
Backup all assets from /assets to /assets_backup.
Note: Only does file move, no files ever duplicated / deleted
restoreAssets()
Restore all assets to /assets folder.
Note: Only does file move, no files ever duplicated / deleted
protected
moveRecursive(string $src, string $dest, array $ignore = [])
Recursively move files from one directory to another
applyState(mixed $state)
Assumes the database has already been created in startTestSession(), as this method can be called from _config.php where we don't yet have a DB connection.
Persists the state to the filesystem.
You can extend this by creating an Extension object and implementing either onBeforeApplyState() or onAfterApplyState() to add your own test state handling in.
importDatabase(string $path, bool $requireDefaultRecords = false)
Import the database
requireDefaultRecords()
Build the database with default records, see DataObject->requireDefaultRecords().
saveState(mixed $state)
Sliented as if the file already exists by another process, we don't want to modify.
loadFromFile()
No description
endTestSession()
Cleans up the test session state by restoring the normal database connect (for the rest of this request, if any) and removes the TestSessionEnvironment::$test_state_file so that future requests don't use this test state.
Can be extended by implementing either onBeforeEndTestSession() or onAfterEndTestSession().
This should implement itself cleanly in case it is called twice (e.g. don't throw errors when the state file doesn't exist anymore because it's already been cleaned up etc.) This is because during behat test runs where a queueing system (e.g. silverstripe-resque) is used, the behat module may call this first, and then the forked worker will call it as well - but there is only one state file that is created.
FixtureFactory
loadFixtureIntoDb(string $fixtureFile)
Loads a YAML fixture into the database as part of the TestSessionController.
resetDatabaseName()
Reset the database connection to use the original database.
Called by TestSessionEnvironment::endTestSession().
stdClass
getState()
No description
protected string
getAssetsBackupfolder()
Path where assets should be backed up during testing
connectToDatabase(mixed $state = null)
Ensure that there is a connection to the database
bool
waitForPendingRequests(int $await = 700, int $timeout = 10000)
Wait for pending requests