[gentoo-commits] proj/pms-test-suite:master commit in: doc/

["Michał Górny" <mgorny@gentoo.org>]

commit:     bf06933c9d33ee68241646630d85b051e7f5febe
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Mon Jun 20 19:19:32 2011 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Mon Jun 20 19:19:32 2011 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/pms-test-suite.git;a=commit;h=bf06933c

Add docs about the TestCase.

---
 doc/library-format.md |   26 +++++++++++++++++++++++++-
 1 files changed, 25 insertions(+), 1 deletions(-)

diff --git a/doc/library-format.md b/doc/library-format.md
index 14d6e00..203c6c4 100644
--- a/doc/library-format.md
+++ b/doc/library-format.md
@@ -58,11 +58,35 @@ The above example would load two tests:
 - and `FooTest` from `PMSTestSuite.library.foobar.bar`.
 
 
+The test class
+--------------
+
+Each _test case_ has to be a subclass of `PMSTestSuite.library.case.TestCase`.
+That class represents a most general test case with an interface described
+above. A particular subclass needs to override the following methods:
+
+- `get_output_files()` returning a dict representing files which should be
+	output to the test repository (keys being filenames relative
+	to the repository root and values being file contents),
+- `clean()` removing any merged test data before and after performing the test,
+- `start()` starting (scheduling) the actual test,
+- `check_result()` checking the test results. It should return True if the test
+	succeeded and False otherwise.
+
+The three latter functions will be passed a `PackageManager` instance, which
+methods `merge()`, `unmerge()` and `lookup_vardb()` can be used. For more
+information, please see the docs of `PMSTestSuite.pm` module.
+
+In most cases, though, you won't be subclassing `TestCase` directly but using
+one of its subclasses defined in the `PMSTestSuite.library` submodules.
+
+
 More information
 ----------------
 
 1. `pydoc PMSTestSuite.library`
 2. `pydoc PMSTestSuite.library.case`
-3. `pydoc PMSTestSuite.library.depend_case`
+3. `pydoc PMSTestSuite.pm.PackageManager`
+4. `pydoc PMSTestSuite.library.depend_case`
 
 <!-- vim:se syn=markdown :-->