[people/ms/nitsi.git] / man / nitsi.recipe.xml

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="nitsi.recipe">
	<refentryinfo>
		<title>nitsi.recipe</title>
		<productname>nitsi</productname>

		<authorgroup>
			<author>
				<contrib>Developer</contrib>
				<firstname>Jonatan</firstname>
				<surname>Schlag</surname>
				<email>jonatan.schlag@ipfire.org</email>
			</author>
		</authorgroup>
	</refentryinfo>

	<refmeta>
		<refentrytitle>nitsi.recipe</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>nitsi.recipe</refname>
		<refpurpose>Recipe file for a nitsi test</refpurpose>
	</refnamediv>


	<refsect1>
		<title>Description</title>

		<para>
			The <filename>recipe</filename> file contains the actions for a test.
			So it consist of lines which state which command should executed on which machine.
		</para>
	</refsect1>

	<refsect1>
		<title>Basic Syntax</title>

		<para>
			All lines follows the following syntax:
		</para>

		<variablelist>
			<varlistentry>
				<term>
					<option>machine: command</option>
				</term>

				<listitem>
					<para>
						The machine name is the first part of the line followed by an ':'.
						After the ':' follows the command which should be executed.
					</para>

				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1>
		<title>Extended Syntax</title>

		<para>
			The following syntax examples shows how you could solve common problems.
		</para>

		<variablelist>
			<varlistentry>
				<term>
					<option>machine !: command</option>
				</term>

				<listitem>
					<para>
						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.
					</para>

				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>all: command</option>
				</term>

				<listitem>
					<para>
						This command is executed on all machines of this test.
					</para>

				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>machine1,machine2: command</option>
				</term>

				<listitem>
					<para>
						This command is on all machines of the comma seperated list. So on machine1 and on machine2.
					</para>

				</listitem>
			</varlistentry>

						<varlistentry>
				<term>
					<option>include: ../test2</option>
				</term>

				<listitem>
					<para>
						This will include the recipe of test2.
						The path is relativ to the directory of the recipe file which contain the include statement.
					</para>

				</listitem>
			</varlistentry>

		</variablelist>
	</refsect1>

	<refsect1>
		<title>Example</title>

		<example>

			<simplelist>
				<member>alice: echo "Hello World"</member>
				<member>bob !: eecho "Hello World"</member>
				<member>alice: ls -l</member>
				<member>all: blkid</member>
				<member>alice,bob: echo "This is a comma seperated list"</member>
				<member>include: ../test2</member>
			</simplelist>
		</example>

	</refsect1>

	<refsect1>
		<title>Bugs</title>

		<para>
			Please report all bugs to the official bugtracker at
			http://bugzilla.ipfire.org/.
		</para>
	</refsect1>

	<refsect1>
		<title>See Also</title>

		<para>
			<citerefentry>
				<refentrytitle>nitsi</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>
		</para>
	</refsect1>
</refentry>
Commit	Line	Data
20b41754 JS	1	<?xml version="1.0"?>
	2	<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4
	5	<refentry id="nitsi.recipe">
	6	<refentryinfo>
	7	<title>nitsi.recipe</title>
	8	<productname>nitsi</productname>
	9
	10	<authorgroup>
	11	<author>
	12	<contrib>Developer</contrib>
	13	<firstname>Jonatan</firstname>
	14	<surname>Schlag</surname>
	15	<email>jonatan.schlag@ipfire.org</email>
	16	</author>
	17	</authorgroup>
	18	</refentryinfo>
	19
	20	<refmeta>
	21	<refentrytitle>nitsi.recipe</refentrytitle>
	22	<manvolnum>1</manvolnum>
	23	</refmeta>
	24
	25	<refnamediv>
	26	<refname>nitsi.recipe</refname>
	27	<refpurpose>Recipe file for a nitsi test</refpurpose>
	28	</refnamediv>
	29
	30
	31	<refsect1>
	32	<title>Description</title>
	33
	34	<para>
	35	The <filename>recipe</filename> file contains the actions for a test.
	36	So it consist of lines which state which command should executed on which machine.
	37	</para>
	38	</refsect1>
	39
	40	<refsect1>
	41	<title>Basic Syntax</title>
	42
	43	<para>
	44	All lines follows the following syntax:
	45	</para>
	46
	47	<variablelist>
	48	<varlistentry>
	49	<term>
	50	<option>machine: command</option>
	51	</term>
	52
	53	<listitem>
	54	<para>
	55	The machine name is the first part of the line followed by an ':'.
	56	After the ':' follows the command which should be executed.
	57	</para>
	58
	59	</listitem>
	60	</varlistentry>
	61	</variablelist>
	62	</refsect1>
	63
	64	<refsect1>
65	<title>Extended Syntax</title>
66
67	<para>
68	The following syntax examples shows how you could solve common problems.
69	</para>
70
71	<variablelist>
72	<varlistentry>
73	<term>
74	<option>machine !: command</option>
75	</term>
76
77	<listitem>
78	<para>
79	The '!' is similar to the 'not' in python. So this line will fail if the command succeds
80	and succeds if the command fails. Between the machine name and the '!' must be a space.
81	</para>
82
83	</listitem>
84	</varlistentry>
85
86	<varlistentry>
87	<term>
88	<option>all: command</option>
89	</term>
90
91	<listitem>
92	<para>
93	This command is executed on all machines of this test.
94	</para>
95
96	</listitem>
97	</varlistentry>
98	<varlistentry>
99	<term>
100	<option>machine1,machine2: command</option>
101	</term>
102
103	<listitem>
104	<para>
105	This command is on all machines of the comma seperated list. So on machine1 and on machine2.
106	</para>
107
108	</listitem>
109	</varlistentry>
110
111	<varlistentry>
112	<term>
113	<option>include: ../test2</option>
114	</term>
115
116	<listitem>
117	<para>
118	This will include the recipe of test2.
119	The path is relativ to the directory of the recipe file which contain the include statement.
120	</para>
121
122	</listitem>
123	</varlistentry>
124
125	</variablelist>
126	</refsect1>
127
128	<refsect1>
129	<title>Example</title>
130
131	<example>
132
133	<simplelist>
134	<member>alice: echo "Hello World"</member>
135	<member>bob !: eecho "Hello World"</member>
136	<member>alice: ls -l</member>
137	<member>all: blkid</member>
138	<member>alice,bob: echo "This is a comma seperated list"</member>
139	<member>include: ../test2</member>
140	</simplelist>
141	</example>
142
143	</refsect1>
144
145	<refsect1>
146	<title>Bugs</title>
147
148	<para>
149	Please report all bugs to the official bugtracker at
150	http://bugzilla.ipfire.org/.
151	</para>
152	</refsect1>
153
154	<refsect1>
155	<title>See Also</title>
156
157	<para>
158	<citerefentry>
159	<refentrytitle>nitsi</refentrytitle>
160	<manvolnum>1</manvolnum>
161	</citerefentry>
162	</para>
163	</refsect1>
164	</refentry>