Skip to content

Add docs for testing flash messages. #4971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 21, 2017
Merged

Add docs for testing flash messages. #4971

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
717515f
Add docs for testing flash messages.
markstory May 16, 2017
7552f6e
AES, not aes
ravage84 May 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 86 additions & 70 deletions en/development/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,92 @@ events/routes are connected for each test case.
.. versionadded:: 3.3.0
PSR-7 Middleware and the ``useHttpServer()`` method were added in 3.3.0.

Testing with Encrypted Cookies
------------------------------

If you use the :php:class:`Cake\\Controller\\Component\\CookieComponent` in your
controllers, your cookies are likely encrypted. As of 3.1.7, CakePHP provides
helper methods for interacting with encrypted cookies in your test cases::

// Set a cookie using AES and the default key.
$this->cookieEncrypted('my_cookie', 'Some secret values');

// Assume this action modifies the cookie.
$this->get('/bookmarks/index');

$this->assertCookieEncrypted('An updated value', 'my_cookie');

.. versionadded: 3.1.7
``assertCookieEncrypted`` and ``cookieEncrypted`` were added in 3.1.7.

Testing Flash Messages
----------------------

If you want to assert the presence of flash messages in the session and not the
rendered HTML, you can use ``enableRetainFlashMessages()`` in your tests to
retain flash messages in the session so you can write assertions::

$this->enableRetainFlashMessages();
$this->get('/bookmarks/delete/9999');

$this->assertSession('That bookmark does not exist', 'Flash.flash.0.message');

.. versionadded:: 3.4.7
``enableRetainFlashMessages()`` was added in 3.4.7

Testing a JSON Responding Controller
------------------------------------

JSON is a friendly and common format to use when building a web service.
Testing the endpoints of your web service is very simple with CakePHP. Let us
begin with a simple example controller that responds in JSON::

class MarkersController extends AppController
{
public function initialize()
{
parent::initialize();
$this->loadComponent('RequestHandler');
}

public function view($id)
{
$marker = $this->Markers->get($id);
$this->set([
'_serialize' => ['marker'],
'marker' => $marker,
]);
}
}

Now we create the file **tests/TestCase/Controller/MarkersControllerTest.php**
and make sure our web service is returning the proper response::

class MarkersControllerTest extends IntegrationTestCase
{

public function testGet()
{
$this->configRequest([
'headers' => ['Accept' => 'application/json']
Copy link
Member

@ravage84 ravage84 May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this could be quite common, I presume, couldn't we have a setAcceptsJson() or something like that?

]);
$result = $this->get('/markers/view/1.json');

// Check that the response was a 200
$this->assertResponseOk();

$expected = [
['id' => 1, 'lng' => 66, 'lat' => 45],
];
$expected = json_encode($expected, JSON_PRETTY_PRINT);
Copy link
Member

@ravage84 ravage84 May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't there an assertion taht does JSON encoding already?

$this->assertEquals($expected, $this->_response->body());
}
}

We use the ``JSON_PRETTY_PRINT`` option as CakePHP's built in JsonView will use
that option when ``debug`` is enabled.


Assertion methods
-----------------

Expand Down Expand Up @@ -1201,76 +1287,6 @@ comparison files as they are referenced:
#
# modified: tests/comparisons/example.php

Testing with Encrypted Cookies
------------------------------

If you use the :php:class:`Cake\\Controller\\Component\\CookieComponent` in your
controllers, your cookies are likely encrypted. As of 3.1.7, CakePHP provides
helper methods for interacting with encrypted cookies in your test cases::

// Set a cookie using aes and the default key.
$this->cookieEncrypted('my_cookie', 'Some secret values');

// Assume this action modifies the cookie.
$this->get('/bookmarks/index');

$this->assertCookieEncrypted('An updated value', 'my_cookie');

.. versionadded: 3.1.7
``assertCookieEncrypted`` and ``cookieEncrypted`` were added in 3.1.7.

Testing a JSON Responding Controller
------------------------------------

JSON is a friendly and common format to use when building a web service.
Testing the endpoints of your web service is very simple with CakePHP. Let us
begin with a simple example controller that responds in JSON::

class MarkersController extends AppController
{
public function initialize()
{
parent::initialize();
$this->loadComponent('RequestHandler');
}

public function view($id)
{
$marker = $this->Markers->get($id);
$this->set([
'_serialize' => ['marker'],
'marker' => $marker,
]);
}
}

Now we create the file **tests/TestCase/Controller/MarkersControllerTest.php**
and make sure our web service is returning the proper response::

class MarkersControllerTest extends IntegrationTestCase
{

public function testGet()
{
$this->configRequest([
'headers' => ['Accept' => 'application/json']
]);
$result = $this->get('/markers/view/1.json');

// Check that the response was a 200
$this->assertResponseOk();

$expected = [
['id' => 1, 'lng' => 66, 'lat' => 45],
];
$expected = json_encode($expected, JSON_PRETTY_PRINT);
$this->assertEquals($expected, $this->_response->body());
}
}

We use the ``JSON_PRETTY_PRINT`` option as CakePHP's built in JsonView will use
that option when ``debug`` is enabled.

Testing Views
=============

Expand Down