Ansible 模块单元测试 

介绍 

本文档解释了为什么、如何以及何时为 Ansible 模块使用单元测试。本文档不适用于 Ansible 的其他部分，对于这些部分，建议通常更接近 Python 标准。开发者指南中提供了 Ansible 单元测试的基本文档单元测试。本文档应该对 Ansible 模块的新作者易于阅读。如果您发现它不完整或令人困惑，请在 Ansible 论坛上打开错误或寻求帮助。

什么是单元测试？

Ansible 在 test/units 目录中包含一组单元测试。这些测试主要涵盖内部，但也涵盖 Ansible 模块。单元测试的结构与代码库的结构相匹配，因此位于 test/units/modules/ 目录中的测试按模块组进行组织。

集成测试可用于大多数模块，但某些情况下无法使用集成测试验证情况。这意味着 Ansible 单元测试用例可能会超出仅测试最小单元的范围，在某些情况下将包含一定程度的功能测试。

为什么要使用单元测试？

Ansible 单元测试具有优点和缺点。了解这一点很重要。优点包括

大多数单元测试比大多数 Ansible 集成测试快得多。开发人员可以在本地系统上定期运行完整的单元测试套件。
没有访问模块设计为在其上运行的系统的开发人员可以运行单元测试，从而提供一定程度的验证，即对核心功能的更改不会破坏模块期望。
单元测试可以轻松替换系统功能，从而允许测试不切实际的软件。例如，sleep() 函数可以被替换，我们可以检查是否调用了十分钟的休眠，而无需实际等待十分钟。
单元测试在不同的 Python 版本上运行。这使我们能够确保代码在不同的 Python 版本上以相同的方式运行。

单元测试也有一些潜在的缺点。单元测试通常不会直接测试软件的实际有用价值特征，而是仅测试内部实现

测试软件内部不可见特征的单元测试可能会使重构变得困难，如果这些内部特征必须更改（另请参见以下“如何”中的命名）
即使内部特征正常工作，也可能在测试的内部代码与传递给用户的实际结果之间存在问题

通常，Ansible 集成测试（使用 Ansible YAML 编写）可以更好地测试大多数模块功能。如果这些测试已经测试了某个功能并运行良好，那么可能没有必要再提供涵盖相同领域的单元测试。

何时使用单元测试 

在许多情况下，单元测试比集成测试更适合。例如，测试使用集成测试不可能、缓慢或非常难以测试的事物，例如

强制执行罕见/奇怪/随机情况，这些情况无法强制执行，例如特定的网络故障和异常
对缓慢的配置 API 进行广泛的测试
集成测试无法作为 Azure Pipelines 中运行的主要 Ansible 持续集成的一部分运行的情况。

提供快速反馈 

示例: rds_instance 测试用例的单个步骤可能需要长达 20 分钟（在亚马逊中创建 RDS 实例的时间）。整个测试运行可能需要超过一个小时。所有 16 个单元测试在不到 2 秒的时间内完成执行。

能够在单元测试中运行代码所节省的时间使得在调试模块时创建单元测试变得值得，即使这些测试并不经常在以后识别问题。作为一个基本目标，每个模块至少应该有一个单元测试，它可以在简单的案例中提供快速反馈，而无需等待集成测试完成。

确保正确使用外部接口 

单元测试可以检查运行外部服务的的方式，以确保它们符合规范或尽可能高效即使最终输出不会改变。

示例: 包管理器在一次安装多个包时通常比分别安装每个包效率高得多。最终结果相同：所有包都已安装，因此很难通过集成测试验证效率。通过提供模拟包管理器并验证它只被调用了一次，我们可以为模块效率构建宝贵的测试。

另一个相关的用法是在 API 具有行为不同的版本的场景中。在处理新版本时，程序员可能会更改模块以使用新版本的 API，并无意中破坏旧版本。检查旧版本的调用是否正确完成的测试用例可以帮助避免此问题。在这种情况下，在测试用例名称中包含版本号非常重要（请参阅以下命名单元测试）。

提供特定的设计测试 

通过构建对代码特定部分的要求，然后根据该要求进行编码，单元测试可以有时改进代码并帮助未来的开发人员理解该代码。

另一方面，测试代码内部实现细节的单元测试几乎总是弊大于利。测试要安装的包存储在一个列表中会减慢并混淆未来的开发人员，他们可能需要将该列表更改为字典以提高效率。这个问题可以通过清晰的测试命名来减少，这样未来的开发人员会立即知道删除测试用例，但通常最好是完全省略测试用例，并测试代码的真正有价值的特性，例如安装作为参数传递给模块的所有包。

如何对 Ansible 模块进行单元测试 

