Unit Testing TYPO3
<< Back to Document matrix
see also: Category:PHPUnit
- 1 Unit testing TYPO3 since 6.2 and above
- 2 Functional testing
- 3 Unit testing below TYPO3 CMS 6.2
- 4 Additional Resources
Unit testing TYPO3 since 6.2 and above
warning - Message
With TYPO3 CMS version 6.2 the unit test execution and its required setup was streamlined. See Blueprints/StandaloneUnitTests for more details.
composer should be available on the system already, see its documentation for installation details.
Setup and run tests:
git clone git://git.typo3.org/Packages/TYPO3.CMS.git cd TYPO3.CMS composer install ./bin/phpunit -c typo3/sysext/core/Build/UnitTests.xml
Test for cross dependencies in unit tests
Cross dependencies may occur, if you write tests that depend (willingly or not) on the earlier execution of another test (e.g setting locals without reseting them after finished test). To reveal such cases you can use the phpunit-randomizer, that executes all test in a random order.
Install the randomizer using composer.
composer require fiunchinho/phpunit-randomizer --dev
Using the randomizer works in a similar way as the normal phpunit.
./bin/phpunit-randomizer -c typo3/sysext/core/Build/UnitTests.xml --order rand
Mind the parameter "--order rand". After running the command once, you'll be provided with a seed (e.g. 1234) by the randomizer. Adding this seed to the randomizer command reproduces the same order.
./bin/phpunit-randomizer -c typo3/sysext/core/Build/UnitTests.xml --order rand:1234
This way you are be able to reproduce the same order (within the same git commit) over and over again to remove all test failures caused by cross dependencies.
Unit Testing on Windows
For Unit Testing on Windows use the Windows shell (cmd.exe) - do not use the git shell, because it does not have the Environment Variables set. This leads to OPENSSL_CONF not being set which makes the RsaAuth-Tests fail.
Normal windows users are not allowed to create symbolic links, the tests will fail with "symlink(): Cannot create symlink, error code(1314)". You either have to set the according rights (see https://wiki.typo3.org/Flow_Installation_Hints#Symbolic_Links) or start the Windows shell as Administrator (Right-click => Open as administrator). On Windows Home the second option is your only choice because secpol.msc is not available there (polsedit doesn't seem to work).
.\bin\phpunit.bat -c typo3/sysext/core/Build/UnitTests.xml
To run a certain test, just append the test class:
.\bin\phpunit.bat -c typo3/sysext/core/Build/UnitTests.xml typo3/sysext/form/Tests/Unit/Filter/StripNewLinesFilterTest.php
There currently is a bug in xampp with a wrong path to OPENSSL_CONF: https://community.apachefriends.org/f/viewtopic.php?f=16&t=69986
Unit Testing with PhpStorm
Select vendor/autoload.php as custom autloader and typo3/sysext/core/Build/UnitTest.xml as default configuration file. http://confluence.jetbrains.com/display/PhpStorm/PHPUnit+Installation+via+Composer+in+PhpStorm
For information about functional testing see https://wiki.typo3.org/Functional_testing
Unit testing below TYPO3 CMS 6.2
On top of that, some systems require special PHP extensions, like xdebug which is required to generate the code coverage report.
On rpm based systems, like Fedora and RHEL, you need the packages php-process and php-posix in addition to the normal list of PHP extensions.
Integrating phpunit into your IDE
There are several IDE which can run phpunit test. Unfortunately this does not work that easy on TYPO3, because most TYPO3 functions required a fully bootstrapped framework to function. This requires to pull up TYPO3 prior to running any tests. This task is done by the extension phpunit, thus all request must be routed trough the phpunit e.g. via the cli interface.
- your IDE
- If using data providers, any code in the providers should be avoided. Especially time calculations are not a good idea, if tests are grunalar to seconds or minutes. Reason for that is, that all data provider data is calculated at the very befinning of a whole run. So, if you run 4000 tests in 2 minutes, there will be time offsets. See for example issue 40515: Core - Fix scheduler tests for travis [Resolved] on that. Furthermore, if additional initialization is done in setUp(), they won't hit depending calculations in dataProviders. If for example a dataProvider uses strtotime() and setUp() sets a specific timezone, the strtotime() will be executed *before* setUp() is called, and thus not take the different timezone setting of setUp() into account.
Using PHPUnit via CLI and MAMP (or any other php binary that is not located in your default path)
Make aliases for php and phpunit (preferably place it in
~/.profile so that it will be available every time you open a terminal window
alias php="/Applications/MAMP/bin/php/php5.4.19/bin/php" alias phpunit="typo3conf/ext/phpunit/Composer/vendor/bin/phpunit"
Then you can execute core unit or functional test just by doing (you have to be in your TYPO3 installation directory):
phpunit -c typo3/sysext/core/Build/UnitTests.xml phpunit -c typo3/sysext/core/Build/FunctionalTests.xml
The phpunit TYPO3 extension must be located in typo3conf/ext/ for this to work of course.