unittest.mock：断言方法参数的部分匹配

Question

Rubyist 在这里编写 Python。我有一些看起来像这样的代码：

result = database.Query('complicated sql with an id: %s' % id)

database.Query 被模拟出来，我想测试 ID 是否正确注入，而不会将整个 SQL 语句硬编码到我的测试中。在 Ruby/RR 中，我会这样做：

mock(database).query(/#{id}/)

但我看不到在 unittest.mock 中设置“选择性模拟”的方法，至少没有一些毛茸茸的side_effect 逻辑。所以我尝试在断言中使用正则表达式：

with patch(database) as MockDatabase:
  instance = MockDatabase.return_value
  ...
  instance.Query.assert_called_once_with(re.compile("%s" % id))

但这也不起作用。这种方法确实有效，但很丑：

with patch(database) as MockDatabase:
  instance = MockDatabase.return_value
  ...
  self.assertIn(id, instance.Query.call_args[0][0])

更好的想法？

Answer 1

The chosen answer 太棒了。

但是，最初的问题似乎想根据正则表达式进行匹配。我提供以下内容，如果没有 falsetru 选择的答案，我将永远无法设计：

class AnyStringWithRegex(str):
    def __init__(self, case_insensitive=True):
        self.case_insensitive = case_insensitive
    def __eq__(self, other):
        if self.case_insensitive:
            return len(re.findall(self.lower(), other.lower())) != 0
        return len(re.findall(self, other)) != 0

Answer 2

您可以使用来自PyHamcrest library 的match_equality 来包装来自同一库的matches_regexp 匹配器：

from hamcrest.library.integration import match_equality

with patch(database) as MockDatabase:
  instance = MockDatabase.return_value
  ...
  expected_arg = matches_regexp(id)
  instance.Query.assert_called_once_with(match_equality(expected_arg))

Python 的unittest.mock 文档中也提到了这种方法：

从 1.5 版开始，Python 测试库 PyHamcrest 提供了类似的功能，在这里可能很有用，形式为相等匹配器 (hamcrest.library.integration.match_equality)。

如果您不想使用 PyHamcrest，上面链接的文档还显示了如何通过使用__eq__ 方法定义一个类来编写自定义匹配器（如falsetrus 答案中所建议的那样）：

class Matcher:
    def __init__(self, compare, expected):
        self.compare = compare
        self.expected = expected

    def __eq__(self, actual):
        return self.compare(self.expected, actual)

match_foo = Matcher(compare, Foo(1, 2))
mock.assert_called_with(match_foo)

您可以在此处用您自己的正则表达式匹配替换对self.compare 的调用，如果没有找到则返回False，或者使用您选择的描述性错误消息引发AssertionError。

Answer 3

import mock

class AnyStringWith(str):
    def __eq__(self, other):
        return self in other

...
result = database.Query('complicated sql with an id: %s' % id)
database.Query.assert_called_once_with(AnyStringWith(id))
...

抢先要求匹配字符串

def arg_should_contain(x):
    def wrapper(arg):
        assert str(x) in arg, "'%s' does not contain '%s'" % (arg, x)
    return wrapper

...
database.Query = arg_should_contain(id)
result = database.Query('complicated sql with an id: %s' % id)

更新

使用像callee 这样的库，你不需要实现AnyStringWith。

from callee import Contains

database.Query.assert_called_once_with(Contains(id))

https://callee.readthedocs.io/en/latest/reference/operators.html#callee.operators.Contains

Answer 4

你可以使用unittest.mock.ANY :)

from unittest.mock import Mock, ANY

def foo(some_string):
    print(some_string)

foo = Mock()
foo("bla")
foo.assert_called_with(ANY)

如此处所述 - https://docs.python.org/3/library/unittest.mock.html#any

Answer 5

我总是编写单元测试，以便它们反映“真实世界”。除了the ID gets injected in correctly，我真的不知道你想测试什么。

我不知道database.Query 应该做什么，但我猜它应该创建一个查询对象，您可以稍后调用或传递给连接？

以真实世界为例进行测试的最佳方法。做一些简单的事情，比如检查 id 是否出现在查询中，太容易出错了。我经常看到人们想在他们的单元测试中做一些神奇的事情，这总是会导致问题。保持你的单元测试简单和静态。在你的情况下，你可以这样做：

class QueryTest(unittest.TestCase):
    def test_insert_id_simple(self):
        expected = 'a simple query with an id: 2'
        query = database.Query('a simple query with an id: %s' % 2)
        self.assertEqual(query, expected)

    def test_insert_id_complex(self):
        expected = 'some complex query with an id: 6'
        query = database.Query('some complex query with an id: %s' 6)
        self.assertEqual(query, expected)

如果database.Query 直接在数据库中执行查询，您可能需要考虑使用类似database.query 或database.execute 的东西。 Query 中的大写字母表示您创建了一个对象，如果它全部为小写，则表示您调用了一个函数。这更像是一个命名约定和我的观点，但我只是把它扔在那里。 ;-)

如果database.Query 直接查询，您最好修补它正在调用的方法。例如，如果它看起来像这样：

def Query(self, query):
    self.executeSQL(query)
    return query

你可以使用mock.patch来阻止单元测试进入数据库：

@mock.patch('database.executeSQL')
def test_insert_id_simple(self, mck):
    expected = 'a simple query with an id: 2'
    query = database.Query('a simple query with an id: %s' % 2)
    self.assertEqual(query, expected)

作为额外提示，请尝试使用str.format 方法。 % 格式将来可能会消失。请参阅this question 了解更多信息。

我也忍不住觉得测试字符串格式是多余的。如果'test %s' % 'test' 不起作用，则意味着 Python 有问题。仅当您想测试自定义查询构建时才有意义。例如插入字符串应该被引用，数字不应该，转义特殊字符等。