Using PHPUnit to test-develop Joomla extensions in PhpStorm

Details: Category: Joomla; Published on Friday, 17 August 2012 11:55; Written by Administrator; Hits: 1253

Since I did not find any clear how to on the internet how to run test cases for 3rd party extensions that use Joomla CMS, here is my version of it.

Prerequisites

Having PHPUnit properly install, if you use XAMPP you may want to read this post.

How to use PHPUnit in Joomla

At the root of your Joomla installation directory, make a checkout of https://github.com/joomla/joomla-cms/tree/master/tests/unit

You’ll need at least the following file

${joomla_root}\tests\unit\bootstrap.php
${joomla_root}\tests\unit\config.php
${joomla_root}\tests\unit\JoomlaDatabaseTestCase.php
${joomla_root}\tests\unit\JoomlaTestCase.php
${joomla_root}\tests\unit\phpunit.xml
${joomla_root}\tests\unit\readme.txt

config.php is a custom or a copy of your configuration.php

For your convenience, I provide a zip file (joomla_phpunit_testing.zip), unpack in your Joomla root and you’re done.

Note when using PHPUnit 3.6 , Joomla should not need to include/require anything PHPUnit related since (at least) PHPUnit 3.6. This create errors otherwise.

In PHPStorm

Set Up PHPUnit

Go to Settings, using CTRL+ALT+S, under PHPUnit, select the option “Use Bootstrap file” and use as value ${joomla_root}\tests\unit\bootstrap.php

Set Up PHPUnit Skeleton Generator

Go to Settings, using CTRL+ALT+S, under “Skeleton Generator”

Enter for “Path to phpunit-skelgen” the value is ${xampp_root}\php, for example C:\xampp\php
Enter for “use bootstrap file” the value ${joomla_root}\tests\unit\phpunit.xml

Your first Joomla test case

Create a test case from any of your Joomla classes, by hitting CTRL+SHIFT+T, this will let you select the method you want to test and generate a runnable albeit incomplete test classes.

It is only the beginning of testing your Joomla extensions, there is a lot now to learn