FunctionalTest
class FunctionalTest extends SapphireTest (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
| static private | $dependencies | from SapphireTest |
Methods
Determines if unit tests are currently run (via {@link TestRunner}).
Set the manifest to be used to look up test classes by helper functions
Return the manifest being used to look up test classes by helper functions
No description
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
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.
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
Returns true if we are currently using a temporary database
Reset the testing database's schema.
Create a member and group with the given permission code, and log in with it.
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.
Log in as the given member
Use the draft (stage) site for testing.
Return a static variable from this class.
No description
No description
Details
static bool
is_running_test()
Determines if unit tests are currently run (via {@link TestRunner}).
This is used as a cheap replacement for fully mockable state in certain contiditions (e.g. access checks). Caution: When set to FALSE, certain controllers might bypass access checks, so this is a very security sensitive setting.
static
set_is_running_test($bool)
static
set_test_class_manifest($manifest)
Set the manifest to be used to look up test classes by helper functions
static
get_test_class_manifest()
Return the manifest being used to look up test classes by helper functions
static string
get_fixture_file()
setUp()
setUpOnce()
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 tearDownOnce()} for tearing down the state again.
tearDownOnce()
tearDown method that's called once per test class rather once per test method.
FixtureFactory
getFixtureFactory()
setFixtureFactory(FixtureFactory $factory)
loadFixture($fixtureFile)
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 {@link loadFixture()}
tearDown()
static
assertContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)
static
assertNotContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)
clearEmails()
Clear the log of emails sent
array
findEmail($to, $from = null, $subject = null, $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.
array
assertEmailSent($to, $from = null, $subject = null, $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.
assertDOSContains($matches, $dataObjectSet)
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
assertDOSEquals($matches, $dataObjectSet)
Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
assertDOSAllMatch($match, $dataObjectSet)
Assert that the every record in the given {@link SS_List} matches the given key-value pairs.
assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '', float $delta = 0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)
Asserts that two SQL queries are equivalent
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
static
using_temp_db()
Returns true if we are currently using a temporary database
static
kill_temp_db()
static
empty_temp_db()
Remove all content from the temporary database.
static
create_temp_db()
static
delete_all_temp_dbs()
resetDBSchema($includeExtraDataObjects = false)
Reset the testing database's schema.
logInWithPermission($permCode = "ADMIN")
Create a member and group with the given permission code, and log in with it.
Returns the member ID.
Session
session()
Returns the {@link Session} object for this test
SS_HTTPResponse
get(string $url, Session $session = null, array $headers = null, array $cookies = null)
Submit a get request
SS_HTTPResponse
post(string $url, array $data, array $headers = null, Session $session = null, string $body = null, array $cookies = null)
Submit a post request
SS_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')
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.
bool
assertPartialMatchBySelector(string $selector, array|string $expectedMatches)
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.
bool
assertExactMatchBySelector(string $selector, array|string $expectedMatches)
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.
bool
assertPartialHTMLMatchBySelector(string $selector, array|string $expectedMatches)
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.
bool
assertExactHTMLMatchBySelector(string $selector, array|string $expectedMatches)
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.
logInAs($member)
Log in as the given member
useDraftSite($enabled = true)
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.
mixed
stat(string $varName)
Return a static variable from this class.