1LIBVIRT-TCK(1)        User Contributed Perl Documentation       LIBVIRT-TCK(1)
2
3
4

NAME

6       libvirt-tck - libvirt Technology Compatability Kit
7

SYNOPSIS

9        # libvirt-tck [OPTIONS] [TESTS..]
10
11       Run with default config, probing for URI to use
12
13        # libvirt-tck
14
15       Run with a custom config
16
17        # libvirt-tck --config /etc/libvirt/other.cfg
18
19       Run with verbose progress information
20
21        # libvirt-tck -v
22
23       Generate a formal XML document of results
24
25        # libvirt-tck --format xml
26
27       Generate a JUnit XML document of results
28
29        # libvirt-tck --format junit
30

DESCRIPTION

32       The "libvirt-tck" (libvirt Technology Compatability Kit) command
33       provides the primary mechanism to run the functional, integration test
34       suite for libvirt drivers.
35
36   WARNING
37       The test suite is intended to be moderately safe to run on arbitrary
38       hosts and takes steps to avoid intentionally breaking things.
39
40       All objects (guests, networks, storage pools, etc) that are created
41       will  have a name prefix of "tck" to minimize risk of clashes. The test
42       suite will only ever (intentionally) delete objects with a "tck" name
43       prefix.
44
45       Where a test suite needs access to a precious host resource (physical
46       NIC, PCI device, USB device, block device), execution will be skipped
47       until the admin has white listed one or more suitable resources in the
48       "/etc/libvirt-tck/default.cfg" configuration file.
49
50       Despite these precautions, running automated tests always carries some
51       degree of risk to the host system. It is thus advisable to avoid
52       executing this test suite on hosts with precious state.
53
54   OPTIONS
55       If invoked without any arguments the test suite will run using the
56       default configuration file from "/etc/libvirt-tck/default.cfg" and will
57       allow libvirt to probe for the hypervisor driver to run. If a reliably
58       repeatable test result set is desired, it is recommended to always give
59       an explicit libvirt connection URI to choose the driver.
60
61       Any command line arguments that are not parsed as options will be
62       considered paths to test scripts to invoke. If no paths are given, all
63       tests under "/usr/share/libvirt-tck/tests" will be executed.
64
65       The following options are available when running the "libvirt-tck"
66       command
67
68       -v, --verbose
69           Display fine details of individual test progresss. Without this
70           only the name of each test will be printed, along with details of
71           failures.
72
73       -q, --quiet
74           Do not display any information about test progress, not even the
75           name of each test case
76
77       -c, --config FILE
78           Specify the name of the configuration file to use, rather than the
79           default "/etc/libvirt-tck/default.cfg"
80
81       --format text|html|xml|junit
82           Choose the output format for the test results. The default format
83           is "text", producing human readable results on the console. The
84           "html" option dumps an HTML file of results to STDOUT, while the
85           "xml" option generates a formal XML document of results.
86
87       --force
88           Forcably remove all previously created objects, including guests,
89           networks, storage pools, etc which have a "tck" name prefix.
90
91           User created objects whose name does not start with "tck" will be
92           left untouched.
93
94       -a, --archive FILE
95           Generate an archive containing all the raw test results. The
96           filename given should end in either ".bz", ".tar.gz" or ".tgz"
97
98       --timer
99           Print elapsed time after each test.
100

AUTHORS

102       Written by Daniel P. Berrange <berrange@redhat.com>
103

BUGS

105       Probably. Report any bugs found to your OS distribution's bug tracker
106       or the libvirt mailing list
107       <http://www.redhat.com/mailman/listinfo/libvir-list>
108

LICENSE

110       Copyright (C) 2009 Daniel P. Berrange Copyright (C) 2009 Red Hat, Inc.
111
112       "libvirt-tck" is distributed under the terms of the GNU GPL v2+. This
113       is free software; see the source for copying conditions.  There is NO
114       warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
115       PURPOSE.
116

SEE ALSO

118       "prove". If you need more fine grained control over running the tests,
119       then set the LIBVIRT_TCK_CONFIG environment variable to point to your
120       configuration file, and then run the "prove" command passing in the
121       path to the test scripts to run.
122
123
124
125perl v5.38.0                      2023-07-21                    LIBVIRT-TCK(1)