docs/reference/glib/gtester.xml

   1 <refentry id="gtester">
   2
   3 <refentryinfo>
   4 <title>gtester</title>
   5 <productname>GLib</productname>
   6 <authorgroup>
   7 <author>
   8 <contrib>Developer</contrib>
   9 <firstname>Tim</firstname>
  10 <surname>Janik</surname>
  11 </author>
  12 <author>
  13 <contrib>Developer</contrib>
  14 <firstname>Sven</firstname>
  15 <surname>Herzberg</surname>
  16 </author>
  17 </authorgroup>
  18 </refentryinfo>
  19
  20 <refmeta>
  21 <refentrytitle>gtester</refentrytitle>
  22 <manvolnum>1</manvolnum>
  23 <refmiscinfo class="manual">User Commands</refmiscinfo>
  24 </refmeta>
  25
  26 <refnamediv>
  27 <refname>gtester</refname>
  28 <refpurpose>test running utility</refpurpose>
  29 </refnamediv>
  30
  31 <refsynopsisdiv>
  32 <cmdsynopsis>
  33 <command>gtester</command>
  34 <arg choice="opt" rep="repeat">OPTION</arg>
  35 <arg>testprogram</arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39 <refsect1><title>Description</title>
  40 <para><command>gtester</command> is a utility to run unit tests that have
  41 been written using the GLib test framework.
  42 </para>
  43 <para>
  44 When called with the <option>-o</option> option, <command>gtester</command>
  45 writes an XML report of the test results, which can be converted
  46 into HTML using the <command>gtester-report</command> utility.
  47 </para>
  48 </refsect1>
  49
  50 <refsect1><title>Options</title>
  51 <variablelist>
  52
  53 <varlistentry>
  54 <term><option>-h</option>, <option>--help</option></term>
  55 <listitem><para>
  56 print help and exit
  57 </para></listitem>
  58 </varlistentry>
  59
  60 <varlistentry>
  61 <term><option>-v</option>, <option>--version</option></term>
  62 <listitem><para>
  63 print version information and exit
  64 </para></listitem>
  65 </varlistentry>
  66
  67 <varlistentry>
  68 <term><option>--g-fatal-warnings</option></term>
  69 <listitem><para>
  70 make warnings fatal
  71 </para></listitem>
  72 </varlistentry>
  73
  74 <varlistentry>
  75 <term><option>-k</option>, <option>--keep-going</option></term>
  76 <listitem><para>
  77 continue running after tests failed
  78 </para></listitem>
  79 </varlistentry>
  80
  81 <varlistentry>
  82 <term><option>-l</option></term>
  83 <listitem><para>
  84 list paths of available test cases
  85 </para></listitem>
  86 </varlistentry>
  87
  88 <varlistentry>
  89 <term><option>-m=<replaceable>MODE</replaceable></option></term>
  90 <listitem><para>
  91     run test cases in <replaceable>MODE</replaceable>, which can be one of:
  92
  93     <variablelist>
  94       <varlistentry>
  95       <term><option>perf</option></term>
  96       <listitem><para>
  97           run performance tests
  98       </para></listitem>
  99       </varlistentry>
 100
 101       <varlistentry>
 102       <term><option>slow</option>, <option>thorough</option></term>
 103       <listitem><para>
 104           run slow tests, or repeat non-deterministic tests more often
 105       </para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109       <term><option>quick</option></term>
 110       <listitem><para>
 111           do not run slow or performance tests, or do extra repeats
 112           of non-deterministic tests (default)
 113       </para></listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117       <term><option>undefined</option></term>
 118       <listitem><para>
 119           run test cases that deliberately provoke checks or assertion
 120           failures, if implemented (default)
 121       </para></listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125       <term><option>no-undefined</option></term>
 126       <listitem><para>
 127           do not run test cases that deliberately provoke checks or
 128           assertion failures
 129       </para></listitem>
 130       </varlistentry>
 131     </variablelist>
 132
 133 </para></listitem>
 134 </varlistentry>
 135
 136 <varlistentry>
 137 <term><option>-p=<replaceable>TESTPATH</replaceable></option></term>
 138 <listitem><para>
 139 only run test cases matching <replaceable>TESTPATH</replaceable>
 140 </para></listitem>
 141 </varlistentry>
 142
 143 <varlistentry>
 144 <term><option>-s=<replaceable>TESTPATH</replaceable></option></term>
 145 <listitem><para>
 146 skip test cases matching <replaceable>TESTPATH</replaceable>
 147 </para></listitem>
 148 </varlistentry>
 149
 150 <varlistentry>
 151 <term><option>--seed=<replaceable>SEEDSTRING</replaceable></option></term>
 152 <listitem><para>
 153 run all test cases with random number seed <replaceable>SEEDSTRING</replaceable>
 154 </para></listitem>
 155 </varlistentry>
 156
 157 <varlistentry>
 158 <term><option>-o=<replaceable>LOGFILE</replaceable></option></term>
 159 <listitem><para>
 160 write the test log to <replaceable>LOGFILE</replaceable>
 161 </para></listitem>
 162 </varlistentry>
 163
 164 <varlistentry>
 165 <term><option>-q</option>, <option>--quiet</option></term>
 166 <listitem><para>
 167 suppress per test binary output
 168 </para></listitem>
 169 </varlistentry>
 170
 171 <varlistentry>
 172 <term><option>--verbose</option></term>
 173 <listitem><para>
 174 report success per testcase
 175 </para></listitem>
 176 </varlistentry>
 177
 178 </variablelist>
 179 </refsect1>
 180
 181 <refsect1><title>See also</title>
 182 <para>
 183 <citerefentry>
 184 <refentrytitle>gtester-report</refentrytitle>
 185 <manvolnum>1</manvolnum>
 186 </citerefentry>
 187 </para>
 188 </refsect1>
 189 </refentry>