net_command platform agnostic module (#25249)

* net_command platform agnostic implementation

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add net_command platform agnostic module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add integration test for net_command module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* fix yaml issue

test/integration/net_command.yml

@@ -1,7 +0,0 @@
-- hosts:
-    - vyos
-    - junos
-    - ios
-  gather_facts: false
-  roles:
-    - { role: net_command, tags: net_command }

test/integration/platform_agnostic.yaml

@@ -10,3 +10,4 @@
   roles:
     - { role: net_system, when: "limit_to in ['*', 'net_system']" }
     - { role: net_banner, when: "limit_to in ['*', 'net_banner']" }
+    - { role: net_command, when: "limit_to in ['*', 'net_command']" }

test/integration/targets/net_command/aliases

@@ -0,0 +1 @@
+network/ci

test/integration/targets/net_command/defaults/main.yaml

@@ -0,0 +1,2 @@
+---
+testcase: "*"

test/integration/targets/net_command/tasks/cli.yaml

@@ -0,0 +1,16 @@
+---
+- name: collect all cli test cases
+  find:
+    paths: "{{ role_path }}/tests/cli"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+  delegate_to: localhost
+
+- name: set test_items
+  set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
+
+- name: run test case
+  include: "{{ test_case_to_run }}"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run

test/integration/targets/net_command/tasks/main.yaml

@@ -0,0 +1,2 @@
+---
+- { include: cli.yaml, tags: ['cli'] }

test/integration/targets/net_command/tests/cli/contains.yaml

@@ -0,0 +1,19 @@
+---
+- debug: msg="START cli/contains.yaml"
+
+- include: "{{ role_path }}/tests/ios/contains.yaml"
+  when: hostvars[inventory_hostname]['ansible_network_os'] == 'ios'
+
+- include: "{{ role_path }}/tests/iosxr/contains.yaml"
+  when: hostvars[inventory_hostname]['ansible_network_os'] == 'iosxr'
+
+- include: "{{ role_path }}/tests/nxos/contains.yaml"
+  when: hostvars[inventory_hostname]['ansible_network_os'] == 'nxos'
+
+- include: "{{ role_path }}/tests/eos/contains.yaml"
+  when: hostvars[inventory_hostname]['ansible_network_os'] == 'eos'
+
+- include: "{{ role_path }}/tests/vyos/contains.yaml"
+  when: hostvars[inventory_hostname]['ansible_network_os'] == 'vyos'
+
+- debug: msg="END cli/contains.yaml"

test/integration/targets/net_command/tests/eos/contains.yaml

@@ -0,0 +1,20 @@
+---
+- debug: msg="START eos/contains.yaml"
+
+- name: test contains operator
+  net_command:
+    commands:
+      - show version
+      - show interface Management1 | json
+    wait_for:
+      - "result[0] contains EOS"
+      - "result[1].interfaces.Management1.name contains Manage"
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.stdout is defined"
+
+- debug: msg="END eos/contains.yaml"

test/integration/targets/net_command/tests/ios/contains.yaml

@@ -0,0 +1,19 @@
+---
+- debug: msg="START ios/contains.yaml"
+
+- name: test contains operator
+  net_command:
+    commands:
+      - show version
+      - show interface loopback 888
+    wait_for:
+      - "result[0] contains Cisco"
+      - "result[1] contains Loopback888"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.stdout is defined"
+
+- debug: msg="END ios/contains.yaml"

test/integration/targets/net_command/tests/iosxr/contains.yaml

@@ -0,0 +1,19 @@
+---
+- debug: msg="START iosxr/contains.yaml"
+
+- name: test contains operator
+  net_command:
+    commands:
+      - show version
+      - show interfaces Loopback 888
+    wait_for:
+      - "result[0] contains 'Cisco IOS XR Software'"
+      - "result[1] contains 'Hardware is Loopback interface'"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.stdout is defined"
+
+- debug: msg="END iosxr/contains.yaml"

test/integration/targets/net_command/tests/nxos/contains.yaml

@@ -0,0 +1,19 @@
+---
+- debug: msg="START nxos/contains.yaml"
+
+- name: test contains operator
+  net_command:
+    commands:
+      - show version
+      - show interface mgmt0 | json
+    wait_for:
+      - "result[0] contains NX-OS"
+      - "result[1].TABLE_interface.ROW_interface.interface contains mgmt"
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- debug: msg="END nxos/contains.yaml"

test/integration/targets/net_command/tests/vyos/contains.yaml

@@ -0,0 +1,21 @@
+---
+- debug: msg="START vyos/contains.yaml"
+
+- name: test contains operator
+  net_command:
+    commands:
+      - show version
+      - show interface
+    wait_for:
+      - result[0] contains VyOS
+      - result[1] contains eth0
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - result.changed == false
+      - result.stdout is defined
+      - result.stdout_lines is defined
+
+- debug: msg="END vyos/contains.yaml"