Project

General

Profile

Wiki » History » Version 13

okurz, 2016-02-03 10:22
Add proposals for ticket templates

1 3 okurz
# Introduction
2 1 alarrosa
3 3 okurz
This is the organisation wiki for the **openQA Project**.
4 1 alarrosa
5 3 okurz
# Organisational
6 1 alarrosa
7 3 okurz
## openQA calls
8
9
Currently there are two recurring openQA calls conducted at SUSE on http://jangouts.suse.de/. If there would be more interest from the outside the call could be made on a public platform.
10
11
Both meetings should target to finish in 15 minutes each. If more time is needed, propose to stay in the call with the required subset of attendees.
12
13
Standard rules of good "standup meetings" apply here, too, e.g.
14
15
* Be on time (be there at meeting start)
16
* Be concise (help keep the time limit)
17
* Be polite
18
* focus on
19
 * what you achieved
20
 * what you plan
21
 * where did you face problems where you could use help
22
23
24
### "openQA backend coordination" call
25
26
**objectives**:
27
28
* Coordination on openQA backend development
29
30
**execution**: A regular daily call from Mon-Fri at 0900 UTC
31
32
33
### "SUSE QA test coordination" call
34
35
**objectives**:
36
37
* Coordination on openQA based test development, especially SLE products
38
* Information about important development in openQA backend by backend responsibles
39
40
**execution**: Mon + Wed, at 0930 UTC
41
42
If somebody from SUSE QA team will do back-end development he can attend the first call as well, of course.
43
44
45 13 okurz
## ticket templates
46
You can use these templates to fill in tickets and further improve them with more detail over time. Copy the code block, paste it into a new issue, replace every block marked with "<…>" with your content or delete if not appropriate.
47
48
49
### defects
50
51
Subject: `<Short description, example: "openQA dies when triggering any Windows ME tests">`
52
53
54
```
55
## observation
56
<description of what can be observed and what the symptoms are, provide links to failing test results and/or put short blocks from the log output here to visualize what is happening>
57
58
## steps to reproduce
59
* <do this>
60
* <do that>
61
* <observe result>
62
63
## problem
64
<problem investigation, can also include different hypotheses, should be labeled as "H1" for first hypothesis, etc.>
65
66
## suggestion
67
<what to do as a first step>
68
69
## workaround
70
<example: retrigger job>
71
```
72
73
example ticket: #10526
74
75
### feature requests
76
77
Subject: `<Short description, example: "grub3 btrfs support" (feature)>`
78
79
80
```
81
## User story
82
<As a <role>, I want to <do an action>, to <achieve which goal> >
83
84
## acceptance criteria
85
* <**AC1:** the first acceptance criterion that needs to be fulfilled to do this, example: Clicking "restart button" causes restart of the job>
86
* <**AC2:** also think about the "not-actions", example: other jobs are not affected>
87
88
## tasks
89
* <first task to do as an easy starting point>
90
* <what do do next>
91
* <optional: mark "optional" tasks>
92
93
## further details
94
<verything that does not fit into above sections>
95
```
96
97
example ticket: #10212
98
99 4 okurz
# User stories
100
101 7 okurz
## User story 1
102 6 okurz
**User:** QA-Project Managment
103 4 okurz
**primary actor:** QA Project Manager, QA Team Leads
104
**stakeholder:** Directors, VP
105 1 alarrosa
**trigger:** product milestones, providing a daily status
106 7 okurz
**user story:** „As a QA project manager I want to check on a daily basis the „openQA Dashboard“ to get a summary/an overall status of the „reviewers results“ in order to take the right actions and prioritize tasks in QA accordingly.“
107 1 alarrosa
	