有许多技术可以对模块进行单元测试。请注意，大多数没有单元测试的模块的结构使得测试非常困难，并且可能导致非常复杂的测试，这些测试需要比代码更多的工作。有效地使用单元测试可能会导致你重构代码。这通常是一件好事，并且会导致更好的整体代码。良好的重构可以使你的代码更清晰，更容易理解。

命名单元测试 

单元测试应该有逻辑名称。如果正在处理被测模块的开发人员破坏了测试用例，则应该很容易从名称中弄清楚单元测试涵盖的内容。如果单元测试旨在验证与特定软件或 API 版本的兼容性，则在单元测试名称中包含该版本。

例如，test_v2_state_present_should_call_create_server_with_name() 将是一个好名称，test_create_server() 则不是。

模拟的使用 

模拟对象（来自 https://docs.pythonlang.cn/3/library/unittest.mock.html）在构建针对特殊/困难案例的单元测试时非常有用，但它们也可能导致复杂且令人困惑的编码情况。模拟的一个很好的用途是模拟 API。至于 'six'，'mock' Python 包与 Ansible 捆绑在一起（使用 import units.compat.mock）。

使用模拟对象确保故障案例可见 

像 module.fail_json() 这样的函数通常被预期会终止执行。当你使用模拟模块对象运行时，这不会发生，因为模拟对象总是从函数调用中返回另一个模拟对象。你可以像上面那样设置模拟对象来引发异常，或者你可以在每个测试中断言这些函数没有被调用。例如

module = MagicMock()
function_to_test(module, argument)
module.fail_json.assert_not_called()

这不仅适用于调用主模块，还适用于模块中几乎所有获取模块对象的函数。

实际模块的模拟 

实际模块的设置非常复杂（参见下面的传递参数），并且对于大多数使用模块的函数来说，通常不需要。相反，你可以使用模拟对象作为模块，并创建测试函数所需的任何模块属性。如果你这样做，请注意模块退出函数需要特殊的处理，如上所述，要么抛出异常，要么确保它们没有被调用。例如

class AnsibleExitJson(Exception):
    """Exception class to be raised by module.exit_json and caught by the test case"""
    pass

# you may also do the same to fail json
module = MagicMock()
module.exit_json.side_effect = AnsibleExitJson(Exception)
with self.assertRaises(AnsibleExitJson) as result:
    results = my_module.test_this_function(module, argument)
module.fail_json.assert_not_called()
assert results["changed"] == True

带有单元测试用例的 API 定义 

API 交互通常最好使用 Ansible 集成测试部分中定义的函数测试来测试，这些测试针对实际的 API 运行。在一些情况下，单元测试可能会更好地工作。

根据 API 规范定义模块 

这种情况对于与 Web 服务交互的模块尤其重要，这些 Web 服务提供了 Ansible 使用的 API，但超出了用户的控制范围。

通过编写 API 调用的自定义模拟，这些模拟从 API 返回数据，我们可以确保 API 规范中明确定义的功能存在于消息中。这意味着我们可以检查我们是否使用了正确的参数，而不是其他任何东西。

示例：在 rds_instance 单元测试中定义了一个简单的实例状态:

def simple_instance_list(status, pending):
    return {u'DBInstances': [{u'DBInstanceArn': 'arn:aws:rds:us-east-1:1234567890:db:fakedb',
                              u'DBInstanceStatus': status,
                              u'PendingModifiedValues': pending,
                              u'DBInstanceIdentifier': 'fakedb'}]}

然后使用它来创建一个状态列表

rds_client_double = MagicMock()
rds_client_double.describe_db_instances.side_effect = [
    simple_instance_list('rebooting', {"a": "b", "c": "d"}),
    simple_instance_list('available', {"c": "d", "e": "f"}),
    simple_instance_list('rebooting', {"a": "b"}),
    simple_instance_list('rebooting', {"e": "f", "g": "h"}),
    simple_instance_list('rebooting', {}),
    simple_instance_list('available', {"g": "h", "i": "j"}),
    simple_instance_list('rebooting', {"i": "j", "k": "l"}),
    simple_instance_list('available', {}),
    simple_instance_list('available', {}),
]

然后这些状态被用作模拟对象的返回值，以确保 await 函数等待所有状态，这意味着 RDS 实例尚未完成配置

rds_i.await_resource(rds_client_double, "some-instance", "available", mod_mock,
                     await_pending=1)
assert(len(sleeper_double.mock_calls) > 5), "await_pending didn't wait enough"

通过这样做，我们检查了 await 函数是否会继续等待，即使在整合测试中无法可靠地触发，但在现实中却不可预测地发生。

定义一个模块来处理多个 API 版本 

这种情况对于与许多不同软件版本交互的模块尤其重要；例如，预期可以与许多不同操作系统版本一起工作的软件包安装模块。

