External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-01 17:35:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Convert 'testapi' page to rST

Browse Source 
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2022-03-10 16:23:24 +01:00
parent 5042a5def6
commit 6c0f4c02b9
3 changed files with 35 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/meson.build
View File

@ -57,7 +57,6 @@ docs_html_in_files = [
'python',
'remote',
'storage',
'testapi',
'testsuites',
'testtck',
'tlscerts',
@ -112,6 +111,7 @@ docs_rst_files = [
'styleguide',
'submitting-patches',
'support',
'testapi',
]
# list of web targets to build for docs/web rule

35
docs/testapi.html.in
View File

@ -1,35 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
<h1>libvirt-test-API: Python based test suite </h1>
<p>Libvirt-test-API is a powerful test tool designed to complement
existing libvirt test tools such as libvirt-TCK and the internal
test suite. It aims at functional regression testing, trying to
exercise nearly all the API by the way of the Python bindings.</p>
<p>The test API currently covers:</p>
<ul>
<li>domain: all classical lifetime operations, installation of
various guests OSes, snapshots</li>
<li>interfaces: define, create, destroy, undefine, NPIV</li>
<li>virtual networks: define, create, destroy, undefine</li>
<li>storage: regression tests for most storage types and configurations
dir, disk, netfs, iSCSI, multipath</li>
</ul>
<p>Some of the tests need dedicated local resources whose definitions
are stored in a configuration file. The tests are defined using
Python modules defining the code for the test, this is called
a <tt>test case</tt>, and test <tt>configuration files</tt> using one
or more test case to define a given test scenario.</p>
<p>For more details you can look at:</p>
<ul>
<li> A <a href="https://libvirt.org/sources/libvirt-test-API/Libvirt-test-API.pdf">documentation PDF</a>
file describing the test suite and how to write test cases
and test scenarios.</li>
</ul>
<p> Libvirt-test-API is maintained using
<a href="https://gitlab.com/libvirt/libvirt-test-API">a GIT
repository</a>, and comment, patches and reviews are carried
on the <a href="contact.html">libvir-list</a> development list.</p>
</body>
</html>

34
docs/testapi.rst Normal file
View File

@ -0,0 +1,34 @@
=========================================
libvirt-test-API: Python based test suite
=========================================
Libvirt-test-API is a powerful test tool designed to complement existing libvirt
test tools such as libvirt-TCK and the internal test suite. It aims at
functional regression testing, trying to exercise nearly all the API by the way
of the Python bindings.
The test API currently covers:
- domain: all classical lifetime operations, installation of various guests
OSes, snapshots
- interfaces: define, create, destroy, undefine, NPIV
- virtual networks: define, create, destroy, undefine
- storage: regression tests for most storage types and configurations dir,
disk, netfs, iSCSI, multipath
Some of the tests need dedicated local resources whose definitions are stored in
a configuration file. The tests are defined using Python modules defining the
code for the test, this is called a test case, and test configuration files
using one or more test case to define a given test scenario.
For more details you can look at:
- A `documentation
PDF <https://libvirt.org/sources/libvirt-test-API/Libvirt-test-API.pdf>`__
file describing the test suite and how to write test cases and test
scenarios.
Libvirt-test-API is maintained using `a GIT
repository <https://gitlab.com/libvirt/libvirt-test-API>`__, and comment,
patches and reviews are carried on the `libvir-list <contact.html>`__
development list.