测试集合
测试您的集合可确保您的代码运行良好，并与 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 要求。有关更多信息，请参阅 单元测试，特别是关于 fixture 文件。
添加集成测试
您必须将集成测试放在相应的 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 通信指南