cisco_node_utils 1.3.0 → 1.4.0

data/tests/test_snmpuser.rb

@@ -14,6 +14,7 @@
 
 require_relative 'ciscotest'
 require_relative '../lib/cisco_node_utils/snmpuser'
+require 'pry'
 
 DEFAULT_SNMP_USER_AUTH_PASSWORD = ''
 DEFAULT_SNMP_USER_PRIV_PASSWORD = ''
@@ -23,13 +24,13 @@ DEFAULT_SNMP_USER_GROUP_NAME = 'network-operator'
 class TestSnmpUser < CiscoTestCase
   @skip_unless_supported = 'snmp_user'
 
-  @@existing_users = nil # rubocop:disable Style/ClassVars
+  @@current_users = nil # rubocop:disable Style/ClassVars
 
   def setup
     super
     @test_users = []
     # Get the list of users that exist on the node when we first begin
-    @@existing_users ||= SnmpUser.users.keys # rubocop:disable Style/ClassVars
+    @@current_users = SnmpUser.users if @@current_users.nil? # rubocop:disable Style/ClassVars
   end
 
   def create_user(name, opts='')
@@ -42,21 +43,40 @@ class TestSnmpUser < CiscoTestCase
     user.destroy
   end
 
-  def teardown
-    unless @test_users.empty?
-      cfg = @test_users.collect { |name| "no snmp-server user #{name}" }
-      config(*cfg)
+  def remove_test_users
+    SnmpUser.users.values.each do |obj|
+      # Delete users that are in current but also added by these tests.
+      if @@current_users.keys.include?(obj.name) && @test_users.include?(obj.name)
+        obj.destroy
+      # Delete users that are part of test.
+      elsif @test_users.include? obj.name
+        obj.destroy
+      # Do not delete users in current but not in test.
+      elsif @@current_users.keys.include? obj.name
+        next
+      else
+        # Delete if not in current or test.
+        obj.destroy
+      end
     end
+  end
+
+  def teardown
+    # This teardown tries to preserve any non-test snmp-server user entries
+    # and only teardown the entries added by this test.
+    remove_test_users
     super
-    delta = SnmpUser.users.keys - @@existing_users
-    # User deletion can take some time, for some reason
+    delta = SnmpUser.users.keys - @@current_users.keys
     unless delta.empty?
-      sleep(5)
-      node.cache_flush
-      delta = SnmpUser.users.keys - @@existing_users
+      # Some platforms are slow, wait for snmp-server user entries to be deleted
+      15.times do
+        sleep(1)
+        node.cache_flush
+        delta = SnmpUser.users.keys - @@current_users.keys
+        break if delta.empty?
+      end
     end
-    @@existing_users = SnmpUser.users.keys # rubocop:disable Style/ClassVars
-    assert_empty(delta, 'Users not deleted after test!')
+    assert_empty(delta, 'teardown method did not clean up all users')
   end
 
   def user_pat(name, group='network-admin')
@@ -65,13 +85,13 @@ class TestSnmpUser < CiscoTestCase
 
   ## test cases starts here
 
-  def test_snmpuser_collection_not_empty
+  def test_collection_not_empty
     create_user('tester')
     refute_empty(SnmpUser.users,
                  'SnmpUser collection is empty')
   end
 
