FunctionalTest
class FunctionalTest extends SapphireTest implements TestOnly (View source)
SilverStripe-specific testing object designed to support functional testing of your web app. It simulates get/post requests, form submission, and can validate resulting HTML, looking up content by CSS selector.
The example below shows how it works.
public function testMyForm() {
// Visit a URL
$this->get("your/url");
// Submit a form on the page that you get in response
$this->submitForm("MyForm_ID", "action_dologin", array("Email" => "invalid email ^&*&^"));
// Validate the content that is returned
$this->assertExactMatchBySelector("#MyForm_ID p.error", array("That email address is invalid."));
}Properties
| protected static | string|array | $fixture_file | Path to fixture data for this test run. |
from SapphireTest |
| protected deprecated | FixtureFactory | $fixtureFactory | from SapphireTest | |
| protected | bool | $usesDatabase | from SapphireTest | |
| protected | bool | $usesTransactions | This test will cleanup its state via transactions. |
from SapphireTest |
| protected static | bool | $is_running_test | from SapphireTest | |
| protected | array | $requireDefaultRecordsFrom | By default, setUp() does not require default records. Pass class names in here, and the require/augment default records function will be called on them. |
from SapphireTest |
| protected static | array | $illegal_extensions | A list of extensions that can't be applied during the execution of this run. If they are applied, they will be temporarily removed and a database migration called. |
from SapphireTest |
| protected static | array | $required_extensions | A list of extensions that must be applied during the execution of this run. If they are not applied, they will be temporarily added and a database migration called. |
from SapphireTest |
| protected static | array | $extra_dataobjects | By default, the test database won't contain any DataObjects that have the interface TestOnly. |
from SapphireTest |
| protected static | array | $extra_controllers | List of class names of {Controller} objects to register routes for Controllers must implement Link() method |
from SapphireTest |
| protected | $backupGlobals | We need to disabling backing up of globals to avoid overriding the few globals SilverStripe relies on, like $lang for the i18n subsystem. |
from SapphireTest | |
| protected static | SapphireTestState | $state | State management container for SapphireTest |
from SapphireTest |
| protected static | TempDatabase | $tempDB | Temp database helper |
from SapphireTest |
| protected | $cache_generatedMembers | Cache for logInWithPermission() |
from SapphireTest | |
| protected static | bool | $disable_themes | Set this to true on your sub-class to disable the use of themes in this test. |
|
| protected static deprecated | bool | $use_draft_site | Set this to true on your sub-class to use the draft site by default for every test in this class. |
|
| protected | TestSession | $mainSession | ||
| protected | CSSContentParser | $cssParser | CSSContentParser for the most recently requested page. |
|
| protected | bool | $autoFollowRedirection | If this is true, then 30x Location headers will be automatically followed. |
Methods
Gets required extensions for this class
Check if test bootstrapping has been performed. Must not be relied on outside of unit tests.
Helper method to determine if the current test should enable a test database
Helper method to check, if the current test uses the database.
Helper method to check, if the current test uses the database.
Called once per test case (SapphireTest subclass).
tearDown method that's called once per test class rather once per test method.
Get the ID of an object from the fixture.
Return all of the IDs in the fixture of a particular class name.
Get an object from the fixture.
Clear all fixtures which were previously loaded through loadFixture()
Useful for writing unit tests without hardcoding folder structures.
No description
No description
Search for an email that was sent.
Assert that the matching email was sent since the last call to clearEmails() All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
Assert that the given SS_List includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Asserts that no items in a given list appear in the given dataobject list
Assert that the given SS_List includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Assert that the every record in the given SS_List matches the given key-value pairs.
Removes sequences of repeated whitespace characters from SQL queries making them suitable for string comparison
Asserts that two SQL queries are equivalent
Asserts that a SQL query contains a SQL fragment
Asserts that a SQL query contains a SQL fragment
Reset the testing database's schema, but only if it is active
A wrapper for automatically performing callbacks as a user with a specific permission
Create Member and Group objects on demand with specific permission code
Create a member and group with the given permission code, and log in with it.
Test against a theme.
Return all extra objects to scaffold for this test
Get additional controller classes to register routes for
Map a fixture path to a physical file
Run a test while mocking the base url with the provided value
Run a test while mocking the base folder with the provided value
Submit the form with the given HTML ID, filling it out with the given data.
Find an attribute in a SimpleXMLElement object by name.
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
Details
static TempDatabase
tempDB()
No description
static array
getIllegalExtensions()
Gets illegal extensions for this class
static array
getRequiredExtensions()
Gets required extensions for this class
static protected bool
is_running_test()
Check if test bootstrapping has been performed. Must not be relied on outside of unit tests.
static protected
set_is_running_test(bool $bool)
Set test running state
static string
get_fixture_file()
No description
bool
getUsesDatabase()
No description
bool
getUsesTransactions()
No description
array
getRequireDefaultRecordsFrom()
No description
protected
setUp()
Setup the test.
Always sets up in order:
- Reset php state
- Nest
- Custom state helpers
User code should call parent::setUp() before custom setup code
protected bool
shouldSetupDatabaseForCurrentTest($fixtureFiles)
Helper method to determine if the current test should enable a test database
protected bool
currentTestEnablesDatabase()
Helper method to check, if the current test uses the database.
This can be switched on with the annotation "@useDatabase"
protected bool
currentTestDisablesDatabase()
Helper method to check, if the current test uses the database.
This can be switched on with the annotation "@useDatabase false"
static
setUpBeforeClass()
Called once per test case (SapphireTest subclass).
This is different to setUp(), which gets called once per method. Useful to initialize expensive operations which don't change state for any called method inside the test, e.g. dynamically adding an extension. See teardownAfterClass() for tearing down the state again.
Always sets up in order:
- Reset php state
- Nest
- Custom state helpers
User code should call parent::setUpBeforeClass() before custom setup code
static
tearDownAfterClass()
tearDown method that's called once per test class rather once per test method.
Always sets up in order:
- Custom state helpers
- Unnest
- Reset php state
User code should call parent::tearDownAfterClass() after custom tear down code
FixtureFactory|false
getFixtureFactory()
deprecated
deprecated
No description
$this
setFixtureFactory(FixtureFactory $factory)
deprecated
deprecated
Sets a new fixture factory
protected int
idFromFixture(string $className, string $identifier)
Get the ID of an object from the fixture.
protected array
allFixtureIDs(string $className)
Return all of the IDs in the fixture of a particular class name.
Will collate all IDs form all fixtures if multiple fixtures are provided.
protected DataObject
objFromFixture(string $className, string $identifier)
Get an object from the fixture.
loadFixture(string $fixtureFile)
deprecated
deprecated
Load a YAML fixture file into the database.
Once loaded, you can use idFromFixture() and objFromFixture() to get items from the fixture. Doesn't clear existing fixtures.
clearFixtures()
Clear all fixtures which were previously loaded through loadFixture()
protected string
getCurrentAbsolutePath()
Useful for writing unit tests without hardcoding folder structures.
protected string
getCurrentRelativePath()
No description
protected
tearDown()
Setup the test.
Always sets up in order:
- Custom state helpers
- Unnest
- Reset php state
User code should call parent::tearDown() after custom tear down code
static
assertContains($needle, $haystack, $message = '', $ignoreCase = false, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false)
No description
static
assertNotContains($needle, $haystack, $message = '', $ignoreCase = false, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false)
No description
bool
clearEmails()
Clear the log of emails sent
static array|null
findEmail(string $to, string $from = null, string $subject = null, string $content = null)
Search for an email that was sent.
All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
static
assertEmailSent(string $to, string $from = null, string $subject = null, string $content = null)
Assert that the matching email was sent since the last call to clearEmails() All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
static
assertListContains(SS_List|array $matches, SS_List $list, string $message = '')
Assert that the given SS_List includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
assertDOSContains($matches, $dataObjectSet)
deprecated
deprecated
No description
static
assertListNotContains(SS_List|array $matches, SS_List $list, string $message = '')
Asserts that no items in a given list appear in the given dataobject list
static
assertNotDOSContains($matches, $dataObjectSet)
deprecated
deprecated
No description
static
assertListEquals(mixed $matches, SS_List $list, string $message = '')
Assert that the given SS_List includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Example
Check that only the entries Sam Minnee and Ingo Schommer exist in $members. Order doesn't matter: $this->assertListEquals([ ['FirstName' =>'Sam', 'Surname' => 'Minnee'], ['FirstName' => 'Ingo', 'Surname' => 'Schommer'], ], $members);
assertDOSEquals($matches, SS_List $dataObjectSet)
deprecated
deprecated
No description
static
assertListAllMatch(mixed $match, SS_List $list, string $message = '')
Assert that the every record in the given SS_List matches the given key-value pairs.
Example
Check that every entry in $members has a Status of 'Active': $this->assertListAllMatch(['Status' => 'Active'], $members);
assertDOSAllMatch($match, SS_List $dataObjectSet)
deprecated
deprecated
No description
static protected string
normaliseSQL(string $sql)
Removes sequences of repeated whitespace characters from SQL queries making them suitable for string comparison
static
assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '', float|int $delta = 0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)
Asserts that two SQL queries are equivalent
static
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
static
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
static
start()
Start test environment
static
resetDBSchema(bool $includeExtraDataObjects = false, bool $forceCreate = false)
Reset the testing database's schema, but only if it is active
mixed
actWithPermission(string|array $permCode, callable $callback)
A wrapper for automatically performing callbacks as a user with a specific permission
protected Member
createMemberWithPermission(string|array $permCode)
Create Member and Group objects on demand with specific permission code
int
logInWithPermission(string|array $permCode = 'ADMIN')
Create a member and group with the given permission code, and log in with it.
Returns the member ID.
logInAs(Member|int|string $member)
Log in as the given member
logOut()
Log out the current user
protected
useTestTheme(string $themeBaseDir, string $theme, callable $callback)
Test against a theme.
protected array
getFixturePaths()
Get fixture paths for this test
static array
getExtraDataObjects()
Return all extra objects to scaffold for this test
static array
getExtraControllers()
Get additional controller classes to register routes for
protected string
resolveFixturePath(string $fixtureFilePath)
Map a fixture path to a physical file
protected
setUpRoutes()
No description
protected array
getExtraRoutes()
Get extra routes to merge into Director.rules
protected DBDatetime
mockSleep(int $seconds)
Test safe version of sleep()
Session
session()
Returns the Session object for this test
protected
withBaseURL(string $url, callable $callback)
Run a test while mocking the base url with the provided value
protected
withBaseFolder(string $folder, callable $callback)
Run a test while mocking the base folder with the provided value
HTTPResponse
get(string $url, Session $session = null, array $headers = null, array $cookies = null)
Submit a get request
HTTPResponse
post(string $url, array $data, array $headers = null, Session $session = null, string $body = null, array $cookies = null)
Submit a post request
HTTPResponse
submitForm(string $formID, string $button = null, array $data = [])
Submit the form with the given HTML ID, filling it out with the given data.
Acts on the most recent response.
Any data parameters have to be present in the form, with exact form field name and values, otherwise they are removed from the submission.
Caution: Parameter names have to be formatted as they are in the form submission, not as they are interpreted by PHP. Wrong: array('mycheckboxvalues' => array(1 => 'one', 2 => 'two')) Right: array('mycheckboxvalues[1]' => 'one', 'mycheckboxvalues[2]' => 'two')
string
content()
Return the most recent content
SimpleXMLElement
findAttribute(SimpleXMLElement $object, string $attribute)
Find an attribute in a SimpleXMLElement object by name.
CSSContentParser
cssParser()
Return a CSSContentParser for the most recent content.
assertPartialMatchBySelector(string $selector, array|string $expectedMatches, string $message = null)
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
The given CSS selector will be applied to the HTML of the most recent page. The content of every matching tag will be examined. The assertion fails if one of the expectedMatches fails to appear.
Note: characters are stripped from the content; make sure that your assertions take this into account.
assertExactMatchBySelector(string $selector, array|string $expectedMatches, string $message = null)
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
The given CSS selector will be applied to the HTML of the most recent page. The full HTML of every matching tag will be examined. The assertion fails if one of the expectedMatches fails to appear.
Note: characters are stripped from the content; make sure that your assertions take this into account.
assertPartialHTMLMatchBySelector(string $selector, array|string $expectedMatches, string $message = null)
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
The given CSS selector will be applied to the HTML of the most recent page. The content of every matching tag will be examined. The assertion fails if one of the expectedMatches fails to appear.
Note: characters are stripped from the content; make sure that your assertions take this into account.
assertExactHTMLMatchBySelector(string $selector, array|string $expectedMatches, string $message = null)
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
The given CSS selector will be applied to the HTML of the most recent page. The full HTML of every matching tag will be examined. The assertion fails if one of the expectedMatches fails to appear.
Note: characters are stripped from the content; make sure that your assertions take this into account.
useDraftSite(bool $enabled = true)
deprecated
deprecated
Use the draft (stage) site for testing.
This is helpful if you're not testing publication functionality and don't want "stage management" cluttering your test.
static bool
get_disable_themes()
No description
static bool
get_use_draft_site()
deprecated
deprecated
No description