{"id":293,"date":"2015-07-25T13:19:23","date_gmt":"2015-07-25T11:19:23","guid":{"rendered":"http:\/\/staratnight.de\/blog\/?p=293"},"modified":"2018-12-02T16:39:17","modified_gmt":"2018-12-02T14:39:17","slug":"e2e-tests-in-php-mit-codeception","status":"publish","type":"post","link":"https:\/\/staratnight.de\/blog\/e2e-tests-in-php-mit-codeception\/","title":{"rendered":"E2E-Tests in PHP mit Codeception"},"content":{"rendered":"

End-To-End-Tests in PHP lassen sich sehr elegant mit Codeception<\/a> durchf\u00fchren. Angelehnt an Behaviour-Driven-Tests ist der Sourcecode der Tests sehr ausdrucksstark, einfach zu schreiben und sehr gut lesbar.<\/p>\n

 <\/p>\n

Installation<\/h1>\n

Codeception wird \u00fcber Composer installiert<\/a>. Das zu installierende Paket hei\u00dft<\/p>\n

Codeception\/Codeception<\/strong><\/em><\/p>\n

Nach der Installation steht uns im Ordner \\vendor\\bin\\ <\/em>eine Batch-Datei namens codecept.bat<\/em> zur Verf\u00fcgung, mit der wir die weitere Einrichtung und den Aufruf der Tests durchf\u00fchren k\u00f6nnen.<\/p>\n

<\/p>\n

Codeception einrichten<\/h1>\n

Das initiale Einrichten von Codeception wird bootstrap <\/em>genannt. Um den Bootstrap von Codeception<\/em> durchzuf\u00fchren muss die oben angegebene Batch-Datei mit folgenden Parametern aufgerufen werden:<\/p>\n

codecept bootstrap<\/em><\/strong><\/p>\n

Dieser Aufruf erstellt die Beschreibungsdatei Codeception.yml<\/em> und ein Verezichnis tests<\/em> mit Unterordnern.<\/p>\n

Hinweis: <\/strong>Ich habe es nicht sauber hinbekommen, den Ordner in das Projekt zu schieben. Da mit Codeception aber auch Integrationstests verschiedener Projekte m\u00f6glich ist, ist es vielleicht auch besser so, den Ordner auf oberster Ebene zu lassen.<\/p>\n

 <\/p>\n

Beim Bootstrap werden drei Test-Suites erstellt:<\/p>\n

    \n
  • acceptance<\/li>\n
  • functional<\/li>\n
  • unit<\/li>\n<\/ul>\n

     <\/p>\n

     <\/p>\n

    L\u00f6schen nicht verwendeter Suites<\/h2>\n

    Ich verwende f\u00fcr Unit-Tests phpunit, auch funktionale Tests habe ich selten. Entweder sind es echte Akzeptanz-Tests der Webseite oder Tests von Webservices. Deshalb l\u00f6sche ich diese Suites, darin schreibe ich niemals Tests.<\/p>\n

    Zum L\u00f6schen einfach alle Verzeichnisse mit dem Namen der Suites l\u00f6schen, die nicht verwendet werden und in allen anderen Verzeichnissen die PHP-Dateien l\u00f6schen, die den Namen der Suite tragen (also Functional*). Dann noch die .yml-Datei mit dem Namen der Suite im tests<\/em>-Ordner l\u00f6schen und man ist die nicht verwendeten Dateien los.<\/p>\n

     <\/p>\n

    Akzeptanztests erstellen<\/h1>\n

    Als n\u00e4chstes wollen wir unseren ersten Akzeptanztest innerhalb der oben angelegten Suite erstellen.<\/p>\n

    Um einen Akzeptanztest zu erstellen rufen wir wieder die Batch-Datei auf:<\/p>\n

    codecept generate:cept acceptance [name des tests]<\/em><\/strong><\/p>\n

    Hinweis: <\/strong>Im Standard wird pro Datei genau ein Akzeptanztest ausgef\u00fchrt. M\u00f6chten wir, wie wir es von UnitTests gewohnt sind, \u00e4hnliche Tests in einer Testklasse gruppieren, m\u00fcssen wir einen cest<\/em> erstellen (nicht wie oben einen cept<\/em>). Der Aufruf dazu:<\/p>\n

    codecept generate:cest<\/span> acceptance [name der testklasse]<\/em><\/strong><\/p>\n

    Nach diesen Aufrufen finden wir nun im Ordner der Suite (hier: acceptance<\/em>) eine neue Datei, die einen Rumpf f\u00fcr einen Test enth\u00e4lt.<\/p>\n

    In diesen Rumpf k\u00f6nnen wir nun unsere Tests schreiben. Hier mal ein einfaches Beispiel, in dem das Routing einer auf dem Slim-Framework basierten Anwendung gepr\u00fcft wird:<\/p>\n

    <?php\r\nclass RoutingCest\r\n{\r\n \tpublic function ensureRoutingToSchemaVersion(AcceptanceTester $I)\r\n\t{\r\n\t\t$I->wantTo('ensure that routing to schema version works');\r\n\t\t$I->amOnPage('\/schemaVersion');\r\n\t\t$I->dontSee('Fatal error:');\r\n\t\t$I->dontSee('404');\r\n\t}\r\n}<\/pre>\n
    Der Test ist sprechend, oder? Im Falle eines Routing-Fehlers gibt Slim eine Fehlerseite aus, auf der der Text „Fatal error“ steht. Finden wir diesen Text nicht und landen auch nicht auf einer Seite mit einem 404, ist das Routing in Ordnung.<\/p>\n
    M\u00f6chten wir nun weitere Tests hinzuf\u00fcgen, k\u00f6nnen wir dies einfach durch den obigen Aufruf erledigen.<\/p>\n
     <\/p>\n
    Testsuite f\u00fcr REST-Services hinzuf\u00fcgen<\/h1>\n
    M\u00f6chten wir nun eine weitere Test-Suite hinzuf\u00fcgen, etwa um einen Rest-Service zu testen, geht das ebenfalls \u00fcber einen Aufruf der Batch-Datei:<\/p>\n
    codecept generate:cest<\/span> api [name der testklasse]<\/em><\/strong><\/p>\n
    Wichtig: <\/strong>Nach diesem Aufruf m\u00fcssen wir noch Support-Klassen generieren lassen, die bei unserem ersten Beispiel oben implizit durch den bootstrap <\/em>Parameter mit erstellt wurden. Um das zu erreichen, m\u00fcssen wir folgenden Aufruf hinterher machen:<\/p>\n
    codecept build<\/strong><\/em><\/p>\n
    Dies erstellt uns die Klasse tests\/_support\/ApiTester.php<\/em> und tests\/_generated\/ApiTesterActions.php<\/em>, die wir f\u00fcr die Ausf\u00fchrung der Tests ben\u00f6tigen.<\/p>\n
    Nach der Erstellung m\u00fcssen wir die Suite noch konfigurieren. Dazu \u00f6ffnen wir die Datei api.suite.yml und erg\u00e4nzen einige Informationen:<\/p>\n
    class_name: ApiTester\r\nmodules:\r\n    enabled:\r\n        - \\Helper\\Api\r\n        - REST:\r\n            url: http:\/\/localhost\/\r\n            depends: PhpBrowser\r\n            part: Json\r\n<\/pre>\n
    In diesem Beispiel etwa habe ich die URL angepasst, das Format auf Json eingeschr\u00e4nkt (zus\u00e4tzlich g\u00fcltig ist noch XML) welches Codeception<\/em> f\u00fcr die Tests verwenden soll.<\/p>\n
    Nun k\u00f6nnen wir unseren API-Test schreiben. Hier wieder ein einfaches Beispiel:<\/p>\n
    <?php\r\n\r\nclass ReadingSchemaVersionCest\r\n{\r\n    \/\/ tests\r\n    public function tryToTest(ApiTester $I)\r\n    {\r\n\t    $I->wantTo('check the schema version via API');\r\n\t    $I->haveHttpHeader('Content-Type', 'application\/x-www-form-urlencoded');\r\n\t    $I->sendGET('\/schemaVersion');\r\n\t    $I->seeResponseCodeIs(200);\r\n\t    $I->seeResponseIsJson();\r\n\t    $I->seeResponseContains('\"Version\":\"2013-09-01 00:00:00 \"');\r\n    }\r\n}\r\n<\/pre>\n
    Auch dieser Test ist wider sehr sch\u00f6n lesbar. Wir geben das Format an, welches wir verwenden, rufen die URL ab, von der wir das JSON-Ergebnis haben m\u00f6chten und pr\u00fcfen dann ob wir …<\/p>\n
      \n
    • … einen HTTP-Status 200 (OK) erhalten<\/li>\n
    • … unsere Antwort auch wirklich JSON ist<\/li>\n
    • … in unserer Antwort ein gewisses Ergebnis enthalten ist<\/li>\n<\/ul>\n
       <\/p>\n
      Tests aufrufen und Pr\u00fcfen<\/h1>\n
      Die Tests lassen sich nun ganz einfach wieder \u00fcber die Batch-Datei aufrufen:<\/p>\n
      codecept run<\/strong><\/em><\/p>\n
      Das Ergebnis wird dann gleich in der Konsole angezeigt, und sieht dann etwa so aus:<\/p>\n
      Acceptance Tests (11) ——————————————————————————————-<\/span>
      \nEnsure that routing to entities works (RoutingEntitiesCest::ensureRoutingtoEntities)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to entities by id works (RoutingEntitiesCest::ensureRoutingtoEntitiesById)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to entities by name works (RoutingEntitiesCest::ensureRoutingtoEntitiesByName)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to ingredients works (RoutingIngredientsCest::ensureRoutingToIngredients)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to recipes works (RoutingRecipesCest::ensureRoutingToRecipes)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to recipes by id works (RoutingRecipesCest::ensureRoutingToRecipesById)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to recipes by name works (RoutingRecipesCest::ensureRoutingToRecipesByName)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to recipes by name works (RoutingRecipesCest::ensureRoutingToRecipesByNameLike)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \nEnsure that routing to recipes by name works (RoutingRecipesCest::ensureRoutingToRecipesByIngredientName)\u00a0 Ok<\/span>
      \nEnsure that routing to recipes by name works (RoutingRecipesCest::ensureRoutingToRecipesByIngredientNames) Ok<\/span>
      \nEnsure that routing to schema version works (RoutingCest::ensureRoutingToSchemaVersion)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ok<\/span>
      \n—————————————————————————————————————–<\/span><\/p>\n
       <\/p>\n
      Am Ende der Zeile wird „ok“ oder „fail“ ausgegeben, je nach Erfolg des Tests. Anschlie\u00dfend werden die Test-Ergebnisse aufgelistet, sodass man die fehlgeschlagenen Tests analysieren kann. Detaillierte Informationen dar\u00fcber, was der Test geliefert hat, werden im Ordner _output in Form von HTML-Dateien abgelegt.<\/p>\n
       <\/p>\n
      Wenn wir nur Tests f\u00fcr eine bestimmte Suite aufrufen wollen, geben wir am Ende des Aufrufs einfach den Namen der Suite an:<\/p>\n
      codecept run acceptance
      \n<\/strong><\/em><\/p>\n
      Dann werden nur die Tests dieser Suite aufgerufen.<\/p>\n
       <\/p>\n
      Fazit<\/h1>\n
      Mit Codeception<\/em> lassen sich sehr leicht sch\u00f6n lesbare Tests schreiben.<\/p>\n
      Leider fehlt ein Plugin f\u00fcr IntelliJ, sodass der Aufruf und die Auswertung des Ergebnisses \u00fcber die Kommandozeile erfolgen muss (oder dem Terminal-Fenster in IntelliJ).<\/p>\n
      Aber die Ausgabe der Testergebnisse machen die Analyse der Tests einfach und \u00fcbersichtlich.<\/p>\n
      So macht Testen Spa\u00df!<\/p>\n
       <\/p>\n","protected":false},"excerpt":{"rendered":"
      End-To-End-Tests in PHP lassen sich sehr elegant mit Codeception durchf\u00fchren. Angelehnt an Behaviour-Driven-Tests ist der Sourcecode der Tests sehr ausdrucksstark, einfach zu schreiben…<\/p>\n","protected":false},"author":1,"featured_media":435,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18,14,9],"tags":[24,27,28,25,26,19,23],"class_list":["post-293","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-intellij","category-php","category-tools","tag-akzeptanztest","tag-bdd","tag-behavior-driven","tag-codeception","tag-end-to-end-test","tag-php","tag-test"],"_links":{"self":[{"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/posts\/293","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/comments?post=293"}],"version-history":[{"count":8,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/posts\/293\/revisions"}],"predecessor-version":[{"id":436,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/posts\/293\/revisions\/436"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/media\/435"}],"wp:attachment":[{"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/media?parent=293"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/categories?post=293"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/staratnight.de\/blog\/wp-json\/wp\/v2\/tags?post=293"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}