~crunch.io/ubuntu/precise/codespeak-lib/unstable

<li><a class="reference internal" href="#conditionally-mark-a-function-as-expected-to-fail" id="id2">conditionally mark a function as "expected to fail"</a></li>

<li><a class="reference internal" href="#skip-xfail-a-whole-test-class-or-module" id="id3">skip/xfail a whole test class or module</a></li>

<li><a class="reference internal" href="#skip-if-a-dependency-cannot-be-imported" id="id4">skip if a dependency cannot be imported</a></li>

<li><a class="reference internal" href="#dynamically-skip-from-within-a-test-or-setup" id="id5">dynamically skip from within a test or setup</a></li>

</ul>

</div>

<p>skipping (skipif) or as expected-to-fail (xfail). Both declarations

lead to special reporting and both can be systematically associated

with functions, whole classes or modules. The difference between

the two is that 'xfail' will still execute test functions

but it will revert the outcome. A passing test is now

a failure and failing test is expected. All skip conditions

are reported at the end of test run through the terminal

reporter.</p>

<span id="skipif"></span><h2><a class="toc-backref" href="#id1">skip a test function conditionally</a></h2>

<p>Here is an example for skipping a test function on Python3:</p>

@py.test.mark.skipif("sys.version_info >= (3,0)")

def test_function():

...

</pre>

<p>Conditions are specified as python expressions

and can access the <tt class="docutils literal"><span class="pre">sys</span></tt> module. They can also

access the config object and thus depend on command

line or conftest options:</p>

@py.test.mark.skipif("config.getvalue('db') is None")

def test_function(...):

...

</pre>

</div>

<h2><a class="toc-backref" href="#id2">conditionally mark a function as "expected to fail"</a></h2>

<p>You can use the <tt class="docutils literal"><span class="pre">xfail</span></tt> keyword to mark your test functions as

'expected to fail':</p>

@py.test.mark.xfail

def test_hello():

...

</pre>

<p>This test will be executed but no traceback will be reported

when it fails. Instead terminal reporting will list it in the

"expected to fail" or "unexpectedly passing" sections.

As with <a class="reference internal" href="#skipif">skipif</a> you may selectively expect a failure

depending on platform:</p>

@py.test.mark.xfail("sys.version_info >= (3,0)")

def test_function():

...

</pre>

</div>

<h2><a class="toc-backref" href="#id3">skip/xfail a whole test class or module</a></h2>

100

<p>Instead of marking single functions you can skip

101

a whole class of tests when runnign on a specific

102

platform:</p>

103

104

class TestSomething:

105

skipif = "sys.platform == 'win32'"

106

</pre>

107

<p>Or you can mark all test functions as expected

108

to fail for a specific test configuration:</p>

109

110

xfail = "config.getvalue('db') == 'mysql'"

111

</pre>

112

</div>

113

114

<h2><a class="toc-backref" href="#id4">skip if a dependency cannot be imported</a></h2>

115

<p>You can use a helper to skip on a failing import:</p>

116

117

docutils = py.test.importorskip("docutils")

118

</pre>

119

<p>You can use this helper at module level or within

120

a test or setup function.</p>

121

<p>You can aslo skip if a library does not have the right version:</p>

122

123

docutils = py.test.importorskip("docutils", minversion="0.3")

124

</pre>

125

<p>The version will be read from the specified module's <tt class="docutils literal"><span class="pre">__version__</span></tt> attribute.</p>

126

</div>

127

128

<h2><a class="toc-backref" href="#id5">dynamically skip from within a test or setup</a></h2>

129

<p>If you want to skip the execution of a test you can call

130

<tt class="docutils literal"><span class="pre">py.test.skip()</span></tt> within a test, a setup or from a

131

<a class="reference external" href="../funcargs.html#factory">funcarg factory</a> function. Example:</p>

132

133

def test_function():

134

if not valid_config():

135

py.test.skip("unsuppored configuration")

136

</pre>

137

</div>

138

</div>

139

140

<h1>Start improving this plugin in 30 seconds</h1>

141

142

<li>Download <a class="reference external" href="http://bitbucket.org/hpk42/py-trunk/raw/1.1.0b1/py/test/plugin/pytest_xfail.py">pytest_xfail.py</a> plugin source code</li>

143

<li>put it somewhere as <tt class="docutils literal"><span class="pre">pytest_xfail.py</span></tt> into your import path</li>

144

<li>a subsequent <tt class="docutils literal"><span class="pre">py.test</span></tt> run will use your local version</li>

145

</ol>

146

<p>Checkout <a class="reference external" href="../customize.html">customize</a>, other <a class="reference external" href="index.html">plugins</a> or <a class="reference external" href="../../contact.html">get in contact</a>.</p>

147

</div>

148

</div>

149

150

var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");

151

document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));

152

</script>

153

154

try {

155

var pageTracker = _gat._getTracker("UA-7597274-3");

156

pageTracker._trackPageview();

157

} catch(err) {}</script>

158

</body></html>

b'\\ No newline at end of file'

Older »