Fix nxos_snmp_community idempotence issue (#30388)

* Fix nxos_snmp_community idempotence issue

* Use passed in name to filter

* Test updates and remove unused method

lib/ansible/modules/network/nxos/nxos_snmp_community.py

@@ -79,31 +79,24 @@ commands:
     sample: ["snmp-server community TESTING7 group network-operator"]
 '''
 
-
+import re
 from ansible.module_utils.nxos import load_config, run_commands
 from ansible.module_utils.nxos import nxos_argument_spec, check_args
 from ansible.module_utils.basic import AnsibleModule
 
 
 def execute_show_command(command, module):
-    command = {
+    if 'show run' not in command:
+        output = 'json'
+    else:
+        output = 'text'
+    cmds = [{
         'command': command,
-        'output': 'json',
-    }
+        'output': output,
+    }]
 
-    return run_commands(module, command)
-
-
-def apply_key_map(key_map, table):
-    new_dict = {}
-    for key, value in table.items():
-        new_key = key_map.get(key)
-        if new_key:
-            if value:
-                new_dict[new_key] = str(value)
-            else:
-                new_dict[new_key] = value
-    return new_dict
+    body = run_commands(module, cmds)
+    return body
 
 
 def flatten_list(command_lists):
@@ -130,38 +123,34 @@ def get_snmp_groups(module):
     return group_list
 
 
-def get_snmp_community(module, find_filter=None):
-    data = execute_show_command('show snmp community', module)[0]
-
+def get_snmp_community(module, name):
+    command = 'show run snmp all | grep {0}'.format(name)
+    data = execute_show_command(command, module)[0]
     community_dict = {}
 
-    community_map = {
-        'grouporaccess': 'group',
-        'aclfilter': 'acl'
-    }
-
-    try:
-        community_table = data['TABLE_snmp_community']['ROW_snmp_community']
-        for each in community_table:
-            community = apply_key_map(community_map, each)
-            key = each['community_name']
-            community_dict[key] = community
-    except (KeyError, AttributeError, TypeError):
+    if not data:
         return community_dict
 
-    if find_filter:
-        find = community_dict.get(find_filter, None)
-
-    if find_filter is None or find is None:
-        return {}
+    community_re = r'snmp-server community (\S+)'
+    mo = re.search(community_re, data)
+    if mo:
+        community_name = mo.group(1)
     else:
-        fix_find = {}
-        for (key, value) in find.items():
-            if isinstance(value, str):
-                fix_find[key] = value.strip()
-            else:
-                fix_find[key] = value
-        return fix_find
+        return community_dict
+
+    community_dict['group'] = None
+    group_re = r'snmp-server community {0} group (\S+)'.format(community_name)
+    mo = re.search(group_re, data)
+    if mo:
+        community_dict['group'] = mo.group(1)
+
+    community_dict['acl'] = None
+    acl_re = r'snmp-server community {0} use-acl (\S+)'.format(community_name)
+    mo = re.search(acl_re, data)
+    if mo:
+        community_dict['acl'] = mo.group(1)
+
+    return community_dict
 
 
 def config_snmp_community(delta, community):

test/integration/nxos.yaml

@@ -360,6 +360,12 @@
       rescue:
         - set_fact: test_failed=true
 
+    - block:
+      - include_role:
+          name: nxos_snmp_community
+        when: "limit_to in ['*', 'nxos_snmp_community']"
+      rescue:
+        - set_fact: test_failed=true
 ###########
     - debug: var=failed_modules
       when: test_failed

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

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

test/integration/targets/nxos_snmp_community/meta/main.yml

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

test/integration/targets/nxos_snmp_community/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_snmp_community/tasks/main.yaml

@@ -0,0 +1,7 @@
+---
+# Use block to ensure that both cli and nxapi tests
+# will run even if there are failures or errors.
+- block:
+  - { include: cli.yaml, tags: ['cli'] }
+  always:
+  - { include: nxapi.yaml, tags: ['nxapi'] }

test/integration/targets/nxos_snmp_community/tasks/nxapi.yaml

@@ -0,0 +1,28 @@
+---
+- name: collect all nxapi test cases
+  find:
+    paths: "{{ role_path }}/tests/nxapi"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+
+- name: set test_items
+  set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
+
+- name: enable nxapi
+  nxos_config:
+    lines:
+      - feature nxapi
+      - nxapi http port 80
+    provider: "{{ cli }}"
+
+- name: run test case
+  include: "{{ test_case_to_run }}"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run
+
+- name: disable nxapi
+  nxos_config:
+    lines:
+      - no feature nxapi
+    provider: "{{ cli }}"

test/integration/targets/nxos_snmp_community/tests/cli/sanity.yaml

@@ -0,0 +1,4 @@
+---
+- set_fact: connection="{{ cli }}"
+
+- import_tasks: "{{ role_path }}/tests/common/sanity.yaml"

test/integration/targets/nxos_snmp_community/tests/common/sanity.yaml

@@ -0,0 +1,96 @@
+---
+- debug: msg="START TRANSPORT:{{ connection.transport }} nxos_snmp_community sanity test"
+
+- name: Setup - Remove snmp_community if configured
+  nxos_snmp_community: &remove
+    community: TESTING7
+    group: network-operator
+    state: absent 
+    provider: "{{ connection }}"
+  ignore_errors: yes
+
+- block:
+
+  - name: Configure snmp_community group
+    nxos_snmp_community: &config
+      community: TESTING7
+      group: network-operator
+      #access: ro
+      state: present
+      provider: "{{ connection }}"
+    register: result
+
+  - assert: &true
+      that:
+        - "result.changed == true"
+
+  - name: Idempotence Check
+    nxos_snmp_community: *config
+    register: result
+
+  - assert: &false
+      that:
+        - "result.changed == false"
+
+  - name: Remove snmp_community
+    nxos_snmp_community: *remove
+    register: result
+
+  - assert: *true
+
+  - name: Idempotence Check
+    nxos_snmp_community: *remove
+    register: result
+
+  - assert: *false
+
+  - name: Configure snmp_community access read-only
+    nxos_snmp_community: &configaccess
+      community: TESTING7
+      access: ro
+      state: present
+      provider: "{{ connection }}"
+    register: result
+
+  - assert: *true
+
+  - name: Idempotence Check
+    nxos_snmp_community: *configaccess
+    register: result
+
+  - assert: *false
+
+  - name: Remove snmp_community
+    nxos_snmp_community: *remove
+    register: result
+
+  - assert: *true
+
+  - name: Idempotence Check
+    nxos_snmp_community: *remove
+    register: result
+
+  - assert: *false
+
+  - name: Configure snmp_community access read-write
+    nxos_snmp_community: &configaccessrw
+      community: TESTING7
+      access: rw
+      acl: ansible_acl
+      state: present
+      provider: "{{ connection }}"
+    register: result
+
+  - assert: *true
+
+  - name: Idempotence Check
+    nxos_snmp_community: *configaccessrw
+    register: result
+
+  - assert: *false
+
+  always:
+  - name: Cleanup
+    nxos_snmp_community: *remove
+
+  - debug: msg="END TRANSPORT:{{ connection.transport }} nxos_snmp_community sanity test"

test/integration/targets/nxos_snmp_community/tests/nxapi/sanity.yaml

@@ -0,0 +1,4 @@
+---
+- set_fact: connection="{{ nxapi }}"
+
+- import_tasks: "{{ role_path }}/tests/common/sanity.yaml"