python - Python 単体テストはどこに行くのですか?

Question

ライブラリやアプリを作成している場合、単体テストファイルはどこに保存されますか?

テストファイルをメインのアプリコードから分離するのは良いことですが、テストするモジュールをインポートするのが難しくなるため、アプリのルートディレクトリ内の "tests" サブディレクトリにそれらを配置するのは面倒です。

ここにベストプラクティスはありますか?

score 235 · Accepted Answer

ファイルmodule.pyの場合、単体テストは通常test_module.py、Pythonic の命名規則に従って呼び出される必要があります。

一般的に認められている配置場所がいくつかありますtest_module.py。

と同じディレクトリにありmodule.pyます。
内 (../tests/test_module.pyコードディレクトリと同じレベル)。
( tests/test_module.pycode ディレクトリの 1 レベル下) 内。

テストを見つけてインポートするのが簡単なため、#1 を好みます。使用しているビルドシステムが何であれ、で始まるファイルを実行するように簡単に構成できますtest_。実際、テスト検出に使用されるデフォルトunittesttest*.pyのパターンはです。

score 92 · Accepted Answer

1 つのテストファイルのみ

テストファイルが 1 つしかない場合は、最上位ディレクトリに配置することをお勧めします。

module/
    lib/
        __init__.py
        module.py
    test.py

CLI でテストを実行する

python test.py

多くのテストファイル

多くのテストファイルがある場合は、次のtestsフォルダーに配置します。

module/
    lib/
        __init__.py
        module.py
    tests/
        test_module.py
        test_module_function.py

# test_module.py

import unittest
from lib import module

class TestModule(unittest.TestCase):
    def test_module(self):
        pass

if __name__ == '__main__':
    unittest.main()

CLI でテストを実行する

# In top-level /module/ folder
python -m tests.test_module
python -m tests.test_module_function

使用する`unittest discovery`

unittest discoveryパッケージフォルダー内のすべてのテストを検索します。

フォルダー内__init__.pyに作成するtests/

module/
    lib/
        __init__.py
        module.py
    tests/
        __init__.py
        test_module.py
        test_module_function.py

CLI でテストを実行する

# In top-level /module/ folder

# -s, --start-directory (default current directory)
# -p, --pattern (default test*.py)

python -m unittest discover

参照

pytestテストレイアウトのグッドプラクティス
unittest

単体テストフレームワーク

score 51 · Accepted Answer

一般的な方法は、テストディレクトリをモジュール/パッケージと同じ親ディレクトリに配置することです。したがって、モジュールの名前が foo.py の場合、ディレクトリレイアウトは次のようになります。

parent_dir/
  foo.py
  tests/

もちろん、やり方は一つではありません。また、 tests サブディレクトリを作成し、絶対インポートを使用してモジュールをインポートすることもできます。

テストをどこに置いても、noseを使用して実行することをお勧めします。Noseはディレクトリを検索してテストを行います。このようにして、組織的に最も意味のある場所にテストを配置できます。

score 32 · Accepted Answer

Pythonプログラムの単体テストを生成するPythoscope（https://pypi.org/project/pythoscope/ ）を作成するときに、まったく同じ質問がありました。ディレクトリを選択する前に、Pythonリストでのテストについて人々をポーリングしましたが、さまざまな意見がありました。最終的に、ソースコードと同じディレクトリに「tests」ディレクトリを配置することにしました。そのディレクトリで、親ディレクトリの各モジュールのテストファイルを生成します。

score 27 · Accepted Answer

上記の Jeremy Cantrell が指摘しているように、私は単体テストをファイル自体に入れる傾向もありますが、テスト関数を本体に入れるのではなく、すべてをファイルに入れる傾向があります。

if __name__ == '__main__':
   do tests...

ブロック。これにより、テストしているpythonファイルの使用方法に関する「サンプルコード」としてドキュメントがファイルに追加されます。

