<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>xdist: pytest の分散テストプラグイン</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.2.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/translations.js"></script>
<link rel="top" title="None" href="index.html" />
<link rel="up" title="py.test リファレンスドキュメント" href="apiref.html" />
<link rel="next" title="一時ディレクトリとファイル" href="tmpdir.html" />
<link rel="prev" title="モンキーパッチ／モックのモジュールと環境" href="monkeypatch.html" />
</head>
<body>
<div class="related">
<h3>ナビゲーション</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="py-modindex.html" title="Pythonモジュール索引"
>モジュール</a></li>
<li class="right" >
<a href="tmpdir.html" title="一時ディレクトリとファイル"
accesskey="N">次へ</a> |</li>
<li class="right" >
<a href="monkeypatch.html" title="モンキーパッチ／モックのモジュールと環境"
accesskey="P">前へ</a> |</li>
<li><a href="contents.html">pytest-2.2.4.0</a> »</li>
<li><a href="apiref.html" accesskey="U">py.test リファレンスドキュメント</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="contents.html">目次</a></h3>
<ul>
<li><a class="reference internal" href="#">xdist: pytest の分散テストプラグイン</a><ul>
<li><a class="reference internal" href="#id1">xdist プラグインのインストール</a></li>
<li><a class="reference internal" href="#id2">使用例</a><ul>
<li><a class="reference internal" href="#cpu">複数の CPU を使ったテスト実行の高速化</a></li>
<li><a class="reference internal" href="#python">Python のサブプロセスでテスト実行</a></li>
<li><a class="reference internal" href="#looponfailing">looponfailing モードでのテスト実行</a></li>
<li><a class="reference internal" href="#ssh">リモートの SSH アカウントへテストを送信</a></li>
<li><a class="reference internal" href="#id4">リモートのソケットサーバーへテストを送信</a></li>
<li><a class="reference internal" href="#atonce">多くのプラットフォーム上で同時にテストを実行</a></li>
<li><a class="reference internal" href="#ini">Ini ファイルでテスト実行環境の指定</a></li>
<li><a class="reference internal" href="#ini-rsync">ini ファイルで “rsync” ディレクトリの指定</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>前のトピックへ</h4>
<p class="topless"><a href="monkeypatch.html"
title="前の章へ">モンキーパッチ／モックのモジュールと環境</a></p>
<h4>次のトピックへ</h4>
<p class="topless"><a href="tmpdir.html"
title="次の章へ">一時ディレクトリとファイル</a></p>
<div id="searchbox" style="display: none">
<h3>クイック検索</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="検索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
モジュール、クラス、または関数名を入力してください
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="xdist-pytest">
<span id="xdist"></span><h1>xdist: pytest の分散テストプラグイン<a class="headerlink" href="#xdist-pytest" title="このヘッドラインへのパーマリンク">¶</a></h1>
<p><a class="reference external" href="http://pypi.python.org/pypi/pytest-xdist">pytest-xdist</a> プラグインは、独自のテストモードで py.test を拡張します:</p>
<ul class="simple">
<li>Looponfail: サブプロセスでテストを繰り返し実行します。各テストを実行してから py.test はプロジェクト内のファイルが変更されるまで待ち、事前に失敗したテストのみを再実行します。この動作は全てのテストが成功するまで繰り返されます。この段階になって再度、全てのテストを実行します。</li>
</ul>
<ul class="simple">
<li>マルチプロセス負荷分散: 複数 CPU または複数ホストがある場合、それらを結合テストの実行に使います。これにより開発を高速化したり、リモートマシンの特別なリソースを使ったりします。</li>
</ul>
<ul class="simple">
<li>マルチプラットフォームのカバレッジ: 異なる Python インタープリター、または異なるプラットフォームを指定して、全ての環境で並行してテストを実行します。</li>
</ul>
<p>リモート環境でテストを実行する前に、 <tt class="docutils literal"><span class="pre">py.test</span></tt> はプログラムのソースコードをリモートマシンへ効率的に “rsync” します。全てのテスト結果は、ローカルマシンのターミナル上で表示されます。異なる Python バージョンやインタープリターも指定できます。</p>
<div class="section" id="id1">
<h2>xdist プラグインのインストール<a class="headerlink" href="#id1" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>プラグインをインストールします:</p>
<div class="highlight-python"><pre>easy_install pytest-xdist
# または
pip install pytest-xdist</pre>
</div>
<p>もしくは <a class="reference external" href="http://bitbucket.org/hpk42/pytest-xdist">pytest-xdist リポジトリ</a> からチェックアウトして develop コマンドでパッケージを使います:</p>
<div class="highlight-python"><pre>python setup.py develop</pre>
</div>
</div>
<div class="section" id="id2">
<h2>使用例<a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2>
<div class="section" id="cpu">
<span id="xdistcpu"></span><h3>複数の CPU を使ったテスト実行の高速化<a class="headerlink" href="#cpu" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>複数の CPU でテストを行うには、次のように実行します:</p>
<div class="highlight-python"><pre>py.test -n NUM</pre>
</div>
<p>特に長時間実行されるテスト、またはたくさんの I/O を必要とするテストの速度向上が見込めます。</p>
</div>
<div class="section" id="python">
<h3>Python のサブプロセスでテスト実行<a class="headerlink" href="#python" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>Python 2.4 の subprocess をインスタンス化するには、そこにテストを送り、次のように実行します:</p>
<div class="highlight-python"><pre>py.test -d --tx popen//python=python2.4</pre>
</div>
<p>システムのバイナリ検索パスで見つけた “Python 2.4” インタープリターで実行するサブプロセスを開始します。</p>
<p>次のように –tx オプションに値を指定する場合:</p>
<div class="highlight-python"><pre>py.test -d --tx 3*popen//python=python2.4</pre>
</div>
<p>3つのサブプロセスが作成され、その3つのサブプロセスにテストが分散されて並行で実行されます。</p>
</div>
<div class="section" id="looponfailing">
<span id="id3"></span><h3>looponfailing モードでのテスト実行<a class="headerlink" href="#looponfailing" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>中規模または大規模のテストスイートをもつプロジェクトをリファクタリングするために、looponfailing モードが便利です。単純に <tt class="docutils literal"><span class="pre">--f</span></tt> オプションを追加します:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">-</span><span class="n">f</span>
</pre></div>
</div>
<p>py.test はテストを実行します。ここで実行したテストに失敗すると仮定して、ファイルの更新を待ってからその失敗したテストを再実行します。ファイルの更新は <tt class="docutils literal"><span class="pre">looponfailingroots</span></tt> というルートディレクトリとその全てのコンテンツを (再帰的に) 調べることで検出されます。このデフォルト値が意図したように作用しないなら、設定オプションを追加することで自分のプロジェクト向けの値を変更できます:</p>
<div class="highlight-python"><pre># pytest.ini, setup.cfg または tox.ini ファイルの内容
[pytest]
looponfailroots = mypkg testdir</pre>
</div>
<p>この設定は ini ファイルがあるディレクトリからみて、相対パスで指定したディレクトリのファイルの更新のみを調べるようにします。</p>
</div>
<div class="section" id="ssh">
<h3>リモートの SSH アカウントへテストを送信<a class="headerlink" href="#ssh" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>ローカルで正常に実行できるテストを含む <tt class="docutils literal"><span class="pre">mypkg</span></tt> と、ssh でログインできるマシン <tt class="docutils literal"><span class="pre">myhost</span></tt> もあると仮定します。次のように実行してアドホックに分散テストを実行できます:</p>
<div class="highlight-python"><pre>py.test -d --tx ssh=myhostpopen --rsyncdir mypkg mypkg</pre>
</div>
<p>これはリモートの ssh アカウントで <tt class="docutils literal"><span class="pre">mypkg</span></tt> パッケージのディレクトリを同期させ、リモートマシン上でテストを実行します。</p>
<p>リモートマシンへ送るために 複数の <tt class="docutils literal"><span class="pre">--rsyncdir</span></tt> ディレクトリを指定できます。</p>
</div>
<div class="section" id="id4">
<h3>リモートのソケットサーバーへテストを送信<a class="headerlink" href="#id4" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p><a class="reference external" href="http://bitbucket.org/hpk42/execnet/raw/2af991418160/execnet/script/socketserver.py">socketserver.py</a> という単一モジュールの Python プログラムをダウンロードし、次のように実行してください:</p>
<div class="highlight-python"><pre>python socketserver.py</pre>
</div>
<p>このプログラムはデフォルトのポートで待機状態を起動します。自宅のマシン上で、何かのパッケージと一緒にこの新たなソケットホストを指定できます:</p>
<div class="highlight-python"><pre>py.test -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg mypkg</pre>
</div>
</div>
<div class="section" id="atonce">
<span id="id5"></span><h3>多くのプラットフォーム上で同時にテストを実行<a class="headerlink" href="#atonce" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>複数のプラットフォームでテストを実行する基本的なコマンドです:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">dist</span><span class="o">=</span><span class="n">each</span> <span class="o">--</span><span class="n">tx</span><span class="o">=</span><span class="n">spec1</span> <span class="o">--</span><span class="n">tx</span><span class="o">=</span><span class="n">spec2</span>
</pre></div>
</div>
<p>Windows ホスト、OSX ホスト、Linux 環境を指定する場合、このコマンドはそれぞれのテストを全てのプラットフォームに送信します。そして、全てのプラットフォームから同時に失敗レポートを受け取ります。この設定には <a class="reference external" href="http://codespeak.net/execnet/basics.html#xspec">xspec 構文</a> を使います。</p>
</div>
<div class="section" id="ini">
<h3>Ini ファイルでテスト実行環境の指定<a class="headerlink" href="#ini" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>pytest (バージョン 2.0) は ini スタイルの設定ファイルに対応しています。例えば、デフォルトで3つのサブプロセスを使ってテストを実行させます:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="n">pytest</span><span class="p">]</span>
<span class="n">addopts</span> <span class="o">=</span> <span class="o">-</span><span class="n">n3</span>
</pre></div>
</div>
<p>次のようにしてデフォルト環境も追加できます:</p>
<div class="highlight-python"><pre>[pytest]
addopts = --tx ssh=myhost//python=python2.5 --tx ssh=myhost//python=python2.6</pre>
</div>
<p>そして、次のように入力して実行すると:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">dist</span><span class="o">=</span><span class="n">each</span>
</pre></div>
</div>
<p>それぞれの環境でテストが実行されます。</p>
</div>
<div class="section" id="ini-rsync">
<h3>ini ファイルで “rsync” ディレクトリの指定<a class="headerlink" href="#ini-rsync" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>プロジェクトのルートディレクトリに <tt class="docutils literal"><span class="pre">tox.ini</span></tt> か <tt class="docutils literal"><span class="pre">setup.cfg</span></tt> ファイルを置き、同期に含める、または除外するディレクトリを指定することもできます:</p>
<div class="highlight-python"><pre>[pytest]
rsyncdirs = . mypkg helperpkg
rsyncignore = .hg</pre>
</div>
<p>ここで設定されるディレクトリは、設定ファイルの場所から相対パスでディレクトリを指定します。</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>ナビゲーション</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="py-modindex.html" title="Pythonモジュール索引"
>モジュール</a></li>
<li class="right" >
<a href="tmpdir.html" title="一時ディレクトリとファイル"
>次へ</a> |</li>
<li class="right" >
<a href="monkeypatch.html" title="モンキーパッチ／モックのモジュールと環境"
>前へ</a> |</li>
<li><a href="contents.html">pytest-2.2.4.0</a> »</li>
<li><a href="apiref.html" >py.test リファレンスドキュメント</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, holger krekel et alii.
このドキュメントは <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3 で生成しました。
</div>
</body>
</html>
