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 - 需要无需密码即可连接到本地主机(或使用 --docker 的测试容器)的 SSH 连接。

  • 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 中进行特殊支持。

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

一些可用的别名是

  • 云/AWS

  • 云/Azure

  • 云/CS

  • 云/DigitalOcean

  • 云/OpenShift

  • 云/vCenter

未测试

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

问题

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

问题

有关集成测试的问题,请通过创建带有ansible-testtesting和其他相关标签的主题,在Ansible 论坛上联系社区。