silverstripe-framework/docs/en/02_Developer_Guides/06_Testing/01_Functional_Testing.md

122 lines
3.7 KiB
Markdown
Raw Normal View History

title: Functional Testing
summary: Test controllers, forms and HTTP responses.
# Functional Testing
[FunctionalTest](api:SilverStripe\Dev\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](api:SilverStripe\Control\HTTPRequest), receiving [HTTPResponse](api:SilverStripe\Control\HTTPResponse) objects and modifying the current user session.
## Get
```php
2017-08-07 05:11:17 +02:00
$page = $this->get($url);
```
Performs a GET request on $url and retrieves the [HTTPResponse](api:SilverStripe\Control\HTTPResponse). This also changes the current page to the value
of the response.
## Post
```php
2017-08-07 05:11:17 +02:00
$page = $this->post($url);
```
Performs a POST request on $url and retrieves the [HTTPResponse](api:SilverStripe\Control\HTTPResponse). This also changes the current page to the value
of the response.
## Submit
```php
2017-08-07 05:11:17 +02:00
$submit = $this->submitForm($formID, $button = null, $data = []);
```
Submits the given form (`#ContactForm`) on the current page and returns the [HTTPResponse](api:SilverStripe\Control\HTTPResponse).
## LogInAs
```php
2017-08-07 05:11:17 +02:00
$this->logInAs($member);
```
Logs a given user in, sets the current session. To log all users out pass `null` to the method.
```php
2017-08-07 05:11:17 +02:00
$this->logInAs(null);
```
## Assertions
The `FunctionalTest` class also provides additional asserts to validate your tests.
### assertPartialMatchBySelector
```php
2017-08-07 05:11:17 +02:00
$this->assertPartialMatchBySelector('p.good',[
'Test save was successful'
]);
2017-08-03 05:35:09 +02:00
```
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
```php
2017-08-07 05:11:17 +02:00
$this->assertExactMatchBySelector("#MyForm_ID p.error", [
"That email address is invalid."
]);
2017-08-03 05:35:09 +02:00
```
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
```php
2017-08-07 05:11:17 +02:00
$this->assertPartialHTMLMatchBySelector("#MyForm_ID p.error", [
"That email address is invalid."
]);
2017-08-03 05:35:09 +02:00
```
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.
<div class="notice" markdown="1">
`&amp;nbsp;` characters are stripped from the content; make sure that your assertions take this into account.
</div>
### assertExactHTMLMatchBySelector
```php
2017-08-07 05:11:17 +02:00
$this->assertExactHTMLMatchBySelector("#MyForm_ID p.error", [
"That email address is invalid."
]);
2017-08-03 05:35:09 +02:00
```
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.
<div class="notice" markdown="1">
`&amp;nbsp;` characters are stripped from the content; make sure that your assertions take this into account.
</div>
## Related Documentation
* [How to write a FunctionalTest](how_tos/write_a_functionaltest)
## API Documentation
* [FunctionalTest](api:SilverStripe\Dev\FunctionalTest)