测试 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 等软件包管理器）特定于这些 OS 版本。
创建一个新的工作区域
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 社区论坛。