cisco_node_utils 2.0.2 → 2.1.0

data/lib/cisco_node_utils/itd_service.rb

@@ -376,6 +376,14 @@ module Cisco
       end
       # for boolean we need to do this
       send('load_bal_enable=', false) if attrs[:load_bal_enable] == ''
+      if Platform.image_version[/9.3\(1\)/] && @set_args[:state] == 'no'
+        # In the 9.3(1) release image, the load_balance config cannot
+        # be removed using 'no load-balance'.  It requires a valid
+        # parameter but it can be any parameter, even if not configured.
+        # For this version only we send the following command to
+        # remove load-balance config: 'no load-balance mask-position 0'
+        @set_args[:mask] = 'mask-position 0'
+      end
       @get_args = @set_args
       config_set('itd_service', 'load_balance', @set_args)
       set_args_keys_default

data/lib/cisco_node_utils/node.rb

@@ -89,7 +89,6 @@ module Cisco
         ref.hash['get_value'] = get_args[:value]
         ref.hash['drill_down'] = true
         get_args[:value] = nil
-        cache_flush
       end
       [get_args, ref]
     end

data/lib/cisco_node_utils/platform.rb

@@ -35,13 +35,15 @@ module Cisco
     # Ex: { 'n3000-uk9.6.0.2.U1.1.CSCaa12345.bin' => 'inactive committed',
     #       'n3000-uk9.6.0.2.U1.1.CSCaa12346.bin' => 'active', }
     def self.packages
+      pkgs = []
       pkg_hsh = {}
-      pkgs = config_get('images', 'packages')
+      begin
+        pkgs = config_get('images', 'packages')
+      rescue RuntimeError => e
+        raise unless e.message[/Invalid command/]
+      end
       return {} if pkgs.nil?
       pkgs.each { |p| pkg_hsh[p[0]] = p[1].downcase }
-    rescue RuntimeError => e
-      raise unless e.message[/Invalid command/]
-    ensure
       pkg_hsh
     end
 
@@ -103,7 +105,7 @@ module Cisco
     #       'vid'   => 'V02',
     #       'sn'    => 'SAL1812NTBP' }
     def self.chassis
-      node.cache_flush # TODO: investigate why this is needed
+      # node.cache_flush # TODO: investigate why this is needed
       all = config_get('inventory', 'chassis')
       return nil if all.nil?
 
@@ -126,36 +128,18 @@ module Cisco
     #                     'sn'    => 'SAL1812NTBP' },
     #       'Slot 2' => { ... }}
     def self.inventory_of(type)
-      node.cache_flush # TODO: investigate why this is needed
       inv = config_get('inventory', 'all')
       inv_hsh = {}
       return inv_hsh if inv.nil?
-      if platform == :ios_xr
-        # XR gets a string so we have to process it directly
-        inv_arr = inv.scan(
-          /NAME:\s+"(#{type}[^"]*)",\s+
-           DESCR:\s+"([^"]*)"\s*
-           \n
-           PID:\s+(\S+)\s*,\s+
-           VID:\s+(\S+)\s*,\s+
-           SN:\s+(\S+)\s*/x).flatten
-        inv_arr.each do |entry|
-          inv_hsh[entry[0]] = { 'descr' => entry[1],
-                                'pid'   => entry[2],
-                                'vid'   => entry[3],
-                                'sn'    => entry[4] }
-        end
-      else
-        # Nexus gets structured output
-        inv.select! { |x| x['name'].include? type }
-        return inv_hsh if inv.empty?
-        # match desired output format
-        inv.each do |s|
-          inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
-                                             'pid'   => s['productid'],
-                                             'vid'   => s['vendorid'],
-                                             'sn'    => s['serialnum'] }
-        end
+      # Nexus gets structured output
+      inv_copy = inv.select { |x| x['name'].include? type }
+      return inv_hsh if inv_copy.empty?
+      # match desired output format
+      inv_copy.each do |s|
+        inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
+                                           'pid'   => s['productid'],
+                                           'vid'   => s['vendorid'],
+                                           'sn'    => s['serialnum'] }
       end
       inv_hsh
     end

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
   gem_version = Gem::Version.new(Gem::VERSION)
   min_gem_version = Gem::Version.new('2.1.0')
   fail 'Required rubygems version >= 2.1.0' if gem_version < min_gem_version

data/lib/cisco_node_utils/vlan.rb

@@ -19,14 +19,13 @@ require_relative 'node_util'
 require_relative 'interface'
 require_relative 'fabricpath_global'
 require_relative 'feature'
