summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..68b53a9
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+GENERAL INFO
+============
+
+System checking (dummy) testsuite fw. The tests are *expected* to be
+destructive and always performed under root account; test writer should only
+make sure that no test conflicts with others (so that all tests are able to run
+on one machine successfully in any order).
+
+OVERVIEW
+========
+
+
+Each file should consist of config.sh and runtest.sh. Both are supposed to be
+"sourced" into another scripts (so no need to have execute permissions). Each
+test case should have its own directory.
+
+USAGE
+=====
+
+The most simple usage is like `./run`. Script is able to search for available
+test-cases and then run them. For more info, run `./run --help`. TODO: The
+testsuite is root-only.
+
+API for config.sh file
+======================
+
+Variables which should/may be defined in config.sh file.
+
+$DTF_TEST_ID - unique ID of task. Without spaces.
+
+$DTF_TEST_DESCRIPTION - descriptive info about test, will be used for
+generating html or otherwise formated result output.