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 分钟（在 Amazon 中创建 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 规范中明确定义的功能。这意味着我们可以检查我们是否使用了正确的参数，而不是其他任何参数。

示例：在 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 Services 的模块）。

运行主函数 

如果您确实要运行模块的实际主函数，则必须导入模块，如上所述设置参数，设置适当的退出异常，然后运行模块

# 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