cisco_node_utils_mgx 2.1.0.1

data/tests/test_vtp.rb

@@ -0,0 +1,278 @@
+# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/vtp'
+
+# TestVtp - Minitest for Vtp node utility class
+class TestVtp < CiscoTestCase
+  @skip_unless_supported = 'vtp'
+
+  def setup
+    super
+    config('no feature vtp')
+  end
+
+  def teardown
+    config('no feature vtp')
+    super
+  end
+
+  def vtp_domain(domain)
+    vtp = Vtp.new
+    vtp.domain = domain
+    vtp
+  end
+
+  def test_disabled
+    vtp = Vtp.new(false)
+    assert_empty(vtp.domain)
+    assert_equal(vtp.default_password, vtp.password)
+    assert_equal(vtp.default_filename, vtp.filename)
+    assert_equal(vtp.default_version, vtp.version)
+    refute(Feature.vtp_enabled?, 'VTP feature was unexpectedly enabled?')
+  end
+
+  def test_enabled_but_no_domain
+    vtp = Vtp.new(false)
+    config('feature vtp')
+    assert(Feature.vtp_enabled?)
+    assert_empty(vtp.domain)
+    assert_equal(vtp.default_password, vtp.password)
+    assert_equal(vtp.default_filename, vtp.filename)
+    assert_equal(vtp.default_version, vtp.version)
+    # Can set these without setting domain
+    vtp.filename = 'bootflash:/foo.bar'
+    assert_equal('bootflash:/foo.bar', vtp.filename)
+    vtp.version = 1
+    assert_equal(1, vtp.version)
+    # Can't set any of the below without setting a domain first
+    assert_raises(CliError) do
+      vtp.password = 'hello'
+    end
+  end
+
+  def test_domain_enable_disable
+    assert_empty(Vtp.domain)
+    vtp = vtp_domain('enable')
+    assert_equal('enable', Vtp.domain)
+    vtp.destroy
+    assert_empty(Vtp.domain)
+  end
+
+  def test_create_valid
+    vtp = vtp_domain('accounting')
+    assert_equal('accounting', vtp.domain)
+  end
+
+  def test_domain_name_change
+    vtp = vtp_domain('accounting')
+    vtp_domain('uplink')
+    assert_equal('uplink', vtp.domain,
+                 'Error: vtp domain name incorrect')
+  end
+
+  def test_negative
+    assert_raises(ArgumentError) { vtp_domain(nil) }
+    assert_raises(ArgumentError) { vtp_domain('') }
+
+    vtp = vtp_domain('accounting')
+
+    # Set password to nil
+    assert_raises(TypeError) { vtp.password = nil }
+
+    # Password too long
+    password = 'a' * (Vtp::MAX_VTP_PASSWORD_SIZE + 1)
+    assert_raises(ArgumentError) { vtp.password = password }
+
+    # Set filename to nil
+    assert_raises(TypeError) { vtp.filename = nil }
+
+    # Invalid version
+    assert_raises(Cisco::CliError) { vtp.version = 34 }
+  end
+
+  def test_assignment
+    vtp = vtp_domain('accounting')
+    vtp.password = 'copy_test'
+    assert_equal('copy_test', vtp.password,
+                 'Error: vtp password not set')
+    vtp_extra = vtp
+    assert_equal('copy_test', vtp_extra.password,
+                 'Error: vtp password not set')
+  end
+
+  def test_domain_get
+    vtp = vtp_domain('accounting')
+    assert_equal('accounting', vtp.domain,
+                 'Error: vtp domain incorrect')
+  end
+
+  def test_password_default
+    vtp = vtp_domain('accounting')
+    vtp.password = 'test_me'
+    assert_equal('test_me', vtp.password,
+                 'Error: vtp password not correct')
+
+    vtp.password = vtp.default_password
+    assert_equal(node.config_get_default('vtp', 'password'), vtp.password,
+                 'Error: vtp password not correct')
+  end
+
+  def test_password_zero_length
+    vtp = vtp_domain('accounting')
+    vtp.password = ''
+    assert_equal('', vtp.password,
+                 'Error: vtp password not empty')
+  end
+
+  def test_password_get
+    vtp = vtp_domain('accounting')
+
+    config('vtp password cisco123')
+    assert_equal('cisco123', vtp.password,
+                 'Error: vtp password not correct')
+  end
+
+  def test_password_get_not_set
+    vtp = vtp_domain('accounting')
+    assert_equal('', vtp.password,
+                 'Error: vtp password not empty')
+  end
+
+  def test_password_clear
+    vtp = vtp_domain('accounting')
+    vtp.password = 'cisco123'
+    assert_equal('cisco123', vtp.password,
+                 'Error: vtp password not set')
+
+    vtp.password = ''
+    assert_equal('', vtp.password,
+                 'Error: vtp default password not set')
+  end
+
+  def test_password_valid
+    vtp = vtp_domain('accounting')
+    alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789'
+    password = ''
+    1.upto(Vtp::MAX_VTP_PASSWORD_SIZE - 1) do |i|
+      password += alphabet[i % alphabet.size, 1]
+      vtp.password = password
+      assert_equal(password.rstrip, vtp.password,
+                   'Error: vtp password not set')
+    end
+  end
+
+  # this fails on n7k running 7.3(0)D1.1 image but it
+  # is fixed in some later releases. The bugID is CSCuy87970
+  # which is already verified.
+  def test_password_special_characters
+    skip_legacy_defect?('7.3.[012].(N1|D1)',
+                        'CSCuy87970: NXAPI incorrect backslash escape')
+    # N6k output may triple-escape forward slashes. For now simplify pattern.
+    test_pass = node.product_id[/N[56]/] ? 'hello!//#%$x' : 'hello!//\\#%$x'
+    vtp = vtp_domain('password')
+    vtp.password = test_pass
+    assert_equal(test_pass, vtp.password)
+  end
+
+  def test_filename_valid
+    vtp = vtp_domain('accounting')
+    vtp.filename = 'bootflash:/test.dat'
+    assert_equal('bootflash:/test.dat', vtp.filename,
+                 'Error: vtp file content wrong')
+  end
+
+  def test_filename_zero_length
+    vtp = vtp_domain('accounting')
+    vtp.filename = vtp.default_filename
+    assert_equal(node.config_get_default('vtp', 'filename'), vtp.filename,
+                 'Error: vtp file content wrong')
+
+    # send in 'no' to remove the config. That will cause the default
+    # to get reapplied.
+    vtp.filename = ''
+    assert_equal(node.config_get_default('vtp', 'filename'), vtp.filename,
+                 'Error: vtp file content wrong')
+  end
+
+  def test_filename_auto_enable
+    vtp = Vtp.new(false)
+    refute(Feature.vtp_enabled?, 'VTP should not be enabled')
+    vtp.filename = 'bootflash:/foo.bar'
+    assert(Feature.vtp_enabled?)
+    assert_equal('bootflash:/foo.bar', vtp.filename)
+  end
+
+  def test_version_valid
+    vtp = vtp_domain('accounting')
+    vtp.version = vtp.default_version
+    assert_equal(node.config_get_default('vtp', 'version'), vtp.version,
+                 'Error: vtp version not default')
+  end
+
+  def test_version3_valid
+    vtp = vtp_domain('accounting')
+
+    ref = cmd_ref.lookup('vtp', 'version')
+    assert(ref, 'Error, reference not found for vtp version3')
+
+    case node.product_id
+    when /N(5|6|7)K/
+      vtp.version = 3
+      assert_equal(vtp.version, 3)
+    else
+      assert_raises(Cisco::CliError) { vtp.version = 3 }
+    end
+  end
+
+  # Decides whether to check for a raised Exception or an equal value.
+  def assert_result(expected_result, err_msg, &block)
+    if /Error/ =~ expected_result.to_s
+      if expected_result.is_a?(String)
+        expected_result = Object.const_get(expected_result)
+      end
+      assert_raises(expected_result, &block)
+    else
+      value = block.call
+      assert_equal(expected_result, value, err_msg)
+    end
+  end
+
+  def test_version_default
+    vtp = vtp_domain('accounting')
+    vtp.version = 2
+    assert_equal(2, vtp.version,
+                 'Error: vtp version not correct')
+    vtp.version = vtp.default_version
+    assert_equal(node.config_get_default('vtp', 'version'), vtp.version,
+                 'Error: vtp version not default')
+  end
+
+  def test_version_auto_enable
+    vtp = Vtp.new(false)
+    refute(Feature.vtp_enabled?, 'VTP should not be enabled')
+    vtp.version = 1
+    assert(Feature.vtp_enabled?)
+    assert_equal(1, vtp.version)
+  end
+
+  def test_feature_enable_disable
+    Feature.vtp_enable
+    assert(Feature.vtp_enabled?, 'Error: vtp is not enabled')
+
+    Feature.vtp_disable
+    refute(Feature.vtp_enabled?, 'Error: vtp is not disabled')
+  end
+end