-require_relative 'vlan_DEPRECATED'
 
 # Add some Vlan-specific constants to the Cisco namespace
 module Cisco
   VLAN_NAME_SIZE = 33
 
   # Vlan - node utility class for VLAN configuration management
-  class Vlan < Cisco::VlanDeprecated
+  class Vlan < NodeUtil
     attr_reader :vlan_id
 
     def initialize(vlan_id, instantiate=true)

data/lib/cisco_node_utils/vxlan_vtep.rb

@@ -79,7 +79,7 @@ module Cisco
     ########################################################
 
     def description
-      config_get('interface', 'description', name: @name)
+      config_get('interface', 'description', name: @name, show_name: @name)
     end
 
     def description=(desc)

data/tests/test_interface.rb

@@ -161,6 +161,80 @@ class TestInterface < CiscoTestCase
     end
   end
 
+  def test_non_existent_intf
+    # pre-clean: remove intf if it exists
+    Interface.new('loopback100').destroy
+
+    # Create from non-exist
+    interface = Interface.new('loopback100')
+    refute_nil(interface.name)
+    interface.destroy
+  end
+
+  def test_interface_apis
+    # N7K: verify show_name pattern
+    {
+      'etherNET1/1.42' => 'Ethernet1/1.42$',
+      'LOOPback23'     => 'loopback23$',
+      'Port-Channel19' => 'port-channel19$',
+      'MONGOsonet12'   => '.ongosonet12$',
+    }.each do |k, v|
+      assert_equal(v, Utils.normalize_intf_pattern(k),
+                   "pattern should be #{v}")
+    end if node.product_id[/N7/]
+
+    # Verify intf counter
+    assert_equal(Interface.interface_count, interface_count,
+                 'Interface.interface_count did not return the expected count')
+
+    # Verify raise rescued when loopback does not exist ('Invalid range' rescued)
+    Interface.new('loopback100').destroy
+    no_loopback = Interface.interfaces(nil, 'loopback100')
+    assert_empty(no_loopback,
+                 'Return value should be empty hash when non existent loopback')
+
+    # Verify show_name usage
+    intf = interfaces[0]
+    one = Interface.interfaces(nil, intf)
+    assert_equal(1, one.length,
+                 'Invalid number of keys returned, should be 1')
+    assert_equal(Utils.normalize_intf_pattern(intf), one[intf].show_name,
+                 ':show_name should be intf name when intf specified')
+
+    # Verify 'all' interfaces returned
+    all = Interface.interfaces
+    assert_operator(all.length, :>, 1,
+                    'Invalid number of keys returned, should exceed 1')
+    assert_empty(all[intf].show_name,
+                 ':show_name should be empty string when intf is nil')
+
+    # Verify filter operations
+    eth_count = all.keys.join.scan(/ethernet/).count
+    filtered = Interface.interfaces(:ethernet)
+    assert_equal(eth_count, filtered.length,
+                 'filter returned invalid number of ethernet interfaces')
+
+    filtered = Interface.interfaces(:mgmt)
+    assert_equal(1, filtered.length,
+                 'filter returned invalid number of mgmt interfaces')
+    assert_equal('mgmt0', filtered.keys[0],
+                 'filter returned incorrect interface name')
+
+    filtered = Interface.interfaces(:mgmt, intf)
+    assert_empty(filtered,
+                 'mgmt filter returned interface when it should be an empty hash')
+
+    filtered = Interface.interfaces(:invalid_intf_pattern)
+    assert_empty(filtered,
+                 'invalid filter returned interface when it should be an empty hash')
+
+    filtered = Interface.interfaces(:ethernet, intf)
+    assert_equal(1, filtered.length,
+                 'Invalid number of keys returned by ethernet filter with intf specified')
+    assert_equal(intf, filtered.keys[0],
+                 'filter returned incorrect interface name')
+  end
+
   # Helper to get valid speeds for port
   def capable_speed_values(interface)
     speed_capa = Interface.capabilities(interface.name)['Speed']
@@ -1881,17 +1955,4 @@ class TestInterface < CiscoTestCase
     int.destroy
     assert(int.default?)
   end
-
-  def test_purge_config
-    name = interfaces[0]
-    int = Interface.new(name)
-    int.switchport_mode = :disabled
-
-    int.description = 'destroy_pysical'
-    int.ipv4_addr_mask_set('192.168.0.1', '24')
-    refute(int.purge_config)
-
-    int.purge_config = true
-    assert(int.purge_config)
-  end
 end

data/tests/test_interface_bdi.rb

@@ -26,8 +26,8 @@ class TestInterfaceBdi < CiscoTestCase
   def self.runnable_methods
     # We don't have a separate YAML file to key off, so we check platform
     return super if node.product_id[/N7/]
