スクリプトの出力をテストする

Question

私は1つの入力（テキストファイル）を受け入れるPythonスクリプト./myprog.py file.txtを持っています。スクリプトは、指定された入力に基づいて文字列を出力します。

私は自分のプログラムをテストしたいテストファイルのセットを持っています。私は各ファイルの期待される出力を知っていて、スクリプトが各ファイルに対して正しい出力を生成していることを確認したい。

このタイプのテストを実行する一般的に受け入れられる方法は何ですか？

私はテストフレームワークとしてPythonのunittestモジュールを使用して考えて、その後、subprocess.check_output(stderr=subprocess.STDOUT)を通じて私のスクリプトを実行し、stdoutとstderrを捕捉し、その後、実際と予想される文字列を比較するunittestassertEqualをしていました。私はいくつかのより良いソリューションが欠けていないことを確認したい。

Answer 1

ここには2つの問題があります。関数のライブラリではなくプログラムをテストし、関数から返された値ではなく、出力するものをテストする。どちらもテストを難しくしているので、これらの問題を可能な限り解決することが最善です。

一般的な手法は、関数のライブラリを作成し、そのプログラムをその周りの薄いラッパーにすることです。これらの関数は結果を返し、プログラムだけが印刷を行います。つまり、ほとんどのコードに対して通常のユニットテスト手法を使用することができます。

ライブラリとプログラムの両方に1つのファイルを含めることができます。ここでは簡単な例をhello.pyとしています。最後のビットは、それがプログラムとして実行された場合は、それがライブラリとしてインポートされた場合は、ファイルを伝えることができる方法であることを

def hello(greeting, place): 
    return greeting + ", " + place + "!" 

def main(): 
    print(hello("Hello", "World")) 

if __name__ == '__main__': 
    main() 

。それはimport helloと個々の機能へのアクセスを可能にし、また、ファイルがプログラムとして実行することができます。 See this answer for more information。

次に、ほぼ通常の単体テストを書くことができます。

ここ

import hello 
import unittest 
import sys 
from StringIO import StringIO 
import subprocess 

class TestHello(unittest.TestCase): 
    def test_hello(self): 
     self.assertEqual(
      hello.hello("foo", "bar"), 
      "foo, bar!" 
     ) 

    def test_main(self): 
     saved_stdout = sys.stdout 
     try: 
      out = StringIO() 
      sys.stdout = out 
      hello.main() 
      output = out.getvalue() 
      self.assertEqual(output, "Hello, World!\n") 
     finally: 
      sys.stdout = saved_stdout 

    def test_as_program(self): 
     self.assertEqual(
      subprocess.check_output(["python", "hello.py"]), 
      "Hello, World!\n" 
     ) 

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

test_hello直接関数として、ユニットテストhelloあります。より複雑なプログラムでは、テストする機能が増えます。また、ユニットテストmainにtest_mainがあり、その出力をキャプチャするのにStringIOを使用しています。最後に、プログラムがtest_as_programのプログラムとして実行されるようにします。

重要なことは、データを返す関数として機能をテストし、印刷された文字列やフォーマットされた文字列としてできるだけテストしないことです。実際にプログラムをテストするまでには、mainが呼び出されていることを確認するだけです。