付け加えておきますが、私は非常にタイトなモジュール/クラスを書く傾向があります。モジュールに非常に多くのテストが必要な場合は、それらを別のモジュールに入れることができますが、その場合でも、次のように追加します。

if __name__ == '__main__':
   import tests.thisModule
   tests.thisModule.runtests

これにより、ソースコードを読んでいる人は誰でも、テストコードを探す場所を知ることができます。

score 14 · Accepted Answer

ディレクトリを使用してtests/から、相対インポートを使用して主要なアプリケーションモジュールをインポートします。したがって、MyApp/tests/foo.py には次のようなものがあります。

from .. import foo

モジュールをインポートしMyApp.fooます。

score 13 · Accepted Answer

確立された「ベストプラクティス」があるとは思いません。

アプリコードの外にある別のディレクトリにテストを配置しました。次に、すべてのテストを実行する前に、メインのアプリディレクトリをテストランナースクリプト (他の処理も行う) の sys.path (どこからでもモジュールをインポートできるようにする) に追加します。このようにして、リリース時にテストディレクトリをメインコードから削除する必要がなくなり、時間と労力を節約できます。

score 13 · Accepted Answer

Python でテストフレームワークを開発した経験から、Python 単体テストを別のディレクトリに配置することをお勧めします。対称的なディレクトリ構造を維持します。これは、単体テストをパッケージ化するのではなく、コアライブラリのみをパッケージ化する場合に役立ちます。以下は、概略図を介して実装されます。

                              <Main Package>
                               /          \
                              /            \
                            lib           tests
                            /                \
             [module1.py, module2.py,  [ut_module1.py, ut_module2.py,
              module3.py  module4.py,   ut_module3.py, ut_module.py]
              __init__.py]

このように、これらのライブラリを rpm を使用してパッケージ化すると、メインライブラリモジュール (のみ) をパッケージ化できます。これは、特にアジャイル環境での保守性に役立ちます。

score 11 · Accepted Answer

GitHub でいくつかの主要な Python プロジェクトをチェックして、いくつかのアイデアを得ることをお勧めします。

コードが大きくなり、ライブラリを追加する場合は、setup.py と同じディレクトリにテストフォルダーを作成し、各テストタイプ (ユニットテスト、統合など) のプロジェクトディレクトリ構造をミラーリングすることをお勧めします。

たとえば、次のようなディレクトリ構造があるとします。

myPackage/
    myapp/
       moduleA/
          __init__.py
          module_A.py
       moduleB/
          __init__.py
          module_B.py
setup.py

test フォルダーを追加すると、次のようなディレクトリ構造になります。

myPackage/
    myapp/
       moduleA/
          __init__.py
          module_A.py
       moduleB/
          __init__.py
          module_B.py
test/
   unit/
      myapp/
         moduleA/
            module_A_test.py
         moduleB/
            module_B_test.py
   integration/
          myapp/
             moduleA/
                module_A_test.py
             moduleB/
                module_B_test.py
setup.py

適切に作成された Python パッケージの多くは、同じ構造を使用しています。非常に良い例は Boto パッケージです。https://github.com/boto/boto を確認してください

score 7 · Accepted Answer

どうやって...

フォルダ構造：

project/
    src/
        code.py
    tests/
    setup.py

Setup.pyは、プロジェクトモジュールを含む場所としてsrc /を指し、次のコマンドを実行します。

setup.py develop

これにより、プロジェクトがサイトパッケージに追加され、作業コピーが示されます。私のテストを実行するには、次を使用します。

setup.py tests

構成したテストランナーを使用します。

score 5 · Accepted Answer

私はトップレベルのテストディレクトリを好みます。これは、輸入が少し難しくなることを意味します。そのために、私には2つの解決策があります：

setuptools を使用します。次に、に渡しtest_suite='tests.runalltests.suite'てsetup()、簡単にテストを実行できます。python setup.py test
テストの実行時に PYTHONPATH を設定します。PYTHONPATH=. python tests/runalltests.py

これが M2Crypto のコードでどのようにサポートされているかを示します。

