1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>The VirtualBox Validation Kit</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: VBoxValidationKitReadMe.html $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="the-virtualbox-validation-kit">
<h1 class="title">The VirtualBox Validation Kit</h1>
<div class="section" id="introduction">
<h1>Introduction</h1>
<p>The VirtualBox Validation Kit is our new public tool for doing automated
testing of VirtualBox. We are continually working on adding new features
and guest operating systems to our battery of tests.</p>
<p>We warmly welcome contributions, new ideas for good tests and fixes.</p>
</div>
<div class="section" id="directory-layout">
<h1>Directory Layout</h1>
<dl class="docutils">
<dt>./docs/</dt>
<dd><p class="first">The documentation for the test suite mostly lives here, the exception being
readme.txt files that are better off living near what they concern.</p>
<p class="last">For a definition of terms used here, see the Definitions / Glossary section
of ./docs/AutomaticTestingRevamp.txt / ./docs/AutomaticTestingRevamp.html.</p>
</dd>
<dt>./testdriver/</dt>
<dd><p class="first">Python module implementing the base test drivers and supporting stuff.
The base test driver implementation is found in ./testdriver/base.py while
the VBox centric specialization is in ./testdriver/vbox.py. Various VBox
API wrappers that makes things easier to use and glosses over a lot of API
version differences that live in ./testdriver/vboxwrappers.py.</p>
<p>Test VM collections are often managed thru ./testdriver/vboxtestvms.py, but
doesn't necessarily have to be, it's up to the individual test driver.</p>
<p>For logging, reporting result, uploading useful files and such we have a
reporter singleton sub-package, ./testdriver/reporter.py. It implements
both local (for local testing) and remote (for testboxes + test manager)
reporting.</p>
<p class="last">There is also a VBoxTXS client implementation in txsclient.py and a stacked
test driver for installing VBox (vboxinstaller.py). Most test drivers will
use the TXS client indirectly thru vbox.py methods. The installer driver
is a special trick for the testbox+testmanager setup.</p>
</dd>
<dt>./tests/</dt>
<dd>The python scripts driving the tests. These are organized by what they
test and are all derived from the base classes in ./testdriver (mostly from
vbox.py of course). Most tests use one or more VMs from a standard set of
preconfigured VMs defined by ./testdriver/vboxtestvms.py (mentioned above),
though the installation tests used prepared ISOs and floppy images.</dd>
<dt>./vms/</dt>
<dd>Text documents describing the preconfigured test VMs defined by
./testdrive/vboxtestvms.py. This will also contain description of how to
prepare installation ISOs when we get around to it (soon).</dd>
<dt>./utils/</dt>
<dd><p class="first">Test utilities and lower level test programs, compiled from C, C++ and
Assembly mostly. Generally available for both host and guest, i.e. in the
zip and on the VBoxValidationKit.iso respectively.</p>
<p>The Test eXecution Service (VBoxTXS) found in ./utils/TestExecServ is one
of the more important utilities. It implements a remote execution service
for running programs/tests inside VMs and on other test boxes. See
./utils/TestExecServ/vboxtxs-readme.txt for more details.</p>
<p class="last">A simple network bandwidth and latency test program can be found in
./utils/network/NetPerf.cpp.</p>
</dd>
<dt>./bootsectors/</dt>
<dd><p class="first">Boot sector test environment. This allows creating floppy images in
assembly that tests specific CPU or device behavior. Most tests can be
put on a USB stick, floppy or similar and booted up on real hardware for
comparison. All floppy images can be used for manual testing by developers
and most will be used by test drivers (./tests/<em>/td</em>.py) sooner or later.</p>
<p class="last">The boot sector environment is heavily bound to yasm and it's ability to
link binary images for single assembly input units. There is a "library"
of standard initialization code and runtime code, which include switch to
all (well V8086 mode is still missing, but we'll get that done eventually)
processor modes and paging modes. The image specific code is split into
init/driver code and test template, the latter can be instantiated for each
process execution+paging mode.</p>
</dd>
<dt>./common/</dt>
<dd>Python package containing common python code.</dd>
<dt>./testboxscript/</dt>
<dd>The testbox script. This is installed on testboxes used for automatic
testing with the testmanager.</dd>
<dt>./testmanager/</dt>
<dd>The VirtualBox Test Manager (server side code). This is written in Python
and currently uses postgresql as database backend for no particular reason
other than that it was already installed on the server the test manager was
going to run on. It's relatively generic, though there are of course
things in there that are of more use when testing VirtualBox than other
things. A more detailed account (though perhaps a little dated) of the
test manager can be found in ./docs/AutomaticTestingRevamp.txt and
./docs/AutomaticTestingRevamp.html.</dd>
<dt>./testanalysis/</dt>
<dd>A start a local test result analysis, comparing network test output. We'll
probably be picking this up again later.</dd>
<dt>./snippets/</dt>
<dd>Various code snippets that may be turned into real tests at some point.</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Status:</th><td class="field-body">$Id: VBoxValidationKitReadMe.html $</td>
</tr>
<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Copyright (C) 2010-2023 Oracle Corporation.</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>
|
