runner/adt-run.1

   1 .TH adt\-run 1 2006 autodebtest "Linux Programmer's Manual"
   2 .SH NAME
   3 adt\-run \- test an installed binary package using the package's tests
   4 .SH SYNOPSYS
   5 .B adt\-run
   6 .IR options ...
   7 .B \-\-\-
   8 .I virt\-server
   9 .RI [ virt\-server\-arg ...]
  10 .br
  11 .SH DESCRIPTION
  12 .B adt\-run
  13 is the program for invoking the autodebtest package testing machinery.
  14
  15 autodebtest is a facility for testing binary packages, as installed on
  16 a system (such as a testbed system).  The tests are those supplied in
  17 the source package.
  18
  19 adt\-run runs each test supplied by a particular package and reports
  20 the results.  It drives the specified virtualisation regime as
  21 appropriate, and parses the test description metadata, and arranges
  22 for data to be copied to and from the testbed as required.
  23
  24 adt\-run should be invoked (unless options to the contrary are
  25 supplied) in the top level directory of the built source tree, on the
  26 host.  The package should be installed on the testbed.
  27
  28 .SH OPTIONS
  29 .TP
  30 .BR \-\-build\-tree [ \-tb ] " " \fIdirectory\fR
  31 Specifies that the built source tree can be found in
  32 .IR directory .
  33 (Default: adt\-run's current directory, on the host.)
  34 .TP
  35 .BR \-\-control [ \-tb ] " " \fIcontrol\fR
  36 Specifies that
  37 .I control
  38 should be used as the test control file instead of
  39 .B debian/tests/control
  40 in the build tree.  Note that it is not an error for this file not to
  41 exist; that just means that there are no tests.
  42 .TP
  43 .BR \-d " | " \-\-debug
  44 Enables debugging output.  Probably not hugely interesting.
  45 .TP
  46 \fB\-\-\-\fR \fIvirt\-server virt\-server\-arg\fR...
  47 Specifies the virtualisation regime server, as a command and arguments
  48 to invoke.  All the remaining arguments and options after
  49 .B \-\-\-
  50 are passed to the virtualisation server program.
  51
  52 .SS NOTES
  53 Some options which come in variants with and without
  54 .BR \-tb .
  55 These specify paths on the testbed and the host, respectively.  The
  56 data will be copied by
  57 .B adt\-run
  58 to where it is needed.
  59
  60 .SH OUTPUT FORMAT
  61 During a normal test run, one line is printed for each test.  This
  62 consists of the name of the test, some horizontal whitespace, and
  63 either
  64 .B PASS
  65 or
  66 .BR FAIL " reason"
  67 or
  68 .BR SKIP " reason"
  69 where the pass/fail indication is separated by any reason by some
  70 horizontal whitespace.
  71
  72 Sometimes a
  73 .B SKIP
  74 will be reported when the name of the test is not known or not
  75 applicable: for example, when there are no tests in the package, or a
  76 there is a test stanza which contains features not understood by this
  77 version of
  78 .BR adt\-run .
  79 In this case
  80 .B *
  81 will appear where the name of the test should be.
  82
  83 .SH EXIT STATUS
  84 0       all tests passed
  85 .br
  86 2       at least one test skipped
  87 .br
  88 4       at least one test failed
  89 .br
  90 6       at least one test failed and at least one test skipped
  91 .br
  92 8       no tests in this package
  93 .br
  94 12      erroneous package
  95 .br
  96 16      testbed failure
  97 .br
  98 20      other unexpected failures including bad usage
  99
 100 .SH SEE ALSO
 101 \fBadt\-virt\-chroot\fR(1)
 102
 103 .SH BUGS
 104 This tool still lacks many important features.
 105
 106 .SH AUTHORS AND COPYRIGHT
 107 This manpage is part of autodebtest, a tool for testing Debian binary
 108 packages.  autodebtest is Copyright (C) 2006 Canonical Ltd and others.
 109
 110 See \fB/usr/share/doc/autodebtest/CREDTIS\fR for the list of
 111 contributors and full copying conditions.