Codeception ist ein PHP Testing Framework mit dem man neben Acceptance-, Functional- und Unit-Tests auch API Schnittstellen testen kann. Dafür können u.a. sehr einfache Post- oder Get-Requests ausgeführt werden und zudem auch alle anderen Route Requests. Bei älteren Applikationen ist es jedoch manchmal erforderlich noch nicht einen standarisierten JSON-Request auszuführen, sondern einen in einem Raw-Json-Format. Daher heute das Thema „Codeception POST raw JSON string“.
Codeception POST raw JSON string Header Request anpassen
Im Kapitel 10 der sehr guten Codeception Dokumentation Testing WebServices gibt es ein einfaches Beispiel für einen POST-Request.
|
1 2 3 4 5 6 7 8 9 |
<?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"}'); |
Hier wird auf der Route „/users“ via POST-Request nach einem bestimmten User gesucht. In diesem falle wird der Request standarisiert ausgeführt und die Daten im data-Key übertragen. Leider gibt es immmer noch Applikationen, die das aktuell noch nicht unterstützen und einen POST im raw-Json-Format oder auch Plaintext genannt benötigen. Die erfreuliche Nachricht hier neben der Tatsache, daß es geht, ist das es sehr einfach zu implementieren ist und der oben abgebildete Code dafür gar nicht geändert werden muß. Er kann also so auch für ein Refactoring erhalten bleiben. Stattdessen muß nur vorher das Header-Format für den Request angepasst werden. Dafür müß über dem Code nur eine Zeile ergänzt werden.
|
1 |
$I->haveHttpHeader('Content-Type', 'application/json'); |
Fazit Codeception POST raw JSON string
Codeception ist gerade für PHP-Webdeveloper sehr interessant. Das liegt an den tollen Möglichkeiten neben der einfachen Syntay auch ihr komplexes Wissen beim Thema PHP anwenden und implementieren zu können. So kann man im Falle von API-Tests mit Codeception sehr einfach eine Basisklasse implementieren an die man nur noch Parameter übergibt und dadurch die Requests zentral steuert. Dadruch kamm nam auch einfach ‚format‘ => ‚raw‘ nutzen und muß den Header nicht immer neu setzen.
Codeception auf Talks und Schulungen
Codeception Logo
Als Dozent bei der Entwicklungshilfe NRW ist mein Arbeitssschwerpunkt die Software-Qualität und ich bin sehr erfahren und überzeugt in der täglichen Arbeit mit Codeception. Hierfür halte ich regelmäßig Vorträge auf User-Groups und biete auch Schulungen an. Dabei ist besonders das Starthilfe-Paket herauszuheben. Alle Termine gibt es u.a. auf dem Twitter Kanal von Rogoit.
Codeception für das aktuelle Projekt
Rogoit erstellt auch direkt Tests für bestehende Projekte und implementiert eine Build Pipeline. So startet man schnell in eine professionelle und effektive Art der Software-Entwicklung. Zum Angebot geht es hier.
