Migrate Network Tests into ansible/ansible (#18233)

* Docs Networking tests

* Copy networking tests from test-network-modules

* Networking transport settings - group_vars

* Network playbooks

* Debug should be off by default

* Update nxos.yaml

* Remove items from top level

* Use dependencies, not pre-tasks

* Remove trailing blank lines

* Remove backup files

* newlines

test/integration/targets/eos_config/tests/eapi/backup.yaml

@@ -0,0 +1,50 @@
+---
+- debug: msg="START eapi/backup.yaml"
+
+- name: setup
+  eos_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Ethernet5
+    match: none
+    provider: "{{ eapi }}"
+
+- name: collect any backup files
+  find:
+    paths: "{{ role_path }}/backup"
+    pattern: "{{ inventory_hostname }}_config*"
+  register: backup_files
+  delegate_to: localhost
+
+- name: delete backup files
+  file:
+    path: "{{ item.path }}"
+    state: absent
+  with_items: "{{backup_files.files|default([])}}"
+
+- name: configure device with config
+  eos_config:
+    src: basic/config.j2
+    backup: yes
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "result.updates is not defined"
+
+- name: collect any backup files
+  find:
+    paths: "{{ role_path }}/backup"
+    pattern: "{{ inventory_hostname }}_config*"
+  register: backup_files
+  delegate_to: localhost
+
+- assert:
+    that:
+      - "backup_files.files is defined"
+
+- debug: msg="END eapi/backup.yaml"

test/integration/targets/eos_config/tests/eapi/defaults.yaml

@@ -0,0 +1,42 @@
+---
+- debug: msg="START eapi/defaults.yaml"
+
+- name: setup
+  eos_config:
+    commands:
+      - no description
+      - shutdown
+    parents:
+      - interface Ethernet5
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure device with defaults included
+  eos_config:
+    src: defaults/config.j2
+    defaults: yes
+    provider: "{{ eapi }}"
+  register: result
+
+- debug: var=result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "result.updates is not defined"
+
+- name: check device with defaults included
+  eos_config:
+    src: defaults/config.j2
+    defaults: yes
+    provider: "{{ eapi }}"
+  register: result
+
+- debug: var=result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.updates is not defined"
+
+- debug: msg="END eapi/defaults.yaml"

test/integration/targets/eos_config/tests/eapi/save.yaml

@@ -0,0 +1,35 @@
+---
+- debug: msg="START eapi/save.yaml"
+
+- name: setup
+  eos_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Ethernet5
+    match: none
+    provider: "{{ eapi }}"
+
+
+- name: save config
+  eos_config:
+    save: true
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+
+- name: save should always run
+  eos_config:
+    save: true
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+
+- debug: msg="END eapi/save.yaml"

test/integration/targets/eos_config/tests/eapi/src_basic.yaml

@@ -0,0 +1,38 @@
+---
+- debug: msg="START eapi/src_basic.yaml"
+
+- name: setup
+  eos_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Ethernet5
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure device with config
+  eos_config:
+    src: basic/config.j2
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+# https://github.com/ansible/ansible-modules-core/issues/4807
+      - "result.updates is not defined"
+
+- name: check device with config
+  eos_config:
+    src: basic/config.j2
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+# https://github.com/ansible/ansible-modules-core/issues/4807
+      - "result.updates is not defined"
+
+- debug: msg="END eapi/src_basic.yaml"

test/integration/targets/eos_config/tests/eapi/src_invalid.yaml

@@ -0,0 +1,19 @@
+---
+- debug: msg="START eapi/src_invalid.yaml"
+
+
+# Defend https://github.com/ansible/ansible-modules-core/issues/4797
+- name: configure with invalid src
+  eos_config:
+    src: basic/foobar.j2
+    provider: "{{ eapi }}"
+  register: result
+  ignore_errors: yes
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.failed == true"
+      - "result.msg == 'path specified in src not found'"
+
+- debug: msg="END eapi/src_invalid.yaml"

test/integration/targets/eos_config/tests/eapi/src_match_none.yaml

@@ -0,0 +1,41 @@
+---
+- debug: msg="START eapi/src_match_none.yaml"
+
+- name: setup
+  eos_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Ethernet5
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure device with config
+  eos_config:
+    src: basic/config.j2
+    provider: "{{ eapi }}"
+    match: none
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+# https://github.com/ansible/ansible-modules-core/issues/4807
+      - "result.updates is not defined"
+
+- name: check device with config
+  eos_config:
+    src: basic/config.j2
+    provider: "{{ eapi }}"
+    match: none
+  register: result
+
+- assert:
+    that:
+      # Idempotent test
+# https://github.com/ansible/ansible-modules-core/issues/4807
+      - "result.changed == false"
+      - "result.updates is not defined"
+
+- debug: msg="END eapi/src_match_none.yaml"

test/integration/targets/eos_config/tests/eapi/sublevel.yaml

@@ -0,0 +1,41 @@
+---
+- debug: msg="START eapi/sublevel.yaml"
+
+- name: setup
+  eos_config:
+    lines: no ip access-list test
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure sub level command
+  eos_config:
+    lines: 10 permit ip any any log
+    parents: ip access-list test
+    after: exit
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'ip access-list test' in result.updates"
+      - "'10 permit ip any any log' in result.updates"
+
+- name: configure sub level command idempotent check
+  eos_config:
+    lines: 10 permit ip any any log
+    parents: ip access-list test
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines: no ip access-list test
+    match: none
+    provider: "{{ cli }}"
+
+- debug: msg="END eapi/sublevel.yaml"

test/integration/targets/eos_config/tests/eapi/sublevel_block.yaml

@@ -0,0 +1,59 @@
+---
+- debug: msg="START eapi/sublevel_block.yaml"
+
+- name: setup
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+    parents: ip access-list test
+    before: no ip access-list test
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure sub level command using block resplace
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+    parents: ip access-list test
+    after: end
+    replace: block
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'ip access-list test' in result.updates"
+      - "'10 permit ip host 1.1.1.1 any log' in result.updates"
+      - "'20 permit ip host 2.2.2.2 any log' in result.updates"
+      - "'30 permit ip host 3.3.3.3 any log' in result.updates"
+      - "'40 permit ip host 4.4.4.4 any log' in result.updates"
+
+- name: check sub level command using block replace
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+    parents: ip access-list test
+    replace: block
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines: no ip access-list test
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/sublevel_block.yaml"

test/integration/targets/eos_config/tests/eapi/sublevel_exact.yaml

@@ -0,0 +1,65 @@
+---
+- debug: msg="START eapi/sublevel_exact.yaml"
+
+- name: setup
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+      - 50 permit ip host 5.5.5.5 any log
+    parents: ip access-list test
+    before: no ip access-list test
+    after: exit
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure sub level command using exact match
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+    before: no ip access-list test
+    parents: ip access-list test
+    after: exit
+    match: exact
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'ip access-list test' in result.updates"
+      - "'10 permit ip host 1.1.1.1 any log' in result.updates"
+      - "'20 permit ip host 2.2.2.2 any log' in result.updates"
+      - "'30 permit ip host 3.3.3.3 any log' in result.updates"
+      - "'40 permit ip host 4.4.4.4 any log' in result.updates"
+      - "'50 permit ip host 5.5.5.5 any log' not in result.updates"
+
+- name: check sub level command using exact match
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+    before: no ip access-list test
+    parents: ip access-list test
+    match: exact
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines: no ip access-list test
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/sublevel_exact.yaml"

test/integration/targets/eos_config/tests/eapi/sublevel_strict.yaml

@@ -0,0 +1,64 @@
+---
+- debug: msg="START eapi/sublevel_strict.yaml"
+
+- name: setup
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+      - 50 permit ip host 5.5.5.5 any log
+    parents: ip access-list test
+    before: no ip access-list test
+    provider: "{{ eapi }}"
+    match: none
+
+- name: configure sub level command using strict match
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 3.3.3.3 any log
+      - 30 permit ip host 2.2.2.2 any log
+      - 40 permit ip host 4.4.4.4 any log
+    parents: ip access-list test
+    before: no ip access-list test
+    after: exit
+    match: strict
+    replace: block
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'ip access-list test' in result.updates"
+      - "'10 permit ip host 1.1.1.1 any log' in result.updates"
+      - "'30 permit ip host 2.2.2.2 any log' in result.updates"
+      - "'20 permit ip host 3.3.3.3 any log' in result.updates"
+      - "'40 permit ip host 4.4.4.4 any log' in result.updates"
+      - "'50 permit ip host 5.5.5.5 any log' not in result.updates"
+
+- name: check sub level command using strict match
+  eos_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 3.3.3.3 any log
+      - 30 permit ip host 2.2.2.2 any log
+      - 40 permit ip host 4.4.4.4 any log
+    parents: ip access-list test
+    match: strict
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines: no ip access-list test
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/sublevel_strict.yaml"

test/integration/targets/eos_config/tests/eapi/toplevel.yaml

@@ -0,0 +1,37 @@
+---
+- debug: msg="START eapi/toplevel.yaml"
+
+- name: setup
+  eos_config:
+    lines: hostname {{ inventory_hostname }}
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure top level command
+  eos_config:
+    lines: hostname foo
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+
+- name: configure top level command idempotent check
+  eos_config:
+    lines: hostname foo
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines: hostname {{ inventory_hostname }}
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/toplevel.yaml"

test/integration/targets/eos_config/tests/eapi/toplevel_after.yaml

@@ -0,0 +1,44 @@
+---
+- debug: msg="START eapi/toplevel_after.yaml"
+
+- name: setup
+  eos_config:
+    lines:
+      - "snmp-server contact ansible"
+      - "hostname {{ inventory_hostname }}"
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure top level command with before
+  eos_config:
+    lines: hostname foo
+    after: snmp-server contact bar
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+      - "'snmp-server contact bar' in result.updates"
+
+- name: configure top level command with before idempotent check
+  eos_config:
+    lines: hostname foo
+    after: snmp-server contact foo
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines:
+      - no snmp-server contact
+      - hostname {{ inventory_hostname }}
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/toplevel_after.yaml"

test/integration/targets/eos_config/tests/eapi/toplevel_before.yaml

@@ -0,0 +1,44 @@
+---
+- debug: msg="START eapi/toplevel_before.yaml"
+
+- name: setup
+  eos_config:
+    lines:
+      - "snmp-server contact ansible"
+      - "hostname {{ inventory_hostname }}"
+    match: none
+    provider: "{{ eapi }}"
+
+- name: configure top level command with before
+  eos_config:
+    lines: hostname foo
+    before: snmp-server contact bar
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+      - "'snmp-server contact bar' in result.updates"
+
+- name: configure top level command with before idempotent check
+  eos_config:
+    lines: hostname foo
+    before: snmp-server contact foo
+    provider: "{{ eapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  eos_config:
+    lines:
+      - no snmp-server contact ansible
+      - hostname {{ inventory_hostname }}
+    match: none
+    provider: "{{ eapi }}"
+
+- debug: msg="END eapi/toplevel_before.yaml"