T6982: update SNMP module for 1.3+ (#369)

* fix: get SNMP integration tests running
* fix: remove no_log from docs because it fails sanity
* tests: fix unit tests and no_log args
* tests: fix error in hostname integration test

11 files changed, 102 insertions, 54 deletions

diff --git a/tests/integration/targets/prepare_vyos_tests/tasks/main.yaml b/tests/integration/targets/prepare_vyos_tests/tasks/main.yaml
index 2ed8d8c..5800a58 100644
--- a/tests/integration/targets/prepare_vyos_tests/tasks/main.yaml
+++ b/tests/integration/targets/prepare_vyos_tests/tasks/main.yaml
@@ -5,7 +5,7 @@
       set interfaces ethernet eth0 address dhcp
       set interfaces ethernet eth0 speed auto
       set interfaces ethernet eth0 duplex auto
-      set interfaces ethernet eth1
+      set interfaces ethernet eth1 address 192.0.2.1/24
       set interfaces ethernet eth2
       delete interfaces loopback lo
   ignore_errors: "{{ result.failed }}"
diff --git a/tests/integration/targets/vyos_hostname/tests/cli/_remove_config.yaml b/tests/integration/targets/vyos_hostname/tests/cli/_remove_config.yaml
index 9850e2f..3c1bf09 100644
--- a/tests/integration/targets/vyos_hostname/tests/cli/_remove_config.yaml
+++ b/tests/integration/targets/vyos_hostname/tests/cli/_remove_config.yaml
@@ -1,8 +1,8 @@
 ---
-- name: Delete Hostname vyosuser
+- name: Delete Hostname
   vyos.vyos.vyos_config:
     lines:
-      - delete system host-name 'vyosuser'
+      - delete system host-name
   ignore_errors: true
   vars:
     ansible_connection: ansible.netcommon.network_cli
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/_parsed.cfg b/tests/integration/targets/vyos_snmp_server/tests/cli/_parsed.cfg
index 9750253..493842d 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/_parsed.cfg
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/_parsed.cfg
@@ -11,9 +11,9 @@ set service snmp trap-target 203.0.113.10
 set service snmp v3 engineid '000000000000000000000002'
 set service snmp v3 group default mode 'ro'
 set service snmp v3 group default view 'default'
-set service snmp v3 user vyos auth plaintext-key 'vyos12345678'
+set service snmp v3 user vyos auth plaintext-password 'vyos12345678'
 set service snmp v3 user vyos auth type 'sha'
 set service snmp v3 user vyos group 'default'
-set service snmp v3 user vyos privacy plaintext-key 'vyos12345678'
+set service snmp v3 user vyos privacy plaintext-password 'vyos12345678'
 set service snmp v3 user vyos privacy type 'aes'
 set service snmp v3 view default oid 1
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/_populate_config.yaml b/tests/integration/targets/vyos_snmp_server/tests/cli/_populate_config.yaml
index f4d89f5..f8aa82e 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/_populate_config.yaml
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/_populate_config.yaml
@@ -2,16 +2,21 @@
 - name: setup
   vyos.vyos.vyos_config:
     lines:
+      - set interface ethernet eth2 address 20.1.1.1/24
       - set service snmp community switches authorization rw
       - set service snmp community bridges client 1.1.1.1
       - set service snmp community bridges client 12.1.1.10
       - set service snmp listen-address 20.1.1.1
-      - set service snmp listen-address 100.1.2.1 port 33
-      - set service snmp v3 user adminuser engineid 33
+      - set service snmp listen-address 192.0.2.1 port 33
+      - set service snmp v3 engineid 33
+      - set service snmp v3 group testgroup mode ro
+      - set service snmp v3 group testgroup view default
+      - set service snmp v3 view default oid 1
       - set service snmp v3 user adminuser auth type sha
-      - set service snmp v3 user adminuser auth plaintext-key abc1234567
+      - set service snmp v3 user adminuser auth plaintext-password abc1234567
       - set service snmp v3 user adminuser privacy type aes
-      - set service snmp v3 user adminuser privacy plaintext-key abc1234567
+      - set service snmp v3 user adminuser privacy plaintext-password abc1234567
+      - set service snmp v3 user adminuser group testgroup
       - set service snmp contact admin2@ex.com
   ignore_errors: true
   vars:
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/merged.yaml b/tests/integration/targets/vyos_snmp_server/tests/cli/merged.yaml
index 7f8139d..991cb42 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/merged.yaml
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/merged.yaml
@@ -17,25 +17,36 @@
           contact: admin2@ex.com
           listen_addresses:
             - address: 20.1.1.1
-            - address: 100.1.2.1
+            - address: 192.0.2.1
               port: 33
           snmp_v3:
+            views:
+              - view: default
+                oid: 1
+            groups:
+              - group: testgroup
+                mode: ro
+                view: default
             users:
               - user: adminuser
                 authentication:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: sha
                 privacy:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: aes
+                group: testgroup
         state: merged
 
     - vyos.vyos.vyos_facts:
         gather_network_resources: snmp_server
 
+    - debug:
+        var: result.commands|symmetric_difference(merged.commands)
+
     - assert:
         that:
-          - result.commands|length == 10
+          - result.commands|length == merged.commands|length
           - result.changed == true
           - result.commands|symmetric_difference(merged.commands) == []
           - result.after == ansible_facts['network_resources']['snmp_server']
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/overridden.yaml b/tests/integration/targets/vyos_snmp_server/tests/cli/overridden.yaml
index 2dc6eda..83536ad 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/overridden.yaml
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/overridden.yaml
@@ -16,25 +16,31 @@
               networks: [1.1.1.0/24, 12.1.1.0/24]
           location: RDU
           listen_addresses:
-            - address: 100.1.2.1
+            - address: 192.0.2.1
               port: 33
           snmp_v3:
+            engine_id: "33"
+            groups:
+              - group: testgroup
+                mode: ro
+                view: default
             users:
               - user: adminuser
-                engine_id: "33"
                 authentication:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: sha
                 privacy:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: aes
+                group: testgroup
               - user: guestuser2
                 authentication:
-                  plaintext_key: opq1234567
+                  encrypted_key: a1aadc2ed9912c6176939ce995367861012450a3
                   type: sha
                 privacy:
-                  plaintext_key: opq1234567
+                  encrypted_key: a1aadc2ed9912c6176939ce995367861012450a3
                   type: aes
+                group: testgroup
             views:
               - view: default
                 oid: 1
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/rendered.yaml b/tests/integration/targets/vyos_snmp_server/tests/cli/rendered.yaml
index f3d9254..17334e4 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/rendered.yaml
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/rendered.yaml
@@ -17,17 +17,25 @@
           contact: admin2@ex.com
           listen_addresses:
             - address: 20.1.1.1
-            - address: 100.1.2.1
+            - address: 192.0.2.1
               port: 33
           snmp_v3:
+            views:
+              - view: default
+                oid: 1
+            groups:
+              - group: testgroup
+                mode: ro
+                view: default
             users:
               - user: adminuser
                 authentication:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: sha
                 privacy:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: aes
+                group: testgroup
         state: rendered
 
     - assert:
diff --git a/tests/integration/targets/vyos_snmp_server/tests/cli/replaced.yaml b/tests/integration/targets/vyos_snmp_server/tests/cli/replaced.yaml
index 3b75992..e4270c5 100644
--- a/tests/integration/targets/vyos_snmp_server/tests/cli/replaced.yaml
+++ b/tests/integration/targets/vyos_snmp_server/tests/cli/replaced.yaml
@@ -16,25 +16,31 @@
               networks: [1.1.1.0/24, 12.1.1.0/24]
           location: RDU
           listen_addresses:
-            - address: 100.1.2.1
+            - address: 192.0.2.1
               port: 33
           snmp_v3:
+            engine_id: "33"
+            groups:
+              - group: testgroup
+                mode: ro
+                view: default
             users:
               - user: adminuser
-                engine_id: "33"
                 authentication:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: sha
                 privacy:
-                  plaintext_key: abc1234567
+                  encrypted_key: 33f8bfd6b69ee03a184818a4daea503c9e579633
                   type: aes
+                group: testgroup
               - user: guestuser2
                 authentication:
-                  plaintext_key: opq1234567
+                  encrypted_key: a1aadc2ed9912c6176939ce995367861012450a3
                   type: sha
                 privacy:
-                  plaintext_key: opq1234567
+                  encrypted_key: a1aadc2ed9912c6176939ce995367861012450a3
                   type: aes
+                group: testgroup
             views:
               - view: default
                 oid: 1
diff --git a/tests/integration/targets/vyos_snmp_server/vars/main.yaml b/tests/integration/targets/vyos_snmp_server/vars/main.yaml
index 3034390..4560271 100644
--- a/tests/integration/targets/vyos_snmp_server/vars/main.yaml
+++ b/tests/integration/targets/vyos_snmp_server/vars/main.yaml
@@ -6,11 +6,15 @@ merged:
     - set service snmp community bridges client 1.1.1.1
     - set service snmp community bridges client 12.1.1.10
     - set service snmp listen-address 20.1.1.1
-    - set service snmp listen-address 100.1.2.1 port 33
+    - set service snmp listen-address 192.0.2.1 port 33
+    - set service snmp v3 group testgroup mode ro
+    - set service snmp v3 group testgroup view default
     - set service snmp v3 user adminuser auth type sha
-    - set service snmp v3 user adminuser auth plaintext-key ********
+    - set service snmp v3 user adminuser auth encrypted-password ********
     - set service snmp v3 user adminuser privacy type aes
-    - set service snmp v3 user adminuser privacy plaintext-key ********
+    - set service snmp v3 user adminuser privacy encrypted-password ********
+    - set service snmp v3 user adminuser group testgroup
+    - set service snmp v3 view default oid 1
     - set service snmp contact admin2@ex.com
   after:
     communities:
@@ -22,18 +26,26 @@ merged:
         name: switches
     contact: admin2@ex.com
     listen_addresses:
-      - address: 100.1.2.1
+      - address: 192.0.2.1
         port: 33
       - address: 20.1.1.1
     snmp_v3:
+      groups:
+        - group: testgroup
+          mode: ro
+          view: default
       users:
-        - authentication:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+        - user: adminuser
+          authentication:
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: sha
           privacy:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: aes
-          user: adminuser
+          group: testgroup
+      views:
+        - view: default
+          oid: "1"
 
 overridden:
   commands:
@@ -45,9 +57,9 @@ overridden:
     - set service snmp community bridges network 1.1.1.0/24
     - set service snmp community bridges network 12.1.1.0/24
     - set service snmp v3 user guestuser2 auth type sha
-    - set service snmp v3 user guestuser2 auth plaintext-key ********
+    - set service snmp v3 user guestuser2 auth encrypted-password ********
     - set service snmp v3 user guestuser2 privacy type aes
-    - set service snmp v3 user guestuser2 privacy plaintext-key ********
+    - set service snmp v3 user guestuser2 privacy encrypted-password ********
     - set service snmp v3 view default oid 1
     - set service snmp location \'RDU\'
 
@@ -65,17 +77,17 @@ overridden:
     snmp_v3:
       users:
         - authentication:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: sha
           privacy:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: aes
           user: adminuser
         - authentication:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: sha
           privacy:
-            plaintext_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+            encrypted_key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
             type: aes
           user: guestuser2
       views:
diff --git a/tests/unit/modules/network/vyos/fixtures/vyos_snmp_server_config.cfg b/tests/unit/modules/network/vyos/fixtures/vyos_snmp_server_config.cfg
index 689b18e..957af9d 100644
--- a/tests/unit/modules/network/vyos/fixtures/vyos_snmp_server_config.cfg
+++ b/tests/unit/modules/network/vyos/fixtures/vyos_snmp_server_config.cfg
@@ -2,11 +2,11 @@ set service snmp community bridges network 1.1.1.0/24
 set service snmp community bridges network 12.1.1.0/24
 set service snmp listen-address 100.1.2.1 port 33
 set service snmp location RDU, NC
-set service snmp v3 user admin_user auth plaintext-key abc1234567
+set service snmp v3 user admin_user auth plaintext-password abc1234567
 set service snmp v3 user admin_user auth type sha
-set service snmp v3 user admin_user privacy plaintext-key abc1234567
+set service snmp v3 user admin_user privacy plaintext-password abc1234567
 set service snmp v3 user admin_user privacy type aes
-set service snmp v3 user guest_user auth plaintext-key opq1234567
+set service snmp v3 user guest_user auth plaintext-password opq1234567
 set service snmp v3 user guest_user auth type sha
-set service snmp v3 user guest_user privacy plaintext-key opq1234567
+set service snmp v3 user guest_user privacy plaintext-password opq1234567
 set service snmp v3 user guest_user privacy type aes
diff --git a/tests/unit/modules/network/vyos/test_vyos_snmp_server.py b/tests/unit/modules/network/vyos/test_vyos_snmp_server.py
index 4314465..9ac650b 100644
--- a/tests/unit/modules/network/vyos/test_vyos_snmp_server.py
+++ b/tests/unit/modules/network/vyos/test_vyos_snmp_server.py
@@ -276,13 +276,13 @@ class TestVyosSnmpServerModule(TestVyosModule):
             "set service snmp v3 group default seclevel priv",
             "set service snmp v3 group default view view1",
             "delete service snmp v3 user admin_user auth type sha",
-            "delete service snmp v3 user admin_user auth plaintext-key abc1234567",
+            "delete service snmp v3 user admin_user auth plaintext-password abc1234567",
             "delete service snmp v3 user admin_user privacy type aes",
-            "delete service snmp v3 user admin_user privacy plaintext-key abc1234567",
+            "delete service snmp v3 user admin_user privacy plaintext-password abc1234567",
             "delete service snmp v3 user guest_user auth type sha",
-            "delete service snmp v3 user guest_user auth plaintext-key opq1234567",
+            "delete service snmp v3 user guest_user auth plaintext-password opq1234567",
             "delete service snmp v3 user guest_user privacy type aes",
-            "delete service snmp v3 user guest_user privacy plaintext-key opq1234567",
+            "delete service snmp v3 user guest_user privacy plaintext-password opq1234567",
             "set service snmp v3 engineid 34",
             "set service snmp contact admin@example.com",
             "set service snmp description snmp_config",
@@ -345,13 +345,13 @@ class TestVyosSnmpServerModule(TestVyosModule):
             "set service snmp v3 group default seclevel priv",
             "set service snmp v3 group default view view1",
             "delete service snmp v3 user admin_user auth type sha",
-            "delete service snmp v3 user admin_user auth plaintext-key abc1234567",
+            "delete service snmp v3 user admin_user auth plaintext-password abc1234567",
             "delete service snmp v3 user admin_user privacy type aes",
-            "delete service snmp v3 user admin_user privacy plaintext-key abc1234567",
+            "delete service snmp v3 user admin_user privacy plaintext-password abc1234567",
             "delete service snmp v3 user guest_user auth type sha",
-            "delete service snmp v3 user guest_user auth plaintext-key opq1234567",
+            "delete service snmp v3 user guest_user auth plaintext-password opq1234567",
             "delete service snmp v3 user guest_user privacy type aes",
-            "delete service snmp v3 user guest_user privacy plaintext-key opq1234567",
+            "delete service snmp v3 user guest_user privacy plaintext-password opq1234567",
             "set service snmp v3 engineid 34",
             "set service snmp contact admin@example.com",
             "set service snmp description snmp_config",