-    remove_method :setup
-    remove_method :teardown
+    remove_method :setup if instance_methods(false).include?(:setup)
+    remove_method :teardown if instance_methods(false).include?(:teardown)
     [:unsupported]
   end
 

data/tests/test_interface_channel_group.rb

@@ -31,23 +31,30 @@ class TestInterfaceChanGrp < CiscoTestCase
     interface_cleanup(@intf.name)
   end
 
-  def test_channel_group
-    skip if platform == :nexus
-    i = @intf
-    group = 200
-    i.channel_group = group
-    assert_equal(group, i.channel_group)
-
-    group = 201
-    i.channel_group = group
-    assert_equal(group, i.channel_group)
-
-    group = i.default_channel_group
-    i.channel_group = group
-    assert_equal(group, i.channel_group)
-  rescue Cisco::UnsupportedError => e
-    # Some platforms only support channel-group with certain software versions
-    skip(e.to_s)
+  # Test InterfaceChannelGroup.interfaces class method api
+  def test_interface_apis
+    intf = interfaces[0]
+    intf2 = interfaces[1]
+
+    # Verify show_name usage
+    one = InterfaceChannelGroup.interfaces(intf)
+    assert_equal(1, one.length,
+                 'Invalid number of keys returned, should be 1')
+    assert_equal(Utils.normalize_intf_pattern(intf), one[intf].show_name,
+                 ':show_name should be intf name when show_name param specified')
+
+    # Verify 'all' interfaces
+    all = InterfaceChannelGroup.interfaces
+    assert_operator(all.length, :>, 1,
+                    'Invalid number of keys returned, should exceed 1')
+    assert_empty(all[intf2].show_name,
+                 ':show_name should be empty string when show_name param is nil')
+
+    # Test non-existent loopback does NOT raise when calling interfaces
+    Interface.new('loopback543', false).destroy if
+      Interface.interfaces(nil, 'loopback543').any?
+    one = InterfaceChannelGroup.interfaces('loopback543')
+    assert_empty(one, 'InterfaceChannelGroup.interfaces hash should be empty')
   end
 
   def test_channel_group_mode

data/tests/test_interface_evpn_multisite.rb

@@ -36,6 +36,41 @@ class TestInterfaceEvpnMultisite < CiscoTestCase
     config("default interface #{intf}")
   end
 
+  # Test InterfaceEvpnMultisite.interfaces class method api
+  def test_interface_apis
+    # setup
+    ms = EvpnMultisite.new(100)
+    intf = interfaces[0]
+    intf2 = interfaces[1]
+    interface_ethernet_default(intf2)
+    [intf, intf2].each do |i|
+      InterfaceEvpnMultisite.new(i).enable('dci-tracking')
+    end
+
+    # Verify show_name usage
+    one = InterfaceEvpnMultisite.interfaces(intf)
+    assert_equal(1, one.length,
+                 'Invalid number of keys returned, should be 1')
+    assert_equal(Utils.normalize_intf_pattern(intf), one[intf].show_name,
+                 ':show_name should be intf name when show_name param specified')
+
+    # Verify 'all' interfaces
+    all = InterfaceEvpnMultisite.interfaces
+    assert_operator(all.length, :>, 1,
+                    'Invalid number of keys returned, should exceed 1')
+    assert_empty(all[intf2].show_name,
+                 ':show_name should be empty string when show_name param is nil')
+
+    # Test non-existent interface does NOT raise when calling interfaces
+    Interface.new('loopback543', false).destroy if
+      Interface.interfaces(nil, 'loopback543').any?
+    no_intf = InterfaceEvpnMultisite.interfaces('loopback543')
+    assert_empty(no_intf,
+                 'InterfaceEvpnMultisite.interfaces hash should be empty')
+
+    ms.destroy
+  end
+
   def test_enable_disable
     interface = interfaces[0]
     intf_ms = InterfaceEvpnMultisite.new(interface)

data/tests/test_interface_ospf.rb

@@ -61,6 +61,58 @@ class TestInterfaceOspf < CiscoTestCase
     InterfaceOspf.new(ifname, routerospf.name, area)
   end
 
