cisco_node_utils 1.4.1 → 1.5.0

data/lib/cisco_node_utils/node.rb

@@ -56,7 +56,7 @@ module Cisco
       # If we have a default value but no getter, just return the default
       return ref.default_value if ref.default_value? && !ref.getter?
 
-      get_args = ref.getter(*args)
+      get_args, ref = massage_structured(ref.getter(*args).clone, ref)
       massage(get(command:     ref.get_command,
                   data_format: get_args[:data_format],
                   context:     get_args[:context],
@@ -64,18 +64,80 @@ module Cisco
               ref)
     end
 
+    # The yaml file may specifiy an Array as the get_value to drill down into
+    # nxapi_structured table output.  The table may contain multiple rows but
+    # only one of the rows has the interesting data.
+    def massage_structured(get_args, ref)
+      # Nothing to do unless nxapi_structured.
+      return [get_args, ref] unless
+        ref.hash['get_data_format'] == :nxapi_structured
+
+      # The CmdRef object will contain a get_value Array with 2 values.
+      # The first value is the key to identify the correct row in the table
+      # of structured output and the second is the key to identify the data
+      # to retrieve.
+      #
+      # Example: Get vlanshowbr-vlanname in the row that contains a specific
+      #  vlan_id.
+      # "get_value"=>["vlanshowbr-vlanid-utf <vlan_id>", "vlanshowbr-vlanname"]
+      if ref.hash['get_value'].is_a?(Array) && ref.hash['get_value'].size >= 2
+        # Replace the get_value hash entry with the value after any tokens
+        # specified in the yaml file have been replaced and set get_args[:value]
+        # to nil so that the structured table data can be retrieved properly.
+        ref.hash['get_value'] = get_args[:value]
+        ref.hash['drill_down'] = true
+        get_args[:value] = nil
+      end
+      cache_flush
+      [get_args, ref]
+    end
+
+    # Drill down into structured nxapi table data and return value from the
+    # row specified by a two part key.
+    #
+    # Example: Get vlanshowbr-vlanname in the row that contains vlan id 1000
+    # "get_value"=>["vlanshowbr-vlanid-utf 1000", "vlanshowbr-vlanname"]
+    # Example with optional regexp match
+    # "get_value"=>["vlanshowbr-vlanid-utf 1000", "vlanshowbr-vlanname",
+    #                '/^shutdown$/']
+    def drill_down_structured(value, ref)
+      # Nothing to do unless nxapi_structured
+      return value unless ref.hash['drill_down']
+
+      row_key = ref.hash['get_value'][0][/^\S+/]
+      row_index = ref.hash['get_value'][0][/\S+$/]
+      data_key = ref.hash['get_value'][1]
+      regexp_filter = nil
+      regexp_filter = ref.hash['get_value'][2] if ref.hash['get_value'][2]
+
+      # Get the value using the row_key, row_index and data_key
+      value = value.is_a?(Hash) ? [value] : value
+      data = value.find { |item| item[row_key].to_s[/#{row_index}/] }
+      return value if data.nil?
+      if regexp_filter
+        filtered = regexp_filter.match(data[data_key])
+        return filtered.nil? ? filtered : filtered[0]
+      end
+      data[data_key]
+    end
+
     # Attempt to massage the given value into the format specified by the
     # given CmdRef object.
     def massage(value, ref)
       Cisco::Logger.debug "Massaging '#{value}' (#{value.inspect})"
+      value = drill_down_structured(value, ref)
       if value.is_a?(Array) && !ref.multiple
         fail "Expected zero/one value but got '#{value}'" if value.length > 1
         value = value[0]
       end
-      if (value.nil? || value.empty?) && ref.default_value? && ref.auto_default
+      if (value.nil? || value.to_s.empty?) &&
+         ref.default_value? && ref.auto_default
         Cisco::Logger.debug "Default: #{ref.default_value}"
         return ref.default_value
       end
+      if ref.multiple && ref.hash['get_data_format'] == :nxapi_structured
+        value = [value.to_s] if value.size == 1
+      end
       return value unless ref.kind
       case ref.kind
       when :boolean
@@ -254,13 +316,16 @@ module Cisco
     # @return [String] such as "N3K-C3048TP-1GE"
     def product_id
       if @cmd_ref
-        return config_get('inventory', 'productid')
+        prod = config_get('inventory', 'productid')
+        all  = config_get('inventory', 'all')
+        prod_qualifier(prod, all)
       else
         # We use this function to *find* the appropriate CommandReference
         if @client.platform == :nexus
           entries = get(command:     'show inventory',
                         data_format: :nxapi_structured)
-          return entries['TABLE_inv']['ROW_inv'][0]['productid']
+          prod = entries['TABLE_inv']['ROW_inv'][0]['productid']
+          prod_qualifier(prod, entries['TABLE_inv']['ROW_inv'])
         elsif @client.platform == :ios_xr
           # No support for structured output for this command yet
           output = get(command:     'show inventory',
@@ -270,6 +335,30 @@ module Cisco
       end
     end
 
+    def prod_qualifier(prod, inventory)
+      case prod
+      when /N9K/
+        # Two datapoints are used to determine if the current n9k
+        # platform is a fretta based n9k or non-fretta.
+        #
+        # 1) Image Version == 7.0(3)F*
+        # 2) Fabric Module == N9K-C9*-FM-R
+        if @cmd_ref
+          ver = os_version
+        else
+          ver = get(command:     'show version',
+                    data_format: :nxapi_structured)['kickstart_ver_str']
+        end
+        # Append -F for fretta platform.
+        inventory.each do |row|
+          if row['productid'][/N9K-C9...-FM-R/] && ver[/7.0\(3\)F/]
+            return prod.concat('-F') unless prod[/-F/]
+          end
+        end
+      end
+      prod
+    end
+
     # @return [String] such as "V01"
     def product_version_id
       config_get('inventory', 'versionid')

data/lib/cisco_node_utils/pim.rb

@@ -90,6 +90,7 @@ module Cisco
     def destroy
       return unless Feature.pim_enabled?
       self.ssm_range = ''
+      self.bfd = false
     end
 
     #-----------
@@ -110,5 +111,21 @@ module Cisco
       set_args_keys(state: state, ssm_range: range)
       config_set('pim', 'ssm_range', @set_args)
     end
+
+    def bfd
+      config_get('pim', 'bfd', @get_args)
+    end
+
+    def bfd=(val)
+      return if val == bfd
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      Feature.bfd_enable if val
+      config_set('pim', 'bfd', @set_args)
+    end
+
+    def default_bfd
+      config_get_default('pim', 'bfd')
+    end
   end  # Class
 end    # Module

data/lib/cisco_node_utils/portchannel_global.rb

@@ -113,7 +113,7 @@ module Cisco
           _parse_ethernet_params(hash, params)
         when :asymmetric # n7k
           _parse_asymmetric_params(hash, params, line)
-        when :no_hash # n8k
+        when :no_hash # n9k-f
           _parse_no_hash_params(hash, params)
         when :symmetry # n9k
           _parse_symmetry_params(hash, params, line)
@@ -213,7 +213,7 @@ module Cisco
         # port-channel load-balance dst ip-l4port rotate 4 asymmetric
         config_set('portchannel_global', 'port_channel_load_balance',
                    bselect, bhash, 'rotate', rot.to_s, asym, '')
-      when :no_hash # n8k
+      when :no_hash # n9k-f
         # port-channel load-balance dst ip-l4port rotate 4
         rot_str = rot.zero? ? '' : 'rotate'
         rot_val = rot.zero? ? '' : rot.to_s

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.4.1'
+  VERSION = '1.5.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

@@ -141,8 +141,7 @@ module Cisco
     end
 
     def vlan_name
-      result = config_get('vlan', 'name', @vlan_id)
-      result.nil? ? default_vlan_name : result
+      config_get('vlan', 'name', vlanid: @vlan_id)
     end
 
     def vlan_name=(str)
@@ -184,9 +183,7 @@ module Cisco
     end
 
     def shutdown
-      result = config_get('vlan', 'shutdown', @vlan_id)
-      # Valid result is either: "active"(aka no shutdown) or "shutdown"
-      result[/shut/] ? true : false
+      config_get('vlan', 'shutdown', vlanid: @vlan_id)
     end
 
     def shutdown=(val)

data/lib/cisco_node_utils/yum.rb

@@ -52,13 +52,18 @@ module Cisco
 
     def self.install(pkg, vrf=nil)
       vrf = vrf.nil? ? detect_vrf : "vrf #{vrf}"
-      config_set('yum', 'install', pkg, vrf)
 
-      # HACK: The current nxos host installer is a multi-part command
-      # which may fail at a later stage yet return a false positive;
-      # therefore a post-validation check is needed here to verify the
-      # actual outcome.
-      validate_installed(pkg)
+      begin
+        config_set('yum', 'install', pkg, vrf)
+
+        # HACK: The current nxos host installer is a multi-part command
+        # which may fail at a later stage yet return a false positive;
+        # therefore a post-validation check is needed here to verify the
+        # actual outcome.
+        validate_installed(pkg)
+      rescue Cisco::CliError, RuntimeError => e
+        raise Cisco::CliError, "#{e.class}, #{e.message}"
+      end
     end
 
     # returns version of package, or false if package doesn't exist

data/spec/schema.yaml

@@ -19,8 +19,8 @@ mapping:
           - 'N5k'
           - 'N6k'
           - 'N7k'
-          - 'N8k'
           - 'N9k'
+          - 'N9k-F'
 
   =: &base # default rule - apply to all properties
     type: map
@@ -36,8 +36,8 @@ mapping:
       N5k: *base
       N6k: *base
       N7k: *base
-      N8k: *base
       N9k: *base
+      N9k-F: *base
       # 'else' case if not matching any filter above
       else: *base
       # Generally applicable attributes
@@ -62,7 +62,7 @@ mapping:
       get_data_format: *data_format
       get_context: *context
       get_value:
-        type: str
+        type: any
       kind:
         type: str
         enum: [boolean, int, string, symbol]

data/tests/ciscotest.rb

@@ -260,7 +260,7 @@ class CiscoTestCase < TestCase
     Vrf.vrfs.each do |vrf, obj|
       next if vrf[/management/]
       # TBD: Remove vrf workaround below after CSCuz56697 is resolved
-      config 'vrf context ' + vrf if node.product_id[/N8/]
+      config 'vrf context ' + vrf if node.product_id[/N9K.*-F/]
       obj.destroy
     end
   end
@@ -424,7 +424,7 @@ class CiscoTestCase < TestCase
   # Returns the output of the command.
   def shell_command(command, context='bash')
     fail "shell_command api not supported on #{node.product_id}" unless
-      node.product_id[/N3K|N8K|N9K/]
+      node.product_id[/N3K|N9K.*-F|N9K/]
     unless context == 'bash' || context == 'guestshell'
       fail "Context must be either 'bash' or 'guestshell'"
     end
@@ -434,7 +434,7 @@ class CiscoTestCase < TestCase
   def backup_resolv_file(context='bash')
     # Configuration bleeding is only a problem on some platforms, so
     # only backup the resolv.conf file on required plaforms.
-    return unless node.product_id[/N3K|N8K|N9K/]
+    return unless node.product_id[/N3K|N9K.*-F|N9K/]
     time_stamp = Time.now.strftime('%Y-%m-%d_%H-%M-%S')
     backup_filename = "/tmp/resolv.conf.#{time_stamp}"
     shell_command("cp /etc/resolv.conf #{backup_filename}", context)
@@ -442,7 +442,7 @@ class CiscoTestCase < TestCase
   end
 
   def restore_resolv_file(filename, context='bash')
-    return unless node.product_id[/N3K|N8K|N9K/]
+    return unless node.product_id[/N3K|N9K.*-F|N9K/]
     shell_command("sudo cp #{filename} /etc/resolv.conf", context)
     shell_command("rm #{filename}", context)
   end
@@ -460,4 +460,25 @@ class CiscoTestCase < TestCase
       v.limit_resource_module_type
     end
   end
+
+  # Helper method to massage node.product_id into a short but
+  # meaningful tag to represent the product_type.
+  def product_tag
+    @product_id ||= node.product_id
+    case @product_id
+    when /N3/
+      tag = 'n3k'
+    when /N5/
+      tag = 'n5k'
+    when /N6/
+      tag = 'n6k'
+    when /N7/
+      tag = 'n7k'
+    when /N9/
+      tag = Utils.image_version?(/7.0.3.F/) ? 'n9k-f' : 'n9k'
+    else
+      fail "Unrecognized product_id: #{@product_id}"
+    end
+    tag
+  end
 end

data/tests/cmd_config.yaml

@@ -8,7 +8,6 @@ nexus:
             feature bgp
             feature pim
             feature msdp
-            feature udld
             feature interface-vlan
             feature hsrp
             feature lacp
@@ -22,7 +21,6 @@ nexus:
             no feature bgp
             no feature pim
             no feature msdp
-            no feature udld
             no feature interface-vlan
             no feature hsrp
             no feature lacp

data/tests/test_bgp_af.rb

@@ -46,7 +46,6 @@ class TestBgpAF < CiscoTestCase
 
   # Disabling line length to support wide-format test matrix definition
   # rubocop:disable Metrics/LineLength
-
   # Address Families to test:
   T_AFS = [
     #   afi  safi
@@ -124,6 +123,10 @@ class TestBgpAF < CiscoTestCase
 
     # Tests that are successful even though a rule below says otherwise
     [:next_hop_route_map,            :nexus,  'default', %w(l2vpn evpn),       :success],
+    [:additional_paths_send,         :nexus,  'default', %w(l2vpn evpn),       :runtime],
+    [:additional_paths_selection,    :nexus,  'default', %w(l2vpn evpn),       :runtime],
+    [:maximum_paths,                 :nexus,  'default', %w(l2vpn evpn),       :runtime],
+    [:maximum_paths_ibgp,            :nexus,  'default', %w(l2vpn evpn),       :runtime],
 
     # XR CLI Errors
     [:additional_paths_send,         :ios_xr, :any,      :multicast,           :CliError],
@@ -158,6 +161,15 @@ class TestBgpAF < CiscoTestCase
                     (af == :multicast && (af_.include? 'multicast')) ||
                     (af == :ipv4      && (af_.include? 'ipv4'))      ||
                     (af == :ipv6      && (af_.include? 'ipv6')))
+
+      # We need a connection to the device under test so that we can
+      # query the image version to determine if some properties are
+      # supported.  When TEST_EXCEPTIONS is defined, no connection
+      # to the device is available.  If the entry is :runtime this
+      # triggers a version check below.
+      if expect == :runtime
+        expect = Utils.image_version?(/8.0/) ? :success : :CliError
+      end
       return expect if expect == :success || expect == :skip
 
       # Otherwise, make sure there's no ambiguity/overlap in the exceptions.
@@ -196,7 +208,6 @@ class TestBgpAF < CiscoTestCase
 
             # What result do we expect from this test?
             expect = check_test_exceptions(test, platform, vrf, af)
-
             # Gather initial value, default value, and the first test value..
             initial = bgp_af.send(test)
 

data/tests/test_feature.rb

@@ -32,6 +32,7 @@ class TestFeature < CiscoTestCase
      'no feature dhcp',
      'no feature fabric forwarding',
      'no feature-set fex',
+     'no feature hsrp',
      'no feature itd',
      'no feature nv overlay',
      'no feature ospf',
@@ -97,6 +98,10 @@ class TestFeature < CiscoTestCase
     feature('dhcp')
   end
 
+  def test_hsrp
+    feature('hsrp')
+  end
+
   def test_fabric_forwarding
     if node.product_id[/N(3)/]
       assert_nil(Feature.fabric_forwarding_enabled?)

data/tests/test_hsrp_global.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 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/hsrp_global'
+
+include Cisco
+# TestHsrpGlobal - Minitest for general functionality
+# of the HsrpGlobal class.
+class TestHsrpGlobal < CiscoTestCase
+  @skip_unless_supported = 'hsrp_global'
+
+  # Tests
+  def setup
+    super
+    config_no_warn('no feature hsrp')
+  end
+
+  def teardown
+    config_no_warn('no feature hsrp') if first_or_last_teardown
+    super
+  end
+
+  def test_collection_empty
+    hg = HsrpGlobal.globals
+    assert_empty(hg)
+  end
+
+  def test_destroy
+    hg = HsrpGlobal.new
+    assert_equal(true, Feature.hsrp_enabled?)
+
+    hg.destroy
+    [:bfd_all_intf,
+     :extended_hold,
+    ].each do |prop|
+      assert_equal(hg.send("default_#{prop}"), hg.send("#{prop}")) if
+        hg.send("#{prop}")
+    end
+  end
+
+  def test_bfd_all_intf
+    hg = HsrpGlobal.new
+    if validate_property_excluded?('hsrp_global', 'bfd_all_intf')
+      assert_nil(hg.bfd_all_intf)
+      assert_raises(Cisco::UnsupportedError) do
+        hg.bfd_all_intf = true
+      end
+      return
+    end
+    assert_equal(hg.default_bfd_all_intf, hg.bfd_all_intf)
+    hg.bfd_all_intf = true
+    assert_equal(true, hg.bfd_all_intf)
+    hg.bfd_all_intf = hg.default_bfd_all_intf
+    assert_equal(hg.default_bfd_all_intf, hg.bfd_all_intf)
+  end
+
+  def test_extended_hold
+    hg = HsrpGlobal.new
+    assert_equal(hg.default_extended_hold, hg.extended_hold)
+    hg.extended_hold = '100'
+    assert_equal('100', hg.extended_hold)
+    hg.extended_hold = '10'
+    assert_equal('10', hg.extended_hold)
+    hg.extended_hold = hg.default_extended_hold
+    assert_equal(hg.default_extended_hold, hg.extended_hold)
+  end
+end