通过使用先前存储的来自不同 API 版本的数据，我们可以确保代码针对实际发送的来自该系统版本的数据进行测试，即使该版本非常模糊，并且在测试期间不太可能可用。

Ansible 单元测试的特殊情况 

单元测试 Ansible 模块环境有许多特殊情况。最常见的列在下面，可以通过查看现有单元测试的源代码或咨询社区来找到其他建议。

模块参数处理 

运行模块的主函数有两个问题

由于模块应该在 STDIN 上接受参数，因此正确设置参数有点困难，以便模块将其作为参数获取。
所有模块都应该通过调用 module.fail_json() 或 module.exit_json() 来结束，但这些在测试环境中无法正常工作。

传递参数 

要将参数正确传递给模块，请使用 set_module_args 方法，该方法接受字典作为参数。模块创建和参数处理通过 AnsibleModule 对象在实用程序的基本部分中处理。通常情况下，它接受 STDIN 上的输入，这对于单元测试来说并不方便。当特殊变量被设置时，它将被视为输入来自 STDIN 到模块。在设置模块之前，只需调用该函数

import json
from units.modules.utils import set_module_args
from ansible.module_utils.common.text.converters import to_bytes

def test_already_registered(self):
    set_module_args({
        'activationkey': 'key',
        'username': 'user',
        'password': 'pass',
    })

正确处理退出 

函数 module.exit_json() 在测试环境中无法正常工作，因为它在退出时将错误信息写入 STDOUT，在那里很难检查。可以通过用引发异常的函数替换它（以及 module.fail_json()）来缓解这种情况

def exit_json(*args, **kwargs):
    if 'changed' not in kwargs:
        kwargs['changed'] = False
    raise AnsibleExitJson(kwargs)

现在，你可以通过测试正确的异常来确保第一个被调用的函数是你期望的函数

def test_returned_value(self):
    set_module_args({
        'activationkey': 'key',
        'username': 'user',
        'password': 'pass',
    })

    with self.assertRaises(AnsibleExitJson) as result:
        my_module.main()

相同的技术可以用来替换 module.fail_json()（用于模块的失败返回）以及 aws_module.fail_json_aws()（用于 Amazon Web 服务的模块）。

运行主函数 

如果你确实要运行模块的实际主函数，你必须导入模块，像上面那样设置参数，设置适当的退出异常，然后运行模块

# This test is based around pytest's features for individual test functions
import pytest
import ansible.modules.module.group.my_module as my_module

def test_main_function(monkeypatch):
    monkeypatch.setattr(my_module.AnsibleModule, "exit_json", fake_exit_json)
    set_module_args({
        'activationkey': 'key',
        'username': 'user',
        'password': 'pass',
    })
    my_module.main()

处理对外部可执行文件的调用 

模块必须使用 AnsibleModule.run_command() 来执行外部命令。这个方法需要被模拟

这是一个 AnsibleModule.run_command() 的简单模拟（来自 test/units/modules/packaging/os/test_rhn_register.py)

with patch.object(basic.AnsibleModule, 'run_command') as run_command:
    run_command.return_value = 0, '', ''  # successful execution, no output
    with self.assertRaises(AnsibleExitJson) as result:
        my_module.main()
        self.assertFalse(result.exception.args[0]['changed'])
# Check that run_command has been called
run_command.assert_called_once_with('/usr/bin/command args')
self.assertEqual(run_command.call_count, 1)
self.assertFalse(run_command.called)

一个完整的示例 

以下示例是一个完整的骨架，它重用了上面解释的模拟，并为 Ansible.get_bin_path() 添加了一个新的模拟

import json

from units.compat import unittest
from units.compat.mock import patch
from ansible.module_utils import basic
from ansible.module_utils.common.text.converters import to_bytes
from ansible.modules.namespace import my_module


def set_module_args(args):
    """prepare arguments so that they will be picked up during module creation"""
    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
    basic._ANSIBLE_ARGS = to_bytes(args)


class AnsibleExitJson(Exception):
    """Exception class to be raised by module.exit_json and caught by the test case"""
    pass


class AnsibleFailJson(Exception):
    """Exception class to be raised by module.fail_json and caught by the test case"""
    pass


def exit_json(*args, **kwargs):
    """function to patch over exit_json; package return data into an exception"""
    if 'changed' not in kwargs:
        kwargs['changed'] = False
    raise AnsibleExitJson(kwargs)


def fail_json(*args, **kwargs):
    """function to patch over fail_json; package return data into an exception"""
    kwargs['failed'] = True
    raise AnsibleFailJson(kwargs)


def get_bin_path(self, arg, required=False):
    """Mock AnsibleModule.get_bin_path"""
    if arg.endswith('my_command'):
        return '/usr/bin/my_command'
    else:
        if required:
            fail_json(msg='%r not found !' % arg)


