friendsofcake/cakephp-test-utilities

Package with support traits to ease unit testing.

Test utilities

This package contains support traits to ease unit testing., _(*1)

Installing via composer

You should install this package into your project using composer. To do so you can run the following command:, _(*2)

composer require friendsofcake/cakephp-test-utilities

Traits

At this point there are two traits:, _(*3)

1. AccessibilityHelperTrait : Gain access protected properties and methods.
2. CompareTrait : Assert methods, comparing to files for: HTML, JSON, XML

AccessibilityHelperTrait

This trait gains you access to protected properties and methods. You don't need of a new class with pass-through methods. It uses reflection to achieve this., _(*4)

Setup

Add the trait at the top of your test case:, _(*5)

``` php use \FriendsOfCake\TestUtilities\AccessibilityHelperTrait;, <sub>(*6)</sub>

Now that you have the trait you need to set which object you want to access.
You can do this globally for the entire test in `setUp()` or in your test
methods:

``` php
$object = new ObjectIAmGoingToTest();
$this->setReflectionClassInstance($object);
$this->defaultReflectionTarget = $object; // (optional)

Protected properties

You can get and set the protected properties:, <sub>(*7)</sub>

``` php $data = 'FriendsOfCake'; $this->setProtectedProperty('_myProperty', $data, $object);, <sub>(*8)</sub>

$expected = $data; $actual = $this->getProtectedProperty('_myProperty', $object); $this->assertEquals($expected, $actual);, <sub>(*9)</sub>

#### Protected methods

You can directly call protected methods:

``` php
$parameters = [$argument1, $argument2];

$expected = $expectedReturnValue;
$actual = $this->callProtectedMethod('_myMethod', $parameters, $object);
$this->assertEquals($expected, $actual);

CompareTrait

This trait helps with comparing test results as string, <sub>(*10)</sub>

Setup

Add the trait at the top of your test case and define the _compareBasePath property so the trait knows where to look for comparison files:, <sub>(*11)</sub>

``` php ... use \FriendsOfCake\TestUtilities\CompareTrait;, <sub>(*12)</sub>

class MyTest extends TestCase { use CompareTrait;, <sub>(*13)</sub>

public function setUp(): void
{
    parent::setUp();

    $this->_compareBasePath = 'comparisons/MyTest/';
}

}, <sub>(*14)</sub>

#### Usage

Each of the methods acts similar to the core `assertSameAsFile` method:

```php
public function testExample()
{
    $html = '

Some html, (*15)


';
    $xml = '<thing>...</thing>';
    $json = ['actually' => 'this is an array'];

    $this->assertHtmlSameAsFile('some.html', $html);
    $this->assertXmlSameAsFile('some.xml', $xml);
    $this->assertJsonSameAsFile('some.json', $json);
}

See Cake's docs for more details on usage of assertSameAsFile on which these methods are based., <sub>(*16)</sub>