Unit Testing of TYPO3 Extensions

A Minimal Unit Test

A TYPO3 unit test extends extends \TYPO3\CMS\Core\Tests\UnitTestCase.

<?php
namespace ElmarHinz\MyKey\Tests\Unit;

class MyTestCase extends \TYPO3\CMS\Core\Tests\UnitTestCase
{
    /**
     * @test
     */
    public function assert_true()
    {
        $this->assertTrue(TRUE);
    }
}

?>

The unit tests inside an extension are stored in the directory Tests/Unit or a subdirectory of it, matching the direcotory hierarchy within Classes like Tests/Unit/Domain/Model, Test/Unit/Controller.

Running Unit Tests

# Running all unit tests of the core from the web root (`app/web/`)
../vendor/bin/phpunit -c typo3/sysext/core/Build/UnitTests.xml

# Running all unit tests inside an extension
../vendor/bin/phpunit -c typo3/sysext/core/Build/UnitTests.xml typo3conf/ext/ehfaq/Tests/Unit/

# Running one test file inside an extension
../vendor/bin/phpunit -c typo3/sysext/core/Build/UnitTests.xml typo3conf/ext/ehfaq/Tests/Unit/Controller/FAQControllerTest.php

The Class Hierarchy

\PHPUnit_Framework_TestCase
      ^
\TYPO3\CMS\Core\Tests\BaseTestCase
      ^
\TYPO3\CMS\Core\Tests\UnitTestCase
      ^
\MyTestCase

BaseTestCase

BaseTestCase provides the following functions.

getAccessibleMock:  Creates a mock object which allows for calling protected methods and access of protected properties. getAccessibleMockForAbstractClass:  Returns a mock object which allows for calling protected methods and access of protected properties. Concrete methods to mock can be specified with the last parameter. buildAccessibleProxy:  Creates a proxy class of the specified class which allows for calling even protected methods and access of protected properties. (Used by getAccessibleMock and getAccessibleMockForAbstractClass.) callInaccessibleMethod:  Helper function to call protected or private methods. inject:Injects $dependency into property $name of $target. This is a convenience method for setting a protected or private property in a test subject for the purpose of injecting a dependency. getUniqueId:Create and return a unique id optionally prepended by a given string. This function is used because on windows and in cygwin environments uniqid() has a resolution of one second which results in identical ids if simply uniqid(‘Foo’); is called.

UnitTestCase

UnitTestCase provides one function tearDown.

tearDown:Unset all additional properties of test classes to help PHP garbage collection. This reduces memory footprint with lots of tests.

Important

If overwriting tearDown() in test classes, please call parent::tearDown() at the end. Unsetting of own properties is not needed this way.

Tip

Make it a habit, to always call parent::setUp() or parent::tearDown() for all kinds of tests.

The property $testFilesToDelete is of importance.

testFilesToDelete:  Absolute path to files that should be removed after a test. Handled in tearDown. Tests can register here to get any files within typo3temp/ or typo3conf/ext cleaned up again. This is an array.

Important

Register files with $testFilesToDelete that are created for testing purposes only.