基础设施即代码 / 系统课时

用 Assert 验证自动化结果

用 Assert 验证自动化结果

Playbook 没有 failed 只说明任务执行链没有报错,并不等于交付结果可用。本课把配置文件、服务状态和健康检查转换为 ansible.builtin.assert 条件,让自动化在不满足验收标准时立即失败,并给出可定位的错误信息。

学习目标

  • 先采集事实和探测结果,再把它们写成可执行断言
  • 使用 that、fail_msg、success_msg 构造清晰的验收条件
  • 区分“任务执行成功”与“系统最终状态满足交付要求”

先采集状态,再执行断言

assert 不负责创造目标状态,它负责判断已有变量表达的条件是否成立。因此更稳妥的结构是先用 stat、service_facts、uri 等模块观察系统,再把这些结果集中交给断言。

下面的验收 Playbook 假设目标主机已经部署 myapp.service,配置文件位于 /etc/myapp/app.yml,健康检查返回 JSON {"status":"ok"}。把 Inventory 中的主机和 health_url 改成实际环境即可使用。

yaml
# verify.yml
- name: Verify myapp delivery
  hosts: app
  gather_facts: false
  vars:
    config_path: /etc/myapp/app.yml
    expected_mode: "0640"
    health_url: http://127.0.0.1:8080/health

  tasks:
    - name: Inspect application config
      ansible.builtin.stat:
        path: "{{ config_path }}"
      register: config_file

    - name: Collect service facts
      ansible.builtin.service_facts:

    - name: Probe application health
      ansible.builtin.uri:
        url: "{{ health_url }}"
        method: GET
        return_content: true
        timeout: 3
      register: health
      changed_when: false
      failed_when: false

    - name: Assert delivery result
      ansible.builtin.assert:
        that:
          - 'config_file.stat.exists | default(false)'
          - 'config_file.stat.mode | default("") == expected_mode'
          - 'ansible_facts.services.get("myapp.service", {}).get("state", "") == "running"'
          - 'health.status | default(-1) == 200'
          - '(health.json | default({})).get("status", "") == "ok"'
        fail_msg: "myapp acceptance check failed; inspect config, service state, and health endpoint"
        success_msg: "configuration, service, and health checks all passed"
        quiet: true

这里的条件直接写表达式,不需要再包一层 {{ }}。default 和字典 get 用来避免“服务不存在”或“健康接口没有 JSON”时因取值本身报错,从而让最终失败统一落到可读的断言信息上。

运行验收 Playbook

准备一个包含 app 主机组的 Inventory 后执行:

bash
ansible-playbook -i inventory.ini verify.yml

当配置权限、服务状态和健康接口都满足条件时,断言任务会成功。典型输出如下,主机名和任务耗时会因环境而不同:

text
TASK [Assert delivery result] ****************************************
ok: [app1] => {
    "changed": false,
    "msg": "configuration, service, and health checks all passed"
}

PLAY RECAP ***********************************************************
app1 : ok=4 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

若任一条件为假,该任务会进入 failed,并显示 fail_msg。这比“部署命令返回 0 就算成功”更接近真正的交付验收。

让断言覆盖交付边界

验收条件应检查可观察的最终状态,而不是重复证明前面的任务执行过。配置类条件适合检查文件是否存在、权限是否正确、关键值是否生效;服务类条件适合检查进程或服务是否处于期望状态;业务类条件适合检查健康接口、依赖连通性或关键查询结果。

断言也可以放在变更前充当前置条件,例如要求磁盘空间、变量范围或目标版本满足升级门槛。这样不满足条件时会在修改系统前停止,而不是执行到一半再失败。

避免脆弱和失真的断言

不要依赖整段命令输出的固定文本做字符串全等比较,因为版本、语言环境和空白变化都可能造成误报。能使用模块返回的结构化字段时,应优先判断布尔值、状态码、模式位和解析后的 JSON 字段。

也不要在关键断言上使用 ignore_errors: true,否则验收失败可能被流水线当成成功继续推进。真正需要“收集全部失败再统一报告”时,应显式设计错误聚合逻辑,而不是让断言失去阻断作用。

当自动化同时具备“重复执行后不产生无意义变更”和“最终状态通过机器断言”两层检查时,Playbook 才从能运行提升为可持续验证、可交付的自动化。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 Assert 验证自动化结果

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通