data/tests/test_vxlan_vtep.rb

@@ -0,0 +1,327 @@
+# Copyright (c) 2013-2018 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/feature'
+require_relative '../lib/cisco_node_utils/vxlan_vtep'
+require_relative '../lib/cisco_node_utils/vdc'
+require_relative '../lib/cisco_node_utils/evpn_multisite'
+
+include Cisco
+
+# TestVxlanVtep - Minitest for VxlanVtep node utility
+class TestVxlanVtep < CiscoTestCase
+  @skip_unless_supported = 'vxlan_vtep'
+  @@pre_clean_needed = true # rubocop:disable Style/ClassVars
+  @@feature_unsupported = false # rubocop:disable Style/ClassVars
+
+  def setup
+    super
+    skip('setup: Feature is unsupported on this device') if @@feature_unsupported
+    skip('Platform does not support MT-full or MT-lite') unless
+      VxlanVtep.mt_full_support || VxlanVtep.mt_lite_support
+    Interface.interfaces(:nve).each { |_nve, obj| obj.destroy }
+    vdc_limit_f3_no_intf_needed(:set)
+    feature_cleanup if @@pre_clean_needed
+    Feature.nv_overlay_enable
+    @@pre_clean_needed = false # rubocop:disable Style/ClassVars
+  rescue RuntimeError => e
+    # Skip locally to shortcut the dependencies above for the next test
+    @@feature_unsupported = hardware_supports_feature?(e.message, status_only: true) # rubocop:disable Style/ClassVars
+    @@feature_unsupported ? skip(e.message) : raise(e.message)
+  end
+
+  def teardown
+    if first_or_last_teardown
+      vdc_limit_f3_no_intf_needed(:clear)
+      feature_cleanup
+    end
+    super
+  end
+
+  def feature_cleanup
+    config_no_warn('no feature-set fabricpath')
+    config_no_warn('no feature vni')
+    config_no_warn('no feature vn-segment-vlan-based')
+    config_no_warn('no nv overlay evpn ; no feature nv overlay')
+    # Rapid nv feature toggle can cause failures on some platforms;
+    # symptom e.g. 'show runn | i ^feature' will hang
+    sleep 5
+  end
+
+  def test_create_destroy_one
+    # VxlanVtep.new() will enable 'feature nv overlay'
+    id = 'nve1'
+    vtep = VxlanVtep.new(id)
+    @default_show_command = "show running | i 'interface #{id}'"
+
+    assert_show_match(pattern: /^interface #{id}$/,
+                      msg:     "failed to create interface #{id}")
+
+    assert_includes(Cisco::VxlanVtep.vteps, id)
+    assert_equal(Cisco::VxlanVtep.vteps[id], vtep)
+
+    vtep.destroy
+    refute_show_match(pattern: /^interface #{id}$/,
+                      msg:     "failed to destroy interface #{id}")
+  end
+
+  def test_mt_full_create_destroy_multiple
+    skip('Platform does not support MT-full') unless VxlanVtep.mt_full_support
+
+    id1 = 'nve1'
+    id2 = 'nve2'
+    id3 = 'nve3'
+    id4 = 'nve4'
+    vtep1 = VxlanVtep.new(id1)
+    vtep2 = VxlanVtep.new(id2)
+    vtep3 = VxlanVtep.new(id3)
+    vtep4 = VxlanVtep.new(id4)
+
+    [id1, id2, id3, id4].each do |id|
+      assert_show_match(command: "show running | i 'interface #{id}'",
+                        pattern: /^interface #{id}$/,
+                        msg:     "failed to create interface #{id}")
+      assert_includes(Cisco::VxlanVtep.vteps, id)
+    end
+
+    vtep1.destroy
+    vtep2.destroy
+    vtep3.destroy
+    vtep4.destroy
+
+    [id1, id2, id3, id4].each do |id|
+      refute_show_match(command: "show running | i 'interface #{id}'",
+                        pattern: /^interface #{id}$/,
+                        msg:     "failed to create interface #{id}")
+    end
+  end
+
+  def test_create_negative
+    # MT-lite supports a single nve int, MT-full supports 4.
+    if VxlanVtep.mt_lite_support
+      VxlanVtep.new('nve1')
+      negative_id = 'nve2'
+
+    elsif VxlanVtep.mt_full_support
+      (1..4).each { |n| VxlanVtep.new("nve#{n}") }
+      negative_id = 'nve5'
+    end
+
+    assert_raises(CliError) do
+      VxlanVtep.new(negative_id)
+    end
+  end
+
+  def test_description
+    vtep = VxlanVtep.new('nve1')
+
+    # Set description to non-default value and verify
+    desc = 'vxlan interface'
+    vtep.description = desc
+    assert_equal(desc, vtep.description)
+
+    # Set description to default value and verify
+    desc = vtep.default_description
+    vtep.description = desc
+    assert_equal(desc, vtep.description)
+  end
+
+  def test_host_reachability
+    skip("Test not supported on #{node.product_id}") if
+      cmd_ref.lookup('vxlan_vtep', 'host_reachability').default_value.nil?
+
+    vtep = VxlanVtep.new('nve1')
+
+    vtep.host_reachability = 'flood'
+    assert_equal('flood', vtep.host_reachability)
+    vtep.host_reachability = 'evpn'
+    assert_equal('evpn', vtep.host_reachability)
+
+    # Set value back to flood, currently evpn.
+    vtep.host_reachability = 'flood'
+    assert_equal('flood', vtep.host_reachability)
+  end
+
+  def test_shutdown
+    vtep = VxlanVtep.new('nve1')
+
+    vtep.shutdown = true
+    assert(vtep.shutdown, 'source_interface is not shutdown')
+
+    vtep.shutdown = false
+    refute(vtep.shutdown, 'source_interface is shutdown')
+
+    vtep.shutdown = vtep.default_shutdown
+    assert(vtep.shutdown, 'source_interface is not shutdown')
+  end
+
+  def test_source_interface
+    vtep = VxlanVtep.new('nve1')
+
+    # Set source_interface to non-default value
+    val = 'loopback55'
+    vtep.source_interface = val
+    assert_equal(val, vtep.source_interface)
+
+    # Change source_interface when nve interface is in a 'no shutdown' state
+    vtep.shutdown = false
+    val = 'loopback77'
+    vtep.source_interface = val
+    assert_equal(val, vtep.source_interface)
+    # source_interface should 'no shutdown' after the change.
+    refute(vtep.shutdown, 'source_interface is shutdown')
+
+    # Set source_interface to default value
+    val = vtep.default_source_interface
+    vtep.source_interface = val
+    assert_equal(val, vtep.source_interface)
+  end
+
+  def test_multisite_bg_interface
+    skip("#{node.product_id} doesn't support this feature") unless
+      node.product_id[/N9K.*EX/]
+    vtep = VxlanVtep.new('nve1')
+
+    # Set multisite_bg_interface to non-default value
+    val = 'loopback55'
+    ms = EvpnMultisite.new(100)
+    vtep.multisite_border_gateway_interface = val
+    assert_equal(val, vtep.multisite_border_gateway_interface)
+
+    vtep.multisite_border_gateway_interface = vtep.default_multisite_border_gateway_interface
+    assert_equal(vtep.default_multisite_border_gateway_interface,
+                 vtep.multisite_border_gateway_interface)
+
+    # Should Error when no 'evpn multisite border-gateway' set
+    ms.destroy
+    assert_raises(Cisco::CliError) do
+      vtep.multisite_border_gateway_interface = val
+    end
+  end
+
+  def test_source_interface_hold_down_time
+    vtep = VxlanVtep.new('nve1')
+    if validate_property_excluded?('vxlan_vtep', 'source_intf_hold_down_time')
+      assert_nil(vtep.source_interface_hold_down_time)
+      assert_nil(vtep.default_source_interface_hold_down_time)
+      assert_raises(Cisco::UnsupportedError) do
+        vtep.source_interface_hold_down_time = 50
+      end
+      return
+    end
+
+    skip_incompat_version?('vxlan_vtep', 'source_intf_hold_down_time')
+    # Set source_interface to non-default value
+    val = 'loopback55'
+    vtep.source_interface = val
+    assert_equal(val, vtep.source_interface)
+
+    # Set source_interface_hold_down_time
+    time = 50
+    vtep.source_interface_hold_down_time = time
+    assert_equal(time, vtep.source_interface_hold_down_time)
+
+    # Set source_interface_hold_down_time to default value
+    val = vtep.default_source_interface_hold_down_time
+    vtep.source_interface_hold_down_time = val
+    assert_equal(val, vtep.source_interface_hold_down_time)
+  end
+
+  def test_global_ingress_replication_bgp
+    skip_incompat_version?('vxlan_vtep', 'global_ingress_replication_bgp')
+
+    vtep = VxlanVtep.new('nve1')
+    vtep.host_reachability = 'evpn'
+    if validate_property_excluded?('vxlan_vtep', 'global_ingress_replication_bgp')
+      assert_raises(Cisco::UnsupportedError) { vtep.global_ingress_replication_bgp = true }
+      return
+    end
+
+    # Test: Check global_ingress_replication_bgp is not configured.
+    refute(vtep.global_ingress_replication_bgp, 'global_ingress_replication_bgp should be disabled')
+
+    # Test: Enable global_ingress_replication_bgp
+    vtep.global_ingress_replication_bgp = true
+    assert(vtep.global_ingress_replication_bgp, 'global_ingress_replication_bgp should be enabled')
+    # Test: Default
+    vtep.global_ingress_replication_bgp = vtep.default_global_ingress_replication_bgp
+    refute(vtep.global_ingress_replication_bgp, 'global_ingress_replication_bgp should be disabled')
+  end
+
+  def test_global_suppress_arp
+    skip_incompat_version?('vxlan_vtep', 'global_suppress_arp')
+
+    vtep = VxlanVtep.new('nve1')
+    vtep.host_reachability = 'evpn'
+    if validate_property_excluded?('vxlan_vtep', 'global_suppress_arp')
+      assert_raises(Cisco::UnsupportedError) { vtep.global_suppress_arp = true }
+      return
+    end
+
+    # Test: Check global_suppress_arp is not configured.
+    refute(vtep.global_suppress_arp, 'global_suppress_arp should be disabled')
+
+    # Test: Enable global_suppress_arp
+    begin
+      vtep.global_suppress_arp = true
+    rescue CliError => e
+      skip(e.to_s) if /ERROR: Please configure TCAM/.match(e.to_s)
+    end
+    assert(vtep.global_suppress_arp, 'global_suppress_arp should be enabled')
+    # Test: Default
+    vtep.global_suppress_arp = vtep.default_global_suppress_arp
+    refute(vtep.global_suppress_arp, 'global_suppress_arp should be disabled')
+  end
+
+  def test_global_mcast_group_l2
+    vtep = VxlanVtep.new('nve1')
+    if validate_property_excluded?('vxlan_vtep', 'global_mcast_group_l2')
+      assert_raises(Cisco::UnsupportedError) do
+        vtep.global_mcast_group_l2 = '225.1.1.1'
+      end
+      return
+    end
+    skip_incompat_version?('vxlan_vtep', 'global_mcast_group_l2')
+
+    assert_equal(vtep.global_mcast_group_l2, vtep.default_global_mcast_group_l2)
+    vtep.global_mcast_group_l2 = '225.1.1.1'
+    assert_equal('225.1.1.1', vtep.global_mcast_group_l2)
+    vtep.global_mcast_group_l2 = vtep.default_global_mcast_group_l2
+    assert_equal(vtep.global_mcast_group_l2, vtep.default_global_mcast_group_l2)
+  end
+
+  def test_global_mcast_group_l3
+    vtep = VxlanVtep.new('nve1')
+    if validate_property_excluded?('vxlan_vtep', 'global_mcast_group_l3')
+      assert_raises(Cisco::UnsupportedError) do
+        vtep.global_mcast_group_l3 = '225.1.1.1'
+      end
+      return
+    end
+    skip_incompat_version?('vxlan_vtep', 'global_mcast_group_l3')
+
+    assert_equal(vtep.global_mcast_group_l3, vtep.default_global_mcast_group_l3)
+
+    begin
+      # global_mcast_group_l3 is only supported on certain vxlan capable N9ks
+      vtep.global_mcast_group_l3 = '225.1.1.1'
+    rescue CliError => e
+      skip(e.to_s) if /TRM not supported on this platform/.match(e.to_s)
+    end
+    assert_equal('225.1.1.1', vtep.global_mcast_group_l3)
+    vtep.global_mcast_group_l3 = vtep.default_global_mcast_group_l3
+    assert_equal(vtep.global_mcast_group_l3, vtep.default_global_mcast_group_l3)
+  end
+end