+  # Test InterfaceOspf.interfaces class method api
+  def test_interface_apis
+    intf = interfaces[0]
+    intf2 = interfaces[1]
+
+    # Verify show_name usage when no ospf config on intf
+    none = InterfaceOspf.interfaces(nil, intf)
+    assert_equal(0, none.length,
+                 'Invalid number of keys returned, should be 0')
+
+    # Verify show_name usage when ospf config present on intf
+    InterfaceOspf.new(intf, 'ospf_test', '0')
+    one = InterfaceOspf.interfaces(nil, intf)
+    assert_equal(1, one.length,
+                 'Invalid number of keys returned, should be 1')
+    assert_equal(Utils.normalize_intf_pattern(intf), one[intf].show_name,
+                 ':show_name should be intf name when show_name param specified')
+
+    # Verify 'all' interfaces returned
+    Interface.new(intf2)
+    InterfaceOspf.new(intf2, 'ospf_test', '0')
+    all = InterfaceOspf.interfaces
+    assert_operator(all.length, :>, 1,
+                    'Invalid number of keys returned, should exceed 1')
+    assert_empty(all[intf2].show_name,
+                 ':show_name should be empty string when show_name param is nil')
+
+    # Test with ospf_name parameter specified
+    all = InterfaceOspf.interfaces('ospf_test')
+    assert_operator(all.length, :>, 1,
+                    'Invalid number of keys returned, should exceed 1')
+    assert_empty(all[intf2].show_name,
+                 ':show_name should be empty string when show_name param is nil')
+
+    one = InterfaceOspf.interfaces('ospf_test', intf2)
+    assert_equal(one.length, 1,
+                 'Invalid number of keys returned, should be 1')
+    assert_equal(Utils.normalize_intf_pattern(intf2), one[intf2].show_name,
+                 ':show_name should be intf2 name when show_name param specified')
+
+    # Test non-existent loopback raises fail when calling initialize
+    Interface.new('loopback543', false).destroy if
+      Interface.interfaces(nil, 'loopback543').any?
+    assert_raises(RuntimeError) do
+      InterfaceOspf.new('loopback543', 'ospf_test', '0', false)
+    end
+
+    # Test non-existent loopback does NOT raise when calling interfaces
+    one = InterfaceOspf.interfaces('ospf_test', 'loopback543')
+    assert_empty(one, 'InterfaceOspf.interfaces hash should be empty')
+  end
+
   def test_get_set_area
     # setup a loopback to use
     config('interface loopback12')
@@ -209,7 +261,7 @@ class TestInterfaceOspf < CiscoTestCase
     pattern = (/\s+ip router ospf #{ospf.name} area #{area}/)
     assert_show_match(command: show_cmd(ifname),
                       pattern: pattern)
-    assert_equal(ifname.downcase, interface.interface.name,
+    assert_equal(ifname.downcase, interface.intf_name,
                  'Error: interface name get value mismatch ')
     assert_equal(area, interface.area,
                  'Error: area get value mismatch ')
@@ -320,6 +372,14 @@ class TestInterfaceOspf < CiscoTestCase
     interface.hello_interval = interface.default_hello_interval
     refute_show_match(pattern: /\s+ip ospf hello-interval(.*)/,
                       msg:     'Error: default hello-interval set failed')
+
+    # Test destroy_interval helper method
+    interface.hello_interval = interval
+    interface.destroy_interval('hello_interval')
+    refute_show_match(
+      command: show_cmd(interface.intf_name),
+      pattern: /\s+ip ospf hello-interval/,
+      msg:     'ip ospf hello-interval not removed')
   end
 
   def test_dead_inv
@@ -354,6 +414,14 @@ class TestInterfaceOspf < CiscoTestCase
     assert_show_match(
       pattern: /^\s+ip ospf dead-interval #{interface.default_dead_interval}/,
       msg:     'Error: default dead-interval set failed')
+
+    # Test destroy_interval helper method
+    interface.dead_interval = interval
+    interface.destroy_interval('dead_interval')
+    refute_show_match(
+      command: show_cmd(interface.intf_name),
+      pattern: /\s+ip ospf dead-interval/,
+      msg:     'ip ospf dead-interval not removed')
   end
 
   def test_bfd
@@ -471,7 +539,7 @@ class TestInterfaceOspf < CiscoTestCase
     ifname = interfaces[2]
     area = '1.1.1.1'
     interface1 = create_interfaceospf(ospf, ifname, area)
-    assert_equal(ifname.downcase, interface1.interface.name,
+    assert_equal(ifname.downcase, interface1.intf_name,
                  "Error: 'ip router ospf #{ospf.name} area #{area}' " \
                  'not configured')
 
@@ -483,7 +551,7 @@ class TestInterfaceOspf < CiscoTestCase
 
     # check other interface association still exist.
     assert_show_match(
-      command: show_cmd(interface.interface.name),
+      command: show_cmd(interface.intf_name),
       pattern: /\s+ip router ospf #{ospf.name} area #{interface.area}/,
       msg:     "'ip router ospf #{ospf.name} default area' not configured")
   end