Real-World TDD Application Development / Symfony and its Friends by Chris Holland

Bootstrapping Symfony w/
REST, OAuth, User
Management, Unit &
Acceptance Tests

Chris Holland - https://twitter.com/chrisholland/ @Symfony_live Paris 2019

Transcript

2. Chris Holland - https://twitter.com/chrisholland/ Real-World TDD Application Development w/ Symfony and its Friends Bootstrapping Symfony w/ REST, OAuth, User Management, Unit & Acceptance Tests
3. Slides: http://bit.ly/real-world-tdd
4. What is TDD?
5. What is TDD ❖ Write a failing test ❖ Write just enough code to make that test pass ❖ Refactor
6. Failing Test Make Test Pass Refactor
7. Q: Why TDD?
8. A: Faster Workflow
9. A: Faster Workflow (here’s why)
10. Stimulating Code: Traditional Workflow
11. My Business Logic HTTP Routes Scaffold UI Debug Statement Inspect DB Click the UI Step thru Code
12. Stimulating Code: TDD Workflow
13. My Business Logic HTTP Routes Scaffold UI Debug Statement Inspect DB Click the UI Step thru Code
14. My Business Logic HTTP Routes Scaffold UI Debug Statement Inspect DB Click the UI Step thru Code X X X X X X
15. My Business Logic Run Tests!
16. Real World TDD?
17. Real World TDD ❖ Test-Drive an Application with: ❖ Data Operations ❖ Business Logic ❖ Lean on Frameworks for: ❖ RESTful Endpoints ❖ User Registration / Authentication ❖ OAuth-Based Authentication ❖ Don’t let Frameworks harm Tests
18. What I strive to avoid …
20. My Business
21. My Business My Framework
22. What I strive to achieve …
23. My Business My Business My Framework
24. Outcome
25. Outcome ❖ JSON POST /api/register-user (with password) ❖ HTML GET /oauth/v2/auth?client_id=xxx&redirect= ❖ user submits html form w/ username/password ❖ redirect has token in the URL ❖ JSON POST/GET/PUT/PATCH /api/anything ❖ with token
26. High-Level Tooling
27. Tooling: FOS ❖ FOSRestBundle ❖ FOSUserBundle ❖ FOSOAuthServerBundle
28. TDD Tooling ❖ PHPUnit ❖ Codeception
29. Scope: Symfony 3.4 & Beyond
30. Scope: Symfony 3.4 & Beyond ❖ Concepts are applicable to any framework ❖ Symfony makes it easy ❖ everything works as of latest Symfony 3.4 ❖ I’ve not yet ported it to 4.x ❖ I don’t think it’ll be hard
31. Architecture
32. TDD-Friendly Architecture Acceptance & Integration Tests http://codeception.com http://www.seleniumhq.org è Tests should be lightweight 100% Unit-Test Coverage Commands Services Repositories Controllers Entities DTOs Views Interfaces Interfaces
33. Test-Driving Repositories
34. ORM in-memory DB MySQL Unit Tests Manual Testing
35. xUnit: Test Harness ORM in-memory DB Unit Test Unit Test Unit Test TDD’ing Repositories: PHP
36. xUnit: Test Harness ORM in-memory DB Unit Test Unit Test Unit Test TDD’ing Repositories: PHP SQLite Doctrine PHPUnit
37. Test-Driving Repositories ❖ Being able to Test-Drive Repositories … ❖ … changes Everything
38. Test-Driving Repositories Example: Ride-Hailing
40. testCreateAndSaveUser
41. newUser() getById() testCreateAndSaveUser
42. newUser() getById() testCreateAndSaveUser testAssignRoleToUser (Passenger, User)
43. newUser() getById() testCreateAndSaveUser testAssignRoleToUser (Passenger, User)
44. newUser() getById() testCreateAndSaveUser testAssignRoleToUser (Passenger, User) assignRole (Passenger, User)
45. newUser() getById() testCreateAndSaveUser testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation
46. newUser() getById() testCreateAndSaveUser testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation newLocation()
47. newUser() getById() testCreateAndSaveUser testNewRide (Passenger, Pickup) testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation newLocation()
48. newUser() getById() testCreateAndSaveUser testNewRide (Passenger, Pickup) testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation newLocation()
49. newUser() getById() testCreateAndSaveUser testNewRide (Passenger, Pickup) testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation newLocation()
50. newUser() getById() testCreateAndSaveUser testNewRide (Passenger, Pickup) testAssignRoleToUser (Passenger, User) assignRole (Passenger, User) testCreateLocation newLocation() newRide (Passenger, Pickup)
51. Workflow
52. UI Route Controller Business Logic Schema Migrations TDD Workflow
53. Business Logic TDD Workflow Repos Services Entities UI Route Controller Schema Migrations
54. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations
55. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations TDD in Rapid Iterations
56. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations ORM TDD in Rapid Iterations
57. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations ORM Auto-Generated Migrations from Entity Graph TDD in Rapid Iterations
58. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations ORM Auto-Generated Migrations from Entity Graph TDD in Rapid Iterations
59. Business Logic TDD Workflow Repos Services Entities TDD UI Route Controller Schema Migrations ORM Manual Testing Auto-Generated Migrations from Entity Graph TDD in Rapid Iterations
60. TDD Repo(s)
61. TDD Service TDD Repo(s)
62. TDD Service TDD Repo(s) TDD Service TDD Repo(s)
63. TDD Service TDD Repo(s) TDD Service TDD Repo(s) Build UI Concurrently
64. TDD Service TDD Repo(s) TDD Service TDD Repo(s) TDD Service TDD Repo(s) Build UI Concurrently
65. Map URI Routes to Service Methods Build UI Concurrently TDD Service TDD Repo(s) TDD Service TDD Repo(s) TDD Service TDD Repo(s)
66. Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Build UI Concurrently TDD Service TDD Repo(s) TDD Service TDD Repo(s) TDD Service TDD Repo(s)
67. Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Run SQL Migrations against Local RDBMS Build UI Concurrently TDD Service TDD Repo(s) TDD Service TDD Repo(s) TDD Service TDD Repo(s)
68. Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Run SQL Migrations against Local RDBMS Build UI Concurrently Test Application thru the UI TDD Service TDD Repo(s) TDD Service TDD Repo(s) TDD Service TDD Repo(s)
69. TDD Service TDD Repo TDD Service TDD Repo TDD Service TDD Repo Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Run SQL Migrations against Local RDBMS Build UI Concurrently Test Application thru the UI Zone 1 Zone 2
70. TDD Service TDD Repo TDD Service TDD Repo TDD Service TDD Repo Zone 1 Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Run SQL Migrations against Local RDBMS Build UI Concurrently Test Application thru the UI Zone 2
71. TDD Service TDD Repo TDD Service TDD Repo TDD Service TDD Repo Zone 1 Map URI Routes to Service Methods Generate SQL Migration from Entity Graph Run SQL Migrations against Local RDBMS Build UI Concurrently Test Application thru the UI Zone 2 Decoupled
72. TDD Workflow in Action
73. http://bit.ly/tdd-vids
74. Putting Together: PHPUnit, Doctrine, SQLite
75. Doctrine
76. Doctrine / Uuid ❖ composer require ramsey/uuid-doctrine
77. config.yml: Doctrine / Uuid
78. PHPUnit, Doctrine, SQLite
79. PHPUnit, Doctrine, SQLite ❖ config_test.yml <— used by PHPUnit ❖ doctrine: ❖ dbal: ❖ driver: pdo_sqlite
80. AppTestCase extends WebTestCase
82. Forward-Engineering DB Schema
83. Forward-Engineering DB Schema ❖ composer require doctrine/doctrine-migrations-bundle
84. Forward-Engineering DB Schema ❖ ./bin/console doctrine:migrations:diff ❖ ./bin/console doctrine:migrations:migrate
85. Beyond Doctrine & Repos …
86. Frameworks …
87. … Functionality for Free !
88. Frameworks ❖ FOSRestBundle ❖ composer require friendsofsymfony/rest-bundle ❖ FOSUserBundle ❖ composer require friendsofsymfony/user-bundle ❖ FOSOAuthServerBundle ❖ composer require friendsofsymfony/oauth-server-bundle
89. Frameworks vs Tests
90. Frameworks vs Tests ❖ Avoid loading frameworks not needed in PHPUnit ❖ FOSRestBundle ❖ FOSUserBundle ❖ FOSOAuthBundle ❖ use config segregation ❖ use AppKernel segregation
91. Config Segregation
92. Symfony Config Files ❖ config_test.yml —> PHPUnit ❖ config_dev.yml —> localhost:8000 ❖ config_prod.html —> yoursite.com
93. config_test.yml config_dev.yml config_prod.yml config.yml config.yml config.yml frameworks.yml frameworks.yml frameworks.yml fos_rest fos_user fos_oauth_server config.yml doctrine
94. Frameworks vs Tests: AppKernel if (! in_array($this->getEnvironment(), ['test'], true)) { $bundles[] = new FOS\RestBundle\FOSRestBundle(); $bundles[] = new JMS\SerializerBundle\JMSSerializerBundle(); $bundles[] = new Nelmio\CorsBundle\NelmioCorsBundle(); $bundles[] = new Symfony\Bundle\WebServerBundle\WebServerBundle(); $bundles[] = new FOS\UserBundle\FOSUserBundle(); $bundles[] = new FOS\OAuthServerBundle\FOSOAuthServerBundle(); }
95. FOSRestBundle: frameworks.yml
96. FOSRestBundle: frameworks.yml # FOSRest Configuration fos_rest: routing_loader: default_format: json include_format: false exception: enabled: true body_listener: true format_listener: rules: - { path: '^/api|oauth/token', priorities: ['json'], fallback_format: json, prefer_extension: false } - { path: '^/login', priorities: ['html'], fallback_format: html, prefer_extension: false } - { path: '^/oauth/v2/auth', priorities: ['html'], fallback_format: html, prefer_extension: false } - { path: '^/', priorities: ['html'], fallback_format: html, prefer_extension: false } param_fetcher_listener: true view: view_response_listener: 'force' formats: json: true
97. FOSRestBundle: frameworks.yml # FOSRest Configuration fos_rest: routing_loader: default_format: json include_format: false exception: enabled: true body_listener: true format_listener: rules: - { path: '^/api|oauth/token', priorities: ['json'], fallback_format: json, prefer_extension: false } - { path: '^/login', priorities: ['html'], fallback_format: html, prefer_extension: false } - { path: '^/oauth/v2/auth', priorities: ['html'], fallback_format: html, prefer_extension: false } - { path: '^/', priorities: ['html'], fallback_format: html, prefer_extension: false } param_fetcher_listener: true view: view_response_listener: 'force' formats: json: true <— possibly set to FALSE
98. FOSUserBundle: frameworks.yml
99. FOSUserBundle: frameworks.yml fos_user: db_driver: orm # other valid values are 'mongodb', 'couchdb' and 'propel' firewall_name: api user_class: AppBundle\Entity\AppUser from_email: address: "noreply@yourcompany.com" sender_name: "No Reply"
100. FOSUserBundle: services.yml
102. FOSOauthServerBundle: frameworks.yml
103. OAuthServerBundle: frameworks.yml fos_oauth_server: db_driver: orm client_class: AppBundle\Entity\Client access_token_class: AppBundle\Entity\AccessToken refresh_token_class: AppBundle\Entity\RefreshToken auth_code_class: AppBundle\Entity\AuthCode service: user_provider: fos_user.user_provider.username
104. OAuthServer Entities
105. OAuth: AccessToken
107. OAuth: AuthCode
109. OAuth: Client
111. OAuth: RefreshToken
113. security.yml
117. FOSUser Entity
118. AppUser
121. UserRepository
122. UserRepository: Goals ❖ Leverages FOSUser’s UserManager ❖ Same code in Test vs Production ❖ Inject a FakeUserManager in Test ❖ Inject FOS’s Real UserManager in Production Code
123. UserRepository
124. UserRepository
125. UserRepository ❖ In Test Harness: ❖ Inject:
 FakeUserManager implements UserManagerInterface ❖ In Production Code: ❖ Inject: ❖ $this->container->get(‘fos_user.user_manager.public’);
