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/iosxr_config/defaults/main.yaml

@@ -0,0 +1,3 @@
+---
+testcase: "*"
+test_items: []

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

@@ -0,0 +1,17 @@
+---
+- name: collect all cli test cases
+  find:
+    paths: "{{ role_path }}/tests/cli"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+
+- 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/iosxr_config/tasks/main.yaml

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

test/integration/targets/iosxr_config/templates/basic/config.j2

@@ -0,0 +1,4 @@
+interface Loopback999
+ description this is a test
+ shutdown
+

test/integration/targets/iosxr_config/templates/defaults/config.j2

@@ -0,0 +1,4 @@
+interface Loopback999
+ description this is a test
+ no shutdown
+

test/integration/targets/iosxr_config/tests/cli/backup.yaml

@@ -0,0 +1,50 @@
+---
+- debug: msg="START cli/backup.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Loopback999
+    match: none
+    provider: "{{ cli }}"
+
+- 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
+  iosxr_config:
+    src: basic/config.j2
+    backup: yes
+    provider: "{{ cli }}"
+  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 cli/backup.yaml"

test/integration/targets/iosxr_config/tests/cli/comment-too-long.yaml

@@ -0,0 +1,32 @@
+---
+- debug: msg="START cli/comment-too-long.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Loopback999
+    match: none
+    provider: "{{ cli }}"
+
+# Defend against https://github.com/ansible/ansible-modules-core/issues/5146
+- name: Commit message too long
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+    comment: "this is a really long message  aaaaabbbbbbcdde end-of-message"
+  register: result
+  ignore_errors: true
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.updates is not defined"
+# Defend https://github.com/ansible/ansible-modules-core/issues/5146
+      - "'comment argument cannot be more than 60 characters' in result.msg"
+# Check for the correct error message (and not a generic "Invalid input detected") once fixed
+
+
+- debug: msg="END cli/comment-too-long.yaml"

test/integration/targets/iosxr_config/tests/cli/comment.yaml

@@ -0,0 +1,37 @@
+---
+- debug: msg="START cli/comment.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Loopback999
+    match: none
+    provider: "{{ cli }}"
+
+- name: configure device with comment
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+    comment: "this is sensible commit message"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "result.updates is not defined"
+
+- name: check device with config
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.updates is not defined"
+
+- debug: msg="END cli/comment.yaml"

test/integration/targets/iosxr_config/tests/cli/src_basic.yaml

@@ -0,0 +1,38 @@
+---
+- debug: msg="START cli/src_basic.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Loopback999
+    match: none
+    provider: "{{ cli }}"
+
+- name: configure device with config
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+  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
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+# https://github.com/ansible/ansible-modules-core/issues/4807
+      - "result.updates is not defined"
+
+- debug: msg="END cli/src_basic.yaml"

test/integration/targets/iosxr_config/tests/cli/src_invalid.yaml

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

test/integration/targets/iosxr_config/tests/cli/src_match_none.yaml

@@ -0,0 +1,40 @@
+---
+- debug: msg="START cli/src_match_none.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - no description
+      - no shutdown
+    parents:
+      - interface Loopback999
+    match: none
+    provider: "{{ cli }}"
+
+- name: configure device with config
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+    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
+  iosxr_config:
+    src: basic/config.j2
+    provider: "{{ cli }}"
+  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 cli/src_match_none.yaml"

test/integration/targets/iosxr_config/tests/cli/sublevel.yaml

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

test/integration/targets/iosxr_config/tests/cli/sublevel_block.yaml

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

test/integration/targets/iosxr_config/tests/cli/sublevel_exact.yaml

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

test/integration/targets/iosxr_config/tests/cli/sublevel_strict.yaml

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

test/integration/targets/iosxr_config/tests/cli/toplevel.yaml

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

test/integration/targets/iosxr_config/tests/cli/toplevel_after.yaml

@@ -0,0 +1,44 @@
+---
+- debug: msg="START cli/toplevel_after.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - "no cdp"
+      - "hostname {{ inventory_hostname }}"
+    provider: "{{ cli }}"
+    match: none
+
+- name: configure top level command with before
+  iosxr_config:
+    commands: ['hostname foo']
+    after: ['cdp']
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+      - "'cdp' in result.updates"
+
+- name: configure top level command with before idempotent check
+  iosxr_config:
+    commands: ['hostname foo']
+    after: ['no cdp']
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  iosxr_config:
+    commands:
+      - "no cdp"
+      - "hostname {{ inventory_hostname }}"
+    provider: "{{ cli }}"
+    match: none
+
+- debug: msg="END cli/toplevel_after.yaml"

test/integration/targets/iosxr_config/tests/cli/toplevel_before.yaml

@@ -0,0 +1,44 @@
+---
+- debug: msg="START cli/toplevel_before.yaml"
+
+- name: setup
+  iosxr_config:
+    commands:
+      - "no cdp"
+      - "hostname {{ inventory_hostname }}"
+    provider: "{{ cli }}"
+    match: none
+
+- name: configure top level command with before
+  iosxr_config:
+    commands: ['hostname foo']
+    before: ['cdp']
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+      - "'cdp' in result.updates"
+
+- name: configure top level command with before idempotent check
+  iosxr_config:
+    commands: ['hostname foo']
+    before: ['cdp']
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+
+- name: teardown
+  iosxr_config:
+    commands:
+      - "no cdp"
+      - "hostname {{ inventory_hostname }}"
+    provider: "{{ cli }}"
+    match: none
+
+- debug: msg="END cli/toplevel_before.yaml"

test/integration/targets/iosxr_config/tests/cli/toplevel_nonidempotent.yaml

@@ -0,0 +1,39 @@
+---
+- debug: msg="START cli/toplevel_nonidempotent.yaml"
+
+- name: setup
+  iosxr_config:
+    commands: ['hostname {{ inventory_hostname }}']
+    provider: "{{ cli }}"
+    match: none
+
+- name: configure top level command
+  iosxr_config:
+    commands: ['hostname foo']
+    provider: "{{ cli }}"
+    match: strict
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'hostname foo' in result.updates"
+
+- name: configure top level command idempotent check
+  iosxr_config:
+    commands: ['hostname foo']
+    provider: "{{ cli }}"
+    match: strict
+  register: result
+
+- assert:
+    that:
+      - "result.changed == true"
+
+- name: teardown
+  iosxr_config:
+    commands: ['hostname {{ inventory_hostname }}']
+    provider: "{{ cli }}"
+    match: none
+
+- debug: msg="END cli/toplevel_nonidempotent.yaml"