-  def test_snmpuser_create_invalid_args
+  def test_create_invalid_args
     args_list = [
       ['Empty name',
        ['', ['network-admin'],
@@ -91,17 +111,13 @@ class TestSnmpUser < CiscoTestCase
     end
   end
 
-  def test_snmpuser_create_invalid_cli
+  def test_create_invalid_cli
     args_list = [
       ['Cleartext password with localized key',
        ['userv3testauthsha1', ['network-admin'],
         :sha, 'test123456', :none, '', true, # localized key
         ''],
       ],
-      ['NX-OS Password must be at least 8 characters',
-       ['userv3testauthsha2', ['network-admin'],
-        :sha, 'test', :none, '', false, ''],
-      ],
       ['Invalid group name',
        ['userv3test', ['network-admin123'],
         :none, '', :none, '', false, ''],
@@ -135,7 +151,7 @@ class TestSnmpUser < CiscoTestCase
     assert(found_tester2)
   end
 
-  def test_snmpuser_create_with_single_group_noauth_nopriv
+  def test_noauth_nopriv
     name = 'userv3test2'
     groups = ['network-admin']
     snmpuser = SnmpUser.new(name,
@@ -149,7 +165,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_multi_group_noauth_nopriv
+  def test_noauth_nopriv_multi
     name = 'userv3test3'
     groups = ['network-admin', 'vdc-admin']
     snmpuser = SnmpUser.new(name,
@@ -165,7 +181,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_destroy
+  def test_destroy
     name = 'userv3testdestroy'
     group = 'network-operator'
     create_user(name, group)
@@ -184,7 +200,7 @@ class TestSnmpUser < CiscoTestCase
     assert_nil(SnmpUser.users[name])
   end
 
-  def test_snmpuser_auth_password_equal_invalid_param
+  def test_auth_pw_equal_invalid_param
     name = 'testV3PwEqualInvalid2'
     auth_pw = 'TeSt297534'
     create_user(name, "network-admin auth md5 #{auth_pw}")
@@ -193,7 +209,7 @@ class TestSnmpUser < CiscoTestCase
     refute(SnmpUser.users[name].auth_password_equal?('', false))
   end
 
-  def test_snmpuser_auth_priv_password_equal_invalid_param
+  def test_auth_priv_pw_equal_invalid_param
     name = 'testV3PwEqualInvalid'
     auth_pw = 'XXWWPass0wrf'
     create_user(name, "network-admin auth md5 #{auth_pw} priv #{auth_pw}")
@@ -204,7 +220,7 @@ class TestSnmpUser < CiscoTestCase
     refute(snmpuser.priv_password_equal?('', false))
   end
 
-  def test_snmpuser_auth_password_equal_priv_invalid_param
+  def test_auth_pw_equal_priv_invalid_param
     name = 'testV3PwEqualInvalid'
     auth_pw = 'XXWWPass0wrf'
     create_user(name, "network-operator auth md5 #{auth_pw} priv #{auth_pw}")
@@ -215,7 +231,7 @@ class TestSnmpUser < CiscoTestCase
     refute(snmpuser.priv_password_equal?('', false))
   end
 
-  def test_snmpuser_auth_password_not_equal
+  def test_auth_pw_not_equal
     name = 'testV3PwEqual'
     auth_pw = 'xxwwpass0r!f'
     create_user(name, "network-admin auth md5 #{auth_pw}")
@@ -225,7 +241,7 @@ class TestSnmpUser < CiscoTestCase
     refute(snmpuser.auth_password_equal?('xxwwpass0r!', false))
   end
 
-  def test_snmpuser_auth_password_equal
+  def test_auth_pw_equal
     name = 'testV3PwEqual'
     auth_pw = 'XXWWPass0wrf'
     create_user(name, "network-admin auth md5 #{auth_pw}")
@@ -234,7 +250,7 @@ class TestSnmpUser < CiscoTestCase
     assert(SnmpUser.users[name].auth_password_equal?(auth_pw, false))
   end
 
-  def test_snmpuser_auth_priv_password_equal_empty
+  def test_auth_priv_pw_equal_empty
     name = 'testV3PwEmpty'
     create_user(name, 'network-admin')
     # nil and "" are treated interchangeably
@@ -244,7 +260,7 @@ class TestSnmpUser < CiscoTestCase
     assert(SnmpUser.users[name].priv_password_equal?(nil, false))
   end
 
-  def test_snmpuser_auth_password_equal_localizedkey
+  def test_auth_pw_equal_localizedkey
     name = 'testV3PwEqual'
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
     create_user(name, "network-admin auth md5 #{auth_pw} localizedkey")
@@ -256,7 +272,7 @@ class TestSnmpUser < CiscoTestCase
     refute(snmpuser.auth_password_equal?('0xFe6c', true))
   end
 
-  def test_snmpuser_auth_priv_password_equal_localizedkey
+  def test_auth_priv_pw_equal_localizedkey
     name = 'testV3PwEqual'
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
     priv_pw = '0x29916eac22d90362598abef1b9045018'
@@ -270,7 +286,7 @@ class TestSnmpUser < CiscoTestCase
     refute(snmpuser.priv_password_equal?('0x2291', true))
   end
 
-  def test_snmpuser_auth_priv_des_password_equal
+  def test_auth_priv_des_pw_equal
     name = 'testV3PwEqual'
     auth_pw = 'XXWWPass0wrf'
     priv_pw = 'WWXXPaas0wrf'
@@ -282,7 +298,7 @@ class TestSnmpUser < CiscoTestCase
     assert(snmpuser.priv_password_equal?(priv_pw, false))
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_nopriv
+  def test_auth_md5_nopriv
     name = 'userv3test5'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -298,7 +314,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_nopriv_pw_localized
+  def test_auth_md5_nopriv_pw_localized
     name = 'userv3testauth'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -316,7 +332,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_sha_nopriv
+  def test_auth_sha_nopriv
     name = 'userv3testsha'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -334,7 +350,7 @@ class TestSnmpUser < CiscoTestCase
 
   # If the auth pw is in hex and localized key param in constructor is false,
   # then the pw got localized by the device again.
-  def test_create_1_group_auth_sha_nopriv_pw_localized_localizedkey_false
+  def test_auth_sha_nopriv_pw_localized_false
     name = 'userv3testauthsha3'
     groups = ['network-admin']
     auth_pw = '0xFe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -351,7 +367,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_sha_nopriv_pw_localized
+  def test_auth_sha_nopriv_pw_localized
     name = 'userv3testauthsha4'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -367,7 +383,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_priv_des
+  def test_auth_md5_priv_des
     name = 'userv3test6'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -384,7 +400,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_priv_des_pw_localized
+  def test_auth_md5_priv_des_pw_localized
     name = 'userv3testauth'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -395,15 +411,13 @@ class TestSnmpUser < CiscoTestCase
                             :des, priv_pw,
                             true, # localized
                             '')
-    # rubocop:disable Metrics/LineLength
     assert_show_match(
       pattern: /#{user_pat(name)} auth md5 #{auth_pw} priv #{priv_pw} localizedkey/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_priv_aes128
+  def test_auth_md5_priv_aes128
     name = 'userv3test7'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -420,7 +434,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_priv_aes128_pw_localized
+  def test_auth_md5_priv_aes128_pw_localized
     name = 'userv3testauth'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -431,15 +445,13 @@ class TestSnmpUser < CiscoTestCase
                             :aes128, priv_pw,
                             true, # localized
                             '')
-    # rubocop:disable Metrics/LineLength
     assert_show_match(
       pattern: /#{user_pat(name)} auth md5 #{auth_pw} priv aes-128 #{priv_pw} localizedkey/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_sha_priv_des
+  def test_auth_sha_priv_des
     name = 'userv3test8'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -456,7 +468,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_md5_priv_sha_pw_localized
+  def test_auth_md5_priv_sha_pw_localized
     name = 'userv3testauth'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -467,15 +479,13 @@ class TestSnmpUser < CiscoTestCase
                             :des, priv_pw,
                             true, # localized
                             '')
-    # rubocop:disable Metrics/LineLength
     assert_show_match(
       pattern: /#{user_pat(name)} auth sha #{auth_pw} priv #{priv_pw} localizedkey/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_sha_priv_aes128
+  def test_auth_sha_priv_aes128
     name = 'userv3test9'
     groups = ['network-admin']
     auth_pw = 'XXWWPass0wrf'
@@ -492,7 +502,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_with_single_group_auth_sha_priv_aes128_pw_localized
+  def test_auth_sha_priv_aes128_pw_localized
     name = 'userv3testauth'
     groups = ['network-admin']
     auth_pw = '0xfe6cf9aea159c2c38e0a79ec23ed3cbb'
@@ -503,26 +513,22 @@ class TestSnmpUser < CiscoTestCase
                             :aes128, priv_pw,
                             true, # localized
                             '')
-    # rubocop:disable Metrics/LineLength
     assert_show_match(
       pattern: /#{user_pat(name)} auth sha #{auth_pw} priv aes-128 #{priv_pw} localizedkey/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     snmpuser.destroy
   end
 
-  def test_snmpuser_create_destroy_with_engine_id
+  def test_create_destroy_with_engine_id
     name = 'test_with_engine_id'
     auth_pw = 'XXWWPass0wrf'
     priv_pw = 'XXWWPass0wrf'
     engine_id = '128:12:12:12:12'
     snmpuser = SnmpUser.new(name, [''], :md5, auth_pw, :des, priv_pw,
                             false, engine_id)
-    # rubocop:disable Metrics/LineLength
     assert_show_match(
       pattern: /snmp-server user #{name} auth \S+ \S+ priv .*\S+ localizedkey engineID #{engine_id}/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     user = SnmpUser.users["#{name} #{engine_id}"]
     refute_nil(user)
     assert_equal(snmpuser.name, user.name)
@@ -530,15 +536,13 @@ class TestSnmpUser < CiscoTestCase
     assert_equal(snmpuser.engine_id, engine_id)
     assert_equal(snmpuser.engine_id, user.engine_id)
     snmpuser.destroy
-    # rubocop:disable Metrics/LineLength
     refute_show_match(
       pattern: /snmp-server user #{name} auth \S+ \S+ priv .*\S+ localizedkey engineID #{engine_id}/,
       command: "show run snmp all | in #{name} | no-more")
-    # rubocop:enable Metrics/LineLength
     assert_nil(SnmpUser.users["#{name} #{engine_id}"])
   end
 
-  def test_snmpuser_authpassword
+  def test_authpassword
     name = 'test_authpassword'
     auth_pw = '0x123456'
     snmpuser = SnmpUser.new(name, [''], :md5, auth_pw, :none, '', true, '')
@@ -548,7 +552,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_authpassword_with_engineid
+  def test_authpassword_with_engineid
     name = 'test_authpassword'
     auth_pw = '0x123456'
     engine_id = '128:12:12:12:12'
@@ -560,7 +564,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_privpassword
+  def test_privpassword
     name = 'test_privpassword'
     priv_password = '0x123456'
     snmpuser = SnmpUser.new(name, [''], :md5, priv_password,
@@ -577,7 +581,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_privpassword_with_engineid
+  def test_privpassword_with_engineid
     name = 'test_privpassword2'
     priv_password = '0x123456'
     engine_id = '128:12:12:12:12'
@@ -594,7 +598,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_auth_password_equal_with_engineid
+  def test_auth_password_equal_with_engineid
     name = 'test_authpass_equal'
     auth_pass = 'XXWWPass0wrf'
     engine_id = '128:12:12:12:12'
@@ -608,7 +612,7 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_priv_password_equal_with_engineid
+  def test_priv_password_equal_with_engineid
     name = 'test_privpass_equal'
     priv_pass = 'XXWWPass0wrf'
     engine_id = '128:12:12:12:12'
@@ -626,31 +630,31 @@ class TestSnmpUser < CiscoTestCase
     snmpuser.destroy
   end
 
-  def test_snmpuser_default_groups
+  def test_default_groups
     groups = [DEFAULT_SNMP_USER_GROUP_NAME]
     assert_equal(groups, SnmpUser.default_groups,
                  'Error: Wrong default groups')
   end
 
-  def test_snmpuser_default_auth_protocol
+  def test_default_auth_protocol
     assert_equal(:md5,
                  SnmpUser.default_auth_protocol,
                  'Error: Wrong default auth protocol')
   end
 
-  def test_snmpuser_default_auth_password
+  def test_default_auth_password
     assert_equal(DEFAULT_SNMP_USER_AUTH_PASSWORD,
                  SnmpUser.default_auth_password,
                  'Error: Wrong default auth password')
   end
 
-  def test_snmpuser_default_priv_protocol
+  def test_default_priv_protocol
     assert_equal(:des,
                  SnmpUser.default_priv_protocol,
                  'Error: Wrong default priv protocol')
   end
 
-  def test_snmpuser_default_priv_password
+  def test_default_priv_password
     assert_equal(DEFAULT_SNMP_USER_PRIV_PASSWORD,
                  SnmpUser.default_priv_password,
                  'Error: Wrong default priv password')