First (still non-working) version of test framework.

[omk.git] / tests / README.tests

diff --git a/tests/README.tests b/tests/README.tests
new file mode 100644 (file)
index 0000000..5b156d7
--- /dev/null
+++ b/tests/README.tests
@@ -0,0 +1,46 @@
+Description of Testcases for OMK
+================================
+
+Each test resides in a separate directory. The directories can be
+nested. There is no difference between the tests in diffrent levels of
+directory structure.
+
+Structure of a Testcase
+-----------------------
+
+A directory contain the testcase if it contains at least one of these
+files: Makefile.test, run_test.
+
+Definition of a Testcase:
+
+* Makefile.test: testcase commands in the form of makefile. The test is
+  run by "make -f Makefile.test". If the exit status is zero, the
+  testcase is considered as passed, otherwise as failed.
+
+* run_test: executable file that runs the test(s). The exit status has
+  the same meaning as in the case of Makefile.test.
+
+* rules: Specifies the rules this testcase applies to. The syntax of
+  this files is describes in section Rules description.
+
+Output of testcase:
+
+Besides exit status, the testcases can produce the folowing output.
+
+* FIXME: chybove hlaseni - soubor error nebo stderr?
+
+Rules Description
+-----------------
+
+The rules file contains one or more lines. Each line represents a set
+of zero or more rules. The set of rules to be applied to this testcase
+is union of these sets.
+
+Each line can contain:
+
+* <rule name> - This selects rules of this name
+
+* all: - this selects all rules
+
+* snip:<snippet name> - this selects all the rules, which are composed
+  of the given snippet.