测试策略

将测试与 Ansible Playbook 集成

许多人都会问：“如何才能最好地将测试与 Ansible playbook 集成？”有很多选择。Ansible 实际上被设计成一个“快速失败”且有序的系统，因此它可以很容易地将测试直接嵌入到 Ansible playbook 中。在本章中，我们将介绍一些集成基础设施测试的模式，并讨论可能合适的测试级别。

注意

本章介绍的是测试您正在部署的应用程序，而不是介绍如何在开发过程中测试 Ansible 模块。有关该内容，请转到“开发”部分。

通过将一定程度的测试纳入您的部署工作流程，当代码进入生产环境时，将会减少意外情况，并且在许多情况下，测试可用于生产环境中，以防止失败的更新迁移到整个安装中。由于它是基于推送的，因此也很容易在本地主机或测试服务器上运行这些步骤。Ansible 允许您根据需要在升级工作流程中插入尽可能多的检查和平衡。

合适的测试级别

Ansible 资源是所需状态的模型。因此，无需测试服务是否已启动、软件包是否已安装或其他此类事情。Ansible 是确保这些事情声明性地为真的系统。相反，在您的 playbook 中断言这些事情。

tasks:
  - ansible.builtin.service:
      name: foo
      state: started
      enabled: true

如果您认为服务可能未启动，最好的办法是请求启动它。如果服务未能启动，Ansible 将会发出相应的警告。（这不要与服务是否正在执行某些功能混淆，我们稍后将详细介绍如何操作）。

将检查模式用作漂移测试

在上述设置中，Ansible 中的--check模式也可以用作一层测试。如果针对现有系统运行部署 playbook，则将--check标志用于ansible命令将报告 Ansible 是否认为它需要进行任何更改才能使系统达到所需状态。

这可以让你提前知道是否需要部署到给定的系统。通常情况下，脚本和命令不会在检查模式下运行，因此如果您希望某些步骤即使在使用--check标志时也能在普通模式下执行，例如对脚本模块的调用，请为这些任务禁用检查模式。

roles:
  - webserver

tasks:
  - ansible.builtin.script: verify.sh
    check_mode: false

用于测试的有用模块

某些 playbook 模块特别适合于测试。下面是一个确保端口打开的示例。

tasks:

  - ansible.builtin.wait_for:
      host: "{{ inventory_hostname }}"
      port: 22
    delegate_to: localhost

这是一个使用 URI 模块确保 Web 服务返回的示例。

tasks:

  - action: uri url=https://www.example.com return_content=yes
    register: webpage

  - fail:
      msg: 'service is not happy'
    when: "'AWESOME' not in webpage.content"

很容易将任意脚本（使用任何语言）推送到远程主机上，如果脚本的返回值非零，则脚本将自动失败。

tasks:

  - ansible.builtin.script: test_script1
  - ansible.builtin.script: test_script2 --parameter value --parameter2 value

如果使用角色（您应该使用，角色很棒！），则脚本模块推送的脚本可以位于角色的“files/”目录中。

assert 模块使验证各种类型的真值变得非常容易。

tasks:

   - ansible.builtin.shell: /usr/bin/some-command --parameter value
     register: cmd_result

   - ansible.builtin.assert:
       that:
         - "'not ready' not in cmd_result.stderr"
         - "'gizmo enabled' in cmd_result.stdout"

如果您需要测试 Ansible 配置未声明性设置的文件是否存在，“stat”模块是一个不错的选择。

tasks:

   - ansible.builtin.stat:
       path: /path/to/something
     register: p

   - ansible.builtin.assert:
       that:
         - p.stat.exists and p.stat.isdir

如上所述，无需检查命令的返回值。Ansible 正在自动检查它们。与其检查用户是否存在，不如考虑使用 user 模块使其存在。

Ansible 是一个快速失败的系统，因此当创建该用户时发生错误时，它将停止 playbook 运行。您无需在其后进行检查。

测试生命周期

如果将一定程度的应用程序基本验证写入您的 playbook，则它们将在每次部署时运行。

因此，部署到本地开发虚拟机和暂存环境都将验证部署前的计划是否按计划进行。

您的工作流程可能如下所示：

- Use the same playbook all the time with embedded tests in development
- Use the playbook to deploy to a staging environment (with the same playbooks) that simulates production
- Run an integration test battery written by your QA team against staging
- Deploy to production, with the same integrated tests.

如果您是生产 Web 服务，则您的 QA 团队应该编写类似集成测试电池的内容。这将包括 Selenium 测试或自动化 API 测试等内容，通常不会嵌入到您的 Ansible playbook 中。

但是，将一些基本的运行状况检查包含到您的 playbook 中是有意义的，在某些情况下，可能可以针对远程节点运行 QA 测试电池的一个子集。这就是下一节介绍的内容。

将测试与滚动更新集成

如果您已阅读控制任务运行位置：委托和本地操作，您可能会很快发现滚动更新模式可以扩展，并且您可以使用 playbook 运行的成功或失败来决定是否将机器添加到负载均衡器中。

