测试策略

将测试集成到 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，则对ansible命令使用--check标志将报告 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/”目录中。

并且断言模块可以非常轻松地验证各种类型的真值

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 中编写一定程度的基本应用程序验证，则它们将在每次部署时运行。

因此，部署到本地开发 VM 和暂存环境都将验证事项是否按计划进行，然后再进行生产部署。

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

- 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 文化至关重要。

如果您仍然进行大量的 QA 手动测试，您仍然应该手动做出是否部署的决定，但它仍然可以帮助您使用上一节中的滚动更新模式，并使用“script”、“stat”、“uri”和“assert”等模块合并一些基本健康检查。

结论

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

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

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

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

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

另请参阅

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