Codeception WebServices Api Test Schulung Workshop Software-Qualität

Codeception WebServices Api Test

WebServices und Micro-Services spielen in der modernen Webentwicklung eine entscheidende Rolle. Das gibt die Möglichkeit verschiedene Applikationen als Clients auf die Business Logik zugreifen zu lassen. Das können neben Webseiten oder Webapplikationen auch Apps sein. Aber natürlich auch der Anwendungsfall verschiedener Webseiten. Micropages und Landingpages sind hier ein großes Anwendungsgebiet. In diesem Artikel geht es allerdings um die Möglichkeiten eines „Codeception WebServices Api Test“.

Codeception Testing WebServices

Es ist bei Codeception Tests sehr wichtig eine gute Struktur zu haben. Hier sollte man eine eigene Suite für die API generieren. Das passiert mit folgendem Befehl auf der Command Line CLI.

php codecept.phar generate:suite api

1	php codecept.phar generate:suite api

Neben der Generierung der Suite müssen natürlich einige Settings in der yml-Datei vorgenommen werden.

class_name: ApiTester
modules:
  enabled:
    - REST:
	url: http://serviceapp/api/v1
	depends: PhpBrowser
	part: Json

class_name: ApiTester

modules:

enabled:

- REST:

url: http://serviceapp/api/v1

depends: PhpBrowser

part: Json

Grundsätzlich kann hier auch mit de XML Format gearbeitet werden. Schauen wir uns kurz die Konfiguration an. Hier wird also das REST-Module aktiviert und konfiguriert. Dafür wird die URL angegeben. Ich nutze hier entgegen der offiziellen Codeception Dokumentation keinen abschließenden Slash. So kann ich in den Tests mit absoluten Pfaden arbeiten. Das ist eine persönliche Vorliebe. Danach wird der PhpBrowser gewählt. Das hat viele Vorteile. Es ist nicht mehr nötig mit Selenium auf tatsächliche Browser zuzugreifen. Das macht das automatisierte Deployment wesentlich einfacher und schneller. Schnelle Tests sind immer noch besser.

php codecept.phar generate:cept api CreateUser

1	php codecept.phar generate:cept api CreateUser

Ich halte mich hier weiter an die offizielle Doku. Generell hat es allerdings einen großen Vorteil mit „cest“ statt „cept“ zu arbeiten. Hier nur das Codeception Cept-File

<?php
$I = new ApiTester($scenario);
$I->wantTo('create a user via API');
$I->amHttpAuthenticated('service_user', '123456');
$I->haveHttpHeader('Content-Type', 'application/x-www-form-urlencoded');
$I->sendPOST('/users', ['name' => 'davert', 'email' => 'davert@codeception.com']);
$I->seeResponseCodeIs(200);
$I->seeResponseIsJson();
$I->seeResponseContains('{"result":"ok"}');
?>

<?php

$I = new ApiTester($scenario);

$I->wantTo('create a user via API');

$I->amHttpAuthenticated('service_user', '123456');

$I->haveHttpHeader('Content-Type', 'application/x-www-form-urlencoded');

$I->sendPOST('/users', ['name' => 'davert', 'email' => 'davert@codeception.com']);

$I->seeResponseCodeIs(200);

$I->seeResponseIsJson();

$I->seeResponseContains('{"result":"ok"}');

Wieder besticht Codeception durch diese tolle und einfache Syntax. Werfen wir einen detaillierten Blick auf den Post Request und die Assertions. Hier wird also ein PHP-Array auf eine entsprechende Route gepostet. Das ist vielleicht nicht unbedingt praxisnah. Am Ende möchte man ja seine API einfach und unter realistischen Bedingungen testen. Hier das ganze mit einem Json-Request.

$I->sendPOST('/users', 
  'data' => '{"key": "value", "secondkey": "something"}'
);

$I->sendPOST('/users',

'data' => '{"key": "value", "secondkey": "something"}'

);

das ist schon wesentlich einfacher und übersichtlicher.

Assertions Codeception API Test

Es gibt eine Vielzahl guter und effektiver Möglichkeiten out-of-the box den Api-Response zu testen.

// not good
$I->seeResponseContains('{"result":"ok"}');
// better
$I->seeResponseContains('ok');
$I->dontSeeResponseContains('error');

// not good

$I->seeResponseContains('{"result":"ok"}');

// better

$I->seeResponseContains('ok');

$I->dontSeeResponseContains('error');

Man kann sich schon vorstellen, was man hier mit diesen 2 einfachen Assertions für eine unglaubliche Vereinfachung seiner Tests hat. Natürlich kann man hier auch weiterhin einfach alle Assertions von PHPUnit nutzen und mit grabResponse hier auch weitere Überprüfungen durchführen. Ein Blick in die Codeception Rest Doku loht sich. Hier die Features auf einen Blick.

Never Code Alone – Kostenloser Codeception Workshop in NRW

Never Code Alone – Initiative für Software-Qualität in Deutschland – entwickelt gerade an einem kostenlosen Event für Webworker bei dem die Möglichkeiten von Codeception aufgezeigt und an praktischen Beispielen angewendet werden. Alle Infos dazu gibt es ein ersten Blogpost auf der Never Code Alone Webseite.

Codeception WebServices Api Test

Codeception Testing WebServices

Assertions Codeception API Test

Never Code Alone – Kostenloser Codeception Workshop in NRW

Codeception Rest Documentation

About Author

1 Kommentar

Leave A Reply Cancel Reply

Codeception Testing WebServices

Assertions Codeception API Test

Never Code Alone – Kostenloser Codeception Workshop in NRW

Codeception Rest Documentation

About Author

Related Posts

Pair Programming Tipps und Studien

Codeception Test einzelnen ausführen

Twig key underscore Unterstrich dash Template attribute-Methode

1 Kommentar

Leave A Reply Cancel Reply