viraj/cakephp-integrated

Integration testing for CakePHP

3.0.3 2020-11-30 08:40 UTC

Requires

• php: >=7.2.0
• symfony/css-selector: ^4.4
• symfony/dom-crawler: ^4.4
• viraj/cakephp-testdummy: ^2.0

Requires (Dev)

• phpunit/phpunit: ^5.7|^6.0|^7.0|^8.5

Conflicts

• phpunit/phpunit: <5.7

MIT

• Viraj Khatavkar

• testing
• cakephp
• integration
• stubs
• testdummy

README

Better integration testing with CakePHP. An intuitive API for integration testing your CakePHP applications.

Step 1: Installation & Setup

Install this package using Composer:

composer require viraj/cakephp-integrated --dev

You'll also need to set a baseUrl for your application. By default, it is set to "http://localhost", however, you'll likely need to change this. Do so by adding a $baseUrl to your test class:

protected $baseUrl = 'http://your-dev-url';

This package comes installed with the TestDummy package. It is recommended to use factories and the DatabaseMigrations trait instead of fixtures for optimal productivity with this package. You can learn more about that in the official documentation of the TestDummy package.

Step 2: Extend the base class:

After CakePHP 3.4.1:

class DemoTest extends CakeTestCase
{
}

Before CakePHP 3.4.1

class DemoTest extends LegacyTestCase
{
}

Step 3: Write tests ;)

The API for both the classes is going to be the same. We will use the CakeTestCase as an example. Here is an example test to help you understand how this works:

class DemoTest extends CakeTestCase
{
    use DatabaseMigrations;
    
    protected $baseUrl = "http://local.yourapp.dev";

    /** @test */
    public function unauthenticated_user_cannot_see_the_add_posts_page()
    {
        $this->openPage('/posts/add')
             ->canSeePageUrlContains('/users/login');
    }

    /** @test */
    public function authenticated_user_can_add_a_new_post()
    {
        $user = factory('Users')->create();

        $this->actingAs($user)
             ->openPage('/posts/add')
             ->fillInField('title', 'My first post')
             ->fillInField('author', 'Viraj Khatavkar')
             ->fillInField('body', 'My Post body')
             ->check('published')
             ->press('Submit')
             ->canSeePageIs('/posts')
             ->seeText('My first post');
    }
}

API

Here is the API of this package which can be used to write your tests:

$this->fillInField($elementName, $text)

Fill the text in the input field identified with name of element

$this->fillInField('name', 'Viraj Khatavkar');

$this->check($elementName)

Check the checkbox identified with name element

$this->check('agree_to_terms');

$this->uncheck($elementName)

Uncheck the checkbox identified with name of element

$this->uncheck('agree_to_terms');

$this->select($elementName, $option)

Select a radio button or an option from the dropdown field identified with name of element

//Dropdown
$this->select('state', 'Pennsylvania');

//Radio
$this->select('gender', 'M');

$this->press($buttonText)

Press a button with the provided name or text.

//Text of the button
$this->press('Submit');


//Name of the button
$this->press('submit');

$this->canSeePageIs($url)

Assert that the page URI matches the given url.

$this->canSeePageIs('/posts');

$this->canSeePageUrlContains($url)

Assert that the page URI contains the given url.

$this->canSeePageUrlContains('/po');

$this->actingAs($user)

Set the currently logged in user for the application.

$user = factory('Users')->create();

$this->actingAs($user)->openPage('/posts/add');

Looking for a comprehensive guide on implementing TDD?

I'm writing a book on implementing TDD for real-world CakePHP applications! Check it out if you are having a hard time on writing tests in a real world application.