如何模拟基于 *args 输入返回值的函数？

Question

我有一个函数 foo 调用另一个函数 get_info_from_tags。

这是get_info_from_tags 的实现：

def get_info_from_tags(*args):
    instance_id = get_instance_id()
    proc = subprocess.Popen(["aws", "ec2", "describe-tags", "--filters", f"Name=resource-id,Values={instance_id}"],
                            stdout=subprocess.PIPE, shell=True)
    (out, err) = proc.communicate()
    em_json = json.loads(out.decode('utf8'))
    tags = em_json['Tags']  # tags list

    results = []

    for arg in args:
        for tag in tags:
            if tag['Key'] == arg:
                results.append(tag['Value'])

    return results

有一组 10 个可能的 args 可以传递给get_info_from_tags，我需要返回正确的数组（我不想调用 aws 服务，这就是我模拟的重点，我将手动设置字典中的值）。

如何模拟get_info_from_tags，以便在我调用时

get_info_from_tags('key1', 'key2' ...)

在 foo 函数内部，我得到了我想要的结果？

我已经尝试过pytest的一些功能，但似乎不太明白。

一个可能的解决方案是创建另一个函数：

def mocked_get_info_from_tags(*args):
    values = []
    for arg in args:
        values.append(my_dictionary[arg])
    return values

但我不知道如何在测试环境中实现此覆盖。

谢谢。

Answer 1

unittest.mock.patch 是你的朋友。

你没有指定模块名称，所以我在里面放了一些<placeholders>。

from unittest.mock import patch
from <module_with_foo> import foo
from <module_with_mock> import mocked_get_info_from_tags

with patch('<module_with_foo>.get_info_from_tags', mocked_get_info_from_tags):
    foo()

这会将get_info_from_tags 替换为此函数的模拟版本。替换是在模块级别完成的，因此模块 <module_with_foo> 中调用 get_info_from_tags 的所有内容现在都将调用您的模拟。

---

注意patch的路径：

patch 替换模块属性的值。所以，如果你有一个模块moo 和一个函数foo，它从模块moo2 调用bar：

# moo module
from moo2 import bar

def foo():
    bar()

...从patch 的角度来看，moo.foo 调用moo.bar，而不是moo2.bar。这就是为什么你必须修补使用函数的模块，而不是定义函数的地方。

Answer 2

您可以从另一个函数调用一个函数，然后在您设置数据库时替换。这样你仍然可以在代码中的任何地方调用foo.get_info_from_db('key1', 'key2' ...)，当你添加正确的数据库连接时，你所要做的就是改变一个主要的get_info_from_db函数实现并删除模拟

import db_connector

def mocked_get_info_from_db(*args):
    values = []
    for arg in args:
        values.append(my_dictionary[arg])
    return values

def get_info_from_db(*args):

    # remove this once your database is setup
    return mocked_get_info_from_db(*args)

    # values = []
    # for arg in args:
    #     values.append(db_connector.get(arg))
    # return values