108 7 okurz
## User story 2
109 4 okurz
**User:** openQA-Admin
110
**primary actor:** Backend-Team
111 1 alarrosa
**stakeholder:** Qa-Prjmgr, QA-TL, openQA Tech-Lead
112 4 okurz
**trigger:** Bugs, features, new testcases
113 7 okurz
**user story:** „As an openQA admin I constantly check in the web-UI the system health and I manage its configuration to ensure smooth operation of the tool.“
114 5 okurz
115 7 okurz
## User story 3
116 1 alarrosa
**User:** QA-Reviewer
117
**primary actor:** QA-Team
118
**stakeholder:** QA-Prjmgr, Release-Mgmt, openQA-Admin
119 4 okurz
**trigger:** every new build
120 7 okurz
**user story:** „As an openQA-Reviewer at any point in time I review on the webpage of openQA the overall status of a build in order to track and find bugs, because I want to find bugs as early as possible and report them.“
121
122
## User story 4
123 1 alarrosa
**User:** Testcase-Contributor
124
**primary actor:** All development teams, Maintenance QA
125 4 okurz
**stakeholder:** QA-Reviewer, openQA-Admin, openQA Tech-Lead
126 5 okurz
**trigger:** features, new functionality, bugs, new product/package
127 1 alarrosa
**user story:** 4. „As developer when there are new features, new functionality, bugs, new product/package in git I contribute my testcases because I want to ensure good quality submissions and smooth product integration.“
128 7 okurz
129
## User story 5
130 4 okurz
**User:** Release-Mgmt
131
**primary actor:** Release Manager
132
**stakeholder:** Directors, VP, PM, TAMs, Partners
133 1 alarrosa
**trigger:** Milestones
134 7 okurz
**user story:** „As a Release-Manager on a daily basis I check on a dashboard for the product health/build status in order to act early in case of failures and have concrete and current reports.“
135
136
## User story 6
137 4 okurz
**User:** Staging-Admin
138
**primary actor:** Staging-Manager for the products
139
**stakeholder:** Release-Mgmt, Build-Team
140
**trigger:** every single submission to projects
141 8 okurz
**user story:** „As a Staging-Manager I review the build status of packages with every staged submission to the „staging projects“ in the „staging dashboard“ and the test-status of the pre-integrated fixes, because I want to identify major breakage before integration to the products and provide fast feedback back to the development.“
142
143
# Thoughts about categorizing test results, issues, states within openQA
144
by okurz
145
146
When reviewing test results it is important to distinguish between different causes of "failed tests"
147
148
## Nomenclature
149
150
### Test status categories
151 10 okurz
A common definition about the status of a test regarding the product it tests: "false|true positive|negative" as described on https://en.wikipedia.org/wiki/False_positives_and_false_negatives. "positive|negative" describes the outcome of a test ("positive": PASSED; "negative": FAILED) whereas "false|true" describes the conclusion of the test regarding the presence of issues in the SUT or product in our case ("true": correct reporting; "false": incorrect reporting), e.g. "true negative", test successful, no issues detected and there are no issues, product is working as expected by customer. Another example: Think of testing as of a fire alarm. An alarm (event detector) should only go off (be "positive") *if* there is a fire (event to detect) --> "true positive" whereas *if* there is *no* fire there should be *no* alarm --> "true negative".
152 1 alarrosa
153 10 okurz
Another common but potentially ambiguous categorization:
154 1 alarrosa
155 10 okurz
* *broken*: the test is not behaving as expected (Ambiguity: "as expected" by whom?) --> commonly a "false positive", can also be "false negative" but hard to detect
156
* *failing*: the test is behaving as expected, but the test output is a fail --> "true positive"
157
* *working*: the test is behaving as expected (with no comment regarding the result, though some might ambiguously imply 'result is negative')
158
* *passing*: the test is behaving as expected, but the result is a success --> "true negative"
159
160 8 okurz
If in doubt declare a test as "broken". We should review the test and examine if it is behaving as expected.
161 9 okurz
162 10 okurz
Be careful about "positive/negative" as some might also use "positive" to incorrectly denote a passing test (and "negative" for failing test) as an indicator of "working product" not an indicator about "issue present". If you argue what is "used in common speech" think about how "false positive" is used as in "false alarm" --> "positive" == "alarm raised", also see https://narainko.wordpress.com/2012/08/26/understanding-false-positive-and-false-negative/
163 8 okurz
164
### Priorization of work regarding categories
165 10 okurz
In this sense development+QA want to accomplish a "true negative" state whenever possible (no issues present, therefore none detected). As QA and test developers we want to prevent "false positives" ("false alarms" declaring a product as broken when it is not but the test failed for other reasons), also known as "type I error" and "false negatives" (a product issue is not catched by tests and might "slip through" QA and at worst is only found by an external outside customer) also known as "type II error". Also see https://en.wikipedia.org/wiki/Type_I_and_type_II_errors. In the context of openQA and system testing paired with screen matching a "false positive" is much more likely as the tests are very susceptible to subtle variations and changes even if they should be accepted. So when in doubt, create an issue in progress, look at it again, and find that it was a false alarm, rather than wasting more peoples time with INVALID bug reports by believing the product to be broken when it isn't. To quote Richard Brown: "I […] believe this is the route to ongoing improvement - if we have tests which produce such false alarms, then that is a clear indicator that the test needs to be reworked to be less ambiguous, and that IS our job as openQA developers to deal with".
166 3 okurz
167 11 okurz
## Further categorization of statuses, issues and such in testing, especially automatic tests
168
By okurz
169
170
This categorization scheme is meant to help in communication in either written or spoken discussions being simple, concise, easy to remember while unambiguous in every case.
171
While used for naming it should also be used as a decision tree and can be followed from the top following each branch.
172
173
### Categorization scheme
174
175
To keep it simple I will try to go in steps of deciding if a potential issue is of one of two categories in every step (maybe three) and go further down from there. The degree of further detailing is not limited, i.e. it can be further extended. Naming scheme should follow arabic number (for two levels just 1 and 2) counting schemes added from the right for every additional level of decision step and detail without any separation between the digits, e.g. "1111" for the first type in every level of detail up to level four. Also, I am thinking of giving the fully written form phonetic name to unambiguously identify each on every level as long as not more individual levels are necessary. The alphabet should be reserved for higher levels and higher priority types.
176
Every leaf of the tree must have an action assigned to it.
177
178 12 okurz
1 **failed** (ZULU)
179 11 okurz
11 new (passed->failed) (YANKEE)
180
111 product issue ("true positive") (WHISKEY)
181
1111 unfiled issue (SIERRA)
182
11111 hard issue (KILO)
183
111121 critical / potential ship stopper (INDIA) --> immediately file bug report with "ship_stopper?" flag; opt. inform RM directly
184
111122 non-critical hard issue (HOTEL) --> file bug report
185
11112 soft issue (JULIETT) --> file bug report
186
1112 bugzilla bug exists (ROMEO)
187
11121 bug was known to openqa / openqa developer --> cross-reference (bug->test, test->bug) AND raise review process issue, improve openqa process
188
11122 bug was filed by other sources (e.g. beta-tester) --> cross-reference (bug->test, test->bug)
189
112 test issue ("false positive") (VICTOR)
190
1121 progress issue exists (QUEBEC) --> cross-reference (issue->test, test->issue)
191
1122 unfiled test issue (PAPA)
192
11221 easy to do w/o progress issue
193
112211 need needles update --> re-needle if sure, TODO how to notify?
194
112212 pot. flaky, timeout
195
1122121 retrigger yields PASS --> comment in progress about flaky issue fixed
196
1122122 reproducible on retrigger --> file progress issue
197
11222 needs progress issue filed --> file progress issue
198
12 existing / still failing (failed->failed) (XRAY)
199
121 product issue (UNIFORM)
200
1211 unfiled issue (OSCAR) --> file bug report AND raise review process issue (why has it not been found and filed?)
201
1212 bugzilla bug exists (NOVEMBER) --> ensure cross-reference, also see rules for 1112 ROMEO
202
122 test issue (TANGO)
203
1221 progress issue exists (MIKE) --> monitor, if persisting reprioritize test development work
204
1222 needs progress issue filed (LIMA) --> file progress issue AND raise review process issue, see 1211 OSCAR
205 12 okurz
2 **passed** (ALFA)
206 11 okurz
21 stable (passed->passed) (BRAVO)
207
211 existing "true negative" (DELTA) --> monitor, maybe can be made stricter
208
212 existing "false negative" (ECHO) --> needs test improvement
209
22 fixed (failed->passed) (CHARLIE)
210
222 fixed "true negative" (FOXTROTT) --> TODO split monitor, see 211 DELTA
211
2221 was test issue --> close progress issue
212
2222 was product issue
213
22221 no bug report exists --> raise review process issue (why was it not filed?)
214
22222 bug report exists
215
222221 was marked as RESOLVED FIXED
216
221 fixed but "false negative" (GOLF) --> potentially revert test fix, also see 212 ECHO
217
218
219
Priority from high to low: INDIA->OSCAR->HOTEL->JULIETT->…
220
221
### Further decision steps working on test issues
222
223
Test issues could be one of the following sources
224
225
* "accepted product changes"
226
 * product changed slightly but in an acceptable way without the need for communication with DEV+RM --> adapt test
227
 * product changed slightly but in an acceptable way found after feedback from RM --> adapt test
228
 * product changed significantly --> after approval by RM adapt test
229
230
* changes in test setup, e.g. our test hardware equipment behaves different or the network
231
* changes in test infrastructure software, e.g. os-autoinst, openQA
232
* changes in test management configuration, e.g. openQA database settings
233
* changes in the test software itself
234
235 3 okurz
# Old content
236
## Sprints
237 2 okurz
238 1 alarrosa
239
[[Sprint 01]]
240
[[Sprint 02]]
241
[[Sprint 03]]