cisco_node_utils 1.2.0 → 1.3.0

data/tests/test_interface_service_vni.rb

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 require_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/bridge_domain'
+require_relative '../lib/cisco_node_utils/encapsulation'
 require_relative '../lib/cisco_node_utils/interface'
 require_relative '../lib/cisco_node_utils/interface_service_vni'
 require_relative '../lib/cisco_node_utils/vdc'
@@ -33,96 +35,73 @@ include Cisco
 #      encapsulation profile vni_600_6000 default
 #
 class TestInterfaceServiceVni < CiscoTestCase
+  # rubocop:disable Style/ClassVars
+  @skip_unless_supported = 'interface_service_vni'
+  @@pre_clean_needed = true
+  @@intf = nil
+
   def setup
     super
-  end
+    return unless @@pre_clean_needed
 
-  def teardown
-    # Reset the vdc module type back to default
-    v = Vdc.new('default')
-    v.limit_resource_module_type = '' if v.limit_resource_module_type == 'f3'
+    mt_full_env_setup
+    @@pre_clean_needed = false
   end
 
-  def compatible_interface?
-    # MT-full tests require a specific linecard; either because they need a
-    # compatible interface or simply to enable the features. Either way
-    # we will provide an appropriate interface name if the linecard is present.
-    # Example 'show mod' output to match against:
-    #   '9  12  10/40 Gbps Ethernet Module  N7K-F312FQ-25 ok'
-    sh_mod = @device.cmd("sh mod | i '^[0-9]+.*N7K-F3'")[/^(\d+)\s.*N7K-F3/]
-    slot = sh_mod.nil? ? nil : Regexp.last_match[1]
-    skip('Unable to find compatible interface in chassis') if slot.nil?
-
-    "ethernet#{slot}/1"
+  def teardown
+    config_no_warn("default interface #{@@intf}")
+    super
   end
 
   def mt_full_env_setup
-    skip('Platform does not support MT-full') unless Vni.mt_full_support
-    intf = compatible_interface?
-    v = Vdc.new('default')
-    v.limit_resource_module_type = 'f3' unless
-      v.limit_resource_module_type == 'f3'
-    config("default int #{intf}")
-    intf
+    @@intf = mt_full_interface?
+    Vdc.new('default').limit_resource_module_type = 'f3'
+    config_no_warn("default interface #{@@intf}")
+    global_setup
   end
 
   def global_setup
     # Reset feature to clean up switch
     config('no feature vni', 'feature vni')
 
-    # Create a global encap config
-    config('encapsulation profile vni vni_500_5000', 'dot1q 500  vni 5000',
-           'encapsulation profile vni vni_600_6000', 'dot1q 600  vni 6000',
-           'encapsulation profile vni vni_700_7000', 'dot1q 700  vni 7000',
-           'encapsulation profile vni vni_800_8000', 'dot1q 800  vni 8000')
+    # Create global encap profiles
+    Encapsulation.new('vni_500_5000').dot1q_map = %w(500 5000)
+    Encapsulation.new('vni_600_6000').dot1q_map = %w(600 6000)
+    Encapsulation.new('vni_700_7000').dot1q_map = %w(700 7000)
+    Encapsulation.new('vni_800_8000').dot1q_map = %w(800 8000)
 
-    # Configure a bridge-domain
-    config('system bridge-domain 100-113', 'bridge-domain 100')
+    # Create global bridge domains
+    remove_all_bridge_domains
+    BridgeDomain.new('100-113')
   end
 
   def test_create_destroy
-    # This property has several dependencies:
-    #  - VDC support
-    #  - Specific linecard (F3 or newer)
-    #  - Bridge Domain Configuration
-    #  - Feature vni
-
-    intf = mt_full_env_setup
-    global_setup
-
     # TEST Create / Destroy and svc_vni_ids hash builder