这是嵌入式测试的巨大成果。

---

- hosts: webservers
  serial: 5

  pre_tasks:

    - name: take out of load balancer pool
      ansible.builtin.command: /usr/bin/take_out_of_pool {{ inventory_hostname }}
      delegate_to: 127.0.0.1

  tasks:

    - ansible.builtin.include_role:
        name: "{{ item }}"
      loop:
        - common
        - webserver

    - name: run any notified handlers
      ansible.builtin.meta: flush_handlers

    - name: test the configuration
      ansible.builtin.include_role:
        name: apply_testing_checks

  post_tasks:

    - name: add back to load balancer pool
      ansible.builtin.command: /usr/bin/add_back_to_pool {{ inventory_hostname }}
      delegate_to: 127.0.0.1

当然，在上述情况下，“从池中取出”和“添加回来”步骤将替换为对 Ansible 负载均衡器模块或相应的 shell 命令的调用。您可能还有一些步骤使用监控模块来启动和结束机器的停机窗口。

但是，您可以从上面看到测试用作一个门槛——如果未执行“apply_testing_checks”步骤，则机器将不会返回池中。

阅读有关“max_fail_percentage”的委托章节，您还可以控制多少次失败的测试会阻止滚动更新继续进行。

上述方法也可以修改为从测试机器远程运行步骤到机器。

---

- hosts: webservers
  serial: 5

  pre_tasks:

    - name: take out of load balancer pool
      ansible.builtin.command: /usr/bin/take_out_of_pool {{ inventory_hostname }}
      delegate_to: 127.0.0.1

  roles:

     - common
     - webserver

  tasks:
     - ansible.builtin.script: /srv/qa_team/app_testing_script.sh --server {{ inventory_hostname }}
       delegate_to: testing_server

  post_tasks:

    - name: add back to load balancer pool
      ansible.builtin.command: /usr/bin/add_back_to_pool {{ inventory_hostname }}
      delegate_to: 127.0.0.1

在上面的示例中，在将脚本放回池之前，从测试服务器对远程节点运行一个脚本。

如果出现问题，请使用 Ansible 自动生成的重试文件修复少数失败的服务器，以便仅对这些服务器重复部署。

实现持续部署

如果需要，可以扩展上述技术以实现持续部署实践。

工作流程可能如下所示：

- Write and use automation to deploy local development VMs
- Have a CI system like Jenkins deploy to a staging environment on every code change
- The deploy job calls testing scripts to pass/fail a build on every deploy
- If the deploy job succeeds, it runs the same deploy playbook against production inventory

一些 Ansible 用户使用上述方法每小时部署六到十二次，而不会使所有基础设施脱机。如果您希望达到这个级别，那么自动化 QA 的文化至关重要。

如果您仍在进行大量的 manual QA，您仍然应该决定是否手动部署，但这仍然有助于使用上一节中的滚动更新模式并使用“script”、“stat”、“uri”和“assert”等模块合并一些基本的运行状况检查。

结论

Ansible 认为您不需要另一个框架来验证基础设施的基本内容是否正确。这是因为 Ansible 是一个基于顺序的系统，它将在主机上出现未处理的错误时立即失败，并阻止对该主机的进一步配置。这会将错误强制到顶部，并在 Ansible 运行结束时在摘要中显示它们。

但是，由于 Ansible 被设计为一个多层编排系统，因此它可以很容易地将测试合并到 playbook 运行的末尾，可以使用松散的任务或角色。当与滚动更新一起使用时，测试步骤可以决定是否将机器放回负载均衡池中。

最后，因为 Ansible 错误会一直传播到 Ansible 程序本身的返回码，并且 Ansible 默认情况下以易于使用的基于推送的模式运行，因此如果您希望将其用作持续集成/持续交付管道的一部分来推出系统，Ansible 是一个很好的步骤，如上文所述。

重点不应放在基础设施测试上，而应放在应用测试上。因此，我们强烈建议您与您的 QA 团队一起讨论，确定每次部署开发虚拟机时需要运行哪些测试，以及他们希望在每次部署到预发布环境时运行哪些测试。显然，在开发阶段，单元测试也很重要。但是，不要对您的 playbook 进行单元测试。Ansible 以声明的方式描述资源的状态，因此您无需这样做。但是，如果您想确保某些事情，那是很好的，`stat/assert` 等模块非常适合此目的。

总而言之，测试是一项非常依赖组织和特定站点的活动。每个人都应该进行测试，但是最适合您环境的测试方法会因您部署的内容和使用它的人而异——但每个人都会受益于更强大、更可靠的部署系统。

另请参见

集合索引: 浏览现有的集合、模块和插件
使用 playbook: Playbook 简介
控制任务运行位置：委托和本地操作: 委托，适用于处理负载均衡器、云和本地执行步骤。
沟通: 有问题？需要帮助？想分享您的想法？请访问 Ansible 沟通指南