FunctionalTest
class FunctionalTest extends SapphireTest implements TestOnly
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."));
}
Methods
Called once per test case ({@link SapphireTest} subclass).
tearDown method that's called once per test class rather once per test method.
Clear all fixtures which were previously loaded through {@link loadFixture()}
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 {@link 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 {@link 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 {@link SS_List} matches the given key-value pairs.
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 a member and group with the given permission code, and log in with it.
Return all extra objects to scaffold for this test
Get additional controller classes to register routes for
Submit the form with the given HTML ID, filling it out with the given data.
Return the most recent content
Find an attribute in a SimpleXMLElement object by name.
Return a CSSContentParser for the most recent content.
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.
No description
Details
in SapphireTest at line 174
static TempDatabase
tempDB()
in SapphireTest at line 187
static array
getIllegalExtensions()
Gets illegal extensions for this class
in SapphireTest at line 197
static array
getRequiredExtensions()
Gets required extensions for this class
in SapphireTest at line 226
static string|string[]
get_fixture_file()
in SapphireTest at line 234
bool
getUsesDatabase()
in SapphireTest at line 242
bool
getUsesTransactions()
in SapphireTest at line 250
array
getRequireDefaultRecordsFrom()
in SapphireTest at line 376
static
setUpBeforeClass()
Called once per test case ({@link SapphireTest} subclass).
This is different to {@link 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 {@link 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
in SapphireTest at line 405
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
in SapphireTest at line 418
FixtureFactory|false
getFixtureFactory()
deprecated
deprecated 4.0.0:5.0.0
in SapphireTest at line 432
$this
setFixtureFactory(FixtureFactory $factory)
deprecated
deprecated 4.0.0:5.0.0
Sets a new fixture factory
in SapphireTest at line 515
loadFixture(string $fixtureFile)
deprecated
deprecated 4.0.0:5.0.0
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.
in SapphireTest at line 526
clearFixtures()
Clear all fixtures which were previously loaded through {@link loadFixture()}
in SapphireTest at line 588
static
assertContains($needle, $haystack, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)
in SapphireTest at line 609
static
assertNotContains($needle, $haystack, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)
in SapphireTest at line 635
bool
clearEmails()
Clear the log of emails sent
in SapphireTest at line 656
static array
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.
in SapphireTest at line 675
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.
in SapphireTest at line 725
static
assertListContains(SS_List|array $matches, SS_List $list, string $message = '')
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
in SapphireTest at line 749
assertDOSContains(array $matches, $dataObjectSet)
deprecated
deprecated 4.0.0:5.0.0 Use assertListContains() instead
in SapphireTest at line 775
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
in SapphireTest at line 803
static
assertNotDOSContains($matches, $dataObjectSet)
deprecated
deprecated 4.0.0:5.0.0 Use assertListNotContains() instead
in SapphireTest at line 827
static
assertListEquals(mixed $matches, SS_List $list, string $message = '')
Assert that the given {@link 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);
in SapphireTest at line 851
assertDOSEquals($matches, SS_List $dataObjectSet)
deprecated
deprecated 4.0.0:5.0.0 Use assertListEquals() instead
in SapphireTest at line 871
static
assertListAllMatch(mixed $match, SS_List $list, string $message = '')
Assert that the every record in the given {@link 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);
in SapphireTest at line 895
assertDOSAllMatch($match, SS_List $dataObjectSet)
deprecated
deprecated 4.0.0:5.0.0 Use assertListAllMatch() instead
in SapphireTest at line 924
static
assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '', int $delta, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)
Asserts that two SQL queries are equivalent
in SapphireTest at line 949
static
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
in SapphireTest at line 971
static
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
in SapphireTest at line 987
static
start()
Start test environment
in SapphireTest at line 1035
static
resetDBSchema(bool $includeExtraDataObjects = false, bool $forceCreate = false)
Reset the testing database's schema, but only if it is active
in SapphireTest at line 1055
mixed
actWithPermission(string|array $permCode, callable $callback)
A wrapper for automatically performing callbacks as a user with a specific permission
in SapphireTest at line 1117
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.
in SapphireTest at line 1129
logInAs(Member|int|string $member)
Log in as the given member
in SapphireTest at line 1142
logOut()
Log out the current user
in SapphireTest at line 1201
static array
getExtraDataObjects()
Return all extra objects to scaffold for this test
in SapphireTest at line 1211
static array
getExtraControllers()
Get additional controller classes to register routes for
at line 78
Session
session()
Returns the {@link Session} object for this test
at line 158
HTTPResponse
get(string $url, Session $session = null, array $headers = null, array $cookies = null)
Submit a get request
at line 184
HTTPResponse
post(string $url, array $data, array $headers = null, Session $session = null, string $body = null, array $cookies = null)
Submit a post request
at line 213
HTTPResponse
submitForm(string $formID, string $button = null, array $data = array())
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')
at line 228
string
content()
Return the most recent content
at line 239
SimpleXMLElement
findAttribute(SimpleXMLElement $object, string $attribute)
Find an attribute in a SimpleXMLElement object by name.
at line 255
CSSContentParser
cssParser()
Return a CSSContentParser for the most recent content.
at line 275
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.
at line 312
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.
at line 347
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.
at line 385
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.
at line 413
useDraftSite(bool $enabled = true)
deprecated
deprecated 4.2.0:5.0.0 Use ?stage=Stage querystring arguments instead of useDraftSite
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.
at line 428
static bool
get_disable_themes()
at line 437
static bool
get_use_draft_site()
deprecated
deprecated 4.2.0:5.0.0 Use ?stage=Stage in your querystring arguments instead