126. FakeUserManager implements UserManagerInterface
129. FakeUserManager ❖ override createUser & saveUser methods ❖ gets rid of overhead incompatible with tests ❖ gets rid of bcrypt password hashing ❖ Tests don’t care about other methods ❖ as those pertain to use-cases … ❖ … not in scope of our Domain
130. routing.yml
131. app: resource: "@AppBundle/Controller/" type: annotation fos_oauth_server_token: resource: "@FOSOAuthServerBundle/Resources/config/routing/token.xml" fos_oauth_server_authorize: resource: "@FOSOAuthServerBundle/Resources/config/routing/authorize.xml" fos_user_security: resource: "@FOSUserBundle/Resources/config/routing/security.xml" fos_user_register: resource: "@FOSUserBundle/Resources/config/routing/registration.xml" prefix: /register fos_user_profile: resource: "@FOSUserBundle/Resources/config/routing/profile.xml" prefix: /profile fos_user_resetting: resource: "@FOSUserBundle/Resources/config/routing/resetting.xml" prefix: /resetting fos_user_change_password: resource: "@FOSUserBundle/Resources/config/routing/change_password.xml" prefix: /profile
132. Codeception
133. TDD-Friendly Architecture Acceptance & Integration Tests http://codeception.com http://www.seleniumhq.org è Tests should be lightweight 100% Unit-Test Coverage Commands Services Repositories Controllers Entities DTOs Views Interfaces Interfaces
134. CodeCeption ❖ composer require “codeception/codeception” —dev
135. CodeCeption: acceptance.suite.yml actor: AcceptanceTester modules: enabled: - PhpBrowser: url: http://127.0.0.1:8000 - \Helper\Acceptance
136. CodeCeption ❖ When testing OAuth “Auth Code Grant” Flow … ❖ APITester must be able to: ❖ do HTML for user “login” and “accept” ❖ do JSON for API Requests
137. CodeCeption: api.suite.yml actor: ApiTester modules: enabled: - \Helper\Api - PhpBrowser: url: http://127.0.0.1:8000/ - REST: url: http://127.0.0.1:8000/api/v1 depends: PhpBrowser part: Json
138. Testing OAuth
139. OAuth: “Auth Code Grant” Flow ❖ http://localhost:8000/oauth/v2/auth? client_id=1_3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4&re direct_uri=http://localhost:8000/&response_type=token ❖ redirects to /login if user not logged-in ❖ token request: user Reject or Accept ❖ redirects to / with “token” in the URL ❖ grab “token” & use in subsequent API requests
140. http://localhost:8000/oauth/v2/auth? client_id=1_3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4& redirect_uri=http://localhost:8000/&response_type=token
143. Codeception “Auth Code Grant”
144. protected function loginWithUserName($username) : array { $this->amOnPage('/logout'); $authUrl = '/oauth/v2/auth?client_id=' .UserApi::CLIENT_ID .'&redirect_uri=http://localhost:8000/&response_type=token'; $this->amOnPage($authUrl); $this->canSeeInFormFields('form', [ '_username' => '', '_password' => '' ]); $this->submitForm('form', [ '_username' => $username, '_password' => 'password' ], '_submit'); $this->seeResponseCodeIs(HttpCode::OK); $this->submitForm('form[name=fos_oauth_server_authorize_form]', [], 'accepted'); $token = $this->grabFromCurrentUrl('~.*&access_token=([^&]+)~'); $this->token = $token; return [ 'token_type' => 'bearer', 'access_token' => $token ]; }
145. https://github.com/elchris/kata_tdd_php_symfony/ blob/master/tests/_support/ApiTester.php#L335 Codeception “Auth Code Grant”
146. It’s all in my GitHub
147. https://github.com/elchris/ kata_tdd_php_symfony
148. https://github.com/elchris/ kata_tdd_php_symfony (master branch)
149. ( Pull Requests are Welcome )
150. See it in action ❖ git clone https://github.com/elchris/kata_tdd_php_symfony.git ❖ start mysql && create database named “symfony” ❖ cd kata_tdd_php_symfony && composer install ❖ ./bin/console doctrine:migrations:migrate ❖ ./bin/console server:start (make sure it’s :8000) ❖ ./vendor/bin/phpunit ❖ ./vendor/bin/codecept run
151. See it in action ❖ http://localhost:8000/ ❖ http://localhost:8000/register/ ❖ http://localhost:8000/profile/ ❖ http://localhost:8000/logout ❖ http://localhost:8000/login ❖ http://localhost:8000/oauth/v2/auth? client_id=1_3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0 gwwk4&redirect_uri=http://localhost:8000/ &response_type=token
153. Takeaways
154. Test-Drive Application …
155. … Focus on Core Business Logic
156. … Test-Drive Data Operations (Repositories)
157. … Lean on Frameworks for …
158. RESTful End-Points
159. RESTful End-Points User Management
160. RESTful End-Points User Management OAuth
161. … Without interfering with Unit Tests!
162. Merci Bien!
163. Merci Bien! Slides: http://bit.ly/real-world-tdd
164. Merci Bien! Slides: http://bit.ly/real-world-tdd Suivez-moi sur Touitteure: https://twitter.com/chrisholland