Ansible—— 34. playbook 错误处理

在编写shell脚本时，有可能会有这样的需求，当脚本执行到某个阶段时，需要对某个条件进行判断，如果条件成立，则立即终止脚本的运行，在 shell脚本中实现这个需求很简单，只需要在条件成立时调用"exit"命令即可终止脚本的运行。
在执行playbook时，如果playbook中的任何一个任务执行失败，playbook都会停止运行，除非这个任务设置 了"ignore_errors: true"，在任务没有设置"ignore_errors: yes"的情况下，任务执行失败后，playbook就会自动终止，而fail模块天生就是一个用来"执行失败"的模块，当fail模块执行 后，playbook就会认为有任务失败了，从而终止运行。

---
- hosts: test70
  remote_user: root
  tasks:
  - debug:
      msg: "1"
  - debug:
      msg: "2"
  - fail:
  - debug:
      msg: "3"
  - debug:
      msg: "4"

当执行fail模块时，fail模块默认的输出信息为’Failed as requested from task’，我们可以通过fail模块的msg参数自定义报错的信息。

---
- hosts: test70
  remote_user: root
  tasks:
  - debug:
      msg: "1"
  - fail:
      msg: "Interrupt running playbook"
  - debug:
      msg: "2"

通常并不会毫无理由的想要去中断playbook，通常需要对某些条件进行判断， 如果条件满足，则中断剧本，所以，fail模块通常与when结合使用，比如，如果之前模块执行后的标准输出信息中包含字符串’error’，则认为中断 剧本的条件成立，就立即调用fail模块，以终断playbook。

使用shell模块故意输出了一个包含’error’字符串的文本，并且将shell模块执行后的返回值注册到了变量’ return_value’中，在之后调用了fail模块，并对fail模块添加了判断条件，对应的条件为 “‘error’ in return_value.stdout”，这个条件表示shell模块执行后的标注输出信息中如果包含’error’字符串，则条件成立，其 中，'in’关键字的用法与python中’in’的用法相同，可以使用’in’关键字判断一个字符串是否存在于另一个字符串中，也可以用于判断一个特定 的值是否存在于列表中，由于shell标准输出的信息中的确包含error字符串，所以fail模块对应的条件成立，最终调用fail模 块，playbook终止运行。不过需要注意的是，当使用"in"或者"not in"进行条件判断时，整个条件需要用引号引起，并且，需要判断的字符串也需要使用引号引起。

---
- hosts: test70
  remote_user: root
  tasks:
  - shell: "echo 'This is a string for testing--error'"
    register: return_value
  - fail:
      msg: "Conditions established,Interrupt running playbook"
    when: "'error' in return_value.stdout"
  - debug:
      msg: "I never execute,Because the playbook has stopped"

使用’in’或者’not in’进行条件判断时，如下两种语法是正确的：

when: ' "successful" not in return_value.stdout '
when: " 'successful' not in return_value.stdout "

‘failed_when’的作用就是，当对应的条件成立时，将对应任务的执行状态设置为失败。一共有三个任务，第一个任务通过debug模块输出 “I execute normally”，第二个任务调用shell模块，echo了’This is a string for testing error’这句话，并且将返回值注册到了’return_value’变量中，’ failed_when’关键字与shell关键字对齐，表示其对应的条件是针对shell模块的，’ failed_when’对应的条件是 ’ “error” in return_value.stdout’，表示"error"字符串如果存在于shell模块执行后的标准输出中，则条件成立，当条件成立 后，shell模块的执行状态将会被设置为失败，由于shell模块的执行状态被设置为失败，所以playbook会终止运行，于是，最后的debug模 块并不会被执行。

---
- hosts: test70
  remote_user: root
  tasks:
  - debug:
      msg: "I execute normally"
  - shell: "echo 'This is a string for testing error'"
    register: return_value
    failed_when: ' "error" in return_value.stdout'
  - debug:
      msg: "I never execute,Because the playbook has stopped"

failed_when关键字的作用是在条件成立时，将对应任务的执行状态设置为失败。changed_when关键字的作用是在条件成立时，将对应任务的执行状态设置为changed

---
- hosts: test70
  remote_user: root
  tasks:
  - debug:
      msg: "test message"
    changed_when: 2 > 1

————Blueicex 2020/3/28 11:32 blueice1980@126.com