VirtualBox

source: vbox/trunk/src/VBox/ValidationKit/docs/AutomaticTestingRevamp.html@ 60112

Last change on this file since 60112 was 59549, checked in by vboxsync, 9 years ago

Validation Kit: Documentation.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
  • Property svn:mime-type set to text/html
File size: 53.6 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
7<title></title>
8<style type="text/css">
9
10/*
11:Author: David Goodger ([email protected])
12:Id: $Id: AutomaticTestingRevamp.html 59549 2016-02-01 15:57:21Z vboxsync $
13:Copyright: This stylesheet has been placed in the public domain.
14
15Default cascading style sheet for the HTML output of Docutils.
16
17See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
18customize this style sheet.
19*/
20
21/* used to remove borders from tables and images */
22.borderless, table.borderless td, table.borderless th {
23 border: 0 }
24
25table.borderless td, table.borderless th {
26 /* Override padding for "table.docutils td" with "! important".
27 The right padding separates the table cells. */
28 padding: 0 0.5em 0 0 ! important }
29
30.first {
31 /* Override more specific margin styles with "! important". */
32 margin-top: 0 ! important }
33
34.last, .with-subtitle {
35 margin-bottom: 0 ! important }
36
37.hidden {
38 display: none }
39
40a.toc-backref {
41 text-decoration: none ;
42 color: black }
43
44blockquote.epigraph {
45 margin: 2em 5em ; }
46
47dl.docutils dd {
48 margin-bottom: 0.5em }
49
50object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
51 overflow: hidden;
52}
53
54/* Uncomment (and remove this text!) to get bold-faced definition list terms
55dl.docutils dt {
56 font-weight: bold }
57*/
58
59div.abstract {
60 margin: 2em 5em }
61
62div.abstract p.topic-title {
63 font-weight: bold ;
64 text-align: center }
65
66div.admonition, div.attention, div.caution, div.danger, div.error,
67div.hint, div.important, div.note, div.tip, div.warning {
68 margin: 2em ;
69 border: medium outset ;
70 padding: 1em }
71
72div.admonition p.admonition-title, div.hint p.admonition-title,
73div.important p.admonition-title, div.note p.admonition-title,
74div.tip p.admonition-title {
75 font-weight: bold ;
76 font-family: sans-serif }
77
78div.attention p.admonition-title, div.caution p.admonition-title,
79div.danger p.admonition-title, div.error p.admonition-title,
80div.warning p.admonition-title, .code .error {
81 color: red ;
82 font-weight: bold ;
83 font-family: sans-serif }
84
85/* Uncomment (and remove this text!) to get reduced vertical space in
86 compound paragraphs.
87div.compound .compound-first, div.compound .compound-middle {
88 margin-bottom: 0.5em }
89
90div.compound .compound-last, div.compound .compound-middle {
91 margin-top: 0.5em }
92*/
93
94div.dedication {
95 margin: 2em 5em ;
96 text-align: center ;
97 font-style: italic }
98
99div.dedication p.topic-title {
100 font-weight: bold ;
101 font-style: normal }
102
103div.figure {
104 margin-left: 2em ;
105 margin-right: 2em }
106
107div.footer, div.header {
108 clear: both;
109 font-size: smaller }
110
111div.line-block {
112 display: block ;
113 margin-top: 1em ;
114 margin-bottom: 1em }
115
116div.line-block div.line-block {
117 margin-top: 0 ;
118 margin-bottom: 0 ;
119 margin-left: 1.5em }
120
121div.sidebar {
122 margin: 0 0 0.5em 1em ;
123 border: medium outset ;
124 padding: 1em ;
125 background-color: #ffffee ;
126 width: 40% ;
127 float: right ;
128 clear: right }
129
130div.sidebar p.rubric {
131 font-family: sans-serif ;
132 font-size: medium }
133
134div.system-messages {
135 margin: 5em }
136
137div.system-messages h1 {
138 color: red }
139
140div.system-message {
141 border: medium outset ;
142 padding: 1em }
143
144div.system-message p.system-message-title {
145 color: red ;
146 font-weight: bold }
147
148div.topic {
149 margin: 2em }
150
151h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
152h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
153 margin-top: 0.4em }
154
155h1.title {
156 text-align: center }
157
158h2.subtitle {
159 text-align: center }
160
161hr.docutils {
162 width: 75% }
163
164img.align-left, .figure.align-left, object.align-left {
165 clear: left ;
166 float: left ;
167 margin-right: 1em }
168
169img.align-right, .figure.align-right, object.align-right {
170 clear: right ;
171 float: right ;
172 margin-left: 1em }
173
174img.align-center, .figure.align-center, object.align-center {
175 display: block;
176 margin-left: auto;
177 margin-right: auto;
178}
179
180.align-left {
181 text-align: left }
182
183.align-center {
184 clear: both ;
185 text-align: center }
186
187.align-right {
188 text-align: right }
189
190/* reset inner alignment in figures */
191div.align-right {
192 text-align: inherit }
193
194/* div.align-center * { */
195/* text-align: left } */
196
197ol.simple, ul.simple {
198 margin-bottom: 1em }
199
200ol.arabic {
201 list-style: decimal }
202
203ol.loweralpha {
204 list-style: lower-alpha }
205
206ol.upperalpha {
207 list-style: upper-alpha }
208
209ol.lowerroman {
210 list-style: lower-roman }
211
212ol.upperroman {
213 list-style: upper-roman }
214
215p.attribution {
216 text-align: right ;
217 margin-left: 50% }
218
219p.caption {
220 font-style: italic }
221
222p.credits {
223 font-style: italic ;
224 font-size: smaller }
225
226p.label {
227 white-space: nowrap }
228
229p.rubric {
230 font-weight: bold ;
231 font-size: larger ;
232 color: maroon ;
233 text-align: center }
234
235p.sidebar-title {
236 font-family: sans-serif ;
237 font-weight: bold ;
238 font-size: larger }
239
240p.sidebar-subtitle {
241 font-family: sans-serif ;
242 font-weight: bold }
243
244p.topic-title {
245 font-weight: bold }
246
247pre.address {
248 margin-bottom: 0 ;
249 margin-top: 0 ;
250 font: inherit }
251
252pre.literal-block, pre.doctest-block, pre.math, pre.code {
253 margin-left: 2em ;
254 margin-right: 2em }
255
256pre.code .ln { color: grey; } /* line numbers */
257pre.code, code { background-color: #eeeeee }
258pre.code .comment, code .comment { color: #5C6576 }
259pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
260pre.code .literal.string, code .literal.string { color: #0C5404 }
261pre.code .name.builtin, code .name.builtin { color: #352B84 }
262pre.code .deleted, code .deleted { background-color: #DEB0A1}
263pre.code .inserted, code .inserted { background-color: #A3D289}
264
265span.classifier {
266 font-family: sans-serif ;
267 font-style: oblique }
268
269span.classifier-delimiter {
270 font-family: sans-serif ;
271 font-weight: bold }
272
273span.interpreted {
274 font-family: sans-serif }
275
276span.option {
277 white-space: nowrap }
278
279span.pre {
280 white-space: pre }
281
282span.problematic {
283 color: red }
284
285span.section-subtitle {
286 /* font-size relative to parent (h1..h6 element) */
287 font-size: 80% }
288
289table.citation {
290 border-left: solid 1px gray;
291 margin-left: 1px }
292
293table.docinfo {
294 margin: 2em 4em }
295
296table.docutils {
297 margin-top: 0.5em ;
298 margin-bottom: 0.5em }
299
300table.footnote {
301 border-left: solid 1px black;
302 margin-left: 1px }
303
304table.docutils td, table.docutils th,
305table.docinfo td, table.docinfo th {
306 padding-left: 0.5em ;
307 padding-right: 0.5em ;
308 vertical-align: top }
309
310table.docutils th.field-name, table.docinfo th.docinfo-name {
311 font-weight: bold ;
312 text-align: left ;
313 white-space: nowrap ;
314 padding-left: 0 }
315
316/* "booktabs" style (no vertical lines) */
317table.docutils.booktabs {
318 border: 0px;
319 border-top: 2px solid;
320 border-bottom: 2px solid;
321 border-collapse: collapse;
322}
323table.docutils.booktabs * {
324 border: 0px;
325}
326table.docutils.booktabs th {
327 border-bottom: thin solid;
328 text-align: left;
329}
330
331h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
332h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
333 font-size: 100% }
334
335ul.auto-toc {
336 list-style-type: none }
337
338</style>
339</head>
340<body>
341<div class="document">
342
343
344<div class="section" id="revamp-of-automatic-virtualbox-testing">
345<h1>Revamp of Automatic VirtualBox Testing</h1>
346<div class="section" id="introduction">
347<h2>Introduction</h2>
348<p>This is the design document for a revamped automatic testing framework.
349The revamp aims at replacing the current tinderbox based testing by a new
350system that is written from scratch.</p>
351<p>The old system is not easy to work with and was never meant to be used for
352managing tests, after all it just a simple a build manager tailored for
353contiguous building. Modifying the existing tinderbox system to do what
354we want would require fundamental changes that would render it useless as
355a build manager, it would therefore end up as a fork. The amount of work
356required would probably be about the same as writing a new system from
357scratch. Other considerations, such as the license of the tinderbox
358system (MPL) and language it is realized in (Perl), are also in favor of
359doing it from scratch.</p>
360<p>The language envisioned for the new automatic testing framework is Python. This
361is for several reasons:</p>
362<blockquote>
363<ul class="simple">
364<li>The VirtualBox API has Python bindings.</li>
365<li>Python is used quite a bit inside Sun (dunno about Oracle).</li>
366<li>Works relatively well with Apache for the server side bits.</li>
367<li>It is more difficult to produce write-only code in Python (alias the
368we-don't-like-perl argument).</li>
369<li>You don't need to compile stuff.</li>
370</ul>
371</blockquote>
372<p>Note that the author of this document has no special training as a test
373engineer and may therefore be using the wrong terms here and there. The
374primary focus is to express what we need to do in order to improve
375testing.</p>
376<p>This document is written in reStructuredText (rst) which just happens to
377be used by Python, the primary language for this revamp. For more
378information on reStructuredText: <a class="reference external" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></p>
379</div>
380</div>
381<div class="section" id="definitions-glossary">
382<h1>Definitions / Glossary</h1>
383<dl class="docutils">
384<dt>sub-test driver</dt>
385<dd>A set of test cases that can be used by more than one test driver. Could
386also be called a test unit, in the pascal sense of unit, if it wasn't so
387easily confused with 'unit test'.</dd>
388<dt>test</dt>
389<dd>This is somewhat ambiguous and this document try avoid using it where
390possible. When used it normally refers to doing testing by executing one or
391more testcases.</dd>
392<dt>test case</dt>
393<dd>A set of inputs, test programs and expected results. It validates system
394requirements and generates a pass or failed status. A basic unit of testing.
395Note that we use the term in a rather broad sense.</dd>
396<dt>test driver</dt>
397<dd>A program/script used to execute a test. Also known as a test harness.
398Generally abbreviated 'td'. It can have sub-test drivers.</dd>
399<dt>test manager</dt>
400<dd>Software managing the automatic testing. This is a web application that runs
401on a dedicated server (tindertux).</dd>
402<dt>test set</dt>
403<dd>The output of testing activity. Logs, results, ++. Our usage of this should
404probably be renamed to 'test run'.</dd>
405<dt>test group</dt>
406<dd>A collection of related test cases.</dd>
407<dt>testbox</dt>
408<dd>A computer that does testing.</dd>
409<dt>testbox script</dt>
410<dd>Script executing orders from the test manager on a testbox. Started
411automatically upon bootup.</dd>
412<dt>testing</dt>
413<dd>todo</dd>
414<dt>TODO: Check that we've got all this right and make them more exact</dt>
415<dd>where possible.</dd>
416</dl>
417<p>See also <a class="reference external" href="http://encyclopedia2.thefreedictionary.com/testing%20types">http://encyclopedia2.thefreedictionary.com/testing%20types</a>
418and <a class="reference external" href="http://www.aptest.com/glossary.html">http://www.aptest.com/glossary.html</a> .</p>
419</div>
420<div class="section" id="objectives">
421<h1>Objectives</h1>
422<blockquote>
423<ul class="simple">
424<li>A scalable test manager (&gt;200 testboxes).</li>
425<li>Optimize the web user interface (WUI) for typical workflows and analysis.</li>
426<li>Efficient and flexibile test configuration.</li>
427<li>Import test result from other test systems (logo testing, VDI, ++).</li>
428<li>Easy to add lots of new testscripts.</li>
429<li>Run tests locally without a manager.</li>
430<li>Revamp a bit at the time.</li>
431</ul>
432</blockquote>
433</div>
434<div class="section" id="the-testbox-side">
435<h1>The Testbox Side</h1>
436<p>Each testbox has a unique name corresponding to its DNS zone entry. When booted
437a testbox script is started automatically. This script will query the test
438manager for orders and execute them. The core order downloads and executes a
439test driver with parameters (configuration) from the server. The test driver
440does all the necessary work for executing the test. In a typical VirtualBox
441test this means picking a build, installing it, configuring VMs, running the
442test VMs, collecting the results, submitting them to the server, and finally
443cleaning up afterwards.</p>
444<p>The testbox environment which the test drivers are executed in will have a
445number of environment variables for determining location of the source images
446and other test data, scratch space, test set id, server URL, and so on and so
447forth.</p>
448<p>On startup, the testbox script will look for crash dumps and similar on
449systems where this is possible. If any sign of a crash is found, it will
450put any dumps and reports in the upload directory and inform the test
451manager before reporting for duty. In order to generate the proper file
452names and report the crash in the right test set as well as prevent
453reporting crashes unrelated to automatic testing, the testbox script will
454keep information (test set id, ++) in a separate scratch directory
455(${TESTBOX_PATH_SCRATCH}/../testbox) and make sure it is synced to the
456disk (both files and directories).</p>
457<p>After checking for crashes, the testbox script will clean up any previous test
458which might be around. This involves first invoking the test script in cleanup
459mode and the wiping the scratch space.</p>
460<p>When reporting for duty the script will submit information about the host: OS
461name, OS version, OS bitness, CPU vendor, total number of cores, VT-x support,
462AMD-V support, amount of memory, amount of scratch space, and anything else that
463can be found useful for scheduling tests or filtering test configurations.</p>
464<div class="section" id="testbox-script-orders">
465<h2>Testbox Script Orders</h2>
466<p>The orders are kept in a queue on the server and the testbox script will fetch
467them one by one. Orders that cannot be executed at the moment will be masked in
468the query from the testbox.</p>
469<dl class="docutils">
470<dt>Execute Test Driver</dt>
471<dd>Downloads and executes the a specified test driver with the given
472configuration (arguments). Only one test driver can be executed at a time.
473The server can specify more than one ZIP file to be downloaded and unpacked
474before executing the test driver. The testbox script may cache these zip
475files using http time stamping.</dd>
476<dt>Abort Test Driver</dt>
477<dd>Aborts the current test driver. This will drop a hint to the driver and give
478it 60 seconds to shut down the normal way. If that fails, the testbox script
479will kill the driver processes (SIGKILL or equivalent), invoke the
480testdriver in cleanup mode, and finally wipe the scratch area. Should either
481of the last two steps fail in some way, the testbox will be rebooted.</dd>
482<dt>Idle</dt>
483<dd>Ask again in X seconds, where X is specified by the server.</dd>
484<dt>Reboot</dt>
485<dd>Reboot the testbox. If a test driver is current running, an attempt at
486aborting it (Abort Test Driver) will be made first.</dd>
487<dt>Update</dt>
488<dd>Updates the testbox script. The order includes a server relative path to the
489new testbox script. This can only be executed when no test driver is
490currently being executed.</dd>
491</dl>
492</div>
493<div class="section" id="testbox-environment-variables">
494<h2>Testbox Environment: Variables</h2>
495<dl class="docutils">
496<dt>COMSPEC</dt>
497<dd>This will be set to C:WindowsSystem32cmd.exe on Windows.</dd>
498<dt>PATH</dt>
499<dd>This will contain the kBuild binary directory for the host platform.</dd>
500<dt>SHELL</dt>
501<dd>This will be set to point to kmk_ash(.exe) on all platforms.</dd>
502<dt>TESTBOX_NAME</dt>
503<dd>The testbox name.
504This is not required by the local reporter.</dd>
505<dt>TESTBOX_PATH_BUILDS</dt>
506<dd>The absolute path to where the build repository can be found. This should be
507a read only mount when possible.</dd>
508<dt>TESTBOX_PATH_RESOURCES</dt>
509<dd>The absolute path to where static test resources like ISOs and VDIs can be
510found. The test drivers knows the layout of this. This should be a read only
511mount when possible.</dd>
512<dt>TESTBOX_PATH_SCRATCH</dt>
513<dd>The absolute path to the scratch space. This is the current directory when
514starting the test driver. It will be wiped automatically after executing the
515test.
516(Envisioned as ${TESTBOX_PATH_SCRIPTS}/../scratch and that
517${TESTBOX_PATH_SCRATCH}/ will be automatically wiped by the testbox script.)</dd>
518<dt>TESTBOX_PATH_SCRIPTS</dt>
519<dd>The absolute path to the test driver and the other files that was unzipped
520together with it. This is also where the test-driver-abort file will be put.
521(Envisioned as ${TESTBOX_PATH_SCRATCH}/../driver, see above.)</dd>
522<dt>TESTBOX_PATH_UPLOAD</dt>
523<dd>The absolute path to the upload directory for the testbox. This is for
524putting VOBs, PNGs, core dumps, crash dumps, and such on. The files should be
525bzipped or zipped if they aren't compress already. The names should contain
526the testbox and test set ID.</dd>
527<dt>TESTBOX_REPORTER</dt>
528<dd>The name of the test reporter back end. If not present, it will default to
529the local reporter.</dd>
530<dt>TESTBOX_TEST_SET_ID</dt>
531<dd>The test set ID if we're running.
532This is not required by the local reporter.</dd>
533<dt>TESTBOX_MANAGER_URL</dt>
534<dd>The URL to the test manager.
535This is not required by the local reporter.</dd>
536<dt>TESTBOX_XYZ</dt>
537<dd>There will probably be some more of these.</dd>
538</dl>
539</div>
540<div class="section" id="testbox-environment-core-utilities">
541<h2>Testbox Environment: Core Utilities</h2>
542<p>The testbox will not provide the typical unix /bin and /usr/bin utilities. In
543other words, cygwin will not be used on Windows!</p>
544<p>The testbox will provide the unixy utilties that ships with kBuild and possibly
545some additional ones from tools/<em>.</em>/bin in the VirtualBox tree (wget, unzip,
546zip, and so on). The test drivers will avoid invoking any of these utilites
547directly and instead rely on generic utility methods in the test driver
548framework. That way we can more easily reimplement the functionality of the
549core utilites and drop the dependency on them. It also allows us to quickly
550work around platform specific oddities and bugs.</p>
551</div>
552<div class="section" id="test-drivers">
553<h2>Test Drivers</h2>
554<p>The test drivers are programs that will do the actual testing. In addition to
555run under the testbox script, they can be executed in the VirtualBox development
556environment. This is important for bug analysis and for simplifying local
557testing by the developers before commiting changes. It also means the test
558drivers can be developed locally in the VirtualBox development environment.</p>
559<p>The main difference between executing a driver under the testbox script and
560running it manually is that there is no test manager in the latter case. The
561test result reporter will not talk to the server, but report things to a local
562log file and/or standard out/err. When invoked manually, all the necessary
563arguments will need to be specified by hand of course - it should be possible
564to extract them from a test set as well.</p>
565<p>For the early implementation stages, an implementation of the reporter interface
566that talks to the tinderbox base test manager will be needed. This will be
567dropped later on when a new test manager is ready.</p>
568<p>As hinted at in other sections, there will be a common framework
569(libraries/packages/classes) for taking care of the tedious bits that every
570test driver needs to do. Sharing code is essential to easing test driver
571development as well as reducing their complexity. The framework will contain:</p>
572<blockquote>
573<ul>
574<li><p class="first">A generic way of submitting output. This will be a generic interface with
575multiple implementation, the TESTBOX_REPORTER environment variable
576will decide which of them to use. The interface will have very specific
577methods to allow the reporter to do a best possible job in reporting the
578results to the test manager.</p>
579</li>
580<li><dl class="first docutils">
581<dt>Helpers for typical tasks, like:</dt>
582<dd><ul class="first last simple">
583<li>Copying files.</li>
584<li>Deleting files, directory trees and scratch space.</li>
585<li>Unzipping files.</li>
586<li>Creating ISOs</li>
587<li>And such things.</li>
588</ul>
589</dd>
590</dl>
591</li>
592<li><p class="first">Helpers for installing and uninstalling VirtualBox.</p>
593</li>
594<li><p class="first">Helpers for defining VMs. (The VBox API where available.)</p>
595</li>
596<li><p class="first">Helpers for controlling VMs. (The VBox API where available.)</p>
597</li>
598</ul>
599</blockquote>
600<p>The VirtualBox bits will be separate from the more generic ones, simply because
601this is cleaner it will allow us to reuse the system for testing other products.</p>
602<p>The framework will be packaged in a zip file other than the test driver so we
603don't waste time and space downloading the same common code.</p>
604<p>The test driver will poll for the file
605${TESTBOX_PATH_SCRIPTS}/test-driver-abort and abort all testing when it sees it.</p>
606<p>The test driver can be invoked in three modes: execute, help and cleanup. The
607default is execute mode, the help shows an configuration summary and the cleanup
608is for cleaning up after a reboot or aborted run. The latter is done by the
609testbox script on startup and after abort - the driver is expected to clean up
610by itself after a normal run.</p>
611</div>
612</div>
613<div class="section" id="the-server-side">
614<h1>The Server Side</h1>
615<p>The server side will be implemented using a webserver (apache), a database
616(postgres) and cgi scripts (Python). In addition a cron job (Python) running
617once a minute will generate static html for frequently used pages and maybe
618execute some other tasks for driving the testing forwards. The order queries
619from the testbox script is the primary driving force in the system. The total
620makes up the test manager.</p>
621<p>The test manager can be split up into three rough parts:</p>
622<blockquote>
623<ul class="simple">
624<li>Configuration (of tests, testgroups and testboxes).</li>
625<li>Execution (of tests, collecting and organizing the output).</li>
626<li>Analysis (of test output, mostly about presentation).</li>
627</ul>
628</blockquote>
629</div>
630<div class="section" id="test-manager-requirements">
631<h1>Test Manager: Requirements</h1>
632<p>List of requirements:</p>
633<blockquote>
634<ul>
635<li><p class="first">Two level testing - L1 quick smoke tests and L2 longer tests performed on
636builds passing L1. (Klaus (IIRC) ment this could be realized using
637test dependency.)</p>
638</li>
639<li><p class="first">Black listing builds (by revision or similar) known to be bad.</p>
640</li>
641<li><p class="first">Distinguish between build types so we can do a portion of the testing with
642strict builds.</p>
643</li>
644<li><p class="first">Easy to re-configure build source for testing different branch or for
645testing a release candidate. (Directory based is fine.)</p>
646</li>
647<li><p class="first">Useful to be able to partition testboxes (run specific builds on some
648boxes, let an engineer have a few boxes for a while).</p>
649</li>
650<li><p class="first">Interation with ILOM/...: reset systems.</p>
651</li>
652<li><p class="first">Be able to suspend testing on selected testboxes when doing maintance
653(where automatically resuming testing on reboot is undesired) or similar
654activity.</p>
655</li>
656<li><p class="first">Abort testing on seleced testboxes.</p>
657</li>
658<li><p class="first">Scheduling of tests requiring more than one testbox.</p>
659</li>
660<li><p class="first">Scheduling of tests that cannot be executing concurrently on several
661machines because of some global resource like an iSCSI target.</p>
662</li>
663<li><p class="first">Jump the scheduling queue. Scheduling of specified test the next time a
664testbox is available (optionally specifying which testbox to schedule it
665on).</p>
666</li>
667<li><dl class="first docutils">
668<dt>Configure tests with variable configuration to get better coverage. Two modes:</dt>
669<dd><ul class="first last simple">
670<li>TM generates the permutations based on one or more sets of test script arguments.</li>
671<li>Each configuration permuation is specified manually.</li>
672</ul>
673</dd>
674</dl>
675</li>
676<li><p class="first">Test specification needs to be flexible (select tests, disable test, test
677scheduling (run certain tests nightly), ... ).</p>
678</li>
679<li><p class="first">Test scheduling by hour+weekday and by priority.</p>
680</li>
681<li><p class="first">Test dependencies (test A depends on test B being successful).</p>
682</li>
683<li><p class="first">Historize all configuration data, in particular test configs (permutations
684included) and testboxes.</p>
685</li>
686<li><p class="first">Test sets has at a minimum a build reference, a testbox reference and a
687primary log associated with it.</p>
688</li>
689<li><dl class="first docutils">
690<dt>Test sets stores further result as a recursive collection of:</dt>
691<dd><ul class="first last simple">
692<li>hierachical subtest name (slash sep)</li>
693<li>test parameters / config</li>
694<li>bool fail/succ</li>
695<li>attributes (typed?)</li>
696<li>test time</li>
697<li>e.g. throughput</li>
698<li>subresults</li>
699<li>log</li>
700<li>screenshots, video,...</li>
701</ul>
702</dd>
703</dl>
704</li>
705<li><p class="first">The test sets database structure needs to designed such that data mining
706can be done in an efficient manner.</p>
707</li>
708<li><p class="first">Presentation/analysis: graphs!, categorize bugs, columns reorganizing
709grouped by test (hierarchical), overviews, result for last day.</p>
710</li>
711</ul>
712</blockquote>
713</div>
714<div class="section" id="test-manager-configuration">
715<h1>Test Manager: Configuration</h1>
716<div class="section" id="testboxes">
717<h2>Testboxes</h2>
718<p>Configuration of testboxes doesn't involve much work normally. A testbox
719is added manually to the test manager by entering the DNS entry and/or IP
720address (the test manager resolves the missing one when necessary) as well as
721the system UUID (when obtainable - should be displayed by the testbox script
722installer). Queries from unregistered testboxes will be declined as a kind of
723security measure, the incident should be logged in the webserver log if
724possible. In later dealings with the client the System UUID will be the key
725identifier. It's permittable for the IP address to change when the testbox
726isn't online, but not while testing (just imagine live migration tests and
727network tests). Ideally, the testboxes should not change IP address.</p>
728<p>The testbox edit function must allow changing the name and system UUID.</p>
729<p>One further idea for the testbox configuration is indicating what they are
730capable of to filter out tests and test configurations that won't work on that
731testbox. To examplify this take the ACP2 installation test. If the test
732manager does not make sure the testbox have VT-x or AMD-v capabilities, the test
733is surely going to fail. Other testbox capabilities would be total number of
734CPU cores, memory size, scratch space. These testbox capabilities should be
735collected automatically on bootup by the testbox script together with OS name,
736OS version and OS bitness.</p>
737<p>A final thought, instead of outright declining all requests from new testboxes,
738we could record the unregistered testboxes with ip, UUID, name, os info and
739capabilities but mark them as inactive. The test operator can then activate
740them on an activation page or edit the testbox or something.</p>
741</div>
742<div class="section" id="testcases">
743<h2>Testcases</h2>
744<p>We use the term testcase for a test.</p>
745</div>
746<div class="section" id="testgroups">
747<h2>Testgroups</h2>
748<p>Testcases are organized into groups. A testcase can be member of more than one
749group. The testcase gets a priority assigned to it in connection with the
750group membership.</p>
751<p>Testgroups are picked up by a testbox partition (aka scheduling group) and a
752prioirty, scheduling time restriction and dependencies on other test groups are
753associated with the assignment. A testgroup can be used by several testbox
754partitions.</p>
755<p>(This used to be called 'testsuites' but was renamed to avoid confusion with
756the VBox Test Suite.)</p>
757</div>
758<div class="section" id="scheduling">
759<h2>Scheduling</h2>
760<p>The initial scheduler will be modelled after what we're doing already on in the
761tinderbox driven testing. It's best described as a best effort continuous
762integration scheduler. Meaning, it will always use the latest build suitable
763for a testcase. It will schedule on a testcase level, using the combined
764priority of the testcase in the test group and the test group with the testbox
765partition, trying to spread the test case argument varation out accordingly
766over the whole scheduilng queue. Which argument variation to start with, is
767not undefined (random would be best).</p>
768<p>Later, we may add other schedulers as needed.</p>
769</div>
770</div>
771<div class="section" id="the-test-manager-database">
772<h1>The Test Manager Database</h1>
773<p>First a general warning:</p>
774<blockquote>
775The guys working on this design are not database experts, web
776programming experts or similar, rather we are low level guys
777who's main job is x86 &amp; AMD64 virtualization. So, please don't
778be too hard on us. :-)</blockquote>
779<p>A logical table layout can be found in TestManagerDatabaseMap.png (created by
780Oracle SQL Data Modeler, stored in TestManagerDatabase.dmd). The physical
781database layout can be found in TestManagerDatabaseInit.pgsql postgreSQL
782script. The script is commented.</p>
783<div class="section" id="data-history">
784<h2>Data History</h2>
785<p>We need to somehow track configuration changes over time. We also need to
786be able to query the exact configuration a test set was run with so we can
787understand and make better use of the results.</p>
788<p>There are different techniques for archiving this, one is tuple-versioning
789( <a class="reference external" href="http://en.wikipedia.org/wiki/Tuple-versioning">http://en.wikipedia.org/wiki/Tuple-versioning</a> ), another is log trigger
790( <a class="reference external" href="http://en.wikipedia.org/wiki/Log_trigger">http://en.wikipedia.org/wiki/Log_trigger</a> ). We use tuple-versioning in
791this database, with 'effective' as start date field name and 'expire' as
792the end (exclusive).</p>
793<p>Tuple-versioning has a shortcomming wrt to keys, both primary and foreign.
794The primary key of a table employing tuple-versioning is really
795'id' + 'valid_period', where the latter is expressed using two fields
796([effective...expire-1]). Only, how do you tell the database engine that
797it should not allow overlapping valid_periods? Useful suggestions are
798welcomed. :-)</p>
799<p>Foreign key references to a table using tuple-versioning is running into
800trouble because of the time axsis and that to our knowledge foreign keys
801must reference exactly one row in the other table. When time is involved
802what we wish to tell the database is that at any given time, there actually
803is exactly one row we want to match in the other table, only we've no idea
804how to express this. So, many foreign keys are not expressed in SQL of this
805database.</p>
806<p>In some cases, we extend the tuple-versioning with a generation ID so that
807normal foreign key referencing can be used. We only use this for recording
808(references in testset) and scheduling (schedqueue), as using it more widely
809would force updates (gen_id changes) to propagate into all related tables.</p>
810<dl class="docutils">
811<dt>See also:</dt>
812<dd><ul class="first last simple">
813<li><a class="reference external" href="http://en.wikipedia.org/wiki/Slowly_changing_dimension">http://en.wikipedia.org/wiki/Slowly_changing_dimension</a></li>
814<li><a class="reference external" href="http://en.wikipedia.org/wiki/Change_data_capture">http://en.wikipedia.org/wiki/Change_data_capture</a></li>
815<li><a class="reference external" href="http://en.wikipedia.org/wiki/Temporal_database">http://en.wikipedia.org/wiki/Temporal_database</a></li>
816</ul>
817</dd>
818</dl>
819</div>
820</div>
821<div class="section" id="test-manager-execution">
822<h1>Test Manager: Execution</h1>
823</div>
824<div class="section" id="test-manager-scenarios">
825<h1>Test Manager: Scenarios</h1>
826<div class="section" id="testbox-signs-on-at-bootup">
827<h2>#1 - Testbox Signs On (At Bootup)</h2>
828<dl class="docutils">
829<dt>The testbox supplies a number of inputs when reporting for duty:</dt>
830<dd><ul class="first last simple">
831<li>IP address.</li>
832<li>System UUID.</li>
833<li>OS name.</li>
834<li>OS version.</li>
835<li>CPU architecture.</li>
836<li>CPU count (= threads).</li>
837<li>CPU VT-x/AMD-V capability.</li>
838<li>CPU nested paging capability.</li>
839<li>Chipset I/O MMU capability.</li>
840<li>Memory size.</li>
841<li>Scratch size space (for testing).</li>
842<li>Testbox Script revision.</li>
843</ul>
844</dd>
845<dt>Results:</dt>
846<dd><ul class="first last simple">
847<li>ACK or NACK.</li>
848<li>Testbox ID and name on ACK.</li>
849</ul>
850</dd>
851</dl>
852<p>After receiving a ACK the testbox will ask for work to do, i.e. continue with
853scenario #2. In the NACK case, it will sleep for 60 seconds and try again.</p>
854<p>Actions:</p>
855<ol class="arabic">
856<li><p class="first">Validate the testbox by looking the UUID up in the TestBoxes table.
857If not found, NACK the request. SQL:</p>
858<pre class="literal-block">
859SELECT idTestBox, sName
860FROM TestBoxes
861WHERE uuidSystem = :sUuid
862 AND tsExpire = 'infinity'::timestamp;
863</pre>
864</li>
865<li><p class="first">Check if any of the information by testbox script has changed. The two
866sizes are normalized first, memory size rounded to nearest 4 MB and scratch
867space is rounded down to nearest 64 MB. If anything changed, insert a new
868row in the testbox table and historize the current one, i.e. set
869OLD.tsExpire to NEW.tsEffective and get a new value for NEW.idGenTestBox.</p>
870</li>
871<li><dl class="first docutils">
872<dt>Check with TestBoxStatuses:</dt>
873<dd><ol class="first last loweralpha simple">
874<li>If there is an row for the testbox in it already clean up change it
875to 'idle' state and deal with any open testset like described in
876scenario #9.</li>
877<li>If there is no row, add one with 'idle' state.</li>
878</ol>
879</dd>
880</dl>
881</li>
882<li><p class="first">ACK the request and pass back the idTestBox.</p>
883</li>
884</ol>
885<dl class="docutils">
886<dt>Note! Testbox.enabled is not checked here, that is only relevant when it asks</dt>
887<dd>for a new task (scenario #2 and #5).</dd>
888<dt>Note! Should the testbox script detect changes in any of the inputs, it should</dt>
889<dd>redo the sign in.</dd>
890<dt>Note! In scenario #8, the box will not sign on until it has done the reboot and</dt>
891<dd>cleanup reporting!</dd>
892</dl>
893</div>
894<div class="section" id="testbox-asks-for-work-to-do">
895<h2>#2 - Testbox Asks For Work To Do</h2>
896<dl class="docutils">
897<dt>Inputs:</dt>
898<dd><ul class="first last simple">
899<li>The testbox is supplying its IP indirectly.</li>
900<li>The testbox should supply its UUID and ID directly.</li>
901</ul>
902</dd>
903<dt>Results:</dt>
904<dd><ul class="first last simple">
905<li>IDLE, WAIT, EXEC, REBOOT, UPGRADE, UPGRADE-AND-REBOOT, SPECIAL or DEAD.</li>
906</ul>
907</dd>
908</dl>
909<p>Actions:</p>
910<ol class="arabic">
911<li><p class="first">Validate the ID and IP by selecting the currently valid testbox row:</p>
912<pre class="literal-block">
913SELECT idGenTestBox, fEnabled, idSchedGroup, enmPendingCmd
914FROM TestBoxes
915WHERE id = :id
916 AND uuidSystem = :sUuid
917 AND ip = :ip
918 AND tsExpire = 'infinity'::timestamp;
919</pre>
920<p>If NOT found return DEAD to the testbox client (it will go back to sign on
921mode and retry every 60 seconds or so - see scenario #1).</p>
922<dl class="docutils">
923<dt>Note! The WUI will do all necessary clean-ups when deleting a testbox, so</dt>
924<dd><p class="first last">contrary to the initial plans, we don't need to do anything more for
925the DEAD status.</p>
926</dd>
927</dl>
928</li>
929<li><p class="first">Check with TestBoxStatuses (maybe joined with query from 1).</p>
930<p>If enmState is 'gang-gathering': Goto scenario #6 on timeout or pending
931'abort' or 'reboot' command. Otherwise, tell the testbox to WAIT [done].</p>
932<p>If enmState is 'gang-testing': The gang has been gathered and execution
933has been triggered. Goto 5.</p>
934<p>If enmState is not 'idle', change it to 'idle'.</p>
935<p>If idTestSet is not NULL, CALL scenario #9 to it up.</p>
936<p>If there is a pending abort command, remove it.</p>
937<p>If there is a pending command and the old state doesn't indicate that it was
938being executed, GOTO scenario #3.</p>
939<dl class="docutils">
940<dt>Note! There should be a TestBoxStatuses row after executing scenario #1,</dt>
941<dd><p class="first last">however should none be found for some funky reason, returning DEAD
942will fix the problem (see above)</p>
943</dd>
944</dl>
945</li>
946<li><p class="first">If the testbox was marked as disabled, respond with an IDLE command to the
947testbox [done]. (Note! Must do this after TestBoxStatuses maintainance from
948point 2, or abandond tests won't be cleaned up after a testbox is disabled.)</p>
949</li>
950<li><p class="first">Consider testcases in the scheduling queue, pick the first one which the
951testbox can execute. There is a concurrency issue here, so we put and
952exclusive lock on the SchedQueues table while considering its content.</p>
953<p>The cursor we open looks something like this:</p>
954<pre class="literal-block">
955SELECT idItem, idGenTestCaseArgs,
956 idTestSetGangLeader, cMissingGangMembers
957FROM SchedQueues
958WHERE idSchedGroup = :idSchedGroup
959 AND ( bmHourlySchedule is NULL
960 OR get_bit(bmHourlySchedule, :iHourOfWeek) = 1 ) --&lt; does this work?
961ORDER BY ASC idItem;
962</pre>
963</li>
964</ol>
965<blockquote>
966<p>If there no rows are returned (this can happen because no testgroups are
967associated with this scheduling group, the scheduling group is disabled,
968or because the queue is being regenerated), we will tell the testbox to
969IDLE [done].</p>
970<dl class="docutils">
971<dt>For each returned row we will:</dt>
972<dd><ol class="first last loweralpha">
973<li><p class="first">Check testcase/group dependencies.</p>
974</li>
975<li><p class="first">Select a build (and default testsuite) satisfying the dependencies.</p>
976</li>
977<li><p class="first">Check the testcase requirements with that build in mind.</p>
978</li>
979<li><p class="first">If idTestSetGangLeader is NULL, try allocate the necessary resources.</p>
980</li>
981<li><p class="first">If it didn't check out, fetch the next row and redo from (a).</p>
982</li>
983<li><p class="first">Tentatively create a new test set row.</p>
984</li>
985<li><dl class="first docutils">
986<dt>If not gang scheduling:</dt>
987<dd><ul class="first last simple">
988<li>Next state: 'testing'</li>
989</ul>
990</dd>
991<dt>ElIf we're the last gang participant:</dt>
992<dd><ul class="first last simple">
993<li>Set idTestSetGangLeader to NULL.</li>
994<li>Set cMissingGangMembers to 0.</li>
995<li>Next state: 'gang-testing'</li>
996</ul>
997</dd>
998<dt>ElIf we're the first gang member:</dt>
999<dd><ul class="first last simple">
1000<li>Set cMissingGangMembers to TestCaseArgs.cGangMembers - 1.</li>
1001<li>Set idTestSetGangLeader to our idTestSet.</li>
1002<li>Next state: 'gang-gathering'</li>
1003</ul>
1004</dd>
1005<dt>Else:</dt>
1006<dd><ul class="first last simple">
1007<li>Decrement cMissingGangMembers.</li>
1008<li>Next state: 'gang-gathering'</li>
1009</ul>
1010</dd>
1011<dt>If we're not gang scheduling OR cMissingGangMembers is 0:</dt>
1012<dd><p class="first last">Move the scheduler queue entry to the end of the queue.</p>
1013</dd>
1014</dl>
1015<p>Update our TestBoxStatuses row with the new state and test set.
1016COMMIT;</p>
1017</li>
1018</ol>
1019</dd>
1020</dl>
1021</blockquote>
1022<ol class="arabic" start="5">
1023<li><dl class="first docutils">
1024<dt>If state is 'testing' or 'gang-testing':</dt>
1025<dd><p class="first">EXEC reponse.</p>
1026<p class="last">The EXEC response for a gang scheduled testcase includes a number of
1027extra arguments so that the script knows the position of the testbox
1028it is running on and of the other members. This means the that the
1029TestSet.iGangMemberNo is passed using --gang-member-no and the IP
1030addresses of the all gang members using --gang-ipv4-&lt;memb-no&gt; &lt;ip&gt;.</p>
1031</dd>
1032<dt>Else (state is 'gang-gathering'):</dt>
1033<dd><p class="first last">WAIT</p>
1034</dd>
1035</dl>
1036</li>
1037</ol>
1038</div>
1039<div class="section" id="pending-command-when-testbox-asks-for-work">
1040<h2>#3 - Pending Command When Testbox Asks For Work</h2>
1041<p>This is a subfunction of scenario #2 and #5.</p>
1042<p>As seen in scenario #2, the testbox will send 'abort' commands to /dev/null
1043when it finds one when not executing a test. This includes when it reports
1044that the test has completed (no need to abort a completed test, wasting lot
1045of effort when standing at the finish line).</p>
1046<p>The other commands, though, are passed back to the testbox. The testbox
1047script will respond with an ACK or NACK as it sees fit. If NACKed, the
1048pending command will be removed (pending_cmd set to none) and that's it.
1049If ACKed, the state of the testbox will change to that appropriate for the
1050command and the pending_cmd set to none. Should the testbox script fail to
1051respond, the command will be repeated the next time it asks for work.</p>
1052</div>
1053<div class="section" id="testbox-uploads-results-during-test">
1054<h2>#4 - Testbox Uploads Results During Test</h2>
1055<p>TODO</p>
1056</div>
1057<div class="section" id="testbox-completes-test-and-asks-for-work">
1058<h2>#5 - Testbox Completes Test and Asks For Work</h2>
1059<p>This is very similar to scenario #2</p>
1060<p>TODO</p>
1061</div>
1062<div class="section" id="gang-gathering-timeout">
1063<h2>#6 - Gang Gathering Timeout</h2>
1064<p>This is a subfunction of scenario #2.</p>
1065<p>When gathering a gang of testboxes for a testcase, we do not want to wait
1066forever and have testboxes doing nothing for hours while waiting for partners.
1067So, the gathering has a reasonable timeout (imagine something like 20-30 mins).</p>
1068<p>Also, we need some way of dealing with 'abort' and 'reboot' commands being
1069issued while waiting. The easy way out is pretent it's a time out.</p>
1070<p>When changing the status to 'gang-timeout' we have to be careful. First of all,
1071we need to exclusively lock the SchedQueues and TestBoxStatuses (in that order)
1072and re-query our status. If it changed redo the checks in scenario #2 point 2.</p>
1073<p>If we still want to timeout/abort, change the state from 'gang-gathering' to
1074'gang-gathering-timedout' on all the gang members that has gathered so far.
1075Then reset the scheduling queue record and move it to the end of the queue.</p>
1076<p>When acting on 'gang-timeout' the TM will fail the testset in a manner similar
1077to scenario #9. No need to repeat that.</p>
1078</div>
1079<div class="section" id="gang-cleanup">
1080<h2>#7 - Gang Cleanup</h2>
1081<p>When a testbox completes a gang scheduled test, we will have to serialize
1082resource cleanup (both globally and on testboxes) as they stop. More details
1083can be found in the documentation of 'gang-cleanup'.</p>
1084<p>So, the transition from 'gang-testing' is always to 'gang-cleanup'. When we
1085can safely leave 'gang-cleanup' is decided by the query:</p>
1086<pre class="literal-block">
1087SELECT COUNT(*)
1088FROM TestBoxStatuses,
1089 TestSets
1090WHERE TestSets.idTestSetGangLeader = :idTestSetGangLeader
1091 AND TestSets.idTestBox = TestBoxStatuses.idTestBox
1092 AND TestBoxStatuses.enmState = 'gang-running'::TestBoxState_T;
1093</pre>
1094<p>As long as there are testboxes still running, we stay in the 'gang-cleanup'
1095state. Once there are none, we continue closing the testset and such.</p>
1096</div>
1097<div class="section" id="testbox-reports-a-crash-during-test-execution">
1098<h2>#8 - Testbox Reports A Crash During Test Execution</h2>
1099<p>TODO</p>
1100</div>
1101<div class="section" id="cleaning-up-abandond-testcase">
1102<h2>#9 - Cleaning Up Abandond Testcase</h2>
1103<p>This is a subfunction of scenario #1 and #2. The actions taken are the same in
1104both situations. The precondition for taking this path is that the row in the
1105testboxstatus table is refering to a testset (i.e. testset_id is not NULL).</p>
1106<p>Actions:</p>
1107<ol class="arabic">
1108<li><dl class="first docutils">
1109<dt>If the testset is incomplete, we need to completed:</dt>
1110<dd><ol class="first last loweralpha simple">
1111<li>Add a message to the root TestResults row, creating one if necesary,
1112that explains that the test was abandond. This is done
1113by inserting/finding the string into/in TestResultStrTab and adding
1114a row to TestResultMsgs with idStrMsg set to that string id and
1115enmLevel set to 'failure'.</li>
1116<li>Mark the testset as failed.</li>
1117</ol>
1118</dd>
1119</dl>
1120</li>
1121<li><p class="first">Free any global resources referenced by the test set. This is done by
1122deleting all rows in GlobalResourceStatuses matching the testbox id.</p>
1123</li>
1124<li><p class="first">Set the idTestSet to NULL in the TestBoxStatuses row.</p>
1125</li>
1126</ol>
1127</div>
1128<div class="section" id="cleaning-up-a-disabled-dead-testbox">
1129<h2>#10 - Cleaning Up a Disabled/Dead TestBox</h2>
1130<p>The UI needs to be able to clean up the remains of a testbox which for some
1131reason is out of action. Normal cleaning up of abandond testcases requires
1132that the testbox signs on or asks for work, but if the testbox is dead or
1133in some way indisposed, it won't be doing any of that. So, the testbox
1134sheriff needs to have a way of cleaning up after it.</p>
1135<p>It's basically a manual scenario #9 but with some safe guards, like checking
1136that the box hasn't been active for the last 1-2 mins (max idle/wait time * 2).</p>
1137<dl class="docutils">
1138<dt>Note! When disabling a box that still executing the testbox script, this</dt>
1139<dd>cleanup isn't necessary as it will happen automatically. Also, it's
1140probably desirable that the testbox finishes what ever it is doing first
1141before going dormant.</dd>
1142</dl>
1143</div>
1144</div>
1145<div class="section" id="test-manager-analysis">
1146<h1>Test Manager: Analysis</h1>
1147<p>One of the testbox sheriff's tasks is to try figure out the reason why something
1148failed. The test manager will provide facilities for doing so from very early
1149in it's implementation.</p>
1150<p>We need to work out some useful status reports for the early implementation.
1151Later there will be more advanced analysis tools, where for instance we can
1152create graphs from selected test result values or test execution times.</p>
1153</div>
1154<div class="section" id="implementation-plan">
1155<h1>Implementation Plan</h1>
1156<p>This has changed for various reasons. The current plan is to implement the
1157infrastructure (TM &amp; testbox script) first and do a small deployment with the
11582-5 test drivers in the Testsuite as basis. Once the bugs are worked out, we
1159will convert the rest of the tests and start adding new ones.</p>
1160<p>We just need to finally get this done, no point in doing it piecemeal by now!</p>
1161<div class="section" id="test-manager-implementation-sub-tasks">
1162<h2>Test Manager Implementation Sub-Tasks</h2>
1163<p>The implementation of the test manager and adjusting/completing of the testbox
1164script and the test drivers are tasks which can be done by more than one
1165person. Splitting up the TM implementation into smaller tasks should allow
1166parallel development of different tasks and get us working code sooner.</p>
1167</div>
1168<div class="section" id="milestone-1">
1169<h2>Milestone #1</h2>
1170<p>The goal is to getting the fundamental testmanager engine implemented, debugged
1171and working. With the exception of testboxes, the configuration will be done
1172via SQL inserts.</p>
1173<p>Tasks in somewhat prioritized order:</p>
1174<blockquote>
1175<ul class="simple">
1176<li>Kick off test manager. It will live in testmanager/. Salvage as much as
1177possible from att/testserv. Create basic source and file layout.</li>
1178<li>Adjust the testbox script, part one. There currently is a testbox script
1179in att/testbox, this shall be moved up into testboxscript/. The script
1180needs to be adjusted according to the specification layed down earlier
1181in this document. Installers or installation scripts for all relevant
1182host OSes are required. Left for part two is result reporting beyond the
1183primary log. This task must be 100% feature complete, on all host OSes,
1184there is no room for FIXME, XXX or &#64;todo here.</li>
1185<li>Implement the schedule queue generator.</li>
1186<li>Implement the testbox dispatcher in TM. Support all the testbox script
1187responses implemented above, including upgrading the testbox script.</li>
1188<li>Implement simple testbox management page.</li>
1189<li>Implement some basic activity and result reports so that we can see
1190what's going on.</li>
1191<li>Create a testmanager / testbox test setup. This lives in selftest/.<ol class="arabic">
1192<li>Set up something that runs, no fiddly bits. Debug till it works.</li>
1193<li>Create a setup that tests testgroup dependencies, i.e. real tests
1194depending on smoke tests.</li>
1195<li>Create a setup that exercises testcase dependency.</li>
1196<li>Create a setup that exercises global resource allocation.</li>
1197<li>Create a setup that exercises gang scheduling.</li>
1198</ol>
1199</li>
1200<li>Check that all features work.</li>
1201</ul>
1202</blockquote>
1203</div>
1204<div class="section" id="milestone-2">
1205<h2>Milestone #2</h2>
1206<p>The goal is getting to VBox testing.</p>
1207<p>Tasks in somewhat prioritized order:</p>
1208<blockquote>
1209<ul class="simple">
1210<li>Implement full result reporting in the testbox script and testbox driver.
1211A testbox script specific reporter needs to be implemented for the
1212testdriver framework. The testbox script needs to forward the results to
1213the test manager, or alternatively the testdriver report can talk
1214directly to the TM.</li>
1215<li>Implement the test manager side of the test result reporting.</li>
1216<li>Extend the selftest with some setup that report all kinds of test
1217results.</li>
1218<li>Implement script/whatever feeding builds to the test manager from the
1219tinderboxes.</li>
1220<li>The toplevel test driver is a VBox thing that must be derived from the
1221base TestDriver class or maybe the VBox one. It should move from
1222toptestdriver to testdriver and be renamed to vboxtltd or smth.</li>
1223<li>Create a vbox testdriver that boots the t-xppro VM once and that's it.</li>
1224<li>Create a selftest setup which tests booting t-xppro taking builds from
1225the tinderbox.</li>
1226</ul>
1227</blockquote>
1228</div>
1229<div class="section" id="milestone-3">
1230<h2>Milestone #3</h2>
1231<p>The goal for this milestone is configuration and converting current testscases,
1232the result will be the a minimal test deployment (4-5 new testboxes).</p>
1233<p>Tasks in somewhat prioritized order:</p>
1234<blockquote>
1235<ul class="simple">
1236<li>Implement testcase configuration.</li>
1237<li>Implement testgroup configuration.</li>
1238<li>Implement build source configuration.</li>
1239<li>Implement scheduling group configuration.</li>
1240<li>Implement global resource configuration.</li>
1241<li>Re-visit the testbox configuration.</li>
1242<li>Black listing of builds.</li>
1243<li>Implement simple failure analysis and reporting.</li>
1244<li>Implement the initial smoke tests modelled on the current smoke tests.</li>
1245<li>Implement installation tests for Windows guests.</li>
1246<li>Implement installation tests for Linux guests.</li>
1247<li>Implement installation tests for Solaris guest.</li>
1248<li>Implement installation tests for OS/2 guest.</li>
1249<li>Set up a small test deployment.</li>
1250</ul>
1251</blockquote>
1252</div>
1253<div class="section" id="further-work">
1254<h2>Further work</h2>
1255<p>After milestone #3 has been reached and issues found by the other team members
1256have been addressed, we will probably go for full deployment.</p>
1257<p>Beyond this point we will need to improve reporting and analysis. There may be
1258configuration aspects needing reporting as well.</p>
1259<p>Once deployed, a golden rule will be that all new features shall have test
1260coverage. Preferrably, implemented by someone else and prior to the feature
1261implementation.</p>
1262</div>
1263</div>
1264<div class="section" id="discussion-logs">
1265<h1>Discussion Logs</h1>
1266<div class="section" id="various-discussions-with-michal-and-or-klaus">
1267<h2>2009-07-21,22,23 Various Discussions with Michal and/or Klaus</h2>
1268<ul class="simple">
1269<li>Scheduling of tests requiring more than one testbox.</li>
1270<li>Scheduling of tests that cannot be executing concurrently on several machines
1271because of some global resource like an iSCSI target.</li>
1272<li>Manually create the test config permutations instead of having the test
1273manager create all possible ones and wasting time.</li>
1274<li>Distinguish between built types so we can run smoke tests on strick builds as
1275well as release ones.</li>
1276</ul>
1277</div>
1278<div class="section" id="brief-discussion-with-michal">
1279<h2>2009-07-20 Brief Discussion with Michal</h2>
1280<ul class="simple">
1281<li>Installer for the testbox script to make bringing up a new testbox even
1282smoother.</li>
1283</ul>
1284</div>
1285<div class="section" id="raw-input">
1286<h2>2009-07-16 Raw Input</h2>
1287<ul>
1288<li><dl class="first docutils">
1289<dt>test set. recursive collection of:</dt>
1290<dd><ul class="first last simple">
1291<li>hierachical subtest name (slash sep)</li>
1292<li>test parameters / config</li>
1293<li>bool fail/succ</li>
1294<li>attributes (typed?)</li>
1295<li>test time</li>
1296<li>e.g. throughput</li>
1297<li>subresults</li>
1298<li>log</li>
1299<li>screenshots,....</li>
1300</ul>
1301</dd>
1302</dl>
1303</li>
1304<li><p class="first">client package (zip) dl from server (maybe client caching)</p>
1305</li>
1306<li><dl class="first docutils">
1307<dt>thoughts on bits to do at once.</dt>
1308<dd><ul class="first last simple">
1309<li>We <em>really</em> need the basic bits ASAP.</li>
1310<li>client -&gt; support for test driver</li>
1311<li>server -&gt; controls configs</li>
1312<li>cleanup on both sides</li>
1313</ul>
1314</dd>
1315</dl>
1316</li>
1317</ul>
1318</div>
1319<div class="section" id="id1">
1320<h2>2009-07-15 Raw Input</h2>
1321<ul class="simple">
1322<li>testing should start automatically</li>
1323<li>switching to branch too tedious</li>
1324<li>useful to be able to partition testboxes (run specific builds on some boxes, let an engineer have a few boxes for a while).</li>
1325<li>test specification needs to be more flexible (select tests, disable test, test scheduling (run certain tests nightly), ... )</li>
1326<li>testcase dependencies (blacklisting builds, run smoketests on box A before long tests on box B, ...)</li>
1327<li>more testing flexibility, more test than just install/moke. For instance unit tests, benchmarks, ...</li>
1328<li>presentation/analysis: graphs!, categorize bugs, columns reorganizing grouped by test (hierarchical), overviews, result for last day.</li>
1329<li>testcase specificion, variables (e.g. I/O-APIC, SMP, HWVIRT, SATA...) as sub-tests</li>
1330<li>interation with ILOM/...: reset systems</li>
1331<li>Changes needs LDAP authentication</li>
1332<li>historize all configuration w/ name</li>
1333<li>ability to run testcase locally (provided the VDI/ISO/whatever extra requirements can be met).</li>
1334</ul>
1335<hr class="docutils" />
1336<table class="docutils footnote" frame="void" id="id2" rules="none">
1337<colgroup><col class="label" /><col /></colgroup>
1338<tbody valign="top">
1339<tr><td class="label">[1]</td><td>no such footnote</td></tr>
1340</tbody>
1341</table>
1342<hr class="docutils" />
1343<table class="docutils field-list" frame="void" rules="none">
1344<col class="field-name" />
1345<col class="field-body" />
1346<tbody valign="top">
1347<tr class="field"><th class="field-name">Status:</th><td class="field-body">$Id: AutomaticTestingRevamp.html 59549 2016-02-01 15:57:21Z vboxsync $</td>
1348</tr>
1349<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Copyright (C) 2010-2016 Oracle Corporation.</td>
1350</tr>
1351</tbody>
1352</table>
1353</div>
1354</div>
1355</div>
1356</body>
1357</html>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette