integration-aliases

集成测试由 ansible-test 执行，并位于 test/integration/targets/ 下的目录中。每个测试都必须有一个 aliases 文件来控制测试执行。

别名将在以下部分中解释。每个别名必须位于 aliases 文件中的单独一行上。

分组

必须配置测试以在一个组中运行。这是通过将适当的组添加到 aliases 文件来完成的。

以下是一些可用组的示例

  • shippable/posix/group1

  • shippable/windows/group2

  • shippable/azure/group3

  • shippable/aws/group1

  • shippable/cloud/group1

组用于在多个 CI 作业之间平衡测试，以最大限度地减少测试运行时间。它们还通过保持具有相似要求的测试一起运行来提高效率。

为新测试选择组时，请使用与正在添加的类似现有测试相同的组。如果有多个组可用，请随机选择一个。

设置

别名可用于在运行测试之前执行设置目标

  • setup/once/TARGET - 在第一个需要它的目标之前运行目标 TARGET。

  • setup/always/TARGET - 在每个需要它的目标之前运行目标 TARGET。

要求

别名可用于表达一些测试要求

  • needs/privileged - 使用 --docker 运行测试时需要 --docker-privileged。

  • needs/root - 需要以 root 或使用 --docker 运行测试。

  • needs/ssh - 需要与 localhost 的 SSH 连接（或使用 --docker 的测试容器），而无需密码。

  • needs/httptester - 需要使用 http-test-container 来运行测试。

依赖关系

一些测试依赖关系会自动发现

  • 在 meta/main.yml 文件中定义的 Ansible 角色依赖关系。

  • 使用 setup/* 别名定义设置目标。

  • 从一个目标到另一个目标中的文件的符号链接。

别名可用于声明未自动处理的依赖关系

  • needs/target/TARGET - 需要使用测试目标 TARGET。

  • needs/file/PATH - 需要使用相对于 Git 根目录的文件 PATH。

跳过

可以使用以下方法之一的别名来跳过平台

  • skip/freebsd - 跳过 FreeBSD 上的测试。

  • skip/macos - 跳过 macOS 上的测试。

  • skip/rhel - 跳过 RHEL 上的测试。

  • skip/docker - 在 Docker 容器中运行时跳过测试。

还可以跳过平台版本，如使用 --remote 选项指定并删除了 /

  • skip/freebsd11.1 - 跳过 FreeBSD 11.1 上的测试。

  • skip/rhel7.6 - 跳过 RHEL 7.6 上的测试。

还可以跳过 Windows 版本，如使用 --windows 选项指定

  • skip/windows/2016 - 跳过 Windows Server 2016 上的测试。

  • skip/windows/2019 - 跳过 Windows Server 2019 上的测试。

  • skip/windows/2022 - 跳过 Windows Server 2022 上的测试。

可以使用以下方法之一的别名来跳过 Python 主要版本

  • skip/python2 - 跳过 Python 2.x 上的测试。

  • skip/python3 - 跳过 Python 3.x 上的测试。

对于更精细的跳过，请在集成测试 playbook 中使用条件，例如

when: ansible_distribution in ('Ubuntu')

其他

还有其他几个可用的别名

  • destructive - 需要 --allow-destructive 才能在没有 --docker 或 --remote 的情况下运行。

  • hidden - 目标被忽略。可用作依赖项。对于以 setup_ 和 prepare_ 为前缀的目标自动执行。

  • retry/never - 目标被排除在 --retry-on-error 选项启用的重试之外。

  • gather_facts/yes - 启用在运行目标之前收集事实（默认选项）。

  • gather_facts/no - 禁用在运行目标之前收集事实。

不稳定

有时会失败的测试应标记为 unstable 别名，直到不稳定性得到修复。这些测试将继续为修改测试或被测模块的拉取请求运行。

这避免了其他拉取请求以及合并运行和夜间 CI 作业中不必要的测试失败。

有两种手动运行不稳定测试的方法

  • 对 ansible-test 使用 --allow-unstable 选项

  • 将其传递给 ansible-test 时，在测试名称前加上 unstable/。

测试将由 Ansible Core 团队的成员标记为不稳定。将创建 GitHub 问题来跟踪每个不稳定的测试。

禁用

始终失败的测试应标记为 disabled 别名，直到它们可以被修复。

禁用的测试会自动跳过。

有两种手动运行禁用测试的方法

  • 对 ansible-test 使用 --allow-disabled 选项

  • 将其传递给 ansible-test 时，在测试名称前加上 disabled/。

测试将由 Ansible Core 团队的成员标记为禁用。将创建 GitHub 问题来跟踪每个禁用的测试。

不支持

无法在 CI 中运行的测试应标记为 unsupported 别名。大多数测试可以通过使用模拟器和/或云插件来支持。

然而，如果无法做到这一点，将测试标记为不支持将阻止其在 CI 中运行。

有两种手动运行不支持的测试的方法

  • 为 ansible-test 使用 --allow-unsupported 选项

  • 在将测试名称传递给 ansible-test 时，使用 unsupported/ 作为前缀。

测试将由测试的贡献者标记为不支持。

云

针对云服务和其他需要访问外部 API 的模块的测试，通常需要在 CI 中进行特殊的测试支持。

这些需要额外的别名来指示所需的测试插件。

一些可用的别名是

  • cloud/aws

  • cloud/azure

  • cloud/cs

  • cloud/digitalocean

  • cloud/openshift

  • cloud/vcenter

未测试

每个模块和插件都应该有集成测试，即使这些测试不能在 CI 中运行。

问题

被标记为不稳定或禁用的测试将创建一个 issue 来跟踪测试的状态。每个 issue 将被分配到以下项目之一

问题

有关集成测试的问题，请通过创建带有 ansible-test、testing 和其他适当标签的主题，在 Ansible 论坛 上联系社区。