-    i5 = InterfaceServiceVni.new(intf, 5)
-    assert_equal(1, InterfaceServiceVni.svc_vni_ids[intf].count)
-    i6 = InterfaceServiceVni.new(intf, 6)
-    i7 = InterfaceServiceVni.new(intf, 7)
-    assert_equal(3, InterfaceServiceVni.svc_vni_ids[intf].count)
+    i5 = InterfaceServiceVni.new(@@intf, 5)
+    assert_equal(1, InterfaceServiceVni.svc_vni_ids[@@intf].count)
+    i6 = InterfaceServiceVni.new(@@intf, 6)
+    i7 = InterfaceServiceVni.new(@@intf, 7)
+    assert_equal(3, InterfaceServiceVni.svc_vni_ids[@@intf].count)
     i6.destroy
-    assert_equal(2, InterfaceServiceVni.svc_vni_ids[intf].count)
+    assert_equal(2, InterfaceServiceVni.svc_vni_ids[@@intf].count)
     i5.destroy
     i7.destroy
   end
 
   def test_shutdown
-    intf = mt_full_env_setup
-    global_setup
+    i5 = InterfaceServiceVni.new(@@intf, 5)
+    assert_equal(i5.default_shutdown, i5.shutdown)
 
-    i5 = InterfaceServiceVni.new(intf, 5)
-    # Test shutdown
     i5.shutdown = false
     refute(i5.shutdown)
     i5.shutdown = true
     assert(i5.shutdown)
-    i5.shutdown = false
-    refute(i5.shutdown)
-    i5.shutdown = i5.default_shutdown
-    assert(i5.shutdown)
   end
 
   def test_encapsulation_profile_vni
-    intf = mt_full_env_setup
-    global_setup
-
-    i5 = InterfaceServiceVni.new(intf, 5)
+    i5 = InterfaceServiceVni.new(@@intf, 5)
+    assert_equal(i5.default_encapsulation_profile_vni,
+                 i5.encapsulation_profile_vni)
 
     # Test removal when profile not present
     i5.encapsulation_profile_vni = ''
@@ -149,16 +128,8 @@ class TestInterfaceServiceVni < CiscoTestCase
   def test_vlan_mapping
     # This test covers two properties:
     #  vlan_mapping & vlan_mapping_enabled
-    #
-    # This property has several dependencies:
-    #  - VDC support
-    #  - Specific linecard (F3)
-    #  - Bridge Domain Configuration
-    #  - Feature vni
-    intf = mt_full_env_setup
-    global_setup
 
-    i = Interface.new(intf)
+    i = Interface.new(@@intf)
     i.switchport_mode = :trunk
     i.vlan_mapping = []
     assert_equal([], i.vlan_mapping, 'Initial cleanup failed')

data/tests/test_interface_svi.rb

@@ -20,49 +20,100 @@ include Cisco
 # TestSvi - Minitest for Interface configuration of SVI interfaces.
 class TestSvi < CiscoTestCase
   @@pre_clean_needed = true # rubocop:disable Style/ClassVars
+  attr_reader :svi
+
+  def self.runnable_methods
+    # We don't have a separate YAML file to key off, so we check platform
+    return super unless platform == :ios_xr
+    remove_method :setup
+    remove_method :teardown
+    [:xr_unsupported]
+  end
 
-  def remove_all_svis
-    Interface.interfaces.each do |int, obj|
-      next unless int[/vlan/]
-      next if int[/vlan1/]
-      obj.destroy
-    end
+  def xr_unsupported
+    skip("Skipping #{self.class}; Vlan interfaces are not supported on IOS XR")
   end
 
   def setup
     super
     remove_all_svis if @@pre_clean_needed
     @@pre_clean_needed = false # rubocop:disable Style/ClassVars
+    @svi = Interface.new('Vlan23')
+  end
+
+  def remove_all_svis
+    Interface.interfaces.each do |int, obj|
+      next unless int[/vlan/]
+      next if int[/vlan1/]
+      obj.destroy
+    end
   end
 
   def teardown
-    super
     remove_all_svis
+    config_no_warn('no feature private-vlan')
+    super
   end
 
-  def cmd_ref_autostate
-    ref = cmd_ref.lookup('interface', 'svi_autostate')
-    assert(ref, 'Error, reference not found for autostate')
-    ref
+  def skip_autostate_test?
+    skip('svi autostate properties are not supported on this platform') if
+      node.product_id =~ /N(5|6)K/
   end
 
