测试集合
测试你的集合可以确保你的代码能够正常工作并与 Ansible 生态系统的其他部分良好集成。你的集合应该通过 Ansible 代码的健全性测试。你还可以添加单元测试以覆盖集合中的代码，并添加集成测试以覆盖集合与 ansible-core 之间的交互。
测试工具
测试集合的主要工具是 ansible-test，Ansible 的测试工具，如 测试 Ansible 中所述，并由 ansible 和 ansible-core 软件包提供。
从你的集合目录使用 ansible-test 工具，该目录必须在路径中包含 ansible_collections，例如 collections/ansible_collections/community/general 用于 community.general 集合。有关测试指南，请参见 测试集合贡献 和 测试 Ansible 和集合。
你可以运行多个健全性测试，以及使用 ansible-test 运行插件的单元测试和集成测试。当测试集合时，针对你所针对的 ansible-core 版本进行测试。
你必须始终从集合的根目录执行 ansible-test。你可以在 Docker 容器中运行 ansible-test，无需安装任何特殊要求。Ansible 团队在 Azure Pipelines 中使用这种方法，无论是在 ansible/ansible GitHub 存储库还是在大型社区集合（如 community.general 和 community.network）中，当提交拉取请求时都会自动运行测试。
许多不需要在不同操作系统发行版上运行测试的集合使用 GitHub Actions 作为其持续集成 (CI) 平台。 collection_template 存储库 包含 GitHub Actions 工作流 模板，集合开发者可以自由使用这些模板，以轻松地在其集合存储库中设置 CI。
以下示例演示了在 Docker 容器中运行测试。
健全性测试
要运行所有健全性测试
ansible-test sanity --docker default -v
添加单元测试
你必须将单元测试放置在适当的 tests/unit/plugins/ 目录中。例如，你将 plugins/module_utils/foo/bar.py 的测试放置在 tests/unit/plugins/module_utils/foo/test_bar.py 或 tests/unit/plugins/module_utils/foo/bar/test_bar.py 中。有关示例，请参见 community.general 中的单元测试。
要运行所有支持的 Python 版本的所有单元测试
ansible-test units --docker default -v
要运行特定 Python 版本的所有单元测试
ansible-test units --docker default -v --python 3.6
要仅运行特定单元测试
ansible-test units --docker default -v --python 3.6 tests/unit/plugins/module_utils/foo/test_bar.py
你可以在 tests/unit/requirements.txt 文件中指定 Python 要求。有关更多信息，尤其是有关夹具文件的信息，请参见 单元测试。
添加集成测试
你必须将集成测试放置在适当的 tests/integration/targets/ 目录中。对于模块集成测试，你可以使用模块名称。例如，你将 plugins/modules/foo.py 的集成测试放置在名为 tests/integration/targets/foo/ 的目录中。对于非模块插件集成测试，你必须将插件类型添加到目录名称中。例如，你将 plugins/connections/bar.py 的集成测试放置在名为 tests/integration/targets/connection_bar/ 的目录中。对于查找插件，目录必须名为 lookup_foo，对于资源清单插件，名为 inventory_foo，等等。
你可以编写两种不同的集成测试
Ansible 角色测试使用
ansible-playbook运行，并验证模块的各个方面。它们可能依赖于其他集成测试（通常名为prepare_bar或setup_bar，它们准备一个服务或安装名为bar的要求，以便测试模块foo）来设置所需的资源，例如安装所需的库或设置服务器服务。runme.sh测试直接作为脚本运行。它们可以设置资源清单文件，并使用各种设置执行ansible-playbook或ansible-inventory。
有关示例，请参见 community.general 中的集成测试。有关更多详细信息，请参见 集成测试。
由于集成测试可以安装要求，并设置、启动和停止服务，因此我们建议尽可能在 Docker 容器或其他受限制的环境中运行它们。默认情况下，ansible-test 支持多个操作系统的 Docker 镜像。有关所有选项，请参见 支持的 Docker 镜像列表。主要使用 default 镜像进行平台无关的集成测试，例如针对云模块的测试。以下示例使用 fedora35 镜像。
要执行集合的所有集成测试
ansible-test integration --docker fedora35 -v
如果你想要更详细的输出，请使用 -vvv 而不是 -v 运行命令。或者，指定 --retry-on-error 以自动以更高的详细程度重新运行失败的测试。
要仅执行特定目录中的集成测试
ansible-test integration --docker fedora35 -v connection_bar
你可以指定多个目标名称。每个目标名称都是 tests/integration/targets/ 中目录的名称。
另请参见
- 测试 Ansible
有关测试 Ansible 的更多资源
- 为 Ansible 维护的集合做贡献
为选定集合做贡献的指南
- 邮件列表
开发邮件列表
- 实时聊天
如何加入 Ansible 聊天频道