Testing Rails Service Oriented Architecture

Presented at RubyConf Brazil 2014
More at http://www.bignerdranch.com/blog/testing-rails-service-oriented-architecture/

Transcript

1. Testing Rails Service Oriented Architecture
3. What are Monolithic Applications?
4. What are Monolithic Applications? What is SOA?
5. What are Monolithic Applications? What is SOA? Testing Monolithic Applications
6. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA !
7. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA
8. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA Strategies for Testing SOA
9. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA Strategies for Testing SOA Develop Features for SOA application
10. Monolithic Applications !
11. Client-side ! Monolithic Applications !
12. Client-side ! HTML ! Monolithic Applications !
13. Client-side ! HTML ! JavaScript ! Monolithic Applications !
14. Client-side ! HTML ! CSS ! JavaScript ! Monolithic Applications !
15. Client-side Database Server-side Monolithic Applications !
16. Client-side Database Server-side Monolithic Applications ! db !
17. Client-side Database Server-side Monolithic Applications !
18. Client-side Database Server-side Monolithic Applications ! HTTP requests !
19. Client-side Database Server-side Monolithic Applications ! HTTP requests ! db queries !
20. Client-side Database Server-side Monolithic Applications ! HTTP requests ! Domain Logic ! db queries !
21. Client-side Database Server-side Monolithic Applications ! HTTP requests ! Domain Logic ! db queries ! Populate HTML views !
22. Monolithic Applications ! Deploy Client-side Database Server-side
23. Client-side Database Server-side Monolithic Applications ! School Management App !
24. Service Oriented Architecture !
25. Server-side Database No db Server-side Client-side Server-side Database Service Oriented Architecture !
26. Service Oriented Architecture ! School API Web client Grading
27. Service Oriented Architecture ! Grading Reporting School API Web client
28. Service Oriented Architecture ! Grading Reporting School API Web client HTTP /JSON
29. Service Oriented Architecture ! Grading Reporting School API Web client HTTP /JSON
30. Service Oriented Architecture ! Grading Reporting School API Web client HTTP /JSON
31. Service Oriented Architecture ! Grading Reporting School API Web client HTTP /JSON
32. Service Oriented Architecture ! School API Web client
33. Service Oriented Architecture ! Deploy School API Web client
34. Service Oriented Architecture ! Deploy School API Web client
35. Testing Monolithic Applications Testing Service Oriented Architecture VS
36. Testing Monolithic Applications
37. Testing Monolithic Applications HTML JavaScript HTTP Domain Logic
39. Test
40. Clean database
41. Description
42. Data creation
43. State manipulation
44. Assertion
45. Assertion Passing!
46. Testing Monolithic Applications rspec-rails factory_girl_rails database_cleaner Tools
47. Testing Monolithic Applications rspec-rails factory_girl_rails database_cleaner Tools
48. factory_girl_rails
49. factory_girl_rails
50. factory_girl_rails
51. factory_girl_rails
52. factory_girl_rails
53. factory_girl_rails
54. factory_girl_rails
55. factory_girl makes creating test data easier
56. Testing Monolithic Applications rspec-rails factory_girl_rails database_cleaner Tools
57. database_cleaner
58. Schools 0 Principals s 0 Students 0 Clean database database_cleaner
59. Schools 1 Principals s 1 Students 1 database_cleaner
60. Clean database Schools 0 Principals s 0 Students 0 database_cleaner
61. database_cleaner makes destroying test data easier
62. HTTP /JSON Testing Service Oriented Architecture School API Web client
63. School API Web client HTTP /JSON Testing Service Oriented Architecture
64. School API Web client HTTP /JSON No factory_girl No database_cleaner Testing Service Oriented Architecture
65. This is why writing tests for SOA is hard especially for applications like Web Client
66. Testing Rails SOA in the real world
67. ! ! ! Other ? Strategies
68. No tests ! ! ! Other ? Strategies
69. No tests ! ! ! Other ? Strategies
70. No tests Stub HTTP requests from Web Client to School API ! ! ! ! Other ? Strategies
71. No tests Stub HTTP requests from Web Client to School API Make HTTP requests from Web Client to School API and seed School API test database ! ! Other ? Strategies
72. No tests Stub HTTP requests from Web Client to School API Make HTTP requests from Web Client to School API and seed School API test database Create/destroy data using School API’s API ! Other ? Strategies
73. My experience with SOA
74. / \ /~- y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ /\ ~\ / \ Y V | \,-^-. | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () / / \ /~-~\ / y Y V ,-^-./ | \,-^- / { | } \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ \/ \/ \ \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \ { \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y ,-^ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V -^-./ | \,-^-. { | } \ \ | / A /\ \/ \ \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^ / { | } \ | /\ A / \ / /\ ~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ \ / .\-/. /\ () () /\ / \ /~-~\ / \ y Y V ,-^-./ | \,-^-. / { | } \ \ | / /\ A /\ / \/ \/ \ / \ My experience with SOA
75. Developing Features for Web Client
76. School API Web client HTTP /JSON Testing Service Oriented Architecture
77. School API Web client HTTP /JSON No factory_girl No database_cleaner Testing Service Oriented Architecture
78. features Unregister student from school
79. features Unregister student from school Display count of registered students
80. features Unregister student from school Display count of registered students View student profile
81. features Unregister student from school Display count of registered students View student profile Edit student profile
82. features Unregister student from school Display count of registered students View student profile Edit student profile
83. Stub HTTP Requests from Web Client to School API Strategy #1
84. Strategy #1 Stub HTTP Requests from Web Client to School API
85. Web Client Dev:
86. Web Client Dev: Finished the feature. Tests are green.
87. Web Client Dev: Finished the feature. Tests are green. School API Dev:
88. Web Client Dev: Finished the feature. Tests are green. School API Dev: Great!
89. Web Client Dev: Finished the feature. Tests are green. School API Dev: Great! Web Client Dev:
90. Web Client Dev: Finished the feature. Tests are green. School API Dev: Great! Web Client Dev: I deployed. I also told the customer.
91. Web Client Dev: Finished the feature. Tests are green. School API Dev: Great! Web Client Dev: I deployed. I also told the customer. Customer:
92. Web Client Dev: Finished the feature. Tests are green. School API Dev: Great! Web Client Dev: I deployed. I also told the customer. Customer: The site is down :/
93. Web Client Dev:
94. Web Client Dev: What!? My tests were green.
95. School API Dev: Web Client Dev: What!? My tests were green.
96. School API Dev: I renamed /pupils to /students Web Client Dev: What!? My tests were green.
97. School API Dev: I renamed /pupils to /students School API Dev: Web Client Dev: What!? My tests were green.
98. School API Dev: I renamed /pupils to /students School API Dev: Ooops. I forgot to tell you :( Web Client Dev: What!? My tests were green.
99. School API Dev: I renamed /pupils to /students Web Client Dev: School API Dev: Ooops. I forgot to tell you :( Web Client Dev: What!? My tests were green.
100. School API Dev: I renamed /pupils to /students Web Client Dev: ¯\_(π)_/¯ School API Dev: Ooops. I forgot to tell you :( Web Client Dev: What!? My tests were green.
101. Web Client Dev:
102. Web Client Dev: Tell me when you make changes, please :)
103. School API Dev: Web Client Dev: Tell me when you make changes, please :)
104. School API Dev: It won’t happen again. Promise <3 Web Client Dev: Tell me when you make changes, please :)
105. but, it does.
106. This is WHY you need integration tests in Service Oriented Architecture
107. X Strategy #1 Stub HTTP Requests from Web client to School API
108. Fast X Strategy #1 Stub HTTP Requests from Web client to School API
109. False confidence Fast X Strategy #1 Stub HTTP Requests from Web client to School API
110. False confidence Fast X Strategy #1 Stub HTTP Requests from Web client to School API
111. features Unregister student from school Display count of registered students View student profile Edit student profile
112. Web Client dev no longer trusts the Web Client’s test suite. Problem with previous strategy:
113. Solution: Make HTTP requests to School API when runnig Web Client’s test suite Web Client dev no longer trusts the Web Client’s test suite. Problem with previous strategy:
114. Strategy #2 Make HTTP requests and seed School API database
115. Strategy #2 Make HTTP requests and seed School API database Seed School API test database
116. Strategy #2 Make HTTP requests and seed School API database Start School API server in test env Seed School API test database
117. Start School API server in test env Web Client issues HTTP requests to School API Seed School API test database Strategy #2 Make HTTP requests and seed School API database
118. 1 test Schools 1 Principals s 1 Students 1 School API Web Client Before
119. Schools 1 Principals s 1 Students 1 #1 School API test db
120. Schools 1 Principals s 1 Students 1 #1 School API test db
121. Schools 1 Principals s 1 Students 0 #1 School API test db
122. Schools 1 Principals s 1 Students 0 #1 School API test db Passing!
123. 1 test Schools 1 Principals s 1 Students 0 School API Web Client 1 passing After
124. features Unregister student from school Display count of registered students View student profile Edit student profile
125. 2 tests Schools 1 Principals s 1 Students 1 School API Web Client Before
126. Schools 1 Principals s 1 Students 0 #1 School API test db Passing!
127. #2 Schools 1 Principals s 1 Students 0 School API test db
128. #2 Schools 1 Principals s 1 Students 0 School API test db
129. #2 Schools 1 Principals s 1 Students 0 School API test db FAILS!
130. There has to be a better way
131. X Seed School API db AND issue HTTP requests Strategy #2
132. Confidence X Seed School API db AND issue HTTP requests Strategy #2
133. Manage School API server Confidence X Seed School API db AND issue HTTP requests Strategy #2
134. Manage School API server Bleed state between tests Confidence X Seed School API db AND issue HTTP requests Strategy #2
135. Problem with previous strategy Frequently updating seed data for School API test database
136. Problem with previous strategy Solution Create the test data needed for each test Frequently updating seed data for School API test database when each test is run
137. Create test data using School API’s API Strategy #3
138. Create test data using School API’s API Strategy #3 Start School API server in test env
139. Create test data using School API’s API Strategy #3 Start School API server in test env Web Client issues HTTP requests to School API
140. features Unregister student from school Display count of registered students View student profile Edit student profile
141. Customer:
142. Customer: You there?
143. Customer: Web Client Dev: You there?
144. Customer: Web Client Dev: You there? Yep, need something?
145. Customer: Web Client Dev: You there? Yep, need something? Customer:
146. Customer: Web Client Dev: You there? Yep, need something? Customer: I forgot to mention, you can NOT create a school through School API public API.
147. Can NOT use Strategy #3
148. Can NOT use
149. X Strategy #3 Create test data using School API’s API
150. Confidence X Strategy #3 Create test data using School API’s API
151. Manage School API server Confidence X Strategy #3 Create test data using School API’s API
152. Manage School API server Not possible ! Confidence X Strategy #3 Create test data using School API’s API
153. Manage School API server Not possible Creating complex data associations ! Confidence X Strategy #3 Create test data using School API’s API
154. Manage School API server Not possible Creating complex data associations Bleed state between tests Confidence X Strategy #3 Create test data using School API’s API
155. Problem with previous strategy Can not create school with School API’s API
156. Problem with previous strategy Solution Create a school, but with School API’s API Can not create school with School API’s API
157. We need a Strategy #4
158. I want to create test data in School API test database with factory_girl from the Web Client
161. remote_factory_girl Strategy #4
162. remote_factory_girl Strategy #4 Install remote_factory_girl_home_rails in School API
163. Gemfile School API
164. config/environments/test.rb School API
165. config/routes.rb School API
166. remote_factory_girl Strategy #4 Install remote_factory_girl_home_rails in School API Install remote_factory_girl in Web Client
167. Gemfile Web Client
168. spec/spec_helper.rb Web Client
169. spec/spec_helper.rb client
170. spec/spec_helper.rb client
171. remote_factory_girl Strategy #4 Start School API server in test env Install remote_factory_girl_home_rails in School API Install remote_factory_girl in Web Client
172. remote_factory_girl Strategy #4 Start School API server in test env Web Client issues HTTP requests to School API Install remote_factory_girl_home_rails in School API Install remote_factory_girl in Web Client
173. features Unregister student from school Display count of registered students View student profile Edit student profile
174. 2 tests Schools 0 Principals s 0 Students 0 School API Web Client Before
175. #1 Schools 0 Principals s 0 Students 0 School API test db
176. #1 Schools 1 Principals s 1 Students 1 School API test db
177. #1 Schools 1 Principals s 1 Students 0 School API test db
178. #1 Schools 1 Principals s 1 Students 0 School API test db
179. Passing! #1 Schools 1 Principals s 1 Students 0 School API test db
180. #2 Schools 1 Principals s 1 Students 0 School API test db
181. #2 Passing! Schools 2 Principals s 2 Students 0 School API test db
182. 2 tests Schools 2 Principals s 2 Students 0 School API Web Client 2 passing After
183. Features Unregister student from school Display count of registered students View student profile Edit student profile
184. 3 tests School API Web Client Before Schools 0 Principals s 0 Students 0
185. #1 Schools 1 Principals s 1 Students 0 School API test db Passing!
186. #2 Schools 2 Principals s 2 Students 0 School API test db Passing!
187. #3 Passing! Schools 3 Principals s 3 Students 1 School API test db
188. 3 tests Schools 3 Principals s 3 Students 1 School API Web Client 3 passing After
189. Customer:
190. Customer: You there?
191. Customer: School API Dev: You there?
192. Customer: School API Dev: You there? Yep, need something?
193. Customer: You there? Yep, need something? Customer: School API Dev:
194. Customer: You there? Yep, need something? Customer: Student emails have to be UNIQUE. School API Dev:
195. Customer: You there? Yep, need something? Customer: Student emails have to be UNIQUE. School API Dev: School API Dev:
196. Customer: You there? Yep, need something? Customer: Student emails have to be UNIQUE. School API Dev: Ok. Not a problem. School API Dev:
197. features Unregister student from school Display count of registered students View student profile Edit student profile
198. 4 tests Schools 0 Principals s 0 Students 0 School API Web Client Before
199. #1 Schools 1 Principals s 1 Students 0 School API test db Passing!
200. #2 Schools 2 Principals s 2 Students 0 School API test db Passing!
201. #3 Passing! Schools 3 Principals s 3 Students 1 School API test db
202. #4 FAILS! Schools 3 Principals s 3 Students 1 School API test db student email has to be unique
203. There has to be a better way
204. X remote_factory_girl Strategy #4
205. Confidence ! X remote_factory_girl Strategy #4
206. Confidence Create complex test data ! X remote_factory_girl Strategy #4
207. Confidence Create complex test data Create data not available through API X remote_factory_girl Strategy #4
208. Manage School API server ! Confidence Create complex test data Create data not available through API X remote_factory_girl Strategy #4
209. Manage School API server Bleed state between tests Confidence Create complex test data Create data not available through API X remote_factory_girl Strategy #4
210. Problem with previous strategy State in School API test database persists between tests in Web Client
211. Problem with previous strategy Solution Destroy test data after each test with remote_database_cleaner State in School API test database persists between tests in Web Client
212. remote_database_cleanear Strategy #5
213. remote_database_cleanear Strategy #5 Install remote_database_cleaner_home_rails in School API
214. Gemfile School API
215. config/environments/test.rb School API
216. config/routes.rb School API
217. remote_database_cleanear Strategy #5 Install remote_database_cleaner_home_rails in School API Install remote_database_cleaner in Web Client
218. Gemfile Web Client
219. spec/spec_helper.rb Web Client
220. spec/spec_helper.rb Web Client
221. spec/spec_helper.rb Web Client
222. spec/spec_helper.rb Web Client
223. spec/spec_helper.rb Web Client
224. spec/spec_helper.rb Web Client
225. remote_database_cleanear Strategy #5 Start School API server in test env Install remote_database_cleaner_home_rails in School API Install remote_database_cleaner in Web Client
226. remote_database_cleanear Strategy #5 Start School API server in test env Install remote_database_cleaner_home_rails in School API Install remote_database_cleaner in Web Client Web Client issues HTTP requests to School API
227. features Unregister student from school Display count of registered students View student profile Edit student profile
228. 4 tests Schools 0 Principals s 0 Students 0 School API Web Client Before
229. #1 Schools 0 Principals s 0 Students 0 School API test db Passing!
230. #2 Passing! Schools 0 Principals s 0 Students 0 School API test db
231. #3 Passing! Schools 0 Principals s 0 Students 0 School API test db
232. #4 Schools 0 Principals s 0 Students 0 School API test db Passing!
233. 4 tests Schools 0 Principals s 0 Students 0 School API Web Client 4 passing After
234. X remote_database_cleaner Strategy #4
235. Does not bleed state between tests ! X remote_database_cleaner Strategy #4
236. Manage School API server ! Does not bleed state between tests ! X remote_database_cleaner Strategy #4
237. Now the applications are also setup for Continuous Integration - Jenkins
238. The Takeaway Integration tests give us more confidence in SOA
239. The Takeaway Integration tests give us more confidence in SOA Requires more setup initially
240. The Takeaway Integration tests give us more confidence in SOA Requires more setup initially
241. The Takeaway Integration tests give us more confidence in SOA Requires more setup initially But, pays dividends in the long run
242. blog: http://www.bignerdranch.com/blog/testing-rails-service-oriented-architecture/ example: https://github.com/tdouce/soa_integration_testing
243. What are Monolithic Applications?
244. What are Monolithic Applications? What is SOA?
245. What are Monolithic Applications? What is SOA? Testing Monolithic Applications
246. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA !
247. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA
248. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA Strategies for Testing SOA
249. What are Monolithic Applications? What is SOA? Testing Monolithic Applications Testing SOA Challenges with Testing SOA Strategies for Testing SOA Develop Features for SOA application
250. Questions?