mirror of
https://github.com/silverstripe/silverstripe-testsession
synced 2024-10-22 14:06:00 +02:00
72b48f4c38
- Allow limited state setting when session is already in progress - Allow test sessions without a test database - Denote an “in progress” session through a “testsession.started” session flag rather than the usage of a temporary database
64 lines
2.9 KiB
Markdown
64 lines
2.9 KiB
Markdown
# Browser Test Session Module
|
|
|
|
## Overview
|
|
|
|
This module starts a testing session in a browser,
|
|
in order to test a SilverStripe application in a clean state.
|
|
Usually the session is started on a fresh database with only default records loaded.
|
|
Further data can be loaded from YAML fixtures.
|
|
|
|
The module also serves as an initializer for the
|
|
[SilverStripe Behat Extension](https://github.com/silverstripe-labs/silverstripe-behat-extension/).
|
|
It is required for Behat because the Behat CLI test runner needs to persist
|
|
test configuration just for the tested browser connection,
|
|
available on arbitary URL endpoints. For example,
|
|
we're setting up a test mailer which writes every email
|
|
into a temporary database table for inspection by the CLI-based process.
|
|
|
|
## Setup
|
|
|
|
In order to execute the commands, the environment must be in "dev mode",
|
|
or you must be logged-in with administrative permissions.
|
|
|
|
Since the database name is stored as an encrypted cookie,
|
|
you need to create a secure token for the encryption first:
|
|
|
|
sake dev/generatesecuretoken
|
|
|
|
The resulting configuration code needs to be placed in `mysite/_config.php`.
|
|
|
|
## Usage
|
|
|
|
You start a test session by manually requesting a certain URL,
|
|
and interact with it through other URL endpoints.
|
|
|
|
Commands:
|
|
|
|
* `dev/testsession`: Shows options for starting a test session
|
|
* `dev/testsession/start`: Sets up test state, most commonly a test database will be constructed,
|
|
and your browser session will be amended to use this database. See "Parameters" documentation below.
|
|
* `dev/testsession/end`: Removes the test state, and resets to the original database.
|
|
* `dev/testsession/loadfixture?fixture=<path>`: Loads a fixture into an existing test state.
|
|
* `dev/testsession/clear`: Empties the test state.
|
|
|
|
Parameters for "dev/testsession/start":
|
|
|
|
* `fixture`: Loads a YAML fixture in the format generally accepted by `SapphireTest`
|
|
(see [fixture format docs](http://doc.silverstripe.org/framework/en/topics/testing/fixtures)).
|
|
The path should be relative to the webroot.
|
|
* `createDatabase`: Create a temporary database.
|
|
* `database`: Set an alternative database name in the current
|
|
browser session as a cookie. Does not actually create the database,
|
|
that's usually handled by `SapphireTest::create_temp_db()`.
|
|
Note: The database names are limited to a specific naming convention as a security measure:
|
|
The "ss_tmpdb" prefix and a random sequence of seven digits.
|
|
This avoids the user gaining access to other production databases available on the same connection.
|
|
* `mailer`: Subclass of `Mailer`, typically used to record emails instead of actually sending them.
|
|
* `datetime`: Sets a simulated date used for all framework operations.
|
|
Format as "yyyy-MM-dd HH:mm:ss" (Example: "2012-12-31 18:40:59").
|
|
|
|
Example usage with parameters:
|
|
|
|
dev/testsession/start?database=ss_tmpdb_1234567&fixture=cms/tests/controller/CMSMainTest.yml
|
|
|