如何模拟执行 sys.exit() 的 Python 方法 OptionParser.error()？

Question

我正在尝试对一些如下所示的代码进行单元测试：

def main():
    parser = optparse.OptionParser(description='This tool is cool', prog='cool-tool')
    parser.add_option('--foo', action='store', help='The foo option is self-explanatory')
    options, arguments = parser.parse_args()
    if not options.foo:
        parser.error('--foo option is required')
    print "Your foo is %s." % options.foo
    return 0

if __name__ == '__main__':
   sys.exit(main())

使用如下所示的代码：

@patch('optparse.OptionParser')
def test_main_with_missing_p4clientsdir_option(self, mock_optionparser):
    #
    # setup
    #
    optionparser_mock = Mock()
    mock_optionparser.return_value = optionparser_mock
    options_stub = Mock()
    options_stub.foo = None
    optionparser_mock.parse_args.return_value = (options_stub, sentinel.arguments)
    def parser_error_mock(message):
        self.assertEquals(message, '--foo option is required')
        sys.exit(2)
    optionparser_mock.error = parser_error_mock

    #
    # exercise & verify
    #
    self.assertEquals(sut.main(), 2)

我正在使用 Michael Foord 的 Mock，并运行测试。

当我运行测试时，我得到：

  File "/Users/dspitzer/Programming/Python/test-optparse-error/tests/sut_tests.py", line 27, in parser_error_mock
    sys.exit(2)
SystemExit: 2

----------------------------------------------------------------------
Ran 1 test in 0.012s

FAILED (errors=1)

问题是 OptionParser.error 执行 sys.exit(2)，因此 main() 自然依赖于此。 但是nose或unittest检测到（预期的）sys.exit(2)并且测试失败。

我可以通过在 main() 中的 parser.error() 调用下添加“return 2”并从 parser_error_mock() 中删除 sys.exit() 调用来使测试通过，但我发现将测试中的代码修改为允许测试通过。 有更好的解决方案吗？

更新：df的答案有效，尽管正确的调用是“self.assertRaises(SystemExit ，sut.main)”。

这意味着无论 parser_error_mock() 中 sys.exit() 中的数字是什么，测试都会通过。 有什么方法可以测试退出代码吗？

添加：，测试会更加稳健

self.assertEquals(optionparser_mock.method_calls, [('add_option', ('--foo',), {'action': 'store', 'help': 'The foo option is self-explanatory'}), ('parse_args', (), {})])

顺便说一句，如果我在最后

。 更新 2：我可以通过将“self.assertRaises(SystemExit, sut.main)”替换为以下内容来测试退出代码：

try:
    sut.main()
except SystemExit, e:
    self.assertEquals(type(e), type(SystemExit()))
    self.assertEquals(e.code, 2)
except Exception, e:
    self.fail('unexpected exception: %s' % e)
else:
    self.fail('SystemExit exception expected')

Answer 1

这可以代替 assertEquals 吗？

self.assertRaises(SystemExit, sut.main, 2)

这应该捕获 SystemExit 异常并防止脚本终止。

Answer 2

正如我对问题的更新中所指出的，我必须修改 dF 的答案：

self.assertRaises(SystemExit, sut.main)

......然后我想到了用一些更长的代码片段来测试退出代码。

[注意：我接受了自己的答案，但如果他更新了他的答案，我将删除此答案并接受 dF。]

Answer 3

可能这个问题包含一些新信息：

Java：如何测试方法调用 System.exit()？

Answer 4

将 @raises 添加到您的测试函数中。 IE：

from nose.tools import raises

@raises(SystemExit)
@patch('optparse.OptionParser')
def test_main_with_missing_p4clientsdir_option(self, mock_optionparser):
    # Setup
    ...
    sut.main()