如何为pyunit模拟stdin输入？

Question

我正在尝试测试一个从 stdin 获取输入的函数，目前我用的测试方法是这样的：

cat /usr/share/dict/words | ./spellchecker.py

为了实现测试自动化，有没有办法让 pyunit 模拟输入给 raw_input() 呢？

Answer 1

你没有描述一下 spellchecker.py 里到底是什么样的代码，这让我可以自由猜测。

假设它大概是这样的：

import sys

def check_stdin():
  # some code that uses sys.stdin

为了让 check_stdin 这个函数更容易测试，我建议把它改成这样：

def check_stdin():
  return check(sys.stdin)

def check(input_stream):
  # same as original code, but instead of
  # sys.stdin it is written it terms of input_stream.

现在你大部分的逻辑都放在 check 函数里了，这样你可以随意准备任何你能想到的输入来好好测试它，而不需要去处理 stdin。

这是我个人的一点看法。

Answer 2

更新 -- 使用 unittest.mock.patch

从 Python 3.3 开始，unittest 里新增了一个叫做 mock 的子模块，正好可以满足你的需求。如果你使用的是 Python 2.6 或更高版本，可以在 这里 找到 mock 的回归版本。

import unittest
from unittest.mock import patch

import module_under_test


class MyTestCase(unittest.TestCase):

    def setUp(self):
        # raw_input is untouched before test
        assert module_under_test.raw_input is __builtins__.raw_input

    def test_using_with(self):
        input_data = "123"
        expected = int(input_data)

        with patch.object(module_under_test, "raw_input", create=True, 
                return_value=expected):
            # create=True is needed as raw_input is not in the globals of 
            # module_under_test, but actually found in __builtins__ .
            actual = module_under_test.function()

        self.assertEqual(expected, actual)

    @patch.object(module_under_test, "raw_input", create=True)
    def test_using_decorator(self, raw_input):
        raw_input.return_value = input_data = "123"
        expected = int(input_data)

        actual = module_under_test.function()

        self.assertEqual(expected, actual)

    def tearDown(self):
        # raw input is restored after test
        assert module_under_test.raw_input is __builtins__.raw_input

if __name__ == "__main__":
    unittest.main()
# where module_under_test.function is:
def function():
    return int(raw_input("prompt> "))

之前的回答 -- 替换 sys.stdin

我觉得 sys 模块可能正是你需要的。

你可以这样做：

import sys

# save actual stdin in case we need it again later
stdin = sys.stdin

sys.stdin = open('simulatedInput.txt','r') 
# or whatever else you want to provide the input eg. StringIO

每当调用 raw_input 时，它现在会从 simulatedInput.txt 文件中读取内容。如果 simulatedInput.txt 的内容是：

hello
bob

那么第一次调用 raw_input 会返回 "hello"，第二次返回 "bob"，第三次会抛出一个 EOFError，因为没有更多的文本可以读取了。

Answer 3

简单来说，就是要对 raw_input() 进行一种叫做“猴子补丁”的操作。

在这个问题的回答里有一些不错的例子，讲解了如何在Python中显示重定向的标准输入。

这里有一个简单的例子，使用了一个 lambda 表达式，它会忽略提示信息，直接返回我们想要的内容。

测试系统

cat ./name_getter.py
#!/usr/bin/env python

class NameGetter(object):

    def get_name(self):
        self.name = raw_input('What is your name? ')

    def greet(self):
        print 'Hello, ', self.name, '!'

    def run(self):
        self.get_name()
        self.greet()

if __name__ == '__main__':
    ng = NameGetter()
    ng.run()

$ echo Derek | ./name_getter.py 
What is your name? Hello,  Derek !

测试案例：

$ cat ./t_name_getter.py
#!/usr/bin/env python

import unittest
import name_getter

class TestNameGetter(unittest.TestCase):

    def test_get_alice(self):
        name_getter.raw_input = lambda _: 'Alice'
        ng = name_getter.NameGetter()
        ng.get_name()
        self.assertEquals(ng.name, 'Alice')

    def test_get_bob(self):
        name_getter.raw_input = lambda _: 'Bob'
        ng = name_getter.NameGetter()
        ng.get_name()
        self.assertEquals(ng.name, 'Bob')

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

$ ./t_name_getter.py -v
test_get_alice (__main__.TestNameGetter) ... ok
test_get_bob (__main__.TestNameGetter) ... ok

----------------------------------------------------------------------
Ran 2 tests in 0.000s

OK