Re: [libvirt] [PATCH] Documentation on tests suites and new API test suite
On 05/10/2011 12:21 AM, Daniel Veillard wrote:
I hesitated between creating a new doc section and trying to reuse
one existing, but it didn't fit well in any of the existing section,
though that could have been added under "Download" or "Related
links"
but it was feeling a bit weird in both case so I opted for a new top
level.
Seems okay to me.
Add documentation about test suites
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
diff --git a/docs/testapi.html.in b/docs/testapi.html.in
new file mode 100644
index 0000000..a71c09a
--- /dev/null
+++ b/docs/testapi.html.in
@@ -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
+ exercize nearly all the API by the way of the Python bindings.</p>
s/exercize/exercise/
(We probably already have a mix of US vs. UK spellings on the web pages,
but I think the preference has been to settle on US)
+++ b/docs/testsuites.html.in
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Test suites</h1>
+ <p>There is a few test suites available to developpers for testing
s/developpers/developers/
+ a given version of libvirt:</p>
+ <ul>
+ <li>the internal test suite: present in the source code, it is run
+ by developpers before submitting patches upstream, it is also
s/developpers/developers/
+++ b/docs/testtck.html.in
@@ -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
+ compatability with the corresponding libvirt driver usage</li>
s/compatability/compatibility/
+ <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 compatability of their platform, and
s/compatability/compatibility/
ACK with those spelling nits fixed.
--
Eric Blake eblake(a)redhat.com +1-801-349-2682
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 619 bytes)