lumen e2e test

How to do API E2E Test on Lumen in our team

1. LUMENͰͷ E2Eςετͷ࣮૷ྫ LARAVEL MEETUP #10
2. ࣗݾ঺հ ▸ ଜ্ ढ़հ (Shaka) ▸ @shaka0maru ▸ ReFUEL4 / ΞϥΠυΞʔΩςΫπ
3. TEAM MEMBERS
4. AGENDA ▸ LumenͰͷAPIςετͷॻ͖ํ ▸ ֎෦ґଘͷऔΓѻ͍ ▸ API Documentsͱͷ݉Ͷ߹͍
5. APIςετͷॻ͖ํ ▸ ΦϑΟγϟϧͷυΩϡϝϯτʹ৐ͬͯΔͷͰ͓͞Β͍ఔ౓Ͱ ▸ LumenͷTestCase(ݫີʹ͸MakesHttpRequests Trait) ▸ jsonϝιουܦ༝ͰControllerΛݺͼग़͠ ▸ Trait಺ʹอ࣋͞ΕͨResponseΛseeJsonEqualsͱ͔࢖ͬ ͯAssertion͢Δ ▸ seeJsonEquals಺ͰExpectͱActualͷ݁ՌΛιʔτͯ͠ൺ ֱ͢ΔͷͰॱ൪Λؾʹ͢Δඞཁ͕ͳ͍
6. APIςετͷॻ͖ํ use Concerns\InteractsWithContainer, Concerns\MakesHttpRequests, Concerns\InteractsWithAuthentication, Concerns\InteractsWithConsole, Concerns\InteractsWithDatabase, Concerns\InteractsWithSession, Concerns\MocksApplicationServices; ▸ ༨ஊ) ConcernsΛίϐʔ͢Ε͹4ܥͰ΋ಉ͜͡ͱ͕Ͱ͖Δ public function testTest() { $this->json('GET', '/me', []); $this->seeJsonEquals([ 'id' => 1, 'name' => 'Shaka', ]); } TESTCODE SAMPLE
7. ֎෦ґଘͷऔΓѻ͍ ▸ DatabaseMigrations Trait ▸ DatabaseTransactions Trait ▸ DB૚Λmockͤͣʹςετ͢Δ͜ͱ͕Ͱ͖Δ ▸ ςετέʔε͝ͱʹMigrationͯ͠DB SchemaΛߋ৽ͨ͠ Γ ▸ ςετέʔεશମʹTransactionΛ͔͚ͯςετؒͰͷ σʔλͷӨڹΛແͨ͘͠Γ ֎෦ґଘ DATABASE
8. ֎෦ґଘͷऔΓѻ͍ ▸ 1݅ͣͭmake͢Δඞཁ͕͋ͬͯΊΜͲ͏͍͘͞ ▸ ςετσʔλ͕ଟ͘ͳΔͱͭΒ͍ $factory->define(ModelName::class, function (Faker\Generator $faker) { return ['id' => 1, 'status' => 1,]; }); $factory->state(ModelName::class, ‘state_name’, function (Faker\Generator $faker) { return ['status' => 2,]; }); FACTORYͰςετσʔλੜ੒
9. ֎෦ґଘͷऔΓѻ͍ ▸ ҰԠ͜͏͍͏΍Γํ΋… $factory->define(ModelName::class, function (Faker\Generator $faker) { ModelName::query()->insert([ ['id' => 1, 'status' => 1,], ['id' => 2, 'status' => 2,], ]); // modelͷattributeΛฦ͞ͳ͍ͱ͍͚ͳ͍ return [ 'id' => 3, 'status' => 3, ]; }); ▸ ͜͜·Ͱ͢ΔͳΒSeed࢖ͬͨΒ͍͍ͷͰ͸…
10. ֎෦ґଘͷऔΓѻ͍ MIGRATION ▸ ςετΛ࣮ߦ͢ΔલʹSchemaΛ࠷৽ʹอͭඞཁ͕͋Δ ▸ ςετέʔε͝ͱʹMigrationΛ࣮ߦͰ͖Δ͕ɾɾɾ ▸ αʔϏε͕Ͱ͔͘ͳΔͱMigration͕஗͘ͳͬͨΓrollback͕ յΕ͍ͯͨΓ ▸ ͔ͳΓ஗͍ (खݩͰ1class࣮ߦ͢Δͷʹ18ඵ͔͔ͬͨ) ▸ ͏ͪͷ৔߹MigrationϑΝΠϧ͕APIϦϙδτϦʹແ͍ͷͰͦ΋ ͦ΋Ͱ͖ͳ͍
11. ֎෦ґଘͷऔΓѻ͍ MIGRATION ▸ Migration͕࣮ߦͰ͖ͳ͍ͱӡ༻ʹ৐ͤΒΕͳ͍ ▸ ύϑΥʔϚϯε͕ѱ͍ͱ࢖ΘΕͳ͘ͳΔ
12. ֎෦ґଘͷऔΓѻ͍ SQLITE ▸ ͦΜͳ͋ͳͨʹSQLite ▸ ࠷৽ͷSchemaͷঢ়ଶͷDBΛ࡞͓͍ͬͯͯϝϯόʔͱڞ༗Ͱ ͖Δ ▸ ࣮ମ͕୯ҰͷόΠφϦϑΝΠϧͳͷͰgitͰ؅ཧͰ͖Δ ▸ ʮSQLite DBΛੜ੒͢ΔεΫϦϓτʯΛ࡞͓͚ͬͯ͹ίϯϑ ϦΫτ΋ؾʹ͠ͳͯ͘ྑ͘ͳΔ ͏ͪͰ࢖ͬͯΔartisanίϚϯυஔ͍ͱ͍ͨͷͰݟ͍ͨํͲ͏ͧ IUUQCJUMZ)'09
13. ֎෦ґଘͷऔΓѻ͍ ▸ SQLite(pdo_sqlite)ͰσʔλΛऔಘ͢Δͱ͢΂ͯstringͰฦͬͯ͘ ΔͷͰ஫ҙ ▸ mysqlnd͸int/stringͳͲΧϥϜͷ஋ͷܕʹ߹Θͤͯฦͯ͘͠ΕΔ ▸ intͷ஋Λ === Ͱ൑ఆΛ͍ͯ͠Δ৔߹͸յΕΔ…ͷͰcastsΛॻ͘ ඞཁ͕͋Δɻਖ਼௚͔ͬͨΔ͍ class MyModelName extends Model { protected $casts = [ 'id' => 'int', 'name' => 'string', ]; }
14. ֎෦ґଘͷऔΓѻ͍ ▸ ֎෦APIΛݺͿΤϯυϙΠϯτͷςετͳͲ ▸ Facebook Maketing APIΛίʔϧ͢ΔAPIͷςετͳΜ͔΋ ॻ͍ͯ·͕͢஗͍ͷͰಛఆͷλΠϛϯάͰ͔࣮͠ߦ͠ͳ͍Α ͏ʹ͍ͯ͠·͢ ▸ ςετͷ࣮ߦ࣌ؒͱ͔֎෦APIͷ࢓༷ʹґଘ͢ΔͷͰͦͷล Λߟྀͯ͠Ͳ͏͢Δ͔ܾΊΔͱྑ͍͔ͱ ▸ ඞཁͳ͍৔߹͸ؤுͬͯmock͢Δ ֎෦ґଘ 3RD PARTY SERVICE
15. API DOCUMENTS ▸ Swaggerͱ͔ͷ࿩ ▸ ͏ͪ͸ҎԼͷཧ༝ͰSwaggerΛࣺͯͯapiDocΛ࢖ͬͯ·͢ ▸ DocΛݟΔͨΊʹyamlϑΝΠϧ͕ඞཁʹͳͬͯखؒ ▸ σϑΥϧτͰੜ੒Ͱ͖Δ੩తϖʔδͷσβΠϯ͕͋Μ·Γ ޷͖͡Όͳ͍(ݸਓͷײ૝Ͱ͢) ▸ Swaggerͷίʔυࣗಈੜ੒ػೳΛ·ͬͨ͘࢖͍ͬͯͳ͍ API DOCUMENTATION Swaggerͷཧղ͕ո͍͠Մೳੑ͕͋ΔͷͰؒҧͬͯͨΒ͝ΊΜͳ͍͞
16. API DOCUMENTS ▸ apiDoc ▸ σβΠϯ͕؆ૉͰݟ௨͕͠ྑ͍ ▸ ੩తϑΝΠϧΛϏϧυ͢Ε͹(ૹΓ͚ͭΕ͹)ϩʔΧϧͰ΋ ݟΕΔ ▸ Ϗϧυָ͕ ▸ ίʔυ಺(Doc Comment)ʹυΩϡϝϯτ͕͋ΔͷͰߋ৽ ͠ͳ͍ͱ͍͚ͳ͍ؾ࣋ͪʹͳΔ
17. API DOCUMENTS /** * @param Request $request * @param $id * @return \Illuminate\Http\JsonResponse * * @api {get} /user/:user_id get user info * @apiName indexDynamicAdCreativeName * @apiDescription Get user info * @apiGroup User * * @apiParam {Number} user_id User ID * @apiParam {Number} [status] Status key * @apiSuccess {Number} id ID * @apiSuccess {String} name User Name */ APIDOC SAMPLE
18. API DOCUMENTS
19. API DOCUMENTS ▸ खͰॻ͘ͷ͸͔ͬͨΔ͍ ▸ ςετίʔυ͔ΒυΩϡϝϯτΛࣗಈੜ੒͢Δ ▸ ίʔυˠυΩϡϝϯτ೿Ͱ͢ ▸ APIͷςετΛॻ͜͏ͱ͢Δͱrequest/responseΛॻ͔ͳ͍ ͱ͍͚ͳ͘ͳΔ
20. API DOCUMENTS public function testTest() { $request = [ ‘name’ => ‘updated_name’, ]; $expectedResponse = [ 'id' => 1, 'name' => 'updated_name', ]; $this->json(‘PUT', '/me', $request); $this->seeJsonEquals($expectedResponse); }
21. API DOCUMENTS ▸ req/res͔ΒυΩϡϝϯτͷ਽ܗΛੜ੒͢ΔπʔϧΛॻ͍ͨ IUUQTHJUIVCDPNTINVSBLBNJBQJEPDHFOFSBUPS
22. API DOCUMENTS DOCUMENT GENERATION SAMPLE protected $generateApiDoc = true; public function json($method, $uri, array $request = [], array $headers = [] { if (!$this->generateApiDoc) { return parent::json($method, $uri, $request, $headers); } $self = parent::json($method, $uri, $request, $headers); $response = json_decode($this->response->getContent()); $apiDocGenerator = new ApiDocGenerator(); $apiDocGenerator->setParser(new ApidocjsParser()) ->setFormat(new ApiDocFormatter()); @$apiDocGenerator->generate($request, $response); return $self; }
23. CONCLUSION ▸ E2EͰςετͰ͖ΔΑ͏ʹͳͬͨͷͰࡉ͔͍࣮૷ʹؾΛ࢖͏ ඞཁ͕ݮͬͨ ▸ ؾܰʹϝιου಺ʹnewΛॻ͍ͯ΋ڐ͞ΕΔ(໰୊ͳ͍ͱ͸ ݴ͍ͬͯͳ͍) ▸ େ͖͍มߋ͕͋ͬͯ΋Ϩεϙϯε͕มΘ͍ͬͯͳ͍͜ͱ͕୲ อͰ͖Δ҆৺ײ͸େࣄ ▸ υΩϡϝϯτͷࣗಈੜ੒΋Ͱ͖ͯख࡞ۀ͕ݮͬͨ ·ͱΊ
24. THANK YOU