如何向 Python 单元测试提供标准输入、文件和环境变量输入？

Question

如何在出现以下情况时编写测试：

1. 测试用户输入。
2. 测试从文件读取的输入。
3. 测试从环境变量读取的输入。

如果有人能告诉我如何处理上述场景，那就太好了；如果您能给我指出一些我可以的文档/文章/博客文章，那就太棒了 读。

Answer 1

您所描述的所有三种情况都是您需要特别注意的地方，以确保您在设计中使用松耦合。

您真的需要对Python的raw_input方法进行单元测试吗？ open 方法？ os.environ.get？不可以。

您需要设置您的设计，以便可以替代检索该输入的其他方式。然后，在单元测试期间，您将放入某种实际上并不调用 raw_input 或 open 的存根。

例如，您的正常代码可能类似于：

import os
def say_hello(input_func):
    name = input_func()
    return "Hello " + name

def prompt_for_name():
    return raw_input("What is your name? ")

print say_hello(prompt_for_name)
# Normally would pass in methods, but lambdas can be used for brevity
print say_hello(lambda: open("a.txt").readline())
print say_hello(lambda: os.environ.get("USER"))

会话如下：

What is your name? somebody
Hello somebody
Hello [some text]

Hello mark

那么您的测试将类似于：

def test_say_hello():
    output = say_hello(lambda: "test")
    assert(output == "Hello test")

请记住，您不必测试语言的 IO 设施（除非您是设计该语言的人，即完全不同的情况）。

Answer 2

如果您依赖于使用 raw_input （或任何其他特定输入源），我是 的大力支持者模拟库。鉴于 Mark Rushakoff 在他的示例中使用的代码：

def say_hello():
    name = raw_input("What is your name? ")
    return "Hello " + name

您的测试代码可以使用模拟：

import mock

def test_say_hello():
     with mock.patch('__builtin__.raw_input', return_value='dbw'):
         assert say_hello() == 'Hello dbw'

     with mock.patch('__builtin__.raw_input', side_effect=['dbw', 'uki']):
         assert say_hello() == 'Hello dbw'
         assert say_hello() == 'Hello uki'

这些断言将通过。请注意，side_effect 按顺序返回列表的元素。它还能做更多事情！我建议查看文档。

Answer 3

如果您可以在不使用外部流程的情况下摆脱困境，那就这样做。

然而，在某些情况下，这很复杂，并且您确实想要使用进程，例如，您想要测试 C 可执行文件的命令行界面。

用户输入

使用subprocess.Popen，如下所示：

process = subprocess.Popen(
    command,
    shell  = False,
    stdin  = subprocess.PIPE,
    stdout = subprocess.PIPE,
    stderr = subprocess.PIPE,
    universal_newlines = True
)
stdout, stderr = process.communicate("the user input\nline 2")
exit_status = process.wait()

从用户获取输入和从管道获取输入以使用raw_input<等方法完成输入没有区别/code> 或 sys.stdin.read()。

文件

• 创建一个临时目录并在测试 setUp 方法中创建您想要从中读取的文件：

  tdir = tempfile.mkdtemp(
      前缀 = '文件测试_', 
  ）
  fpath = os.path.join(tdir,'文件名')
  fp = 打开（fpath，'w'）
  fp.write("内容")
  fp.close()
  

• 在测试中读取文件。

• 之后删除临时目录。

  shutil.rmtree(tdir)
  

• 从文件中读取数据是相当复杂的，大多数程序可以从文件中读取，也可以从 STDIN 中读取（例如使用 fileinput）。所以，如果你想测试的是输入特定内容时会发生什么，并且你的程序接受STDIN，只需使用Popen来测试程序。

环境变量

• 使用 os.environ["THE_VAR"] = "the_val" 设置环境变量，
• 使用 del os.environ["THE_VAR"] 取消设置code>
• os.environ = {'a':'b'} 不起作用
• 然后调用 subprocess.Popen。环境是从调用进程继承的。

模板代码

我在我的github上有一个模块< /a> 测试 STDOUT、STDERR 以及给定 STDIN 的退出状态、命令行参数和环境。另外，检查“tests”目录下该模块的测试。一定有更好的模块可以实现这一点，所以我的模块只是为了学习目的。

Answer 4

使用 pytest：

import os


def test_user_input(monkeypatch):
    inputs = [10, 'y']
    input_generator = (i for i in inputs)
    monkeypatch.setattr('__builtin__.raw_input', lambda prompt: next(input_generator))
    assert raw_input('how many?') == 10
    assert raw_input('you sure?') == 'y'


def test_file_input(tmpdir):
    fixture = tmpdir.join('fixture.txt')
    fixture.write(os.linesep.join(['1', '2', '3']))
    fixture_path = str(fixture.realpath())
    with open(fixture_path) as f:
        assert f.readline() == '1' + os.linesep


def test_environment_input(monkeypatch):
    monkeypatch.setenv('STAGING', 1)
    assert os.environ['STAGING'] == '1'