py.test.xml 9.71 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!--

Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'.  A manual page
<package>.<section> will be generated.  You may view the
manual page with: nroff -man <package>.<section> | less'.  A
typical entry in a Makefile or Makefile.am is:

DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet

manpage.1: manpage.dbk
        $(XP) $(DB2MAN) $<
    
The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.  Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Alexandre</firstname>">
  <!ENTITY dhsurname   "<surname>Fayolle</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>jan.  8, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>afayolle@debian.org</email>">
  <!ENTITY dhusername  "Alexandre Fayolle">
  <!ENTITY dhucpackage "<refentrytitle>python-codespeak-lib</refentrytitle>">
  <!ENTITY dhpackage   "py.test">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2007</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>pylib test runner</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option><replaceable>option</replaceable></option></arg>

      <arg><option><replaceable>query</replaceable></option></arg>
      <arg><option><replaceable>filenames of tests...</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
    because the original program does not have a manual page.
    Instead, it has documentation in html available in
    /usr/share/doc/python-codespeak-lib/py/doc/test.html.</para>

    <para><command>&dhpackage;</command> is a program that runs tests
    in a module or directory specified on the command line. It looks
    for functions and methods with names starting with 'test_' and run
    those methods. Assertions about test outcomes are done via the
    standard 'assert' statement.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below. </para>

    <variablelist>
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
        <varlistentry>
          <term>
           <option>-l</option>
           <option>--showlocals</option>
          </term>
          <listitem>
            <para>show locals in tracebacks (disabled by default).</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--tb=style</option>
          </term>
          <listitem>
            <para>traceback verboseness (long/short/no).</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>-p</option>
          </term>
          <listitem>
            <para>LUGINS        load the specified plugin after command line parsing.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>-f</option>
           <option>--looponfail</option>
          </term>
          <listitem>
            <para>run tests, re-run failing test set until all pass.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--boxed</option>
          </term>
          <listitem>
            <para>box each test run in a separate process</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>-s</option>
          </term>
          <listitem>
            <para>shortcut for --capture=no.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--capture=method</option>
          </term>
          <listitem>
            <para>set capturing method during tests: fd (default)|sys|no.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--pdb</option>
          </term>
          <listitem>
            <para>start pdb (the Python debugger) on errors.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--pastebin=mode</option>
          </term>
          <listitem>
            <para>send failed|all info to Pocoo pastebin service.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--basetemp=dir</option>
          </term>
          <listitem>
            <para>base temporary directory for this test run.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--collectonly</option>
          </term>
          <listitem>
            <para>only collect tests, don't execute them.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--traceconfig</option>
          </term>
          <listitem>
            <para>trace considerations of conftest.py files.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--nomagic</option>
          </term>
          <listitem>
            <para>don't reinterpret asserts, no traceback cutting.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--fulltrace</option>
          </term>
          <listitem>
            <para>don't cut any tracebacks (default is to cut).</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--debug</option>
          </term>
          <listitem>
            <para>generate and show debugging information.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--help-config</option>
          </term>
          <listitem>
            <para>show available conftest.py and ENV-variable names.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--version</option>
          </term>
          <listitem>
            <para>display py lib version and import information.</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--dist=distmode</option>
          </term>
          <listitem>
            <para>set mode for distributing tests to exec environments.
                         each: send each test to each available environment.
                         load: send each test to available environment.
                         (default) no: run tests inprocess, don't distribute.
            </para>
         </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--tx=xspec</option>
          </term>
          <listitem>
            <para>add a test execution environment. some examples: --tx
                         popen//python=python2.5 --tx socket=192.168.1.102:8888
                         --tx ssh=user@codespeak.net//chdir=testcache
            </para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>-d</option>
          </term>
          <listitem>
            <para>load-balance tests.  shortcut for '--dist=load'</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>-n numprocesses</option>
          </term>
          <listitem>
            <para>shortcut for '--dist=load --tx=NUM*popen'</para>
          </listitem>
        </varlistentry>
       
        <varlistentry>
          <term>
           <option>--rsyncdir=dir1</option>
          </term>
          <listitem>
            <para>add directory for rsyncing to remote tx nodes.</para>
          </listitem>
        </varlistentry>
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>