docs/reference/glib/gtester.xml

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