Testing Essentials - Bug Report Requirements — Transcript

Full transcript

1. 0:01[Music]
2. 0:05hi this is Marcus and today we will be
3. 0:08talking about buck report quality to be
4. 0:11exact we will talk about requirements
5. 0:14that you need to follow in order to get
6. 0:16your back report approved by our team
7. 0:18leaders before I show you the bug report
8. 0:21form all of its input fields and before
9. 0:24I talk about all the requirements for
10. 0:26each of those fields let's go and find a
11. 0:29buck I will use this exemplary buck to
12. 0:32show and explain to you how it should be
13. 0:34documented according to our rules now
14. 0:37let's go and find a buck that we can use
15. 0:39in the test that you currently see on
16. 0:42your screen you are asked to test the
17. 0:45test our website here's the URL when you
18. 0:49visit this URL you will be redirected to
19. 0:51this website now we want to test the
20. 0:55become a tester workflow which can be
21. 0:59found at the very top of the page in the
22. 1:01header navigation when you click on this
23. 1:04button you will be redirected to this
24. 1:07page now now when we click on the signup
25. 1:10button we expect that the registration
26. 1:13form will become accessible and we can
27. 1:15sign up as a tester but when we click on
28. 1:18it we will realize that the same page
29. 1:21reloads and nothing happened besides
30. 1:23that so we cannot sign up as a new
31. 1:25tester that's actually a critical bug
32. 1:28for a platform that tries to acquire new
33. 1:30testers let's go back and document that
34. 1:35bug now at the very bottom of the page
35. 1:38you will see three features the correct
36. 1:41one for our bug is become a tester
37. 1:43because we tested this section so we
38. 1:46have to click on the submit back button
39. 1:48to open the bug report form
40. 1:50the next step is to select the right
41. 1:52back type for oboe
42. 1:54since only functional box rep being
43. 1:57asked for in this test we can only
44. 1:58select functional in the drop-down menu
45. 2:01for functional bugs you will also be
46. 2:04asked to select a severity that fits
47. 2:06them we have three levels we have low
48. 2:09high or critical since we already
49. 2:12decided that this must be a critical bug
50. 2:14let's select critical in the next field
51. 2:17you will be asked to give your bug
52. 2:19report a title the title is one of the
53. 2:22most important fields of the whole
54. 2:24report because it's the first thing that
55. 2:26somebody reads and it's also important
56. 2:29because bug reports are distinguished by
57. 2:31the title so if your title is not
58. 2:33descriptive enough or too general then
59. 2:36people will not be able to distinguish
60. 2:38between different bug reports and will
61. 2:40be forced to read through all of its
62. 2:42details which should of course not be
63. 2:44the case titles should be precise
64. 2:48detailed enough but not too long at the
65. 2:50same time what information should be
66. 2:53included are the concerned elements this
67. 2:56could for example be at the search field
68. 2:58also what functionality is broken and
69. 3:02the origin of for our given buck let's
70. 3:05see if we can come up with a title that
71. 3:07satisfies all of these requirements what
72. 3:10about this one button does not work so
73. 3:16put yourself in the shoes of a reader
74. 3:18who has never seen your bug report and
75. 3:21who does not know what the problem is
76. 3:23so when reading button does not work the
77. 3:26reader does not know anything about the
78. 3:28bug besides that a button is concerned
79. 3:32and that something is not working now it
80. 3:35doesn't say anything about what button
81. 3:37it is and what doesn't work and what the
82. 3:39consequences are let's see if we can add
83. 3:42the missing information what about this
84. 3:44one
85. 3:45button signup does not react after
86. 3:50clicking on it okay not bad we added
87. 3:55some information now we know what the
88. 3:57button label is it's signup and we know
89. 4:00that we clicked on it and we know it
90. 4:02doesn't react but there's one thing
91. 4:05missing and that's the consequence let's
92. 4:08try a different one
93. 4:11registration impossible because signup
94. 4:15button does not react I think that's a
95. 4:19pretty good one we have all the
96. 4:22information we need we know what element
97. 4:24is concerned it's it's the button we
98. 4:26know which button it is we know what you
99. 4:29did you clicked on it it doesn't react
100. 4:31and the consequence the registration is
101. 4:34impossible so that's all we need another
102. 4:38bad example by the way would be
103. 4:40registration is not possible our
104. 4:42registration does not work again we know
105. 4:45ok the registration is concerned but we
106. 4:47don't know what you did and what the
107. 4:49actual problem is summing up here are
108. 4:53five things that you should keep in mind
109. 4:54when trying to come up with a good luck
110. 4:57report title number one as a rule of
111. 5:01thumb your title should be as short as
112. 5:03possible but as long as necessary your
113. 5:06title is a summary of the problem number
114. 5:09two describe what is happening and not
115. 5:11what is not happening when you say
116. 5:13something does not work you describe
117. 5:15what is not happening and that doesn't
118. 5:17really help number three does not work
119. 5:20and any variations of it are not allowed
120. 5:24number four if a bug only occurs under
121. 5:27some conditions these conditions must be
122. 5:30included in the title so for example if
123. 5:33you have to enter a specific age or if
124. 5:36you have to check a certain filter for
125. 5:39the buck to appear then this condition
126. 5:41must be named in the title number five
127. 5:44write a title read it out loud
128. 5:46and if you don't understand it without
129. 5:48any further information adjust it
130. 5:53let's move on to the next field the URL
131. 5:56field only needs to be filled out if you
132. 5:58test a website which is the case for
133. 6:00Auerbach if you test the mobile app
134. 6:03instead then you can just leave it blank
135. 6:04because there is no URL so for our bug
136. 6:09we just go to the URL bar we copy and
137. 6:13paste it into the field that's all we
138. 6:16have to do the URL needs to be the URL
139. 6:19of the page where the bug occurs on in
140. 6:25the step section you have to provide a
141. 6:27detailed step-by-step guide about what
142. 6:29steps you performed to reach the puck
143. 6:31the very first step always has to start
144. 6:34with the given test environment if you
145. 6:37test the website that's the test URL in
146. 6:40our case test dot IO but if you test an
147. 6:44app it is the app name you describe the
148. 6:46launch of the app afterwards you have to
149. 6:51provide all steps that you took from
150. 6:53there what buttons you press what links
151. 6:55you follow and what you enter at the
152. 6:58very end your last step must describe
153. 7:00the action that you perform that finally
154. 7:03triggers the bug so after your last step
155. 7:06the bug must appear for our bug the
156. 7:10first step should be something like this
157. 7:12open the web site and now we have to
158. 7:15paste the test environment URL which
159. 7:18happens to be the same as the landline
160. 7:20page so we just copy and paste it into
161. 7:23the first step now what we did is we
162. 7:26clicked on the become a tester button in
163. 7:30the header so let's describe that click
164. 7:33on become a test in the header and our
165. 7:40final step was to click on the signup
166. 7:42button so click on the signup but
167. 7:49so that's our last step and after
168. 7:51clicking on the signup button our bug
169. 7:53occurs because nothing happens but does
170. 7:56not react
171. 7:58please note two more things one try to
172. 8:02phrase your steps as general as possible
173. 8:04so if details are not relevant then just
174. 8:07don't mention them for example if you
175. 8:10cannot add a product to the cart in a
176. 8:12webshop and this happens for all
177. 8:15products then you don't need to write
178. 8:17down what product overview page you
179. 8:19visit it and what product detail page
180. 8:22you clicked on and number two
181. 8:24please use realistic names if you have
182. 8:28to provide details so for example if
183. 8:30you're asked to provide what's
184. 8:32credential to use your username or
185. 8:35password then please use names that are
186. 8:39actual words and not something that you
187. 8:41smashed into your keyboard to describe
188. 8:45the result we actually have two fields
189. 8:48the expected result fields which should
190. 8:51describe fixed your expectation after
191. 8:53performing a last step and the actual
192. 8:56result fields to describe what happened
193. 8:59instead so that's the field while you
194. 9:01describe your bug in detail so let's
195. 9:04start with the expected results after
196. 9:07clicking on the sign up button we did
197. 9:09expect that the registration process
198. 9:12would start and that the registration
199. 9:15form would show up so let's let's write
200. 9:17that down the registration form opens
201. 9:21and the registration process starts
202. 9:27and what happened instead was that
203. 9:31nothing happens the button did not react
204. 9:44hence I am not able to register as a
205. 9:49tester as a test I Oh make sure that
206. 9:55you're expected to result in your actual
207. 9:57result apart actually different it
208. 9:59doesn't make any sense if both of them
209. 10:01just differ by one or a few words your
210. 10:06expectation is completely different from
211. 10:07what you described as the buck the extra
212. 10:12result field is probably the most
213. 10:14important field of your buck report so
214. 10:17make sure to spend extra time when
215. 10:19describing your buck here you also make
216. 10:22examples and are very specific so that
217. 10:25the reader understands the full extent
218. 10:28of the problem moving on to the next
219. 10:32fields here we are asked to provide a
220. 10:34tag or multiple tags but you can
221. 10:36actually leave that field blank because
222. 10:39it's a deeper kada feature and we are no
223. 10:42longer using it at least for the moment
224. 10:45the next field asks you to upload
225. 10:48attachments such as screenshots
226. 10:50screencasts and crash locks if you
227. 10:53report in a crash for this demonstration
228. 10:56I already recorded a screencast and will
229. 10:59now upload it to the report
230. 11:08the last thing you have to specify is
231. 11:11what device and browser you used usually
232. 11:13in most tests you will only be able to
233. 11:15select one device because you are
234. 11:17invited for a specific device in that
235. 11:19case you only have to select the browser
236. 11:21for the only available device let's
237. 11:25pretend we use Google Chrome so let me
238. 11:27click on that and now we can submit the
239. 11:29form perfect here it is we made it there
240. 11:41is one more rule that I would like to
241. 11:42explain it's called the straight
242. 11:44rejection rule test IO expects you to
243. 11:47invest enough time in the documentation
244. 11:49of your bug reports if your report does
245. 11:51not meet the requirements then it might
246. 11:53get rejected in general our Academy
247. 11:57article contains more examples and
248. 11:59further information about some of the
249. 12:01aspects we talked about today so it's
250. 12:03definitely a good idea to check it out
251. 12:05thanks for watching and hope to see you
252. 12:07in some of our other videos