ノーズテストでテストを実行したい場合は、少し違うことをする必要があるかもしれません。

score 4 · Accepted Answer

テスト対象のコード (CUT) と同じディレクトリにテストを配置しました。プラグインで pytest を微調整できるプロジェクトでは、特定のモジュールとそのテストを一緒に編集するのが非常に簡単になるテストfoo.pyに使用します。foo.ptvi foo.*

これができない場合は、foo_ut.pyまたは同様のものを使用します。vi foo*それもキャッチされますがfoobar.py、foobar_ut.pyそれらが存在する場合は引き続き使用できます。

どちらの場合も、テスト検出プロセスを微調整してこれらを見つけます。

これにより、ディレクトリリストのコードのすぐ横にテストが配置され、そこにテストがあることが明確になり、別のファイルにある場合と同じくらい簡単にテストを開くことができます。(前述のように、コマンドラインから起動したエディタの場合、GUI システムの場合は、コードファイルと隣接する (またはほぼ隣接する) テストファイルをクリックします。

他の人が指摘しているように、これにより、リファクタリングが容易になり、必要に応じて他の場所で使用するためにコードを抽出することも容易になります。

テストをまったく別のディレクトリツリーに配置するという考えは、私は本当に嫌いです。開発者が CUT でファイルを開くときに、テストを開くのを必要以上に難しくするのはなぜですか? 大多数の開発者が、テストの作成や微調整に熱心であり、そのための障害を言い訳にせずに無視するわけではありません。(私の経験ではまったく逆です。テストをできるだけ簡単に書いたとしても、わざわざテストを書けない開発者をたくさん知っています。)

score 3 · Accepted Answer

を使用しております

app/src/code.py
app/testing/code_test.py 
app/docs/..

各テストファイルで、に挿入../src/しsys.pathます。これは最も優れたソリューションではありませんが、機能します。誰かがJavaのMavenのようなものを思いついたら、どんなプロジェクトに取り組んでいても、うまく機能する標準的な規則を提供してくれるといいと思います。

score 1 · Accepted Answer

テストが単純な場合は、単にそれらをdocstringに入れます-Pythonのほとんどのテストフレームワークはそれを使用できます：

>>> import module
>>> module.method('test')
'testresult'

他のより複雑なテストについては、私はそれらを../tests/test_module.pyまたはに入れますtests/test_module.py。

score 1 · Accepted Answer

C# では、通常、テストを別のアセンブリに分離しました。

Python では、これまでのところ、テストが関数の docstring にある doctest を作成するかif __name__ == "__main__"、モジュールの下部にあるブロックに配置する傾向がありました。

score 0 · Accepted Answer

「foo」というパッケージを作成するときは、単体テストを別のパッケージ「foo_test」に入れます。モジュールとサブパッケージは、SUTパッケージモジュールと同じ名前になります。たとえば、モジュールfoo.xyのテストはfoo_test.xyにあります。各テストパッケージの__init __。pyファイルには、パッケージのすべてのテストスイートを含むAllTestsスイートが含まれています。setuptoolsは、メインのテストパッケージを指定する便利な方法を提供するため、「pythonsetup.pydevelop」の後に「pythonsetup.pytest」または「pythonsetup.pytest-sfoo_test.x.SomeTestSuite」を使用できます。ただ特定のスイート。

score -2 · Accepted Answer

私は最近 Python でプログラミングを始めたので、まだベストプラクティスを見つける機会がありませんでした。しかし、すべてのテストを見つけて実行するモジュールを作成しました。

ので、私は持っています：

アプリ/
 appfile.py
テスト/
 appfileTest.py

より大きなプロジェクトに進むにつれて、それがどのようになるかを確認する必要があります.

python - Python 単体テストはどこに行くのですか?

18 に答える 18

1 つのテスト ファイルのみ

多くのテストファイル

使用するunittest discovery

参照

単体テスト フレームワーク

Related

Reference

1 つのテストファイルのみ

使用する`unittest discovery`

単体テストフレームワーク