From: Jonatan Schlag Date: Fri, 11 May 2018 12:25:01 +0000 (+0200) Subject: Add man pages for nitsi X-Git-Url: http://git.ipfire.org/?p=nitsi.git;a=commitdiff_plain;h=20b41754717ba36c718de060b171cb824810666f Add man pages for nitsi Fixes: #11722 Signed-off-by: Jonatan Schlag --- diff --git a/Makefile.am b/Makefile.am index 689b61e..8562842 100644 --- a/Makefile.am +++ b/Makefile.am @@ -48,7 +48,9 @@ man: $(MANPAGES) $(MANPAGES_HTML) if ENABLE_MANPAGES MANPAGES = \ - man/nitsi.1 + man/nitsi.1 \ + man/nitsi.settings.1 \ + man/nitsi.recipe.1 MANPAGES_XML = $(patsubst %.1,%.xml,$(patsubst %.5,%.xml,$(MANPAGES))) MANPAGES_HTML = $(patsubst %.xml,%.html,$(MANPAGES_XML)) diff --git a/man/custom-html.xsl b/man/custom-html.xsl new file mode 100644 index 0000000..fe2b54e --- /dev/null +++ b/man/custom-html.xsl @@ -0,0 +1,31 @@ + + + + + + + + + + + .html + + + + + + + + + + index.html + + Index + +
+ + + + + + diff --git a/man/nitsi.recipe.xml b/man/nitsi.recipe.xml new file mode 100644 index 0000000..91925d4 --- /dev/null +++ b/man/nitsi.recipe.xml @@ -0,0 +1,164 @@ + + + + + + nitsi.recipe + nitsi + + + + Developer + Jonatan + Schlag + jonatan.schlag@ipfire.org + + + + + + nitsi.recipe + 1 + + + + nitsi.recipe + Recipe file for a nitsi test + + + + + Description + + + The recipe file contains the actions for a test. + So it consist of lines which state which command should executed on which machine. + + + + + Basic Syntax + + + All lines follows the following syntax: + + + + + + + + + + + The machine name is the first part of the line followed by an ':'. + After the ':' follows the command which should be executed. + + + + + + + + + Extended Syntax + + + The following syntax examples shows how you could solve common problems. + + + + + + + + + + + The '!' is similar to the 'not' in python. So this line will fail if the command succeds + and succeds if the command fails. Between the machine name and the '!' must be a space. + + + + + + + + + + + + + This command is executed on all machines of this test. + + + + + + + + + + + + This command is on all machines of the comma seperated list. So on machine1 and on machine2. + + + + + + + + + + + + + This will include the recipe of test2. + The path is relativ to the directory of the recipe file which contain the include statement. + + + + + + + + + + Example + + + + + alice: echo "Hello World" + bob !: eecho "Hello World" + alice: ls -l + all: blkid + alice,bob: echo "This is a comma seperated list" + include: ../test2 + + + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugzilla.ipfire.org/. + + + + + See Also + + + + nitsi + 1 + + + + diff --git a/man/nitsi.settings.xml b/man/nitsi.settings.xml new file mode 100644 index 0000000..680a5c0 --- /dev/null +++ b/man/nitsi.settings.xml @@ -0,0 +1,190 @@ + + + + + + nitsi.settings + nitsi.settings + + + + Developer + Jonatan + Schlag + jonatan.schlag@ipfire.org + + + + + + nitsi.settings + 1 + + + + nitsi.settings + Settings file for a nitsi test + + + + + Description + + + The settings file is the main configuration file of the + nitsi test. + This file specifies runtime configuration parameters for the test + and set the virtual environment to use. + + + + The syntax of the configuration file is based on the INI configuration + file format. Lines starting with hash (#) or semi-colon (;) + are ignored. + + + + + DEFAULT configuration + + + The following options can be configured in the [DEFAULT] section: + + + + + + + + + + + This option will configure the name of the test + and can be something more human readbale then the name of the test directory. + + + + + + + + + + + + + This can be a short description of the test to explain + what we are trying to test and what results we expect when + we are running the recipe. So when do the test succeed and when do the test fails. + + + + + + + + + + + + + The files or directories which should be copied into all virtual machines. + The paths are relativ to the path of the test directory. + + + + + + + + + + + + + The path to which the files should be copied. For example /root/ + + + + + + + + + + VIRTUAL_ENVIRONMENT Configuration + + + The following options can be configured in the [VIRTUAL_ENVIRONMENT] section: + + + + + + + + + + + The Name of the virtual environment to use. + + + + + + + + + + + + + The path of the virtual environment relativ to the path of the test. + + + + + + + + + Example + + + + + [DEFAULT] + Name = Hello World + Description = This is a + short description. + Copy_from = + Copy_to = /root/ + [VIRTUAL_ENVIRONMENT] + Name = basic + path = ../virtual-environment/basic + + + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugzilla.ipfire.org/. + + + + + See Also + + + + nitsi + 1 + + + + diff --git a/man/nitsi.xml b/man/nitsi.xml new file mode 100644 index 0000000..5310de6 --- /dev/null +++ b/man/nitsi.xml @@ -0,0 +1,124 @@ + + + + + + nitsi + nitsi + + + + Developer + Jonatan + Schlag + jonatan.schlag@ipfire.org + + + + + + nitsi + 1 + + + + nitsi + Networking Integration Test Suite for IPFire + + + + + nitsi + OPTIONS + COMMAND + + + + + Description + + + nitsi is a simple, extensible, Integration Test Suite + for the Network code of IPfire written in Python. + + + + + Options + + + The following options are understood: + + + + + + + + + + + + + + Is the directory where all files of a test are located. + So this dir should contain at least a setting file and a recipe file + + + + For further details of the setting file layout and the recipe file layout, please consult the + + nitsi.setting + 5 + + + nitsi.recipe + 5 + + manual page. + + + + + + + + + + + + + + + Shows the help message provided by the program and exit. + + + + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugzilla.ipfire.org/. + + + + + See Also + + + + nitsi.setting + 5 + + + nitsi.recipe + 5 + + + +