Ansible 测试
为什么测试你的 Ansible 贡献？
如果您是开发者，您可以做的最有价值的事情之一就是查看 GitHub 问题并帮助修复错误，因为修复错误几乎总是优先于功能开发。即使对于非开发者来说，帮助测试修复错误和功能的拉取请求仍然非常有价值。
了解如何编写 playbook 和角色的 Ansible 用户应该能够测试他们的工作。GitHub 拉取请求将自动运行各种测试（例如，Azure Pipelines），这些测试会显示实际的错误。但是，贡献者还必须在自动化的 GitHub 检查之外测试他们的工作，并在拉取请求中展示这些测试的证据，以确保他们的工作更有可能被审查和合并。
继续阅读以了解 Ansible 如何进行测试，如何在本地测试你的贡献以及如何扩展测试功能。
如果您想了解有关测试集合的信息，请阅读 测试集合
测试类型
在高级别，我们有以下几类测试：
在 GitHub 和 Azure Pipelines 中进行测试
组织
创建拉取请求 (PR) 时，将使用 Azure Pipelines（一种持续集成 (CI) 工具）对其进行测试。结果显示在每个 PR 的末尾。
当 Azure Pipelines 检测到错误并且可以将其链接回 PR 中已修改的文件时，相关的行将作为 GitHub 评论添加。例如：
The test `ansible-test sanity --test pep8` failed with the following errors:
lib/ansible/modules/network/foo/bar.py:509:17: E265 block comment should start with '# '
The test `ansible-test sanity --test validate-modules` failed with the following error:
lib/ansible/modules/network/foo/bar.py:0:0: E307 version_added should be 2.4. Currently 2.3
从上面的示例中，我们可以看到 --test pep8 和 --test validate-modules 已经识别出一个问题。给出的命令允许您在本地运行相同的测试，以确保您已经修复了所有问题，而无需将更改推送到 GitHub 并等待 Azure Pipelines，例如：
如果您还没有 Ansible，请使用本地检出运行：
source hacking/env-setup
然后运行 GitHub 评论中详细说明的测试。
ansible-test sanity --test pep8
ansible-test sanity --test validate-modules
如果没有 GitHub 评论说明失败的原因，您可以通过单击 PR 末尾“检查已失败”消息下的“详细信息”按钮来检查结果。
重新运行失败的 CI 作业
有时您可能会发现您的 PR 由于与您的更改无关的原因而失败。这可能由于以下几个原因造成：
暂时无法访问外部资源，例如 yum 或 Git 仓库
创建虚拟机以在其上运行测试超时
如果出现上述任一问题，您可以通过以下方式重新运行 Azure Pipelines 测试：
在拉取请求中添加带有
/rebuild（完全重建）或/rebuild_failed（仅重建失败的 CI 节点）的注释关闭并重新打开拉取请求（完全重建）
对分支进行另一次更改并推送到 GitHub
如果问题仍然存在，请联系社区。访问 Ansible 通信指南 获取详细信息。
如何测试 PR
理想情况下，代码应添加测试以证明代码有效。但这并非总是可能的，而且测试并不总是全面的，尤其是在用户无法访问各种平台或正在使用 API 或 Web 服务时。在这些情况下，针对真实设备的现场测试可能比针对模拟接口运行的自动化测试更有价值。无论如何，第一次也应该始终手动测试。
幸运的是，假设您熟悉 Ansible 的工作方式，那么帮助测试 Ansible 就非常简单了。
设置：安装 Pytest 和所需的 Pytest 库
Ansible 的单元测试框架利用 pytest 库。在开始测试之前，请确保已安装 pytest 以及任何其他 pytest 库，例如 pytest-mock 和 pytest-xdist。
有关更多信息，请参阅文档：单元测试。
设置：检出拉取请求
您可以通过以下方式执行此操作：
检出 Ansible
将建议的更改提取到测试分支
测试
在 GitHub 上评论该特定问题
方法如下：
警告
测试从 GitHub 发送给我们的拉取请求中的源代码确实存在一些固有风险，因为发送的源代码可能存在错误或恶意代码，可能会对您的系统产生负面影响。我们建议在虚拟机上进行所有测试，无论是云实例还是本地。一些用户喜欢为此使用 Vagrant 或 Docker，但它们是可选的。拥有不同 Linux 或其他版本的虚拟机也很有用，因为某些功能（例如，apt 或 yum 等包管理器）特定于这些操作系统版本。
创建一个新的工作区
git clone https://github.com/ansible/ansible.git ansible-pr-testing
cd ansible-pr-testing
接下来，找到您要测试的拉取请求并记下它的编号。它看起来像这样：
Use os.path.sep instead of hardcoding / #65381
注意
仅测试 ansible:devel
重要的是 PR 请求目标必须是 ansible:devel，因为我们不接受到任何其他分支的拉取请求。点版本由 Ansible 员工手动挑选。
在提取建议的更改并创建测试分支时，使用拉取请求编号。
git fetch origin refs/pull/XXXX/head:testing_PRXXXX
git checkout testing_PRXXXX
第一个命令从拉取请求中获取建议的更改，并创建一个名为testing_PRXXXX的新分支，其中 XXXX 是与拉取请求关联的实际编号（例如，65381）。第二个命令检出新创建的分支。
注意
如果 GitHub 用户界面显示拉取请求无法干净地合并，如果您不太熟悉 Git 和编码，我们建议不要继续操作，因为您必须解决合并冲突。这是原始拉取请求贡献者的责任。
注意
有些用户不创建功能分支，当他们在其 devel 版本中有多个不相关的提交时，这可能会导致问题。如果源代码类似于 someuser:devel，请确保拉取请求中只列出了一个提交。
Ansible 源代码包含一个脚本，允许您直接从源代码使用 Ansible，而无需完整的安装，Ansible 开发人员经常使用这种方法。
只需对其进行 source 操作（使用 Linux/Unix 术语）即可立即开始使用。
source ./hacking/env-setup
此脚本修改 PYTHONPATH 环境变量（以及其他一些内容），只要您的 shell 会话处于打开状态，这些变量就会临时设置。
测试拉取请求
此时，您应该准备好开始测试了！
一些测试的想法是
使用示例创建一个测试 Playbook，并检查其功能是否正确。
测试是否返回任何 Python 回溯（这是一个错误）。
在不同的操作系统上进行测试，或针对不同的库版本进行测试。
运行完整性测试
ansible-test sanity
更多信息：完整性测试
运行单元测试
ansible-test units
更多信息：单元测试
运行集成测试
ansible-test integration -v ping
更多信息：集成测试
任何潜在的问题都应作为评论添加到拉取请求中（如果功能也能正常工作，添加评论是可以接受的），请记住包含 ansible --version 的输出。
示例
Works for me! Tested on `Ansible 2.3.0`. I verified this on CentOS 6.5 and also Ubuntu 14.04.
如果 PR 没有解决问题，或者您看到单元/集成测试中的任何失败，只需包含该输出即可。
此更改导致我出现错误。当我在 Ubuntu 16.04 上运行它时，它失败并显示以下内容：```一些输出堆栈跟踪其他一些输出```
在线代码覆盖率
在线代码覆盖率报告 是识别 Ansible 测试改进领域的好方法。通过关注红色部分，您可以深入了解报告，找到根本没有测试的文件。添加集成和单元测试，清晰地显示代码的工作方式，验证重要的 Ansible 功能并增加以前没有测试覆盖率的区域的测试覆盖率，是帮助改进 Ansible 的宝贵方法。
代码覆盖率报告仅涵盖 Ansible 的 devel 分支，新的功能开发在此分支进行。拉取请求和新代码将缺失于 codecov.io 覆盖率报告中，因此需要本地报告。大多数 ansible-test 命令允许您收集代码覆盖率，这对于指示在哪里扩展测试特别有用。请参阅 测试 Ansible 和集合 获取更多信息。
想了解更多关于测试的信息？
如果您想了解有关改进 Ansible 测试计划的更多信息，为什么不加入 Ansible 社区论坛 呢？