测试 Ansible
为什么要测试您的 Ansible 贡献？
如果您是开发者，您可以做的一件最有价值的事情是查看 GitHub 问题并帮助修复错误，因为修复错误几乎总是比功能开发优先。即使对于非开发者来说，帮助测试修复错误和功能的拉取请求仍然非常有价值。
了解如何编写剧本和角色的 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 员工手动 cherry-pick。
在您提取建议的更改并创建用于测试的分支时，请使用拉取请求编号
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 上经常使用此脚本。
只需将其作为源代码（使用 Linux/Unix 术语）即可立即开始使用
source ./hacking/env-setup
此脚本修改了 PYTHONPATH 环境变量（以及其他一些内容），只要您的 shell 会话处于打开状态，这些环境变量就会被临时设置。
测试拉取请求
此时，您应该准备好开始测试了！
以下是您可以测试的一些内容：
使用示例创建测试剧本，并检查它们是否正常工作
测试是否返回了任何 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 社区论坛.