Project

General

Profile

Wiki » History » Version 52

okurz, 2016-12-21 21:00
add notice that labels are not automatically carried over (anymore)

1 3 okurz
# Introduction
2 1 alarrosa
3 3 okurz
This is the organisation wiki for the **openQA Project**.
4 49 okurz
The source code is hosted in the [os-autoinst github project](http://github.com/os-autoinst/), especially [openQA itself](http://github.com/os-autoinst/openQA) and the main backend [os-autoinst](http://github.com/os-autoinst/os-autoinst)
5 1 alarrosa
6 48 okurz
If you are interested in the tests for SUSE/openSUSE products take a look into the [openqatests](https://progress.opensuse.org/projects/openqatests) project.
7
8 14 okurz
{{toc}}
9
10 3 okurz
# Organisational
11 1 alarrosa
12 51 okurz
## ticket workflow
13
14
The following ticket statuses are used together and their meaning is explained:
15
16
* *New*: No one has worked on the ticket or no one is feeling responsible for the work on this ticket
17
* *In Progress*: Any state between *New* and *Resolved*
18
* *Resolved*: The complete work on this issue is done and the according issue is supposed to be fixed as observed (Should be updated together with a link to a merged pull request or also a link to an production openQA showing the effect)
19
* *Feedback*: Further work on the ticket is blocked by external dependency or open points. Sometimes also used to ask Assignee about progress on inactivity
20
* *Rejected*: The issue is considered invalid, should not be done, is considered out of scope.
21
* *Closed*: As this can be set only by administrators it is suggested to not use this status.
22
23
It is good practice to update the status together with a comment about it, e.g. a link to a pull request or a reason for reject.
24
25 3 okurz
## openQA calls
26
27
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.
28
29
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.
30
31
Standard rules of good "standup meetings" apply here, too, e.g.
32
33
* Be on time (be there at meeting start)
34
* Be concise (help keep the time limit)
35
* Be polite
36
* focus on
37
 * what you achieved
38
 * what you plan
39
 * where did you face problems where you could use help
40
41
42
### "openQA backend coordination" call
43
44
**objectives**:
45
46
* Coordination on openQA backend development
47
48 39 okurz
**execution**: A regular daily call from Mon-Fri at 1000 CET/CEST
49 3 okurz
50
51
### "SUSE QA test coordination" call
52
53
**objectives**:
54
55
* Coordination on openQA based test development, especially SLE products
56
* Information about important development in openQA backend by backend responsibles
57
58 39 okurz
**execution**: Mon + Wed, at 1030 CET/CEST
59 3 okurz
60
If somebody from SUSE QA team will do back-end development he can attend the first call as well, of course.
61
62 13 okurz
## ticket templates
63
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.
64
65
66
### defects
67
68
Subject: `<Short description, example: "openQA dies when triggering any Windows ME tests">`
69
70
71
```
72
## observation
73
<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>
74
75
## steps to reproduce
76
* <do this>
77
* <do that>
78
* <observe result>
79
80
## problem
81
<problem investigation, can also include different hypotheses, should be labeled as "H1" for first hypothesis, etc.>
82
83
## suggestion
84
<what to do as a first step>
85
86
## workaround
87
<example: retrigger job>
88
```
89
90
example ticket: #10526
91
92
### feature requests
93
94
Subject: `<Short description, example: "grub3 btrfs support" (feature)>`
95
96
97
```
98
## User story
99
<As a <role>, I want to <do an action>, to <achieve which goal> >
100
101
## acceptance criteria
102
* <**AC1:** the first acceptance criterion that needs to be fulfilled to do this, example: Clicking "restart button" causes restart of the job>
103
* <**AC2:** also think about the "not-actions", example: other jobs are not affected>
104
105
## tasks
106
* <first task to do as an easy starting point>
107
* <what do do next>
108
* <optional: mark "optional" tasks>
109
110
## further details
111 17 okurz
<everything that does not fit into above sections>
112 13 okurz
```
113
114
example ticket: #10212
115
116 25 okurz
## pull request handling on github
117
118
As a reviewer of pull requests on github for all related repositories, e.g. https://github.com/os-autoinst/os-autoinst-distri-opensuse/pulls, apply labels in case PRs are open for a longer time and can not be merged so that we keep our backlog clean and know why PRs are blocked.
119
120
* **notready**: Triaged as not ready yet for merging, no (immediate) reaction by the reviewee, e.g. when tests are missing, other scenarios break, only tested for one of SLE/TW
121
* **wip**: Marked by the reviewee itself as "[WIP]" or "[DO-NOT-MERGE]" or similar
122
* **question**: Questions to the reviewee, not answered yet
123
124 28 okurz
# Use cases
125 1 alarrosa
126 40 okurz
The following use cases 1-6 have been defined within a SUSE workshop (others have been defined later) to clarify how different actors work with openQA. Some of them are covered already within openQA quite well, some others are stated as motivation for further feature development.
127 28 okurz
128
## Use case 1
129 6 okurz
**User:** QA-Project Managment
130 4 okurz
**primary actor:** QA Project Manager, QA Team Leads
131 1 alarrosa
**stakeholder:** Directors, VP
132
**trigger:** product milestones, providing a daily status
133 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.“
134 1 alarrosa
	
135 28 okurz
## Use case 2
136 4 okurz
**User:** openQA-Admin
137 1 alarrosa
**primary actor:** Backend-Team
138
**stakeholder:** Qa-Prjmgr, QA-TL, openQA Tech-Lead
139 4 okurz
**trigger:** Bugs, features, new testcases
140 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.“
141 5 okurz
142 28 okurz
## Use case 3
143 1 alarrosa
**User:** QA-Reviewer
144
**primary actor:** QA-Team
145
**stakeholder:** QA-Prjmgr, Release-Mgmt, openQA-Admin
146 4 okurz
**trigger:** every new build
147 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.“
148
149 28 okurz
## Use case 4
150 1 alarrosa
**User:** Testcase-Contributor
151
**primary actor:** All development teams, Maintenance QA
152 4 okurz
**stakeholder:** QA-Reviewer, openQA-Admin, openQA Tech-Lead
153 5 okurz
**trigger:** features, new functionality, bugs, new product/package
154 40 okurz
**user story:** „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.“
155 7 okurz
156 28 okurz
## Use case 5
157 4 okurz
**User:** Release-Mgmt
158
**primary actor:** Release Manager
159
**stakeholder:** Directors, VP, PM, TAMs, Partners
160 1 alarrosa
**trigger:** Milestones
161 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.“
162
163 28 okurz
## Use case 6
164 4 okurz
**User:** Staging-Admin
165
**primary actor:** Staging-Manager for the products
166
**stakeholder:** Release-Mgmt, Build-Team
167 1 alarrosa
**trigger:** every single submission to projects
168
**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.“
169 40 okurz
170
## Use case 7
171
**User:** Bug investigator
172
**primary actor:** Any bug assignee for openQA observed bugs
173
**stakeholder:** Developer
174
**trigger:** bugs
175
**user story:** „As a developer that has been assigned a bug which has been observed in openQA I can review referenced tests, find a newer and the most recent job in the same scenario, understand what changed since the last successful job, what other jobs show same symptoms to investigate the root cause fast and use openQA for verification of a bug fix.“
176 8 okurz
177 15 okurz
# Glossary
178
179
The following terms are used within the context of openQA:
180
181
 * ***test modules***: an individual test case in a single perl module file, e.g. "sshxterm". If not further specified a test module is denoted with its "short name" equivalent to the filename including the test definition. The "full name" is composed of the *test group* (TBC), which itself is formed by the top-folder of the test module file, and the short name, e.g. "x11-sshxterm" (for x11/sshxterm.pm)
182
 * ***test suite***: a collection of *test modules*, e.g. "textmode". All *test modules* within one *test suite* are run serially
183
 * ***job***: one run of individual test cases in a row denoted by a unique number for one instance of openQA, e.g. one installation with subsequent testing of applications within gnome
184
 * ***test run***: equivalent to *job*
185
 * ***test result***: the result of one job, e.g. "passed" with the details of each individual *test module*
186
 * ***test step***: the execution of one *test module* within a *job*
187
 * ***distri***: a test distribution but also sometimes referring to a *product* (CAUTION: ambiguous, historically a "GNU/Linux distribution"), composed of multiple ***test modules*** in a folder structure that compose ***test suites***, e.g. "opensuse" (test distribution, short for "os-autoinst-distri-opensuse")
188
 * ***product***: the main "system under test" (SUT), e.g. "openSUSE"
189
 * ***job group***: equivalent to *product*, used in context of the webUI
190
 * ***version***: one version of a *product*, don't confuse with *builds*, e.g. "Tumbleweed"
191
 * ***flavor***: a specific variant of a *product* to distinguish differing variants, e.g. "DVD"
192 1 alarrosa
 * ***arch***: an architecture variant of a *product*, e.g. "x86_64"
193 22 okurz
 * ***machine***: additional variant of machine, e.g. used for "64bit", "uefi", etc.
194 30 okurz
 * ***scenario***: A composition of `<distri>-<version>-<flavor>-<arch>-<test_suite>@<machine>`, e.g. "openSUSE-Tumbleweed-DVD-x86_64-gnome@64bit", nicknamed *koala*
195 15 okurz
 * ***build***: Different versions of a product as tested, can be considered a "sub-version" of *version*, e.g. "Build1234"; CAUTION: ambiguity: either with the prefix "Build" included or not)
196
197 8 okurz
# Thoughts about categorizing test results, issues, states within openQA
198
by okurz
199
200
When reviewing test results it is important to distinguish between different causes of "failed tests"
201
202
## Nomenclature
203
204
### Test status categories
205 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".
206 1 alarrosa
207 10 okurz
Another common but potentially ambiguous categorization:
208 1 alarrosa
209 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
210
* *failing*: the test is behaving as expected, but the test output is a fail --> "true positive"
211
* *working*: the test is behaving as expected (with no comment regarding the result, though some might ambiguously imply 'result is negative')
212
* *passing*: the test is behaving as expected, but the result is a success --> "true negative"
213
214 8 okurz
If in doubt declare a test as "broken". We should review the test and examine if it is behaving as expected.
215 9 okurz
216 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/
217 8 okurz
218
### Priorization of work regarding categories
219 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".
220 3 okurz
221 11 okurz
## Further categorization of statuses, issues and such in testing, especially automatic tests
222
By okurz
223
224
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.
225
While used for naming it should also be used as a decision tree and can be followed from the top following each branch.
226
227
### Categorization scheme
228
229
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.
230
Every leaf of the tree must have an action assigned to it.
231
232 12 okurz
1 **failed** (ZULU)
233 11 okurz
11 new (passed->failed) (YANKEE)
234
111 product issue ("true positive") (WHISKEY)
235
1111 unfiled issue (SIERRA)
236 44 okurz
11111 hard issue (openqa *fail*) (KILO)
237 11 okurz
111121 critical / potential ship stopper (INDIA) --> immediately file bug report with "ship_stopper?" flag; opt. inform RM directly
238
111122 non-critical hard issue (HOTEL) --> file bug report
239 44 okurz
11112 soft issue (openqa *softfail* on job level, not on module level) (JULIETT) --> file bug report on failing test module
240 11 okurz
1112 bugzilla bug exists (ROMEO)
241
11121 bug was known to openqa / openqa developer --> cross-reference (bug->test, test->bug) AND raise review process issue, improve openqa process
242
11122 bug was filed by other sources (e.g. beta-tester) --> cross-reference (bug->test, test->bug)
243
112 test issue ("false positive") (VICTOR)
244
1121 progress issue exists (QUEBEC) --> cross-reference (issue->test, test->issue)
245
1122 unfiled test issue (PAPA)
246
11221 easy to do w/o progress issue
247
112211 need needles update --> re-needle if sure, TODO how to notify?
248
112212 pot. flaky, timeout
249
1122121 retrigger yields PASS --> comment in progress about flaky issue fixed
250
1122122 reproducible on retrigger --> file progress issue
251
11222 needs progress issue filed --> file progress issue
252
12 existing / still failing (failed->failed) (XRAY)
253
121 product issue (UNIFORM)
254
1211 unfiled issue (OSCAR) --> file bug report AND raise review process issue (why has it not been found and filed?)
255
1212 bugzilla bug exists (NOVEMBER) --> ensure cross-reference, also see rules for 1112 ROMEO
256
122 test issue (TANGO)
257
1221 progress issue exists (MIKE) --> monitor, if persisting reprioritize test development work
258
1222 needs progress issue filed (LIMA) --> file progress issue AND raise review process issue, see 1211 OSCAR
259 12 okurz
2 **passed** (ALFA)
260 11 okurz
21 stable (passed->passed) (BRAVO)
261
211 existing "true negative" (DELTA) --> monitor, maybe can be made stricter
262
212 existing "false negative" (ECHO) --> needs test improvement
263
22 fixed (failed->passed) (CHARLIE)
264
222 fixed "true negative" (FOXTROTT) --> TODO split monitor, see 211 DELTA
265
2221 was test issue --> close progress issue
266
2222 was product issue
267
22221 no bug report exists --> raise review process issue (why was it not filed?)
268
22222 bug report exists
269
222221 was marked as RESOLVED FIXED
270
221 fixed but "false negative" (GOLF) --> potentially revert test fix, also see 212 ECHO
271
272
273
Priority from high to low: INDIA->OSCAR->HOTEL->JULIETT->…
274
275
### Further decision steps working on test issues
276
277
Test issues could be one of the following sources
278
279
* "accepted product changes"
280
 * product changed slightly but in an acceptable way without the need for communication with DEV+RM --> adapt test
281
 * product changed slightly but in an acceptable way found after feedback from RM --> adapt test
282
 * product changed significantly --> after approval by RM adapt test
283
284
* changes in test setup, e.g. our test hardware equipment behaves different or the network
285
* changes in test infrastructure software, e.g. os-autoinst, openQA
286
* changes in test management configuration, e.g. openQA database settings
287 41 okurz
* changes in the test software itself (the test plan in source code as well as needles)
288
* if none of the above it could be a hidden sporadic issue, i.e. the root problem is already hidden in the system for a long time but does not show symptoms every time
289 11 okurz
290 35 okurz
# Advanced features in openQA
291 16 okurz
292
There are some features in openQA for reviewing test results and common practices. Some of these features are presented here based on the pull requests from github.
293
294
## Show previous results in test results page [gh#538](https://github.com/os-autoinst/openQA/pull/538)
295
296
On a tests result page there is a tab for "previous results" showing the result of test runs in the same scenario. This shows previous builds as well as test runs in the same build. This way you can easily check and compare results from before including any comments, labels, bug references (see next section). This helps to answer questions like "Is this a new issue", "Is it reproducable", "has it been seen in before", "how does the history look like".
297
298
Querying the database for former test runs of the same scenario is a rather
299
costly operation which we do not want to do for multiple test results at once
300
but only for each individual test result (1:1 relation). This is why this is done in each individual test result and not for a complete build.
301
302
The evaluation of previous jobs is limited but can be adjusted with the query parameter `limit_previous=<nr>` in the test URL, e.g. to provide a link to the tab in the results page showing the previous 30 results of test 1234 on openqa.opensuse.org you would write
303
`http://openqa.opensuse.org/tests/1234?limit_previous=30#previous`
304
305
Remember that the higher the limit, the more complex the database queries will be increasing the lookup time as well as the load on openQA to generate the result.
306
307
Related issue: #10212
308
309
Screenshot of feature:
310
![screenshot_20160210_142024](https://cloud.githubusercontent.com/assets/1693432/12948308/7e915a3c-d001-11e5-840b-2f070c3cb8a5.png)
311
312 36 okurz
## Link to latest in scenario name [gh#836](https://github.com/os-autoinst/openQA/pull/836)
313
314
Find the always latest job in a scenario with the link after the scenario name in the tab "Previous results"
315
Screenshot:
316
![openqa_link_to_latest_in_previous](https://cloud.githubusercontent.com/assets/1693432/18145393/5b5fb544-6fcb-11e6-967b-f24ffc6a498c.png)
317
318
319
320 34 okurz
## Add 'latest' query route [gh#815](https://github.com/os-autoinst/openQA/pull/815)
321
322
Should always refer to most recent job for the specified scenario.
323
324
* have the same link for test development, i.e. if one retriggers tests, the
325
person has to always update the URL. If there would be a static URL even the
326
browser can be instructed to reload the page automatically
327
328
* for linking to the always current execution of the last job within one
329
scenario, e.g. to respond faster to the standard question in bug reports "does
330
this bug still happen?"
331
332
Examples:
333
334
* `tests/latest?distri=opensuse&version=13.1&flavor=DVD&arch=x86_64&test=kde&machine=64bit`
335
* `tests/latest?flavor=DVD&arch=x86_64&test=kde`
336
* `tests/latest?test=foobar` - this searches for the most recent job using test_suite 'foobar' covering all distri, version, flavor, arch, machines. To be more specific, add the other query entries.
337
338 33 okurz
## Add web UI controls to select 20/50/100/400 previous results [gh#744](https://github.com/os-autoinst/openQA/pull/744)
339
340
The query parameter 'limit_previous' allows to show more than the default 10
341
previous results on demand for some time. There are web UI
342
selections below the table of the previous build to reload the same page with
343
higher number of previous results on demand.
344
345
Example screenshot:
346
![openqa_limit_previous_results_gui_100percent_padded](https://cloud.githubusercontent.com/assets/1693432/16642470/7f3cf080-440b-11e6-84b2-0485b2fd1810.png)
347
348 16 okurz
## Show bug or label icon on overview if labeled [gh#550](https://github.com/os-autoinst/openQA/pull/550)
349
350
* Show bug icon with URL if mentioned in test comments
351
* Show bug or label icon on overview if labeled
352
353
For bugreferences write `<bugtracker_shortname>#<bug_nr>` in a comment, e.g. "bsc#1234", for generic labels use `label:<keyword>` where `<keyword>` can be any valid character up to the next whitespace, e.g. "false_positive". The keywords are not defined within openQA itself. A valid list of keywords should be decided upon within each project or environment of one openQA instance.
354
355
Example for a generic label:
356
![openqa_generic_label](https://cloud.githubusercontent.com/assets/1693432/13027322/7bce7992-d24a-11e5-99ee-839fb5e82169.png)
357
358
Example for bug label:
359
![openqa_bug_label](https://cloud.githubusercontent.com/assets/1693432/13027323/8555238a-d24a-11e5-83d5-5bb2d2140860.png)
360
361 1 alarrosa
Related issue: #10212
362 16 okurz
363 42 okurz
Hint: You can also write (or copy-paste) full links to bugs and issues. The links are automatically changed to the shortlinks (e.g. https://progress.opensuse.org/issues/11110 turns into [poo#11110](https://progress.opensuse.org/issues/11110)). Related issue: #11110
364 16 okurz
365 43 okurz
Also github pull requests and issues can be linked using the generic format
366
`<marker>[#<project/repo>]#<id>`, e.g. [gh#os-autoinst/openQA#1234](https://github.com/os-autoinst/openQA/issues/1234), see [gh#973](https://github.com/os-autoinst/openQA/pull/973)
367
368 50 okurz
## Show certificate next to builds on overview if all failures are labeled [gh#560](https://github.com/os-autoinst/openQA/pull/560), [gh#1052](https://github.com/os-autoinst/openQA/pull/1052)
369 16 okurz
370
Based on comments in the individual job results for each build a certificate
371
icon is shown on the group overview page as well as the index page to indicate
372
that every failure has been reviewed, e.g. a bug reference or a test issue
373
reason is stated. Only the failed and incomplete jobs are regarded for the
374
evaluation if a build is considered "reviewed".
375
376 1 alarrosa
If the badge appears you know you are done for one complete build :-)
377 50 okurz
378
There are two variants of the certificates, a grey one after all failed jobs have been labeled and a black one if all softfailed (if any) have been reviewed additionally.
379
380
So earn the grey one first and aim for the black one :-)
381 16 okurz
382
Example screenshot:
383
![openqa_reviewed_label](https://cloud.githubusercontent.com/assets/1693432/13145996/eb1bb78a-d653-11e5-9f0f-40898915578e.png)
384
385
## Allow group overview query by result [gh#531](https://github.com/os-autoinst/openQA/pull/531)
386
387
This allows e.g. to show only failed builds. Could be included like in http://lists.opensuse.org/opensuse-factory/2016-02/msg00018.html for "known defects".
388
389
Example: Add query parameters like `…&result=failed&arch=x86_64` to show only failed for the single architecture selected.
390 1 alarrosa
391 31 okurz
## Add web UI controls to select more builds in group_overview [gh#804](https://github.com/os-autoinst/openQA/pull/804)
392
393
The query parameter 'limit_builds' allows to show more than the default 10
394
builds on demand. Just like we have for configuring previous results, the
395
current commit adds web UI selections to reload the same page with
396
higher number of builds on demand. For this, the limit of days is increased
397
to show more builds but still limited by the selected number.
398
399
Example screenshot:
400
![openqa_limit_builds_current_bold](https://cloud.githubusercontent.com/assets/1693432/17462279/59e344e6-5ca8-11e6-8350-42a0fbb5267d.png)
401
402
403 18 okurz
## Add more query parameters for configuring last builds [gh#575](https://github.com/os-autoinst/openQA/pull/575)
404
405
By using advanced query parameters in the URLs you can configure the search for builds.
406
Higher numbers would yield more complex database queries but can be selected
407
for special investigation use cases with the advanced query parameters, e.g. if one wants to get an overview of a longer history.
408
This applies to both the index dashboard and group overview page.
409
410
Example to show up to three week old builds instead of the default two weeks
411
with up to 20 builds instead of up to 10 being the default for the group
412
overview page:
413
414
    http://openqa/group_overview/1?time_limit_days=21&limit_builds=20
415 16 okurz
416 20 okurz
## Build tagging and keeping important builds [gh#591](https://github.com/os-autoinst/openQA/pull/591)
417 19 okurz
418
### Tag builds with special comments on group overview
419
420
Based on comments on the group overview individual builds can be tagged. As
421
'build' by themselves do not own any data the job group is used to store this
422 45 okurz
information. A tag has a `build` to link it to a build. It also has a `type`
423
and an optional `description`. The type can later on be used to distinguish
424 1 alarrosa
tag types.
425 45 okurz
426
The generic format for tags is
427
`tag:<build_id>:<type>[:<description>]`, e.g. `tag:1234:important:Beta1`.
428 19 okurz
429
The more recent tag always wins.
430
431
A 'tag' icon is shown next to tagged builds together with the description on
432
the group_overview page. The index page is not changed to prevent a potential
433
performance regression.
434
435
Within the sub group_overview the comments are parsed for comments and then
436
passed to the template explicitly to prevent duplicate database queries.
437
438
### Keeping important builds
439
440
As builds can now be tagged we come up with the convention that the
441
'important' type - the only one for now - is used to tag every job that
442
corresponds to a build as 'important' and keep the logs for these jobs so that
443
we can always refer to the attached data, e.g. for milestone builds, final
444
releases, jobs for which long-lasting bug reports exist, etc.
445
446
As these jobs are not cleaned up automatically a manual or external cleanup
447
scheme has to be applied for important builds and jobs.
448
449
### Example screenshot of a tag coment and corresponding tagged build
450
![openqa_tag_important](https://cloud.githubusercontent.com/assets/1693432/13468316/4fd8f586-e0a2-11e5-99df-4aa3fb787205.png)
451
452 1 alarrosa
Related issue: #9544
453
454 32 okurz
## Add web UI controls to filter only tagged or all builds [gh#807](https://github.com/os-autoinst/openQA/pull/807)
455
456
Using a new query parameter 'only_tagged=[0|1]' the list can be filtered, e.g. show only tagged (important) builds.
457
458
Example screenshot:
459
![openqa_limit_builds_current_bold_and_only_tagged](https://cloud.githubusercontent.com/assets/1693432/17464792/49bb6b18-5ce7-11e6-8053-7b74faf193a7.png)
460
461
Related issue: #11052
462
463 27 okurz
## Carry over labels from previous jobs in same scenario if still failing [gh#564](https://github.com/os-autoinst/openQA/pull/564)
464 21 okurz
465
It is possible to label all failing tests but tedious to do by a human user
466
as many failures are just having the same issue until it gets fixed.
467
It helps if a label is preserved for a build that is still failing. This
468
idea is inspired by
469
https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin
470
471
Does not carry over labels over passes: After a job passed a new issue in a subsequent fail is assumed to be failed
472
for a different reason.
473 1 alarrosa
474
Related issue: #10212
475 23 okurz
476
477 27 okurz
## Distinguish product and test issues bugref [gh#708](https://github.com/os-autoinst/openQA/pull/708)
478 26 okurz
479
"progress" is used to track test issues, bugzilla for product issues, at least for SUSE/openSUSE. openQA bugrefs distinguish this and show corresponding icons
480
481
![different_bug_icons](https://cloud.githubusercontent.com/assets/1693432/15814910/e4e74bf6-2bc9-11e6-83de-20f18a7494de.png)
482
483 37 mkittler
## Pinning comments as group description
484
This is possible by adding the keyword `pinned-description` anywhere in a comment on the group overview page. Then the comment will be shown at the top of the group overview page. However, it only works as operator or admin.
485
486 38 mkittler
## Filtering test results in test result overview
487 46 asmorodskyi
At the top of the test results overview page is a form which allows filtering tests by result, architecture and TODO-status.
488 38 mkittler
![screenshot_20160909_130610](https://cloud.githubusercontent.com/assets/10248953/18385016/3f966b36-768e-11e6-8ee3-fa48dcd0d31d.png)
489
490 23 okurz
## Proposals for uses of labels
491 52 okurz
With [Show bug or label icon on overview if labeled (gh#550)](https://github.com/os-autoinst/openQA/pull/550) it is possible to add custom labels just by writing them. Nevertheless, a convention should be found for a common benefit. <del>Beware that labels are also automatically carried over with (Carry over labels from previous jobs in same scenario if still failing [gh#564])(https://github.com/os-autoinst/openQA/pull/564) which might make consistent test failures less visible when reviewers only look for test results without labels or bugrefs.</del> Labels are not anymore automatically carried over ([gh#1071](https://github.com/os-autoinst/openQA/pull/1071)).
492 23 okurz
493
List of proposed labels with their meaning and where they could be applied.
494
495
* ***`fixed_<build_ref>`***: If a test failure is already fixed in a more recent build and no bug reference is known, use this label together with a reference to a more recent passed test run in the same scenario. Useful for reviewing older builds. Example (https://openqa.suse.de/tests/382518#comments):
496
497
```
498
label:fixed_Build1501
499
500
t#382919
501
```
502
503 24 okurz
* ***`needles_added`***: In case needles were missing for test changes or expected product changes caused needle matching to fail, use this label with a reference to the test PR or a proper reasoning why the needles were missing and how you added them. Example (https://openqa.suse.de/tests/388521#comments):
504
505
```
506
label:needles_added
507
508
needles for https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/1353 were missing, added by jpupava in the meantime.
509
```