]> xenbits.xensource.com Git - libvirt.git/commitdiff
Add documentation about test suites
authorDaniel Veillard <veillard@redhat.com>
Wed, 11 May 2011 11:18:38 +0000 (19:18 +0800)
committerDaniel Veillard <veillard@redhat.com>
Wed, 11 May 2011 11:18:38 +0000 (19:18 +0800)
Create a new top level entry, add a new page listing the 3
test suites, and then one page for the TCK and one page for
libvirt-test-API

docs/sitemap.html.in
docs/testapi.html.in [new file with mode: 0644]
docs/testsuites.html.in [new file with mode: 0644]
docs/testtck.html.in [new file with mode: 0644]

index 5650feeafae1039ca9300ed90430091f7c26d100..ad8dc7b0f43ac500752a8266032d47052e6099e1 100644 (file)
         <a href="contact.html">Contact</a>
         <span>How to contact the developers via email and IRC</span>
       </li>
+      <li>
+        <a href="testsuites.html">Test suites</a>
+        <span>Available test suites for libvirt</span>
+        <ul>
+          <li>
+            <a href="testtck.html">TCK test suite</a>
+            <span>Virtualization functional test suite in Perl</span>
+          </li>
+          <li>
+            <a href="testapi.html">Libvirt-test-API</a>
+            <span>Libvirt functional API test suite in Python</span>
+          </li>
+        </ul>
+      </li>
       <li>
         <a href="relatedlinks.html">Related Links</a>
         <span>Miscellaneous links of interest related to libvirt</span>
diff --git a/docs/testapi.html.in b/docs/testapi.html.in
new file mode 100644 (file)
index 0000000..9b6161d
--- /dev/null
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<html>
+  <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="http://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.
+    </ul>
+    <p> Libvirt-test-API is maintained using
+        <a href="http://libvirt.org/git/?p=libvirt-test-API.git">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>
diff --git a/docs/testsuites.html.in b/docs/testsuites.html.in
new file mode 100644 (file)
index 0000000..86fd5ef
--- /dev/null
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1>Test suites</h1>
+    <p>There is a few test suites available to developers for testing
+    a given version of libvirt:</p>
+    <ul>
+      <li>the internal test suite: present in the source code, it is run
+          by developers before submitting patches upstream, it is also
+          suggested to have it run and pass as part of the packaging
+          process for distributions. It is run by launching:
+          <pre>make check</pre>
+          in a source tree after compilation has finished. It doesn't
+          really make functional testing but checks that large portions
+          of the code not interacting directly with virtualization
+          functions properly.
+      </li>
+      <li>the <a href="testtck.html">TCK test suite</a> is a functional
+          test suite implemented using the
+          <a href="http://search.cpan.org/dist/Sys-Virt/">Perl bindings</a>
+          of libvirt. It is available separately as a
+          <a href="ftp://libvirt.org/libvirt/tck/">download</a>, as a
+          <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libvirt-tck">package</a>
+          in Fedora distributions, but best is probably to get
+          the <a href="http://libvirt.org/git/?p=libvirt-tck.git">version
+          from GIT</a>.
+      <li>the <a href="testapi.html">libvirt-test-API</a> is also a functional
+          test suite, but implemented using the
+          <a href="python.html">Python bindings</a>
+          of libvirt. It is available separately as a
+          <a href="ftp://libvirt.org/libvirt/libvirt-test-API/">download</a>,
+          or directly get the
+          the <a href="http://libvirt.org/git/?p=libvirt-test-API.git">version
+          from GIT</a>.
+    </ul>
+  </body>
+</html>
diff --git a/docs/testtck.html.in b/docs/testtck.html.in
new file mode 100644 (file)
index 0000000..c0e7008
--- /dev/null
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1>libvirt TCK  : Technology Compatibility Kit</h1>
+    <p>The libvirt TCK provides a framework for performing testing
+    of the integration between libvirt drivers, the underlying virt
+    hypervisor technology, related operating system services and system
+    configuration. The idea (and name) is motivated by the Java TCK.</p>
+    <p>In particular the libvirt TCK is intended to address the following
+    scenarios:</p>
+    <ul>
+      <li>Validate that a new libvirt driver is in compliance
+          with the (possibly undocumented!) driver API semantics</li>
+      <li>Validate that an update to an existing driver does not
+         change the API semantics in a non-compliant manner</li>
+      <li>Validate that a new hypervisor release is still providing
+         compatibility with the corresponding libvirt driver usage</li>
+      <li>Validate that an OS distro deployment consisting of a
+         hypervisor and libvirt release is configured correctly</li>
+    </ul>
+    <p>Thus the libvirt TCK will allow developers, administrators and users
+    to determine the level of compatibility of their platform, and
+    evaluate whether it will meet their needs, and get awareness of any
+    regressions that may have occurred since a previous test run.</p>
+    <p>For more details you can look at:</p>
+    <ul>
+      <li> The initial
+<a href="http://www.redhat.com/archives/libvir-list/2009-April/msg00176.html">mail
+           from Daniel Berrange</a> presenting the project.
+      <li> The <a href="http://fedoraproject.org/wiki/Features/VirtTCK">page
+           describing VirtTCK</a> the inclusion of libvirt-TCK as a
+           Fedora Feature.</li>
+    </ul>
+    <p> Libvirt-TCK is maintained using
+        <a href="http://libvirt.org/git/?p=libvirt-tck.git">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>