class TestMyModule(unittest.TestCase):

    def setUp(self):
        self.mock_module_helper = patch.multiple(basic.AnsibleModule,
                                                 exit_json=exit_json,
                                                 fail_json=fail_json,
                                                 get_bin_path=get_bin_path)
        self.mock_module_helper.start()
        self.addCleanup(self.mock_module_helper.stop)

    def test_module_fail_when_required_args_missing(self):
        with self.assertRaises(AnsibleFailJson):
            set_module_args({})
            my_module.main()


    def test_ensure_command_called(self):
        set_module_args({
            'param1': 10,
            'param2': 'test',
        })

        with patch.object(basic.AnsibleModule, 'run_command') as mock_run_command:
            stdout = 'configuration updated'
            stderr = ''
            rc = 0
            mock_run_command.return_value = rc, stdout, stderr  # successful execution

            with self.assertRaises(AnsibleExitJson) as result:
                my_module.main()
            self.assertFalse(result.exception.args[0]['changed']) # ensure result is changed

        mock_run_command.assert_called_once_with('/usr/bin/my_command --value 10 --name test')

重构模块以启用测试模块设置和其他进程 

模块通常有一个 main() 函数，它设置模块，然后执行其他操作。这使得检查参数处理变得困难。通过将模块配置和初始化移到一个单独的函数中，可以更容易地实现这一点。例如

argument_spec = dict(
    # module function variables
    state=dict(choices=['absent', 'present', 'rebooted', 'restarted'], default='present'),
    apply_immediately=dict(type='bool', default=False),
    wait=dict(type='bool', default=False),
    wait_timeout=dict(type='int', default=600),
    allocated_storage=dict(type='int', aliases=['size']),
    db_instance_identifier=dict(aliases=["id"], required=True),
)

def setup_module_object():
    module = AnsibleAWSModule(
        argument_spec=argument_spec,
        required_if=required_if,
        mutually_exclusive=[['old_instance_id', 'source_db_instance_identifier',
                             'db_snapshot_identifier']],
    )
    return module

def main():
    module = setup_module_object()
    validate_parameters(module)
    conn = setup_client(module)
    return_dict = run_task(module, conn)
    module.exit_json(**return_dict)

现在可以针对模块初始化函数运行测试了

def test_rds_module_setup_fails_if_db_instance_identifier_parameter_missing():
    # db_instance_identifier parameter is missing
    set_module_args({
        'state': 'absent',
        'apply_immediately': 'True',
     })

    with self.assertRaises(AnsibleFailJson) as result:
        my_module.setup_json

另请参阅 test/units/module_utils/aws/test_rds.py

请注意，argument_spec 字典在模块变量中可见。这有两个优点，一是允许对参数进行显式测试，二是允许为测试轻松创建模块对象。

相同的重构技术对于测试其他功能也很有价值，例如模块查询其配置对象的那些部分。

维护 Python 2 兼容性的陷阱 

如果你使用来自 Python 2.6 标准库的 mock 库，许多断言函数会丢失，但会像成功一样返回。这意味着测试用例应该非常小心地 *不要* 使用在 Python 3 文档中标记为 _new_ 的函数，因为即使在旧版本的 Python 上运行时代码被破坏，测试也可能总是成功。

一种有益的开发方法应该是确保所有测试都在 Python 2.6 下运行，并且测试用例中的每个断言都已通过破坏 Ansible 代码来触发该失败来检查其是否有效。

警告

维护 Python 2.6 兼容性

请记住，模块需要维护与 Python 2.6 的兼容性，因此模块的单元测试也应该与 Python 2.6 兼容。

另请参阅

沟通: 有问题吗？需要帮助？想分享你的想法？访问 Ansible 沟通指南
单元测试: Ansible 单元测试文档
测试 Ansible 和集合: 在本地运行测试，包括收集和报告覆盖率数据
开发模块: 开始开发模块
Python 3 文档 - 26.4. unittest — 单元测试框架: Python 3 中的 unittest 框架文档
Python 2 文档 - 25.3. unittest — 单元测试框架: 最早支持的 unittest 框架的文档 - 来自 Python 2.6
pytest：帮助你编写更好的程序: pytest 的文档 - 实际上用于运行 Ansible 单元测试的框架
测试你的代码（来自 Python 徒步旅行者指南！）: 关于测试 Python 代码的一般建议
Bob 叔叔在 YouTube 上的许多视频: 单元测试是各种软件开发哲学的一部分，包括极限编程 (XP)、整洁代码。Bob 叔叔谈论了如何从中获益
“为什么大多数单元测试是浪费”: 一篇关于单元测试成本的文章
“对“为什么大多数单元测试是浪费”的回应”: 一篇回应文章，指出了如何维护单元测试的价值