-  # Decides whether to check for a raised Exception or an equal value.
-  def assert_result(expected_result, err_msg, &block)
-    if expected_result.is_a? Class
-      assert_raises(expected_result, &block)
-    else
-      value = block.call
-      assert_equal(expected_result, value, err_msg)
+  def system_default_svi_autostate(state='')
+    s = config("#{state}system default interface-vlan autostate")
+    if s[/Invalid input/] # rubocop:disable Style/GuardClause
+      skip("'system default interface-vlan autostate' is not supported")
     end
   end
 
-  def skip_autostate_test?
-    skip('svi autostate properties are not supported on this platform') if
-      node.product_id =~ /N(5|6)K/
+  def test_private_vlan_mapping
+    if validate_property_excluded?('interface',
+                                   'private_vlan_mapping')
+      assert_nil(svi.private_vlan_mapping)
+      return
+    end
+    input = %w(10-20 30)
+    result = ['10-20,30']
+    svi.private_vlan_mapping = input
+    assert_equal(result,
+                 svi.private_vlan_mapping,
+                 'Error: svi private mapping not configured')
+
+    input = %w(11-13)
+    result = %w(11-13)
+    svi.private_vlan_mapping = input
+    assert_equal(result,
+                 svi.private_vlan_mapping,
+                 'Error: svi private mapping not configured')
+
+    input = []
+    result = []
+    svi.private_vlan_mapping = input
+    input = svi.private_vlan_mapping
+    assert_equal(input, result,
+                 'Err: wrong config for svi pvlan mapping')
   end
 
-  def system_default_svi_autostate(state='')
-    config("#{state}system default interface-vlan autostate")
+  def test_private_vlan_mapping_bad_args
+    if validate_property_excluded?('interface',
+                                   'private_vlan_mapping')
+      assert_nil(svi.private_vlan_mapping)
+      return
+    end
+    input = %w(10 20)
+    result = ['10,20']
+    svi.private_vlan_mapping = input
+    input = svi.private_vlan_mapping
+    assert_equal(result,
+                 svi.private_vlan_mapping,
+                 'Error: svi private mapping not configured')
+
+    input = %w(23)
+    assert_raises(RuntimeError,
+                  'svi pvlan mapping did not raise RuntimeError') do
+      svi.private_vlan_mapping = input
+    end
   end
 
   def test_prop_nil_when_ethernet
@@ -75,27 +126,23 @@ class TestSvi < CiscoTestCase
   end
 
   def test_create_valid
-    svi = Interface.new('Vlan23')
-    s = @device.cmd('show run interface all | inc Vlan')
-    cmd = 'interface Vlan1'
-    assert(s.include?(cmd), 'Error: Failed to create svi Vlan1')
+    @default_show_command = 'show run interface all | inc Vlan'
+    assert_show_match(pattern: /interface Vlan1/,
+                      msg:     'Error: Failed to create svi Vlan1')
+
+    assert_show_match(pattern: /interface Vlan23/,
+                      msg:     'Error: Failed to create svi Vlan23')
 
-    cmd = 'interface Vlan23'
-    assert(s.include?(cmd), 'Error: Failed to create svi Vlan23')
     svi.destroy
 
     # Verify that svi23 got removed now that we invoked svi.destroy
-    s = @device.cmd('show run interface all | inc Vlan')
-    cmd = 'interface Vlan23'
-    refute(s.include?(cmd), 'Error: svi Vlan23 still configured')
+    refute_show_match(pattern: /interface Vlan23/,
+                      msg:     'Error: svi Vlan23 still configured')
   end
 
-  def test_create_vlan_invalid
+  def test_create_invalid
     assert_raises(CliError) { Interface.new('10.1.1.1') }
-  end
-
-  def test_create_vlan_invalid_value
-    assert_raises(CliError) { Interface.new('Vlan0') }
+    assert_raises(CliError, Cisco::UnsupportedError) { Interface.new('Vlan0') }
   end
 
   def test_create_vlan_nil
