More work on releng/README

This commit is contained in:
Thomas Schmitt 2011-08-07 11:03:22 +00:00
parent 9b21530532
commit 920513356b
2 changed files with 27 additions and 8 deletions

View File

@ -9,7 +9,7 @@ Copyright (C) 2011 George Danchev, Thomas Schmitt
Provided under GPL version 2 or later. Provided under GPL version 2 or later.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
The impatient tester will build libisoburn and then do The impatient tester will build libisoburn according to ./README and then do
cd ./releng cd ./releng
./run_all_auto -x ../xorriso/xorriso ./run_all_auto -x ../xorriso/xorriso
@ -73,6 +73,7 @@ or if you want to use an installed xorriso program:
+++ General options -x , -k, -f, -c, -h, -- +++ General options -x , -k, -f, -c, -h, --
+++ + All scripts support -h
There are several options which work with run_all_auto and any single test. There are several options which work with run_all_auto and any single test.
-x absolute or relative path to xorriso binary to be run. -x absolute or relative path to xorriso binary to be run.
@ -87,7 +88,7 @@ particular manually executable test scripts.
Manually executable tests Manually executable tests
>>> list of manual tests +++ list of manual tests
Currently there are the following tests which should have the attention of Currently there are the following tests which should have the attention of
the user or require sysadmin considerations before they are run: the user or require sysadmin considerations before they are run:
@ -120,14 +121,24 @@ the user or require sysadmin considerations before they are run:
directory. MD5 mismatch causes a test failure. Differences to the directory directory. MD5 mismatch causes a test failure. Differences to the directory
state are reported but still regarded as success. state are reported but still regarded as success.
>>> ./run_all_manual >>> ./run_all_manual
>>> + Any auto_* script can be run on its own, regardless. >>> + Any auto_* script can be run on its own, regardless.
>>> List auto tests >>> List auto tests
>>> + All scripts support -h
>>> give hints what to do with FAIL results. +++ give hints what to do with FAIL results.
The text output of the automatic tests is recorded in file
releng_generated_data/log.run_all_auto
Script ./run_all_auto will detect failure of perticular tests and report
lines from the log file which contain problem indicating key words:
NEVER|ABORT|FATAL|FAILURE|MISHAP|SORRY|WARNING|HINT|FAIL|ERROR|WRONG
If the program messages in log.run_all_auto do not explain the failure,
please contact mailing list libburn-hackers@pykix.org .
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
@ -151,8 +162,9 @@ not done as long as such a line remains.
+++ + Each script' self-generated data are to be stored in +++ + Each script' self-generated data are to be stored in
+++ ./releng_generated_data/scriptname/ directory +++ ./releng_generated_data/scriptname/ directory
Your test must not start if no file ./inc/releng_getopts.inc exists, Your test must not start if no file
i.e. if the current working direcoty is not ./releng. ./inc/releng_getopts.inc
exists, i.e. if the current working direcoty is not ./releng.
If your test creates own files on disk, then it must do this underneath If your test creates own files on disk, then it must do this underneath
directory ./releng_generated_data/$test_name (resp. $GEN_DATA_DIR, see below). directory ./releng_generated_data/$test_name (resp. $GEN_DATA_DIR, see below).
@ -161,7 +173,8 @@ directory ./releng_generated_data/$test_name (resp. $GEN_DATA_DIR, see below).
+++ + Use different exit codes for any failure (range 0-31) +++ + Use different exit codes for any failure (range 0-31)
In case of failure, issue a line to stdout that begins by the word "FAIL", In case of failure, issue a line to stdout that begins by the word "FAIL",
and make sure that the test script finally returns a non-zero exit value. followed by " : " and the name of the test (e.g. $SELF, see below).
Make sure that the test script finally returns a non-zero exit value.
This value should be between 1 and 28. Each type of failure should have its This value should be between 1 and 28. Each type of failure should have its
own exit value. own exit value.
Predefined are: Predefined are:
@ -180,14 +193,20 @@ The code piece inc/releng_getopts.inc should get executed inline at the
start of a test script. start of a test script.
It initializes the following variables and sets some of them according It initializes the following variables and sets some of them according
to the general options of the test suite: to the general options of the test suite:
SELF basename $0 SELF basename $0
GEN_DATA_DIR releng_generated_data/${SELF} GEN_DATA_DIR releng_generated_data/${SELF}
RELENG_XORRISO Path to xorriso binary. "" or "0" means no xorriso. RELENG_XORRISO Path to xorriso binary. "" or "0" means no xorriso.
Default "0". Adjustable by option -x. Default "0". Adjustable by option -x.
SIMULATE_FAILURE 0=normal operation, 1=test script shall simulate a failure. SIMULATE_FAILURE 0=normal operation, 1=test script shall simulate a failure.
Default 0. Setable to 1 by option -f. Default 0. Setable to 1 by option -f.
CLEANUP 0=do not cleanup temporary data, 1=normal operation CLEANUP 0=do not cleanup temporary data, 1=normal operation
Default 1. Setable to 0 by option -k. Default 1. Setable to 0 by option -k.
SPECIFIC_HELP 0=normal operation, 1=print help text of script and exit 0 SPECIFIC_HELP 0=normal operation, 1=print help text of script and exit 0
Default 0. Setable to 1 by option -h Default 0. Setable to 1 by option -h

View File

@ -1 +1 @@
#define Xorriso_timestamP "2011.08.01.152915" #define Xorriso_timestamP "2011.08.07.110306"