[Backport 202012] Add an ansible-playbook to collect show tech result of a specific testbed

ansible/collect_show_tech.yml

@@ -0,0 +1,63 @@
+# This Playbook run `show techsupport` on DUTs of a specific testbed and fetch the result.
+#
+# Parameters:
+#   -e testbed_name=vms1-1   - the testbed name specified in testbed.yaml file
+#   -e output_path           - output path for dumped files, default is ./output if not defined
+#
+# Example Usage:
+#   ansible-playbook collect_show_tech.yml -i lab -e testbed_name=vms1-1
+
+- hosts: sonic
+  gather_facts: no
+  tasks:
+    - name: Check variable testbed_name is defained
+      fail: msg="testbed_name is not defined"
+      when: testbed_name is not defined
+
+    - name: Collect DUTs defined in testbed
+      block:
+        - name: Set default testbed file
+          set_fact:
+            testbed_file: testbed.yaml
+          when: testbed_file is not defined
+
+        - name: Gather testbed information
+          test_facts:
+            testbed_name: "{{ testbed_name }}"
+            testbed_file: "{{ testbed_file }}"
+
+        - name: Create group for target DUTs
+          add_host:
+            name: "{{ item }}"
+            groups: target_duts
+          loop: "{{ testbed_facts['duts'] }}"
+      delegate_to: localhost
+      run_once: True
+
+- hosts: target_duts
+  gather_facts: no
+  tasks:
+    - name: Run `show techsupport` on DUT
+      shell: show techsupport --silent | tail -1
+      register: show_tech_result
+
+    - name: Parse the location of dump file
+      set_fact:
+        dump_file: "{{ show_tech_result.stdout_lines[0] }}"
+
+    - name: Set default output path
+      set_fact:
+        output_path: ./output
+      when: output_path is not defined
+
+    - name: Fetch show techsupport dump file from DUTs to localhost
+      fetch:
+        src: "{{ dump_file }}"
+        dest: "{{ output_path }}/"
+        flat: true
+
+    - name: Delete show techsupport dump file on DUTs
+      file:
+        path: "{{ dump_file }}"
+        state: absent
+      become: true

ansible/testbed-cli.sh

@@ -17,6 +17,7 @@ function usage
   echo "    $0 [options] (config-y-cable) <testbed-name> <inventory> <vault-password-file>"
   echo "    $0 [options] (create-master | destroy-master) <k8s-server-name> <vault-password-file>"
   echo "    $0 [options] restart-ptf <testbed-name> <vault-password-file>"
+  echo "    $0 [options] collect-show-tech <testbed-name> <inventory> <vault-password-file>"
   echo
   echo "Options:"
   echo "    -t <tbfile>     : testbed CSV file name (default: 'testbed.csv')"
@@ -67,6 +68,9 @@ function usage
   echo "To create Kubernetes master on a server: $0 -m k8s_ubuntu create-master 'k8s-server-name'  ~/.password"
   echo "To destroy Kubernetes master on a server: $0 -m k8s_ubuntu destroy-master 'k8s-server-name' ~/.password"
   echo "To restart ptf of specified testbed: $0 restart-ptf 'testbed-name' ~/.password"
+  echo "To collect show techsupport result of a testbed: $0 collect-show-tech 'testbed-name' 'inventory' ~/.password"
+  echo "    collect-show-tech supports specify output path for dumped files"
+  echo "        -e output_path=<user-specified-path>"
   echo
   echo "You should define your testbed in testbed CSV file"
   echo
@@ -550,6 +554,23 @@ function cleanup_vmhost
       --vault-password-file="${passwd}" -l "${server}" $@
 }
 
+function collect_show_tech
+{
+  testbed_name=$1
+  inventory=$2
+  passfile=$3
+  shift
+  shift
+  shift
+
+  echo "Collect show techsupport result on testbed '$testbed_name'"
+
+  ansible-playbook -i "$inventory" collect_show_tech.yml --vault-password-file="$passfile" -e testbed_name="$testbed_name" -e testbed_file=$tbfile $@
+
+  echo Done
+
+}
+
 vmfile=veos
 tbfile=testbed.csv
 vm_type=veos
@@ -635,6 +656,8 @@ case "${subcmd}" in
                ;;
   restart-ptf) restart_ptf $@
                ;;
+  collect-show-tech) collect_show_tech $@
+               ;;
   *)           usage
                ;;
 esac