Zend Framework MVC Applikationen testen

Transkript

1 Zend Framework MVC Applikationen testen Jan Burkl, System Engineer, Zend Technologies

2 Wer bin ich? Jan Burkl PHP Entwickler seit 2001 Projektarbeit Bei Zend seit 2006 System Engineer Zend Certified Engineer PHP 5 Zend Framework

3 Was werden wir besprechen Unit Testing Basics Basics: funktionales Testen in ZF Verschiede Advanced ZF Testing Themen

4 Warum testen?

5 Vereinfacht Wartung Das Testen definiert Erwartungen Das Testen beschreibt das Verhalten durch die Applikation Das Testen teilt uns mit, wenn Neuerungen den Code an anderer Stelle auseinander brechen lassen

6 Code Qualität bestimmen Code Coverage durch Unit Tests Test Methoden dokumentieren das Verhalten, welches durch den Code definiert wird

7 Psychologischer Vorteil Warmes, angenehmes Gefühl, wenn es grün leuchtet 7

8 Testen ist nicht Reloading 8

9 Testen ist nicht var_dump() 9

10 Testen ist reproduzierbar 10

11 Testen ist automatisierbar 11

12 PHP Testing Frameworks PHPT Genutzt von PHP, und einigen PEAR und unabhängigen Librarys SimpleTest JUnit-Style Testing Framework PHPUnit JUnit-Style Testing Framework De facto Industrie-Standard

13 Testing Basics 14

14 Unit Tests schreiben Test Klasse erstellen Eine oder mehr Methoden erstellen, die das Verhalten beschreiben Das Verhalten in natürlicher Sprache beschreiben Code schreiben, der das Verhalten erstellt Code schreiben, der die API nutzt Behauptungen aufstellen, die auf die Erwartungen hindeuten

15 Test Klasse erstellen Normalerweise wird die Klasse nach dem Unit Under Test benannt class EntryTest extends PHPUnit_Framework_TestCase { }

16 Methode zum Beschreiben des Verhaltens Präfix mit test class EntryTest extends PHPUnit_Framework_TestCase { public function testmaysettimestampwithstring() { } }

17 Das Verhalten selbst coden class EntryTest extends PHPUnit_Framework_TestCase { public function testmaysettimestampwithstring() { $string = 'Fri, 7 May :26: '; $ts = strtotime($string); $this->entry->settimestamp($string); $setvalue = $this->entry->gettimestamp(); } }

18 Annahmen von Erwartungen class EntryTest extends PHPUnit_Framework_TestCase { public function testmaysettimestampwithstring() { $string = 'Fri, 7 May :26: '; $ts = strtotime($string); $this->entry->settimestamp($string); $setvalue = $this->entry->gettimestamp(); $this->assertsame($ts, $setvalue); } } Data Provider

19 Run the Tests Fehler? Überprüfen der Tests und Assertions auf potentielle Tippfehler oder falscher Benutzung Den Unit Under Test nach Fehlern überprüfen Korrekturen machen und Tests neu starten Erfolg? Weiter zum nächsten Verhalten oder Feature!

20 Ein wenig Testing Terminologie 21

21 Test Scaffolding Sicherstellen, dass das Environment frei von Annahmen/Voraussetzungen ist Abhängigkeiten vor dem Testen initialisieren Normalerweise in der setup() Methode

22 Test Doubles Stubs Ein Objekt mit einem anderen ersetzen, so dass das System unterhalb des Tests weitermachen kann. Behaviour & Status Verifizierung Mock Objects Ein Objekt mit einem anderen ersetzen und dafür Erwartungen definieren. Behaviour Verifizierung html

23 Zusätzliche Test Typen Conditional Testing Nur testen, wenn bestimmte Umgebungsparameter zutreffen Funktions- und Integrations-Tests Testen, dass das System als Ganzes sich wie gewünscht verhält; Testen, dass die Units wie erwartet interagieren

