NAME

       Config::Model::models::Dpkg::Tests::Control - Configuration class Dpkg::Tests::Control

DESCRIPTION

       Configuration classes used by Config::Model

       describes how autopkgtest interprets and executes tests found in Debian source packages.

       See <https://people.debian.org/~mpitt/autopkgtest/README.package-tests.html>

Elements

   Tests
        Optional. Type list of uniline.

   Test-Command
        Optional. Type uniline.

   Restrictions
       Declares some restrictions or problems with the tests defined in this stanza. Depending on the test
       environment capabilities, user requests, and so on, restrictions can cause tests to be skipped or can
       cause the test to be run in a different manner.  Optional. Type check_list. choice: 'rw-build-tree',
       'breaks-testbed', 'needs-root', 'build-needed', 'allow-stderr', 'isolation-container',
       'isolation-machine', 'needs-reboot', 'needs-recommends'.

       Here are some explanations on the possible values:

       'allow-stderr'
           Output  to  stderr  is  not  considered a failure. This is useful for tests which write e. g. lots of
           logging to stderr.

       'breaks-testbed'
           The test, when run, is liable to break the testbed system. This includes causing data  loss,  causing
           services  that  the machine is running to malfunction, or permanently disabling services; it does not
           include causing services on the machine to temporarily fail.

           When this restriction is present the test will usually be skipped unless the testbed's virtualisation
           arrangements are sufficiently powerful, or alternatively if the user explicitly requests.

       'build-needed'
           The tests need to be run from a built source tree.  The  test  runner  will  build  the  source  tree
           (honouring the source package's build dependencies), before running the tests. However, the tests are
           not  entitled  to assume that the source package's build dependencies will be installed when the test
           is run.

           Please use this considerately, as for large builds it unnecessarily builds the  entire  project  when
           you  only  need  a  tiny  subset (like the tests/ subdirectory). It is often possible to run "make -C
           tests" instead, or copy the test code to  $AUTOPKGTEST_TMP  and  build  it  there  with  some  custom
           commands.  This  cuts  down  the load on the Continuous Integration servers and also makes tests more
           robust as it prevents accidentally running  them  against  the  built  source  tree  instead  of  the
           installed packages.

       'isolation-container'
           The  test  wants  to  start  services  or  open  network  TCP  ports. This commonly fails in a simple
           chroot/schroot, so tests need to be run in their own container (e. g. autopkgtest-virt-lxc) or  their
           own  machine/VM  (e.  g.  autopkgtest-virt-qemu or autopkgtest-virt-null). When running the test in a
           virtualization server which does not provide this (like autopkgtest-schroot) it will be skipped.

       'isolation-machine'
           The test wants to interact with the kernel, reboot the machine, or  other  things  which  fail  in  a
           simple  schroot  and  even  a  container.  Those  tests need to be run in their own machine/VM (e. g.
           autopkgtest-virt-qemu or autopkgtest-virt-null). When running the test  in  a  virtualization  server
           which does not provide this it will be skipped.

       'needs-reboot'
           The     test     wants     to    reboot    the    machine    using    /tmp/autopkgtest-reboot.    See
           <https://people.debian.org/~mpitt/autopkgtest/README.package-tests.html>

       'needs-recommends'
           Enable installation of recommended packages in apt for the test dependencies. This  does  not  affect
           build dependencies.

       'needs-root'
           The test script must be run as root.

       'rw-build-tree'
           The  test(s)  needs  write  access to the built source tree (so it may need to be copied first). Even
           with this restriction, the test is not allowed to make any change to the built source tree which  (i)
           isn't cleaned up by debian/rules clean, (ii) affects the future results of any test, or (iii) affects
           binary packages produced by the build tree in the future.

   Features
           Declares some additional capabilities or good properties of the tests defined in this stanza. Any unknown features declared will be completely ignored. See below for the defined features.
       I< Optional. Type uniline.  >

   Depends
       Declares  that  the  specified  packages  must  be  installed for the test to go ahead. This supports all
       features                  of                   dpkg                   dependencies                   (see
       <https://www.debian.org/doc/debian-policy/#document-ch-relationships>), plus the following extensions:

       @  stands  for  the  package(s)  generated  by  the  source package containing the tests; each dependency
       (strictly, or-clause, which may contain |s but not commas) containing @ is replicated once for each  such
       binary  package,  with  the  binary package name substituted for each @ (but normally @ should occur only
       once and without a version restriction).

       @builddeps@ will be replaced  by  the  package's  "Build-Depends:",  "Build-Depends-Indep:",  and  build-
       essential.  This  is  useful if you have many build dependencies which are only necessary for running the
       test suite and you don't want to replicate  them  in  the  test  "Depends:".  However,  please  use  this
       sparingly,  as  this  can easily lead to missing binary package dependencies being overlooked if they get
       pulled in via build dependencies.

       If no Depends field is present, "Depends: @" is assumed. Note that the source  tree's  Build-Dependencies
       are  not  necessarily  installed,  and if you specify any Depends, no binary packages from the source are
       installed unless explicitly requested.   Optional. Type string.

       upstream_default value :
           @

   Tests-Directory
       Replaces the path segment debian/tests in the filenames of the test programs with path. I. e., the  tests
       are  run  by  executing  built/source/tree/path/testname. path must be a relative path and is interpreted
       starting from the root of the built source tree.

       This allows tests to live outside the debian/ metadata area, so that they can more  palatably  be  shared
       with non-Debian distributions.   Optional. Type uniline.

   Classes
       Most  package  tests should work in a minimal environment and are usually not hardware specific. However,
       some packages like the kernel, X.org, or graphics drivers should be tested on  particular  hardware,  and
       also run on a set of different platforms rather than just a single virtual testbeds.

       This  field  can specify a list of abstract class names such as "desktop" or "graphics-driver". Consumers
       of autopkgtest can then map these class names to particular  machines/platforms/policies.  Unknown  class
       names should be ignored.

       This  is  purely  an  informational  field  for  autopkgtest  itself and will be ignored.  Optional. Type
       uniline.

SEE ALSO

       •   cme

perl v5.26.1                                       2018-01-19              Config::Model:...:Tests::Control(3pm)