单元测试 Ansible 模块 

简介 

本文档解释了为什么、如何以及何时应该为 Ansible 模块使用单元测试。本文档不适用于 Ansible 的其他部分，这些部分的建议通常更接近 Python 标准。开发人员指南中提供了 Ansible 单元测试的基本文档单元测试。本文档对于新的 Ansible 模块作者应该是可读的。如果您发现它不完整或令人困惑，请打开一个 bug 或在 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 调用模拟来返回数据，我们可以确保消息中只存在 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

另请参阅 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 代码的一般建议
Uncle Bob 在 YouTube 上的许多视频: 单元测试是包括极限编程 (XP)、整洁代码在内的各种软件开发理念的一部分。Uncle Bob 将讲解如何从中获益
“为什么大多数单元测试都是浪费”: 一篇警告单元测试成本的文章
“对‘为什么大多数单元测试都是浪费’的回应”: 一篇指出如何保持单元测试价值的回应文章