Home` - `` For checking the raw source code, use `seeInSource()`. #### seeAuthentication * `param ?string` $guardName * `return void` Checks that a user is authenticated. {% highlight php %} seeAuthentication(); {% endhighlight %} #### seeCheckboxIsChecked * `param ` $checkbox * `return void` Checks that the specified checkbox is checked. {% highlight php %} seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form. $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]'); {% endhighlight %} #### seeCookie * `param ` $cookie * `param ` $params * `return mixed|void` Checks that a cookie with the given name is set. You can set additional cookie params like `domain`, `path` as array passed in last argument. {% highlight php %} seeCookie('PHPSESSID'); {% endhighlight %} #### seeCurrentActionIs * `param string` $action * `return void` Checks that current url matches action {% highlight php %} seeCurrentActionIs('PostsController@index'); // Laravel 8+: $I->seeCurrentActionIs(PostsController::class . '@index'); {% endhighlight %} #### seeCurrentRouteIs * `param string` $routeName * `return void` Checks that current url matches route {% highlight php %} seeCurrentRouteIs('posts.index'); {% endhighlight %} #### seeCurrentUrlEquals * `param string` $uri * `return void` Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} #### seeCurrentUrlMatches * `param string` $uri * `return void` Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} #### seeElement * `param ` $selector * `param array` $attributes * `return void` Checks that the given element exists on the page and is visible. You can also specify expected attributes of this element. Only works if `` tag is present. {% highlight php %} seeElement('.error'); $I->seeElement('//form/input[1]'); $I->seeElement('input', ['name' => 'login']); $I->seeElement('input', ['value' => '123456']); // strict locator in first arg, attributes in second $I->seeElement(['css' => 'form input'], ['name' => 'login']); {% endhighlight %} #### seeEventTriggered * `param string|object|string[]` $expected * `return void` Make sure events fired during the test. {% highlight php %} seeEventTriggered('App\MyEvent'); $I->seeEventTriggered(new App\Events\MyEvent()); $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); {% endhighlight %} #### seeFormErrorMessage * `param string` $field * `param ?string` $errorMessage * `return void` Assert that a specific form error message is set in the view. If you want to assert that there is a form error message for a specific key but don't care about the actual error message you can omit `$expectedErrorMessage`. If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key contains `$expectedErrorMessage`. {% highlight php %} seeFormErrorMessage('username'); $I->seeFormErrorMessage('username', 'Invalid Username'); {% endhighlight %} #### seeFormErrorMessages * `param array` $expectedErrors * `return void` Verifies that multiple fields on a form have errors. This method will validate that the expected error message is contained in the actual error message, that is, you can specify either the entire error message or just a part of it: {% highlight php %} seeFormErrorMessages([ 'address' => 'The address is too long', 'telephone' => 'too short' // the full error message is 'The telephone is too short' ]); {% endhighlight %} If you don't want to specify the error message for some fields, you can pass `null` as value instead of the message string. If that is the case, it will be validated that that field has at least one error of any type: {% highlight php %} seeFormErrorMessages([ 'telephone' => 'too short', 'address' => null ]); {% endhighlight %} #### seeFormHasErrors * `return void` Assert that form errors are bound to the View. {% highlight php %} seeFormHasErrors(); {% endhighlight %} #### seeInCurrentUrl * `param string` $uri * `return void` Checks that current URI contains the given string. {% highlight php %} seeInCurrentUrl('home'); // to match: /users/1 $I->seeInCurrentUrl('/users/'); {% endhighlight %} #### seeInField * `param string|array` $field * `param ` $value * `return void` Checks that the given input field or textarea *equals* (i.e. not just contains) the given value. Fields are matched by label text, the "name" attribute, CSS, or XPath. {% highlight php %} seeInField('Body','Type your comment here'); $I->seeInField('form textarea[name=body]','Type your comment here'); $I->seeInField('form input[type=hidden]','hidden_value'); $I->seeInField('#searchform input','Search'); $I->seeInField('//form/*[@name=search]','Search'); $I->seeInField(['name' => 'search'], 'Search'); {% endhighlight %} #### seeInFormFields * `param ` $formSelector * `param array` $params * `return void` Checks if the array of form parameters (name => value) are set on the form matched with the passed selector. {% highlight php %} seeInFormFields('form[name=myform]', [ 'input1' => 'value', 'input2' => 'other value', ]); {% endhighlight %} For multi-select elements, or to check values of multiple elements with the same name, an array may be passed: {% highlight php %} seeInFormFields('.form-class', [ 'multiselect' => [ 'value1', 'value2', ], 'checkbox[]' => [ 'a checked value', 'another checked value', ], ]); {% endhighlight %} Additionally, checkbox values can be checked with a boolean. {% highlight php %} seeInFormFields('#form-id', [ 'checkbox1' => true, // passes if checked 'checkbox2' => false, // passes if unchecked ]); {% endhighlight %} Pair this with submitForm for quick testing magic. {% highlight php %} 'value', 'field2' => 'another value', 'checkbox1' => true, // ... ]; $I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed $I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} #### seeInSession * `param string|array` $key * `param mixed|null` $value * `return void` Assert that a session variable exists. {% highlight php %} seeInSession('key'); $I->seeInSession('key', 'value'); {% endhighlight %} #### seeInSource * `param string` $raw * `return void` Checks that the current page contains the given string in its raw source code. {% highlight php %} seeInSource(''); {% endhighlight %} #### seeInTitle * `param ` $title * `return mixed|void` Checks that the page title contains the given string. {% highlight php %} seeInTitle('Blog - Post #1'); {% endhighlight %} #### seeLink * `param string` $text * `param ?string` $url * `return void` Checks that there's a link with the specified text. Give a full URL as the second parameter to match links with that exact URL. {% highlight php %} seeLink('Logout'); // matches Logout $I->seeLink('Logout','/logout'); // matches Logout {% endhighlight %} #### seeNumRecords * `part` orm * `param int` $expectedNum * `param string` $table * `param array` $attributes * `return void` Checks that number of given records were found in database. You can pass the name of a database table or the class name of an Eloquent model as the first argument. {% highlight php %} seeNumRecords(1, 'users', ['name' => 'Davert']); $I->seeNumRecords(1, 'App\Models\User', ['name' => 'Davert']); {% endhighlight %} #### seeNumberOfElements * `param ` $selector * `param int|int[]` $expected * `return void` Checks that there are a certain number of elements matched by the given locator on the page. {% highlight php %} seeNumberOfElements('tr', 10); $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements {% endhighlight %} #### seeOptionIsSelected * `param ` $selector * `param ` $optionText * `return mixed|void` Checks that the given option is selected. {% highlight php %} seeOptionIsSelected('#form input[name=payment]', 'Visa'); {% endhighlight %} #### seePageNotFound * `return void` Asserts that current page has 404 response status code. #### seeRecord * `part` orm * `param string|class-string|object` $table * `param array` $attributes * `return void` Checks that record exists in database. You can pass the name of a database table or the class name of an Eloquent model as the first argument. {% highlight php %} seeRecord($user); $I->seeRecord('users', ['name' => 'Davert']); $I->seeRecord('App\Models\User', ['name' => 'Davert']); {% endhighlight %} #### seeResponseCodeIs * `param int` $code * `return void` Checks that response code is equal to value provided. {% highlight php %} seeResponseCodeIs(200); // recommended \Codeception\Util\HttpCode $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK); {% endhighlight %} #### seeResponseCodeIsBetween * `param int` $from * `param int` $to * `return void` Checks that response code is between a certain range. Between actually means [from <= CODE <= to] #### seeResponseCodeIsClientError * `return void` Checks that the response code is 4xx #### seeResponseCodeIsRedirection * `return void` Checks that the response code 3xx #### seeResponseCodeIsServerError * `return void` Checks that the response code is 5xx #### seeResponseCodeIsSuccessful * `return void` Checks that the response code 2xx #### seeSessionHasValues * `param array` $bindings * `return void` Assert that the session has a given list of values. {% highlight php %} seeSessionHasValues(['key1', 'key2']); $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']); {% endhighlight %} #### seedDatabase * `param class-string|class-string[]` $seeders * `return void` Seed a given database connection. #### selectOption * `param ` $select * `param ` $option * `return void` Selects an option in a select tag or in radio button group. {% highlight php %} selectOption('form select[name=account]', 'Premium'); $I->selectOption('form input[name=payment]', 'Monthly'); $I->selectOption('//form/select[@name=account]', 'Monthly'); {% endhighlight %} Provide an array for the second argument to select multiple options: {% highlight php %} selectOption('Which OS do you use?', ['Windows', 'Linux']); {% endhighlight %} Or provide an associative array for the second argument to specifically define which selection method should be used: {% highlight php %} selectOption('Which OS do you use?', ['text' => 'Windows']); // Only search by text 'Windows' $I->selectOption('Which OS do you use?', ['value' => 'windows']); // Only search by value 'windows' {% endhighlight %} #### sendAjaxGetRequest * `param string` $uri * `param array` $params * `return void` Sends an ajax GET request with the passed parameters. See `sendAjaxPostRequest()` #### sendAjaxPostRequest * `param string` $uri * `param array` $params * `return void` Sends an ajax POST request with the passed parameters. The appropriate HTTP header is added automatically: `X-Requested-With: XMLHttpRequest` Example: {% highlight php %} sendAjaxPostRequest('/add-task', ['task' => 'lorem ipsum']); {% endhighlight %} Some frameworks (e.g. Symfony) create field names in the form of an "array": `` In this case you need to pass the fields like this: {% highlight php %} sendAjaxPostRequest('/add-task', ['form' => [ 'task' => 'lorem ipsum', 'category' => 'miscellaneous', ]]); {% endhighlight %} #### sendAjaxRequest * `param string` $method * `param string` $uri * `param array` $params * `return void` Sends an ajax request, using the passed HTTP method. See `sendAjaxPostRequest()` Example: {% highlight php %} sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']); {% endhighlight %} #### setApplication * `param \Illuminate\Contracts\Foundation\Application` $app * `return void` #### setCookie * `param ` $name * `param ` $val * `param ` $params * `return mixed|void` Sets a cookie with the given name and value. You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument. {% highlight php %} setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3'); {% endhighlight %} #### setMaxRedirects * `param int` $maxRedirects * `return void` Sets the maximum number of redirects that the Client can follow. {% highlight php %} setMaxRedirects(2); {% endhighlight %} #### setServerParameters * `param array` $params * `return void` Sets SERVER parameters valid for all next requests. this will remove old ones. {% highlight php %} $I->setServerParameters([]); {% endhighlight %} #### startFollowingRedirects * `return void` Enables automatic redirects to be followed by the client. {% highlight php %} startFollowingRedirects(); {% endhighlight %} #### stopFollowingRedirects * `return void` Prevents automatic redirects to be followed by the client. {% highlight php %} stopFollowingRedirects(); {% endhighlight %} #### submitForm * `param ` $selector * `param array` $params * `param ?string` $button * `return void` Submits the given form on the page, with the given form values. Pass the form field's values as an array in the second parameter. Although this function can be used as a short-hand version of `fillField()`, `selectOption()`, `click()` etc. it has some important differences: * Only field *names* may be used, not CSS/XPath selectors nor field labels * If a field is sent to this function that does *not* exist on the page, it will silently be added to the HTTP request. This is helpful for testing some types of forms, but be aware that you will *not* get an exception like you would if you called `fillField()` or `selectOption()` with a missing field. Fields that are not provided will be filled by their values from the page, or from any previous calls to `fillField()`, `selectOption()` etc. You don't need to click the 'Submit' button afterwards. This command itself triggers the request to form's action. You can optionally specify which button's value to include in the request with the last parameter (as an alternative to explicitly setting its value in the second parameter), as button values are not otherwise included in the request. Examples: {% highlight php %} submitForm('#login', [ 'login' => 'davert', 'password' => '123456' ]); // or $I->submitForm('#login', [ 'login' => 'davert', 'password' => '123456' ], 'submitButtonName'); {% endhighlight %} For example, given this sample "Sign Up" form: {% highlight html %} Login:
Password:
Do you agree to our terms?
Subscribe to our newsletter?
Select pricing plan: Free Paid {% endhighlight %} You could write the following to submit it: {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ], 'submitButton' ); {% endhighlight %} Note that "2" will be the submitted value for the "plan" field, as it is the selected option. To uncheck the pre-checked checkbox "newsletter", call `$I->uncheckOption(['name' => 'user[newsletter]']);` *before*, then submit the form as shown here (i.e. without the "newsletter" field in the `$params` array). You can also emulate a JavaScript submission by not specifying any buttons in the third parameter to submitForm. {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ] ); {% endhighlight %} This function works well when paired with `seeInFormFields()` for quickly testing CRUD interfaces and form validation logic. {% highlight php %} 'value', 'field2' => 'another value', 'checkbox1' => true, // ... ]; $I->submitForm('#my-form', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed $I->seeInFormFields('#my-form', $form); {% endhighlight %} Parameter values can be set to arrays for multiple input fields of the same name, or multi-select combo boxes. For checkboxes, you can use either the string value or boolean `true`/`false` which will be replaced by the checkbox's value in the DOM. {% highlight php %} submitForm('#my-form', [ 'field1' => 'value', 'checkbox' => [ 'value of first checkbox', 'value of second checkbox', ], 'otherCheckboxes' => [ true, false, false ], 'multiselect' => [ 'first option value', 'second option value' ] ]); {% endhighlight %} Mixing string and boolean values for a checkbox's value is not supported and may produce unexpected results. Field names ending in `[]` must be passed without the trailing square bracket characters, and must contain an array for its value. This allows submitting multiple values with the same name, consider: {% highlight php %} submitForm('#my-form', [ 'field[]' => 'value', 'field[]' => 'another value', // 'field[]' is already a defined key ]); {% endhighlight %} The solution is to pass an array value: {% highlight php %} submitForm('#my-form', [ 'field' => [ 'value', 'another value', ] ]); {% endhighlight %} #### switchToIframe * `param string` $name * `return void` Switch to iframe or frame on the page. Example: {% highlight html %} <iframe name="another_frame" src="http://example.com"> {% endhighlight %} {% highlight php %} switchToIframe("another_frame"); {% endhighlight %} #### uncheckOption * `param ` $option * `return void` Unticks a checkbox. {% highlight php %} uncheckOption('#notify'); {% endhighlight %} #### unsetHttpHeader * `param string` $name the name of the header to unset. * `return void` Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)), so that subsequent requests will not send it anymore. Example: {% highlight php %} haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); // ... $I->unsetHeader('X-Requested-With'); $I->amOnPage('some-other-page.php'); {% endhighlight %}