@@ -103,106 +150,59 @@ class TestSvi < CiscoTestCase
   end
 
   def test_name
-    svi = Interface.new('Vlan23')
     assert_equal('vlan23', svi.name, 'Error: svi vlan name is wrong')
-    svi.destroy
   end
 
   def test_assignment
-    svi = Interface.new('Vlan23')
     svi.svi_management = true
     assert(svi.svi_management, 'Error: svi svi_management, false')
-    svi_extra = svi
+    svi_extra = Interface.new('Vlan23')
     assert(svi_extra.svi_management, 'Error: new svi svi_management, false')
-    svi.destroy
   end
 
-  def test_get_autostate_false
+  def test_get_autostate
     skip_autostate_test?
-    svi = Interface.new('Vlan23')
 
     config('interface vlan 23', 'no autostate')
     refute(svi.svi_autostate, 'Error: svi autostate not correct.')
-    svi.destroy
-  end
-
-  def test_get_autostate_true
-    skip_autostate_test?
-    svi = Interface.new('Vlan23')
 
     config('interface vlan 23', 'autostate')
     assert(svi.svi_autostate, 'Error: svi autostate not correct.')
-    svi.destroy
   end
 
-  def test_set_autostate_false
+  def test_set_autostate
     skip_autostate_test?
-    ref = cmd_ref_autostate
-    svi = Interface.new('Vlan23')
-    assert_result(ref.test_config_result(false),
-                  'Error: svi autostate not set to false') do
-      svi.svi_autostate = false
-    end
-    svi.destroy
-  end
+    svi.svi_autostate = false
+    refute(svi.svi_autostate, 'Error: svi autostate not set to false')
 
-  def test_set_autostate_true
-    skip_autostate_test?
-    svi = Interface.new('Vlan23')
-    ref = cmd_ref_autostate
-    assert_result(ref.test_config_result(true),
-                  'Error: svi autostate not set to true') do
-      svi.svi_autostate = true
-    end
-    svi.destroy
-  end
+    svi.svi_autostate = true
+    assert(svi.svi_autostate, 'Error: svi autostate not set to true')
 
-  def test_set_autostate_default
-    skip_autostate_test?
-    svi = Interface.new('Vlan23')
-    ref = cmd_ref_autostate
-    default_value = ref.default_value
-    assert_result(ref.test_config_result(default_value),
-                  'Error: svi autostate not set to default') do
-      svi.svi_autostate = default_value
-    end
-    svi.destroy
+    svi.svi_autostate = svi.default_svi_autostate
+    assert_equal(svi.default_svi_autostate, svi.svi_autostate,
+                 'Error: svi autostate not set to default')
   end
 
-  def test_get_management_true
-    svi = Interface.new('Vlan23')
-
+  def test_get_management
     config('interface vlan 23', 'management')
 
     assert(svi.svi_management)
-    svi.destroy
   end
 
-  def test_set_management_false
-    svi = Interface.new('Vlan23')
+  def test_set_management
     svi.svi_management = false
     refute(svi.svi_management)
-    svi.destroy
-  end
 
-  def test_set_management_true
-    svi = Interface.new('Vlan23')
-    svi.svi_management = true
-    assert(svi.svi_management)
-    svi.destroy
-  end
-
-  def test_set_management_default
-    svi = Interface.new('Vlan23')
     svi.svi_management = true
     assert(svi.svi_management)
 
     svi.svi_management = svi.default_svi_management
     assert_equal(svi.default_svi_management, svi.svi_management)
-    svi.destroy
   end
 
   def config_svi_properties(state)
+    # We don't want the default vlan23 for this test:
+    svi.destroy
     # Skip default vlan1
     (2..6).each do |i|
       svi = Interface.new('Vlan' + i.to_s)
@@ -234,13 +234,10 @@ class TestSvi < CiscoTestCase
   end
 
   def test_create_interface_description
-    svi = Interface.new('Vlan23')
-
     description = 'Test description'
     svi.description = description
     assert_equal(description, svi.description,
                  'Error: Description not configured')
-    svi.destroy
   end
 
   def test_system_default_svi_autostate_on_off