nimut/testing-framework

TYPO3 testing framework that provides base classes and configuration for PHPUnit tests

Testing Framework for TYPO3 CMS Extensions

There are no plans to support nimut/testing-framework for versions above TYPO3 v11. You are advised to switch to the typo3/testing-framework for TYPO3 v12 and above. The typo3/testing-framework has improved support for testing more than one version of the core. Further information and an introduction can be found in the official TYPO3 documentation:, _(*1)

• Testing Extensions

, _(*3)

The aim of the testing framework is to provide a good way to write and run unit and functional tests for multiple versions of the TYPO3 CMS. Currently TYPO3 CMS 9.5 up to 11.5 are tested and supported., _(*4)

Installation

Use Composer to install the testing framework., _(*5)

composer require --dev nimut/testing-framework

Composer will add the package as a dev requirement to your composer.json and install PHPUnit and vfsStream as its dependencies., _(*6)

Usage

Unit Tests

Inherit your test class from \Nimut\TestingFramework\TestCase\UnitTestCase., _(*7)

To execute the unit tests of your extension run, _(*8)

vendor/bin/phpunit -c vendor/nimut/testing-framework/res/Configuration/UnitTests.xml \
    typo3conf/ext/example_extension/Tests/Unit

ViewHelper

For an easy way to test your Fluid ViewHelper you can inherit the test class from \Nimut\TestingFramework\TestCase\ViewHelperBaseTestcase., _(*9)

You should setup your subject class in your setUp() method of the test class:, _(*10)

/**
 * @var \PHPUnit_Framework_MockObject_MockObject
 */
protected $viewHelper;

protected function setUp()
{
    parent::setUp();
    $this->viewHelper = $this->getMockBuilder(RenderChildrenViewHelper::class)->setMethods(['renderChildren'])->getMock();
    $this->injectDependenciesIntoViewHelper($this->viewHelper);
    $this->viewHelper->initializeArguments();
}

Functional Tests

Inherit your test class from \Nimut\TestingFramework\TestCase\FunctionalTestCase., _(*11)

To execute the functional tests of your extension run, _(*12)

vendor/bin/phpunit -c vendor/nimut/testing-framework/res/Configuration/FunctionalTests.xml \
    typo3conf/ext/example_extension/Tests/Functional

Extension preparation

You can add a script section to your composer.json file to symlink your extension to the proper root-dir/web-dir., _(*13)

"scripts": {
    "post-autoload-dump": [
        "@prepare-extension-test-structure"
    ],
    "prepare-extension-test-structure": [
        "Nimut\\TestingFramework\\Composer\\ExtensionTestEnvironment::prepare"
    ]
}

Database abstraction

To be able to test against TYPO3 CMS 8 and later, nimut/testing-framework provides an own database abstraction layer., _(*14)

In your FunctionalTestCase call $this->getDatabaseConnection() to get an instance of \Nimut\TestingFramework\Database\DatabaseInterface., _(*15)

Following database functions are built in the nimut/testing-framework database interface:, _(*16)

• select
• selectSingleRow
• selectCount
• insertArray
• lastInsertId
• updateArray
• delete
• getDatabaseInstance

If you need own database requests you can get the proper database instance of the current TYPO3 version by using $this->getDatabaseConnection()->getDatabaseInstance(). You have to check weather this instance is a \TYPO3\CMS\Core\Database\Query\QueryBuilder (TYPO3 CMS 8 and above) or an instance of \TYPO3\CMS\Core\Database\DatabaseConnection (TYPO3 CMS 7)., _(*17)

Database fixtures

The nimut/testing-framework ships database fixtures for several TYPO3 CMS core database tables:, _(*18)

• pages
• pages_language_overlay
• sys_file_storage
• sys_language
• tt_content

To use the database fixtures you can trigger an import in your test file, _(*19)

$this->importDataSet('ntf://Database/pages.xml');

Frontend requests

The nimut/testing-framework ships an own TypoScript file for supporting frontend requests out of the box., _(*20)

// First import some page records
$this->importDataSet('ntf://Database/pages.xml');

// Import tt_content record that should be shown on your home page
$this->importDataSet('ntf://Database/tt_content.xml');

// Setup the page with uid 1 and include the TypoScript as sys_template record
$this->setUpFrontendRootPage(1, array('ntf://TypoScript/JsonRenderer.ts'));

// Fetch the frontend response
$response = $this->getFrontendResponse(1);

// Assert no error has occured
$this->assertSame('success', $response->getStatus());

// Get the first section from the response
$sections = $response->getResponseSections();
$defaultSection = array_shift($sections);

// Get the section structure
$structure = $defaultSection->getStructure();

// Make assertions for the structure
$this->assertTrue(is_array($structure['pages:1']['__contents']['tt_content:1']));

Structure

The returned structure of a frontend request is an array with some information about your page and its children., _(*21)

[
    // Page for your request
    'pages:1' => [
        'uid' => '1',
        'pid' => '0',
        'sorting' => '0',
        'title' => 'Root',
        // Array with subpages
        '__pages' => [
            'pages:2' => [
                'uid' => '2',
                'pid' => '1',
                'sorting' => '0',
                'title' => 'Dummy 1-2',
            ],
            'pages:5' => [
                'uid' => '5',
                'pid' => '1',
                'sorting' => '0',
                'title' => 'Dummy 1-5',
            ],
        ],
        // Array with content elements
        '__contents' => [
              'tt_content:1' => [
                  'uid' => '1',
                  'pid' => '1',
                  'sorting' => '0',
                  'header' => 'Test content',
                  'sys_language_uid' => '0',
                  'categories' => '0',
              ],
        ],
    ],
]

If you need additional information about a record, you can provide additional TypoScript with the needed configuration., _(*22)

// Setup the page with uid 1 and include ntf and own TypoScript
$this->setUpFrontendRootPage(
    1,
    array(
        'ntf://TypoScript/JsonRenderer.ts',
        'EXT:example_extension/Tests/Functional/Fixtures/TypoScript/Config.ts'
    )
);

Content of the TypoScript file Config.ts, _(*23)

config.watcher.tableFields.tt_content = uid,_ORIG_uid,_LOCALIZED_UID,pid,sorting,sys_language_uid,header,categories,CType,subheader,bodytext

Additional information

Following links provide documentation and additional information about TYPO3 CMS extension testing, _(*24)

• Unit tests for dummies
• How to write functional test
• Functional tests with TYPO3
• Functional tests for dummies

Last but not least you may ask for further support in the Slack channel "#cig-testing"., _(*25)

, _(*26)