Version 5 supported

Functional testing

FunctionalTest test your applications Controller logic and anything else which requires a web request. The core idea of these tests is the same as SapphireTest unit tests but FunctionalTest adds several methods for creating HTTPRequest, receiving HTTPResponse objects and modifying the current user session.

Get

$page = $this->get($url);

Performs a GET request on $url and retrieves the HTTPResponse. This also changes the current page to the value of the response.

Post

$page = $this->post($url);

Performs a POST request on $url and retrieves the HTTPResponse. This also changes the current page to the value of the response.

Other requests

$page = $this->sendRequest('PUT', $url);

Performs a request on $url with the HTTP method provided (useful for PUT, PATCH, DELETE, etc.). This also changes the current page to the value of the response.

Submit

$submit = $this->submitForm($formID, $button = null, $data = []);

Submits the given form (#ContactForm) on the current page and returns the HTTPResponse.

LogInAs

$this->logInAs($member);

Logs a given user in, sets the current session.

When doing a functional testing it's important to use $this->logInAs($member); rather than simply Security::setCurrentUser($member); or $this->session()->set('loggedInAs', $member->ID); as the latter two will not run any logic contained inside login authenticators.

LogOut

Log out the current user, destroys the current session.

$this->logOut();

Assertions

The FunctionalTest class also provides additional asserts to validate your tests.

assertPartialMatchBySelector

$this->assertPartialMatchBySelector('p.good', [
    'Test save was successful',
]);

Asserts 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.

assertExactMatchBySelector

$this->assertExactMatchBySelector('#MyForm_ID p.error', [
    'That email address is invalid.',
]);

Asserts 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.

assertPartialHTMLMatchBySelector

$this->assertPartialHTMLMatchBySelector('#MyForm_ID p.error', [
    'That email address is invalid.',
]);

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.

  characters are stripped from the content; make sure that your assertions take this into account.

assertExactHTMLMatchBySelector

$this->assertExactHTMLMatchBySelector('#MyForm_ID p.error', [
    'That email address is invalid.',
]);

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.

  characters are stripped from the content; make sure that your assertions take this into account.

Related documentation

API documentation