ZendFramework i PHPUnit

Aktualna wersja Zend Framework wspomaga tworzenie testów jednostkowych. Wykorzystuje do tego znaną paczkę PHPUnit dostępną w repozytorium PEAR.

Obecnie po utworzeniu naszego projektu opartego o ZF (zf create project nazwa_projektu) i po dodaniu automagicznie nowych kontrolerów (zf create controller nazwa_kontrolera) tworzone są automatycznie puste klasy testujące w katalogu /tests.

Dlaczego warto korzystać z testów jednostkowych?

UnitTesty automatyzują nam testowanie aplikacji. Dzięki nim jesteśmy w stanie natychmiast wychwycić błąd z innych części systemu, gdzie takie błędy nie powinny się pojawiać.
Pomagają również kontrolować postęp tworzenia aplikacji, na zasadzie najpierw unitTest, poźniej implementacja, gdzie takie podejście jest używane w eXtreme Programming. Korzystając z unitTestów możemy stworzyć odpowiednie narzędzia monitorujące dany system na podstawie wyników z testów jednostkowych.

Przygotowanie środowiska

Aby móc skorzystać z przyjemności tworzenia testów jednostkowych najpierw musimy zainstalować paczkę PHPUnit.

1. Najpierw zaktualizujmy na wszelki wypadek dotychczasowe pakiety PEAR’a:
   
   Shell

   $ pear upgrade-all

   1	$ pear upgrade-all

2. Dodajemy nowy kanał dla PEAR:
   
   Shell

   $ pear channel-discover pear.phpunit.de

   1	$ pear channel-discover pear.phpunit.de

3. I instalujemy PHPUnit z zależnościami
   
   Shell

   $ pear install --alldeps phpunit/PHPUnit

   1	$ pear install --alldeps phpunit/PHPUnit

Jeśli wszystko poszło bez problemów możemy do korzystania z PHPUnit zwiększyć dostępną pamięć dla PHP w pliku ini zmieniając wartość memory_limit na przynajmniej 64M.

Teraz już możemy przejść do samych testów. Do tego celu posłużymy się przykładowym kontrolerem.

1. Tworzymy kontroler Kontakt:
   
   Shell

   zf create controller kontakt

   1	zf create controller kontakt

2. Nasza hierarchia katalogów w skrócie wygląda teraz tak:
   
   `-- application |-- configs `-- controllers |-- KontaktController.php |-- library |-- public `--tests `-- application `-- controllers |-- KontaktControllerTest.php |-- bootstrap.php |-- library |-- phpunit.xml

   1 2 3 4 5 6 7 8 9 10 11 12 13

   `-- application |-- configs `-- controllers   |-- KontaktController.php |-- library |-- public `--tests `-- application   `-- controllers    |-- KontaktControllerTest.php   |-- bootstrap.php |-- library |-- phpunit.xml

3. Powinniśmy skonfigurować bootstrap do celów testowych, edytujemy /tests/application/bootstrap.php:
   
   PHP

   set_include_path(implode(PATH_SEPARATOR, array( realpath(dirname(__FILE__) . '/../../library'), get_include_path(), ))); defined('APPLICATION_PATH') || define('APPLICATION_PATH', realpath(dirname(__FILE__) . '/../../application')); defined('APPLICATION_ENV') || define('APPLICATION_ENV', 'testing'); defined('APPLICATION_LOAD_TESTDATA') || define('APPLICATION_LOAD_TESTDATA', true); require_once 'Zend/Loader/Autoloader.php'; $autoloader = Zend_Loader_Autoloader::getInstance(); spl_autoload_unregister(array($autoloader, 'autoload')); Zend_Loader_Autoloader::resetInstance(); $autoloader = Zend_Loader_Autoloader::getInstance(); $autoloader->registerNamespace('PHPUnit_');

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

   set_include_path(implode(PATH_SEPARATOR, array( realpath(dirname(__FILE__) . '/../../library'), get_include_path(), )));   defined('APPLICATION_PATH') || define('APPLICATION_PATH', realpath(dirname(__FILE__) . '/../../application')); defined('APPLICATION_ENV') || define('APPLICATION_ENV', 'testing'); defined('APPLICATION_LOAD_TESTDATA') || define('APPLICATION_LOAD_TESTDATA', true);   require_once 'Zend/Loader/Autoloader.php'; $autoloader = Zend_Loader_Autoloader::getInstance(); spl_autoload_unregister(array($autoloader, 'autoload'));   Zend_Loader_Autoloader::resetInstance(); $autoloader = Zend_Loader_Autoloader::getInstance(); $autoloader->registerNamespace('PHPUnit_');

4. Pozostało nam już tylko zedytować klasę KontaktControllerTest, aby korzystało z naszego bootstrapa, i dopisania prostego testu. Po zmianach powinna klasa wyglądać tak:
   
   PHP

   class KontaktControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { public function setUp() { $application = new Zend_Application(APPLICATION_ENV, APPLICATION_PATH . '/configs/application.ini'); $this->bootstrap = array($application->getBootstrap(), 'bootstrap'); return parent::setUp(); } public function tearDown() { /* Tear Down Routine */ } public function testIndexAction() { $this->dispatch('/kontakt'); $this->assertController('kontakt'); $this->assertAction('index'); } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

   class KontaktControllerTest extends Zend_Test_PHPUnit_ControllerTestCase {   public function setUp() { $application = new Zend_Application(APPLICATION_ENV, APPLICATION_PATH . '/configs/application.ini'); $this->bootstrap = array($application->getBootstrap(), 'bootstrap'); return parent::setUp(); }   public function tearDown() { /* Tear Down Routine */ }   public function testIndexAction() { $this->dispatch('/kontakt'); $this->assertController('kontakt'); $this->assertAction('index'); }   }

5. Aby nie musieć każdej klasy wywoływać osobno, możemy skonfigurować odpowiednie phpUnit. Przykładowy plik konfiguracyjny /tests/phpunit.xml może wyglądać tak:
   
   XHTML

   <phpunit bootstrap="./application/bootstrap.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false"> <testsuite name="Test_ZF"> <directory>./application/</directory> </testsuite> </phpunit>

   1 2 3 4 5 6 7 8 9 10 11

   <phpunit bootstrap="./application/bootstrap.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false">   <testsuite name="Test_ZF"> <directory>./application/</directory> </testsuite> </phpunit>

Pierwszy test

Powstała klasę testującą możemy już uruchomić. Umieściłem przykładowy test (testIndexAction) sprawdzający czy znajdujemy się we właściwej lokalizacji. W tym celu udajemy się do /tests i wydajemy polecenie:

Dzięki skorzystaniu z pliku konfiguracyjnego xml, nie będziemy musieli dokonywać żadnych modyfikacji podczas dodawania kolejnych klas testujących. Docelowo, można przygotować stronę, która przedstawi nam graficznie jakie klasy działają już prawidłowo.

Możliwości porównań pakietu Zend_Test / PHPUnit możemy znaleźć w dokumentacji.
Mam nadzieję, ze to małe wprowadzenie poszerzy grono programistów korzystających z Zend Framework do używania testów jednostkowych, tak bardzo przydatnych przy większych aplikacjach.