[ansible-plugin] back port stdout callback plugin 'yaml' from ansible2.5

[dawnbeauty]

Description of PR

With this plugin yaml, we could get pretty-printed stdout of ansible-playbook.
And don't need to put debug everywhere.

Summary:

• Adding the ability to use yaml plugin with stdout content

Signed-off-by: Zhiqian Wu [email protected]

Type of change

• [] Bug fix
• Testbed and Framework(new/improvement)
• [] Test case(new/improvement)

Approach

How did you do it?

• Back port yaml plugin from ansible 2.5
• Enable plugin through ansible.cfg

How to use ?

exec ansible-playbook with ANSIBLE_STDOUT_CALLBACK or set default stdout callback to yaml through ansible.cfg

E.g.

ANSIBLE_STDOUT_CALLBACK=yaml ansible-playbook -i lab -vvv --limit str-msn2700-01 test_sonic.yml -e "testcase_name=mem_check testbed_type=t0 testbed_name=vms-t1 ptf_host=10.250.0.178"

How did you verify/test it?

assume that we have a playbook include below tasks:

   - name: Get process information in syncd docker
     shell: docker exec -i syncd ps aux | grep /usr/bin/syncd
     register: ps_out
     ignore_errors: yes

   - debug: var=ps_out.stdout_lines

without yaml plugin, the stdout is like:

TASK [test : Get process information in syncd docker] **************************
task path: /var/root/sonic-mgmt-vrf/ansible/roles/test/tasks/base_sanity.yml:1
Friday 12 July 2019  08:11:23 +0000 (0:00:00.387)       0:00:10.390 *********** 
...
changed: [str-msn2700-01] => {"changed": true, "cmd": "docker exec -i syncd ps aux | grep /usr/bin/syncd", "delta": "0:00:00.226302", "end": "2019-07-12 08:11:23.601663", "invocation": {"module_args": {"_raw_params": "docker exec -i syncd ps aux | grep /usr/bin/syncd", "_uses_shell": true, "chdir": null, "creates": null, "executable": null, "removes": null, "warn": true}, "module_name": "command"}, "rc": 0, "start": "2019-07-12 08:11:23.375361", "stderr": "", "stdout": "root        16  0.0  0.0  41584  2712 pts/0    Sl   Jul11   0:00 /usr/bin/dsserve /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile\nroot        25 12.8  0.3 1137728 59284 pts/0   Sl   Jul11 220:24 /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile", "stdout_lines": ["root        16  0.0  0.0  41584  2712 pts/0    Sl   Jul11   0:00 /usr/bin/dsserve /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile", "root        25 12.8  0.3 1137728 59284 pts/0   Sl   Jul11 220:24 /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile"], "warnings": []}

TASK [test : debug] ************************************************************
task path: /var/root/sonic-mgmt-vrf/ansible/roles/test/tasks/base_sanity.yml:6
Friday 12 July 2019  08:11:23 +0000 (0:00:00.394)       0:00:10.785 *********** 
ok: [str-msn2700-01] => {
    "ps_out.stdout_lines": [
        "root        16  0.0  0.0  41584  2712 pts/0    Sl   Jul11   0:00 /usr/bin/dsserve /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile", 
        "root        25 12.8  0.3 1137728 59284 pts/0   Sl   Jul11 220:24 /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile"
    ]
}

with yaml plugin, the stdout is like:

TASK [test : Get process information in syncd docker] **************************
task path: /var/root/sonic-mgmt-vrf/ansible/roles/test/tasks/base_sanity.yml:1
Friday 12 July 2019  08:17:45 +0000 (0:00:00.389)       0:00:10.965 *********** 
...
changed: [str-msn2700-01] => changed=true 
  cmd: docker exec -i syncd ps aux | grep /usr/bin/syncd
  delta: '0:00:00.214221'
  end: '2019-07-12 08:17:46.200908'
  invocation:
    module_args:
      _raw_params: docker exec -i syncd ps aux | grep /usr/bin/syncd
      _uses_shell: true
      chdir: null
      creates: null
      executable: null
      removes: null
      warn: true
    module_name: command
  rc: 0
  start: '2019-07-12 08:17:45.986687'
  stderr: ''
  stdout: |-
    root        16  0.0  0.0  41584  2712 pts/0    Sl   Jul11   0:00 /usr/bin/dsserve /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile
    root        25 12.8  0.3 1137728 59284 pts/0   Sl   Jul11 221:13 /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile
  stdout_lines: <omitted>
  warnings: []

TASK [test : debug] ************************************************************
task path: /var/root/sonic-mgmt-vrf/ansible/roles/test/tasks/base_sanity.yml:6
Friday 12 July 2019  08:17:46 +0000 (0:00:00.368)       0:00:11.333 *********** 
ok: [str-msn2700-01] => 
  ps_out.stdout_lines:
  - root        16  0.0  0.0  41584  2712 pts/0    Sl   Jul11   0:00 /usr/bin/dsserve /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile
  - root        25 12.8  0.3 1137728 59284 pts/0   Sl   Jul11 221:13 /usr/bin/syncd --diag -u -p /usr/share/sonic/hwsku/sai.profile

[msftclas]

All CLA requirements met.