24 Quasi-Functional Testing im Zend Framework 25

25 Überblick Das PHPUnit Environment aufsetzen Einen Test-Case basierend auf einem ControllerTestCase erstellen Bootstrap der Applikation Erstellen und Dispatchen eines Requests Assertions auf der Response durchführen

26 Das PHPUnit Environment Verzeichnisstruktur tests -- application `-- controllers -- Bootstrap.php -- library `-- Custom `-- phpunit.xml 4 directories, 2 files

27 Das PHPUnit Environment phpunit.xml <phpunit bootstrap="./bootstrap.php"> <testsuite name="test Suite"> <directory>./</directory> </testsuite> <filter> <whitelist> <directory suffix=".php">../library/</directory> <directory suffix=".php">../application/</directory> <exclude> <directory suffix=".phtml">../application/</directory> </exclude> </whitelist> </filter> </phpunit>

28 Das PHPUnit Environment Bootstrap.php $rootpath = realpath(dirname( FILE ). '/../..'); if (!defined('application_path')) { define('application_path', $rootpath. '/application'); } if (!defined('application_env')) { define('application_env', 'testing'); } set_include_path(implode(path_separator, array( '.', $rootpath. '/library', get_include_path(), ))); require_once 'Zend/Loader/Autoloader.php'; $loader = Zend_Loader_Autoloader::getInstance(); $loader->registernamespace('custom_');

29 Test Case Klasse erstellen Extend Zend_Test_PHPUnit_ControllerTestCase class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { }

30 Bootstrap Zend_Application Instanz erstellen und in setup() referenzieren class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { public function setup() { $this->bootstrap = new Zend_Application( APPLICATION_ENV, APPLICATION_PATH. '/configs/application.ini' ); parent::setup(); } }

31 Erstellen und Dispatchen eines Requests Einfache Methode: Dispatchen einer URL class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { //... public function teststaticpagehasgoodstructure() { $this->dispatch('/example/page'); //... } }

32 Erstellen und Dispatchen eines Requests Fortgeschritten: Vor dem Dispatchen das Request Objekt anpassen class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { //... public function testxhrrequestreturnsjson() { $this->getrequest() ->setheader('x-requested-with', 'XMLHttpRequest') ->setquery('format', 'json'); $this->dispatch('/example/xhr-endpoint'); //... } }

33 Assertions erstellen Typische Assertions für: Struktur des Response Markup Entweder CSS Selektoren oder XPath Assertions benutzen. HTTP Response Headers und Status Code Request und/oder Response Objekt Teile

34 CSS Selektor Assertions assertquery($path, $message = '') assertquerycontentcontains( $path, $match, $message = '') assertquerycontentregex( $path, $pattern, $message = '') assertquerycount($path, $count, $message = '') assertquerycountmin($path, $count, $message = '') assertquerycountmax($path, $count, $message = '') Jede Methode hat auch eine Not Variante

35 XPath Selektor Assertions assertxpath($path, $message = '') assertxpathcontentcontains( $path, $match, $message = '') assertxpathcontentregex( $path, $pattern, $message = '') assertxpathcount($path, $count, $message = '') assertxpathcountmin($path, $count, $message = '') assertxpathcountmax($path, $count, $message = '') Jede Methode hat auch eine Not Variante

36 Redirect Assertions assertredirect($message = '') assertredirectto($url, $message = '') assertredirectregex($pattern, $message = '') Jede Methode hat auch eine Not Variante

37 Response Assertions assertresponsecode($code, $message = '') assertheader($header, $message = '') assertheadercontains($header, $match, $message = '') assertheaderregex($header, $pattern, $message = '') Jede Methode hat auch eine Not Variante

38 Request Assertions assertmodule($module, $message = '') assertcontroller($controller, $message = '') assertaction($action, $message = '') assertroute($route, $message = '') Jede Methode hat auch eine Not Variante

39 Assertion Beispiele public function testsomestaticpagehasgoodstructure() { $this->dispatch('/example/page'); $this->assertresponsecode(200); $this->assertquery('div#content p'); $this->assertquerycount('div#sidebar ul li', 3); }

40 Assertion Beispiele public function testxhrrequestreturnsjson() { //... $this->assertnotredirect(); $this->assertheadercontains( 'Content-Type', 'application/json'); }

41 Advanced Topics oder: Real World Use Cases 42

42 Testing Models und Resources Das Problem: Diese Klassen können mit dem Standard- Autoloader nicht geladen werden Die Lösung: Zend_Application benutzen, um während der setup() Phase die modules Ressource zu bootstrappen

43 Testing Models und Resources class Blog_Model_EntryTest extends PHPUnit_Framework_TestCase { public function setup() { $this->bootstrap = new Zend_Application( APPLICATION_ENV, APPLICATION_PATH. '/configs/application.ini' ); $this->bootstrap->bootstrap('modules'); } $this->model = new Blog_Model_Entry(); }

44 Testing Actions mit Authentifizierung Das Problem: Einige Actions benötigen einen authentifizierten User wie kann man das emulieren? Die Lösung: Manuell gegen Zend_Auth authentifizieren bevor der Dispatcher aufgerufen wird

45 Test User authentifizieren class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { //... public function loginuser($user) { $params = array('user' => $user); $adapter = new Custom_Auth_TestAdapter( $params); $auth = Zend_Auth::getInstance(); $auth->authenticate($adapter); $this->asserttrue($auth->hasidentity()); } }

46 Authentifizierung und Dispatchen class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { //... public function testadminusercanaccessadmin() { $this->loginuser('admin'); $this->dispatch('/example/admin'); $this->assertquery('div#content.admin'); }

47 Von Actions abhängige Seiten testen Das Problem: Einige Actions hängen von anderen ab, z.b. das Erstellen einer Seite mit Content Highlighting, das auf einem Suchstring basiert Die Lösung: Zweimal dispatchen, den Request und die Response zwischen den Aufrufen resetten

48 Von Actions abhängige Seiten testen class ExampleControllerTest extends Zend_Test_PHPUnit_ControllerTestCase { //... public function testhighlightedtextaftersearch() { $this->getrequest()->setquery( 'search', 'foobar'); $this->dispatch('/search'); $this->resetrequest(); $this->resetresponse(); } $this->dispatch('/example/page'); $this->assertquerycontains( 'span.highlight', 'foobar');

49 Schlussfolgerung 50

50 Immer Testen! Unit Tests der Models, Service Layers, etc. Funktions- und Akzeptanztests der Workflows, Seitenstruktur, etc.

51 Zend Framework Training & Certification Zend Framework: Fundamentals Dieser Kurs vermittelt Wissen über ZF mit der Einführung des MVC-Entwurfsmusters (Model- View-Controller), um sicherzustellen, dass Sie die Best Practices bei der PHP-Entwicklung lernen. Nächste Kurse: September (englisch) November (deutsch)

52 Zend Framework Training & Certification Zend Framework: Advanced Der Fortgeschrittenen-Kurs soll Zend Framework Entwicklern näherbringen, wie Best Practices beim Aufbau und der Konfiguration von Anwendungen für Skalierbarkeit, Interaktivität und hoher Performance angewendet werden. Nächster Kurs September (englisch)

53 Zend Framework Training & Certification Test Prep: Zend Framework Certification Der ZF Zertifizierungskurs bereitet erfahrene ZF Entwickler auf die Herausforderung der Zertifizierungsprüfung vor. Bei bestandener Prüfung erhält der Entwickler den Status des Zend Certified Engineer in Zend Framework(ZCE-ZF). Nächste Kurse September (deutsch) 13. September 1. Oktober (englisch) Freier Study Guide

54 ZendCon 2010! 1. bis 4. November

55 Danke schön! 56