Kategorien
Computer PHP Tutorials

[:de]Modultests mit PHPUnit[:en]Unittests with PHPUnit

[:de]Eine kleine private Exkursion in die Tiefen einer OpenSource-Gemeinde hat mir mal wieder vor Augen gehalten, wie man sich das Coder-Dasein durch die Verwendung von Modultests („UnitTests“) vereinfachen kann. Nicht jeder benutzt sie, jeder sollte. In der PHP-Programmierung ist die ideale Software hierfür PHPUnit.

Die Software wird im GitHub verteilt, ist gut dokumentiert, weit verbreitet (guckt mal in viele größere Klassen rein, man stolpert oft über den einen oder anderen Testordner) und genießt hohes Ansehen bei Entwicklern. Die Software ist auch im PEAR und kann darüber installiert werden (ein paar Dependencies gibt es für zusätzliche Funktionen).

An einem einfachen Beispiel möchte ich die grundsätzliche Verfahrensweise demonstrieren. Angenommen, in einem PHP-Projekt gibt es irgendwo eine Funktion, welche den Ostersonntag eines Jahres bestimmt. Der Einfachheit halber nennen wir sie easter($jahr). So eine Funktion könnte beispielsweise eingebunden sein, wenn es um die Errechnung von verschiedenen Feiertage geht – somit könnte sie eine gewisse Kritikalität im Projekt innehaben. Wie testet man nun so eine Funktion mit PHPUnit?

Ich steige hier mal mitten in PHPUnit ein:

[php]
require_once ‚includes/functions.php‘;

class EasterTest extends PHPUnit_Framework_TestCase {
public function testEasterOk() {
$easter2011 = easter(2011);
$this->assertEquals($easter2011, gmmktime(0,0,0,4,24,2011));
}

public function testEasterFalse() {
$easter2011 = easter(2011);
$this->assertNotEquals($easter2011, gmmktime(0,0,0,12,24,2011));
}
}
[/php]

Zuerst habe einen Verweis auf das PHP-Script (hier: functions.php), in welcher die Funktion easter($Jahr) enthalten ist. Dann generiere ich eine Klasse („EasterTest“), welche PHPUnit erweitert. In dieser Klasse sind zwei Tests abgelegt:

  • Ein Gutfall (ist der 24.4.2011 Ostern?)
  • Ein Schlechtfall (ist der 24.12.2011 Ostern?)

Jetzt kommt der trockene theoretische Teil…
Hier geht es nicht etwa darum, das Ergebnis zu finden – das hat man ohnehin schneller mit einem Blick auf dem Kalender. Vielmehr ist es Ziel, das Ergebnis der Funktion mit einem definierten „Wunschergebnis“ zu vergleichen. Ich weiß, dass der 24.04. dieses Jahr der Ostersonntag ist… und ich weiß, dass es der 24.12. definitiv nicht ist.

PHPUnit – wie auch fast alle andere Software in diesem Umfeld – arbeitet mit „Assertions“ (Behauptungen). Es gibt eine Sammlung von einfachen Funktionen, welche solche Assertions in verschiedenen Konstrukten ermöglichen – angefangen von Vergleichsoperationen wie die im Beispiel verwendeten assertEquals und assertNotEquals über False/True-Varianten, Array-Prüfern und einigem anderen.

Ist dies viel Arbeit?
Bitte urteilt selbst.. ein einfacher Test ist fix geschrieben. Nicht schwer, oder?

Zurück zur Praxis.
Wie kann man nun die Tests auswerten? Am einfachsten über die Shell. Und hier ist es nun wirklich egal, ob man sich in einer Dosbox, Bash oder wo auch immer aufhält.

[shell]
D:\htdocs\>phpunit EasterTest.php
PHPUnit 3.5.11 by Sebastian Bergmann.

..

Time: 0 seconds, Memory: 3.75Mb

OK (2 tests, 2 assertions)
[/shell]

PHPUnit kann auch andere Output-Formate, beispielsweise das TAP-Format („Test Anything Protocol“), JSON, XML und andere.

[shell]
D:\htdocs\>phpunit –tap EasterTest.php
TAP version 13
ok 1 – EasterTest::testEasterOk
ok 2 – EasterTest::testEasterFalse
1..2
[/shell]

Wenn ich nun in einem Test einen Fehler habe, sieht das so aus (ich habe hierfür den Test 1 so verändert, dass die Behauptung lautet, der 23.04.2011 wäre Ostersonntag – ist aber in Wirklichkeit der Samstag davor):

