Testing¶
DHIL Symfony applications use PHPUnit Testing Framework to run automated tests on the code components. PHPUnit manual is here. A comprehensive tutorial can be found here.
Note
PHPUnit is enabled after installing Composer and CEWW specific composer dependencies. It should be located at ceww/vendor/bin/phpunit. You can check the installation guide here for more details.
Navigate into the ceww main directory. Check to see if the phpunit is active:
vendor/bin/phpunit --version
In order to run a particular test class, type:
vendor/bin/phpunit <path_of_the_file>
Alternatively, you can run the entire test suite by omitting the file path:
vendor/bin/phpunit
Note
Running the entire test suite can take a lot of time. You can fasten this process by replacing the “phpunit.xml.dist” file with the “phpunit.xml” (simply remove the extension). You can then tweak the configuration file to suit your needs.
It would be helpful to get some sort of report on our tests. PHPUnit comes with a code coverage analysis tool. This tool needs the Xdebug extension for PHP to be enabled.
If you are on Windows, get the extension from here. Place the file into your php/ext/ folder. (if you use a server suite like XAMPP, php folder should be in it). If you are on MAC OS, type the following in terminal:
brew install homebrew/php/<php-version>-xdebug
To enable the extension, add the following line to the php.ini file:
zend_extension=”file_path”
More information can be found in Xdebug Installation Guide.
Time to get our coverage report. This will likely take some time:
vendor/bin/phpunit --coverage-html coverage
More information on coverage reports can be found here.
Note
since this step generates a folder named “coverage” in the main application directory, we need to add its path into our “gitignore” file (located in the main app directory) to prevent it from being pushed to the main repository.
