单元测试 

单元测试是针对特定库或模块的小型隔离测试。目前，Ansible 中的单元测试是在 Ansible 的持续集成过程中从 Python 驱动测试的唯一方法。这意味着在某些情况下，测试可能比仅是单元测试的范围更广。

可用测试 

单元测试可以在 test/units 中找到。请注意，测试的目录结构与 lib/ansible/ 的目录结构相匹配。

运行测试 

注意

要使用 Docker 运行单元测试，始终通过传递 --docker 或 --docker default 参数来使用默认的 Docker 镜像。

可以通过执行以下操作来运行整个代码库的 Ansible 单元测试

cd /path/to/ansible/source
source hacking/env-setup
ansible-test units --docker -v

通过执行以下操作来针对单个文件进行测试

ansible-test units --docker -v apt

或通过执行以下操作来针对特定的 Python 版本进行测试

ansible-test units --docker -v --python 2.7 apt

如果要对模块以外的其他内容（例如模块实用程序）运行单元测试，请指定完整的文件路径

ansible-test units --docker -v test/units/module_utils/basic/test_imports.py

有关高级用法，请参见在线帮助

ansible-test units --help

您还可以通过打开拉取请求来在 Ansible 的持续集成系统中运行测试。这将根据您的拉取请求中所做的更改自动确定要运行的测试。

安装依赖 

如果您使用 --docker 或 --venv 选项运行 ansible-test，则无需手动安装依赖项。

否则，您可以使用 --requirements 选项安装依赖项，该选项将安装单元测试所需的所有必需依赖项。例如

ansible-test units --python 2.7 --requirements apache2_module

单元测试要求列表可以在 test/units/requirements.txt 中找到。

这不包括 ansible-test 本身的单元测试要求的列表，该列表可以在 test/lib/ansible_test/_data/requirements/units.txt 中找到。

另请参阅适用于所有测试命令的约束。

扩展单元测试 

警告

单元测试不是什么

如果您开始编写需要外部服务的测试，则您可能正在编写集成测试，而不是单元测试。

组织单元测试 

Ansible 通过 pytest 驱动单元测试。这意味着测试可以编写为简单的函数，这些函数包含在任何文件名（如 test_<something>.py）中，也可以编写为类。

这是一个函数的示例

#this function will be called simply because it is called test_*()

def test_add():
    a = 10
    b = 23
    c = 33
    assert a + b == c

这是一个类的示例

import unittest

class AddTester(unittest.TestCase):

    def SetUp():
        self.a = 10
        self.b = 23

    # this function will
    def test_add():
      c = 33
      assert self.a + self.b == c

   # this function will
    def test_subtract():
      c = -13
      assert self.a - self.b == c

两种方法在大多数情况下都工作正常；基于函数的接口更简单快捷，因此当您只是尝试为模块添加一些基本测试时，这可能是您应该开始的地方。基于类的测试允许更整洁地设置和拆卸先决条件，因此如果您的模块有许多测试用例，您可能需要重构为使用它。

在测试中使用简单的 assert 函数进行断言将提供有关失败原因的完整信息，并提供断言期间调用的函数的回溯。这意味着建议使用普通的断言而不是其他外部断言库。

许多单元测试套件都包含在多个模块之间共享的函数，尤其是在网络领域。在这些情况下，将在同一目录中创建一个文件，然后直接包含该文件。

模块测试用例通用代码 

在 test/units/ 目录结构中，尽可能保持通用代码的特定性。不要从当前目录或父目录之外的目录导入通用单元测试代码。

不要从单元测试中导入其他单元测试。任何通用代码都应位于本身不是测试的专用文件中。

Fixtures 文件 

要模拟从设备获取结果，或提供来自外部库的其他复杂数据结构，您可以使用 fixtures 来读取预生成的数据。

您可以检查 fixtures 如何在 cpuinfo fact tests 中使用

如果您正在模拟 API，您可能会发现 Python placebo 非常有用。有关更多信息，请参见单元测试 Ansible 模块。

新的或更新的单元测试的代码覆盖率 

新代码将从 codecov.io 覆盖率报告中丢失（请参阅测试 Ansible），因此需要本地报告。大多数 ansible-test 命令都允许您收集代码覆盖率；这在指示在哪里扩展测试时特别有用。

要收集覆盖率数据，请将 --coverage 参数添加到您的 ansible-test 命令行

ansible-test units --coverage apt
ansible-test coverage html

结果将写入 test/results/reports/coverage/index.html

可以生成几种不同格式的报告

ansible-test coverage report - 控制台报告。
ansible-test coverage html - HTML 报告。
ansible-test coverage xml - XML 报告。

要在测试运行之间清除数据，请使用 ansible-test coverage erase 命令。有关生成覆盖率报告的更多信息，请参见测试 Ansible 和集合。

另请参阅

单元测试 Ansible 模块: 单元测试模块的特殊注意事项
测试 Ansible 和集合: 在本地运行测试，包括收集和报告覆盖率数据
Python 3 文档 - 26.4. unittest — 单元测试框架: Python 3 中 unittest 框架的文档
Python 2 文档 - 25.3. unittest — 单元测试框架: 最早支持的 unittest 框架的文档 - 来自 Python 2.6
pytest：帮助您编写更好的程序: pytest 的文档 - 实际用于运行 Ansible 单元测试的框架