[shell]
D:\htdocs\>phpunit –tap EasterTest.php
TAP version 13
not ok 1 – Failure: EasterTest::testEasterOk

message: ‚Failed asserting that <integer:1303516800> matches expected <integer:1303603200>.‘
severity: fail
data:
got: 1303516800
expected: 1303603200

ok 2 – EasterTest::testEasterFalse
1..2
[/shell]

Wenn ich nun – wann und warum auch immer – an der eigentlichen Funktion wieder mal arbeite, dann habe ich weiterhin meine gespeicherten Tests. Wenn diese mir also Mist zurückgeben, ist entweder mein Test falsch (eher unwahrscheinlich), oder meine veränderte Funktion ist nicht ok… und genau darum geht es hier. Modultests wie dieser hier machen den Code deutlich stabiler und nachträgliche Arbeiten, Erweiterungen etc. erheblich einfacher.

Und wenn es mal Bugs gibt… schreibt einen Test und fixt dann den Bug!

[:en]A little private encounter with the community of an open source project opened my eyes, how good and easy life as a coder is if you’re working with unit tests. Not everybody uses them, but everybody should. For php programming the ideal software for this is PHPUnit.

The software can be obtained from GitHub verteilt, is well documented, widely used and very popular. It is also in the PEAR project and can be installed using the PEAR installer (it has some dependencies for additional features).

To demonstrate the basic procedural manner I’ll use a simple example. Imagine… somewhere within a php project there is a function, which returns easter sunday given any year. To make things easy, we’ll name it easter($year). Such a function could be used for determining holidays and therefore could have a certain criticality. How can this be tested with PHPUnit?

Let’s delve into code:

[php]
require_once ‚includes/functions.php‘;

class EasterTest extends PHPUnit_Framework_TestCase {
public function testEasterOk() {
$easter2011 = easter(2011);
$this->assertEquals($easter2011, gmmktime(0,0,0,4,24,2011));
}

public function testEasterFalse() {
$easter2011 = easter(2011);
$this->assertNotEquals($easter2011, gmmktime(0,0,0,12,24,2011));
}
}
[/php]

First there is a link to the script containing the easter-function (here: functions.php). Then I generate a new class („EasterTest“), which extends PHPUnit. In this class there are two basic tests:

  • A positive test (24.4.2011, is this easter sunday?)
  • A negative test (24.12.2011, is this easter sunday?)

Now to the boring theoretical part…
The solution isn’t the aim here – one glance at a calender should help you way better. The goal is, to compare the functions result with a defined result. I know for sure, that this years easter sunday is on 24.04. (as long as my calendar isn’t lying!) … und I know for sure, 24.12. ain’t somewhere near easter.

PHPUnit – like many other software products around unit testing – works with „assertions“. There is a library of simple functions for assertions in different constructs – for comparisms (like the here used assertEquals and assertNotEquals), arrays, bools and so on.

How much work is it?
Please decide for yourself. An easy test should be coded within less than five minutes. Not too difficult, ain’t it?

Back to work.

How can you now run those tests? Easiest way: use your shell (whatever, either Dos, Bash or anything else php runs on).

[shell]
D:\htdocs\>phpunit EasterTest.php
PHPUnit 3.5.11 by Sebastian Bergmann.

..

Time: 0 seconds, Memory: 3.75Mb

OK (2 tests, 2 assertions)
[/shell]

PHPUnit can express itself using different output formats, for example TAP („Test Anything Protocol“), JSON, XML and some more.

[shell]
D:\htdocs\>phpunit –tap EasterTest.php
TAP version 13
ok 1 – EasterTest::testEasterOk
ok 2 – EasterTest::testEasterFalse
1..2
[/shell]

Now… how does it look like if there is an error? To test this I slighly changed my first test and assumed, 23.04.2011 is easter sunday – in reality it is the saturday.

[shell]
D:\htdocs\>phpunit –tap EasterTest.php
TAP version 13
not ok 1 – Failure: EasterTest::testEasterOk

message: ‚Failed asserting that <integer:1303516800> matches expected <integer:1303603200>.‘
severity: fail
data:
got: 1303516800
expected: 1303603200

ok 2 – EasterTest::testEasterFalse
1..2
[/shell]

If I return coding on the easter-function in the far future, then I still have my unit tests and can run them whenever I like (or whenever I need!). If the tests then return errors, either my tests are wrong or my function is (guess what is more likely). And this is what this is all about. Unit testing makes your code stronger and additions much easier.

And…if you encounter bugs… just write a test first and then fix it!

Von Björn

Tja, ich bin Schöpfer und Admin von dieser Seite!

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.