Add nxos_banner implementation module (#25695)

* Add nxos_banner implementation module

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

* nxos_banner integration test

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

* nxos_banner unit test

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

* doc update

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

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

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

test/integration/targets/nxos_banner/meta/main.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_nxos_tests

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

@@ -0,0 +1,15 @@
+---
+- 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/nxos_banner/tasks/main.yaml

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

test/integration/targets/nxos_banner/tests/cli/basic-exec.yaml

@@ -0,0 +1,45 @@
+---
+- name: setup - remove exec
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ cli }}"
+
+- name: Set exec
+  nxos_banner:
+    banner: exec
+    text: |
+      this is my exec banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ cli }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'banner exec @\nthis is my exec banner\nthat has a multiline\nstring\n@' in result.commands"
+
+- name: Set exec again (idempotent)
+  nxos_banner:
+    banner: exec
+    text: |
+      this is my exec banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"

test/integration/targets/nxos_banner/tests/cli/basic-motd.yaml

@@ -0,0 +1,46 @@
+---
+- name: setup - remove motd
+  nxos_banner:
+    banner: motd
+    state: absent
+    provider: "{{ cli }}"
+
+- name: Set motd
+  nxos_banner:
+    banner: motd
+    text: |
+      this is my motd banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ cli }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'banner motd @\nthis is my motd banner\nthat has a multiline\nstring\n@' in result.commands"
+
+- name: Set motd again (idempotent)
+  nxos_banner:
+    banner: motd
+    text: |
+      this is my motd banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"

test/integration/targets/nxos_banner/tests/cli/basic-no-exec.yaml

@@ -0,0 +1,41 @@
+---
+- name: Setup
+  nxos_banner:
+    banner: exec
+    text: |
+      Junk exec banner
+      over multiple lines
+    state: present
+    provider: "{{ cli }}"
+
+- name: remove exec
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ cli }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'no banner exec' in result.commands"
+
+- name: remove exec (idempotent)
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"

test/integration/targets/nxos_banner/tests/nxapi/basic-exec.yaml

@@ -0,0 +1,45 @@
+---
+- name: setup - remove exec
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ nxapi }}"
+
+- name: Set exec
+  nxos_banner:
+    banner: exec
+    text: |
+      this is my exec banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ nxapi }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'banner exec @\nthis is my exec banner\nthat has a multiline\nstring\n@' in result.commands"
+
+- name: Set exec again (idempotent)
+  nxos_banner:
+    banner: exec
+    text: |
+      this is my exec banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ nxapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"

test/integration/targets/nxos_banner/tests/nxapi/basic-motd.yaml

@@ -0,0 +1,46 @@
+---
+- name: setup - remove motd
+  nxos_banner:
+    banner: motd
+    state: absent
+    provider: "{{ nxapi }}"
+
+- name: Set motd
+  nxos_banner:
+    banner: motd
+    text: |
+      this is my motd banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ nxapi }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'banner motd @\nthis is my motd banner\nthat has a multiline\nstring\n@' in result.commands"
+
+- name: Set motd again (idempotent)
+  nxos_banner:
+    banner: motd
+    text: |
+      this is my motd banner
+      that has a multiline
+      string
+    state: present
+    provider: "{{ nxapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"

test/integration/targets/nxos_banner/tests/nxapi/basic-no-exec.yaml

@@ -0,0 +1,41 @@
+---
+- name: Setup
+  nxos_banner:
+    banner: exec
+    text: |
+      Junk exec banner
+      over multiple lines
+    state: present
+    provider: "{{ nxapi }}"
+
+- name: remove exec
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ nxapi }}"
+  register: result
+
+- debug:
+    msg: "{{ result }}"
+
+- assert:
+    that:
+      - "result.changed == true"
+      - "'no banner exec' in result.commands"
+
+- name: remove exec (idempotent)
+  nxos_banner:
+    banner: exec
+    state: absent
+    provider: "{{ nxapi }}"
+  register: result
+
+- assert:
+    that:
+      - "result.changed == false"
+      - "result.commands | length == 0"
+
+
+# FIXME add in tests for everything defined in docs
+# FIXME Test state:absent + test:
+# FIXME Without powers ensure "privileged mode required"