From 6c0f4c02b9ff83bc368b51120a39705e9122d4ab Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 16:23:24 +0100 Subject: [PATCH] docs: Convert 'testapi' page to rST MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/meson.build | 2 +- docs/testapi.html.in | 35 ----------------------------------- docs/testapi.rst | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 36 deletions(-) delete mode 100644 docs/testapi.html.in create mode 100644 docs/testapi.rst diff --git a/docs/meson.build b/docs/meson.build index aaafa7d8e1..087afb15d9 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -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 diff --git a/docs/testapi.html.in b/docs/testapi.html.in deleted file mode 100644 index e7cd9453ee..0000000000 --- a/docs/testapi.html.in +++ /dev/null @@ -1,35 +0,0 @@ - - - - -

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 - file describing the test suite and how to write test cases - and test scenarios.
    • -
-

Libvirt-test-API is maintained using - a GIT - repository, and comment, patches and reviews are carried - on the libvir-list development list.

- - diff --git a/docs/testapi.rst b/docs/testapi.rst new file mode 100644 index 0000000000..9aa0afb761 --- /dev/null +++ b/docs/testapi.rst @@ -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 `__ + file describing the test suite and how to write test cases and test + scenarios. + +Libvirt-test-API is maintained using `a GIT +repository `__, and comment, +patches and reviews are carried on the `libvir-list `__ +development list.