From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1QYFeE-0001OD-MS for garchives@archives.gentoo.org; Sun, 19 Jun 2011 10:54:34 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 468BC1C036; Sun, 19 Jun 2011 10:54:27 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id 177991C036 for ; Sun, 19 Jun 2011 10:54:27 +0000 (UTC) Received: from pelican.gentoo.org (unknown [66.219.59.40]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 910241B4012 for ; Sun, 19 Jun 2011 10:54:26 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by pelican.gentoo.org (Postfix) with ESMTP id D494B8003C for ; Sun, 19 Jun 2011 10:54:25 +0000 (UTC) From: "Michał Górny" To: gentoo-commits@lists.gentoo.org Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Michał Górny" Message-ID: <98fed8f726aaf5d41a59b775f412eeed7a31ee0c.mgorny@gentoo> Subject: [gentoo-commits] proj/pms-test-suite:master commit in: doc/ X-VCS-Repository: proj/pms-test-suite X-VCS-Files: doc/library-format.md X-VCS-Directories: doc/ X-VCS-Committer: mgorny X-VCS-Committer-Name: Michał Górny X-VCS-Revision: 98fed8f726aaf5d41a59b775f412eeed7a31ee0c Date: Sun, 19 Jun 2011 10:54:25 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: X-Archives-Hash: 880bb38d95a7898c2253736ed7d1fe14 commit: 98fed8f726aaf5d41a59b775f412eeed7a31ee0c Author: Micha=C5=82 G=C3=B3rny gentoo org> AuthorDate: Sun Jun 19 10:33:08 2011 +0000 Commit: Micha=C5=82 G=C3=B3rny gentoo org> CommitDate: Sun Jun 19 10:33:08 2011 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=3Dproj/pms-test-suit= e.git;a=3Dcommit;h=3D98fed8f7 Basic docs on the library format. --- doc/library-format.md | 32 ++++++++++++++++++++++++++++++++ 1 files changed, 32 insertions(+), 0 deletions(-) diff --git a/doc/library-format.md b/doc/library-format.md new file mode 100644 index 0000000..a2fa056 --- /dev/null +++ b/doc/library-format.md @@ -0,0 +1,32 @@ +PMS Test Suite -- test library format +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Basic concepts +-------------- + +The basic unit of a test suite is a _test case_. A test case forms a sin= gle +Python class. That class is then instantiated into one or more test case +instances. + +A _test case instance_ corresponds to a single actual test. Each instanc= e +provides functions to: + +1. merge any number of files to the test repository, +2. clean up the system before and after performing the tests, +3. merge the tests, +4. check the test results. + +A number of tests builds up a test library. Each _test library_ consists= of one +or more Python packages, providing a number of Python modules. Those mod= ules +shall contain at least the test case classes, and a single `TestLibrary` +subclass, providing a complete list of test cases. + + +More information +---------------- + +1. `pydoc PMSTestSuite.library.library` +2. `pydoc PMSTestSuite.library.case` +3. `pydoc PMSTestSuite.library.depend_case` + +