cisco_node_utils 1.3.0 → 1.4.0

data/lib/cisco_node_utils/yang.rb

@@ -0,0 +1,160 @@
+# June 2016, Charles Burkett
+#
+# Copyright (c) 2015-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 'json'
+
+module Cisco
+  # class Cisco::Yang
+  # Utility class mainly containing methods to compare YANG configurations
+  # in order to determine if the running config is in-sync with the
+  # desired config.
+  class Yang
+    # Is the specified yang string empty?
+    def self.empty?(yang)
+      !yang || yang.empty?
+    end
+
+    # Given target and current YANG configurations, returns true if
+    # the configurations are in-sync, relative to a "merge_config" action
+    # @param should [String] the should configuration in YANG JASON format
+    # @param is [String] the is configuration in YANG JASON format
+    def self.insync_for_merge?(should, is)
+      should_hash = self.empty?(should) ? {} : JSON.parse(should)
+      is_hash = self.empty?(is) ? {} : JSON.parse(is)
+
+      !needs_something?(:merge, should_hash, is_hash)
+    end
+
+    # Given a is and should YANG configuration, returns true if
+    # the configuration are in-sync, relative to a "replace_config" action
+    # @param should [String] the should configuration in YANG JASON format
+    # @param is [String] the is configuration in YANG JASON format
+    def self.insync_for_replace?(should, is)
+      should_hash = self.empty?(should) ? {} : JSON.parse(should)
+      is_hash = self.empty?(is) ? {} : JSON.parse(is)
+
+      !needs_something?(:replace, should_hash, is_hash)
+    end
+
+    # usage:
+    #   needs_something?(op, should, run)
+    #
+    #   op     - symbol - If value is not :replace, it's assumed to be :merge.
+    #                     Indicates to the function whether to check for a
+    #                     possible merge vs. replace
+    #
+    #   should - JSON   - JSON tree representing target configuration
+    #
+    #   is     - JSON   - JSON tree representing current configuration
+    #
+    #
+    # Needs merge will determine if should and is differ
+    # sufficiently to necessitate running the merge command.
+    #
+    # The logic here amounts to determining if should is a subtree
+    # of is, with a tiny bit of domain trickiness surrounding
+    # elements that are arrays that contain a single nil element
+    # that is required for "creating" certain configuration elements.
+    #
+    # There are ultimately 3 different types of elements in a json
+    # tree.  Hashes, Arrays, and leaves.  While hashes and array values
+    # are organized with an order, the logic here ignores the order.
+    # In fact, it specifically attempts to match assuming order
+    # doesn't matter.  This is largely to allow users some freedom
+    # in specifying the target configuration.  The gRPC interface
+    # doesn't seem to care about order.  If that changes, then so
+    # should this code.
+    #
+    # Arrays and Hashes are compared by iterating over every element
+    # in should, and ensuring it is within is.
+    #
+    # Leaves are directly compared for equality, excepting the
+    # condition that the should leaf is in fact an array with one
+    # element that is nil.
+    #
+    # Needs replace will determine if should and is differ
+    # sufficiently to necessitate running the replace command.
+    #
+    # The logic is the same as merge, except when comparing
+    # hashes, if the is hash table has elements that are not
+    # in should, we ultimately indicate that replace is needed
+    def self.needs_something?(op, should, is)
+      !hash_equiv?(op, should, is)
+    end
+
+    def self.nil_array(elt)
+      elt.nil? || (elt.is_a?(Array) && elt.length == 1 && elt[0].nil?)
+    end
+
+    def self.sub_elt(op, should, is)
+      if should.is_a?(Hash) && is.is_a?(Hash)
+        return self.hash_equiv?(op, should, is)
+      elsif should.is_a?(Array) && is.is_a?(Array)
+        return self.array_equiv?(op, should, is)
+      else
+        return !(should != is && !nil_array(should))
+      end
+    end
+
+    def self.array_equiv?(op, should, is)
+      n = should.length
+      loop = lambda do|i|
+        if i == n
+          if op == :replace
+            is.length == should.length
+          else
+            true
+          end
+        else
+          should_elt = should[i]
+          is_elt = is.find do |elt|
+            sub_elt(op, should_elt, elt)
+          end
+          if is_elt.nil? && !nil_array(should_elt)
+            should_elt.nil?
+          else
+            loop.call(i + 1)
+          end
+        end
+      end
+      loop.call(0)
+    end
+
+    def self.hash_equiv?(op, should, is)
+      keys = should.keys
+      n = keys.length
+      loop = lambda do|i|
+        if i == n
+          if op == :replace
+            is.keys.length == should.keys.length
+          else
+            true
+          end
+        else
+          k = keys[i]
+          is_v = is[k]
+          should_v = should[k]
+          if is_v.nil? && !nil_array(should_v)
+            false
+          else
+            sub_elt(op, should_v, is_v) && loop.call(i + 1)
+          end
+        end
+      end
+      loop.call(0)
+    end
+  end # Yang
+end # Cisco

data/lib/cisco_node_utils/yum.rb

@@ -22,38 +22,22 @@ require_relative 'node_util'
 module Cisco
   # This Yum class provides cisco package management functions through nxapi.
   class Yum < NodeUtil
-    def self.decompose_name(file_name)
-      # ex: chef-12.0.0alpha.2+20150319.git.1.b6f-1.el5.x86_64.rpm
-      name_ver_arch_regex = /^([\w\-\+]+)-(\d+\..*)\.(\w{4,})(?:\.rpm)?$/
-
-      # ex n9000_sample-1.0.0-7.0.3.x86_64.rpm
-      name_ver_arch_regex_nx = /^(.*)-([\d\.]+-[\d\.]+)\.(\w{4,})\.rpm$/
-
-      # ex: b+z-ip2.x64_64
-      name_arch_regex = /^([\w\-\+]+)\.(\w+)$/
-
-      file_name.match(name_ver_arch_regex) ||
-        file_name.match(name_ver_arch_regex_nx) ||
-        file_name.match(name_arch_regex)
-    end
-
-    def self.validate(pkg)
-      file_name = pkg.strip.tr(':', '/').split('/').last
-      pkg_info = Yum.decompose_name(file_name)
-      if pkg_info.nil?
-        query_name = file_name
-      else
-        if pkg_info[3].nil?
-          query_name = pkg_info[1]
-        else
-          query_name = "#{pkg_info[1]}.#{pkg_info[3]}"
+    def self.validate_installed(pkg)
+      # Sample data returned from config_get('yum', 'query_all')
+      # ["nxos.sample-n8k_EOR.lib32_nxos", "1.0.0-7.0.3.F1.1", "@patching"],
+      patch_data = config_get('yum', 'query_all')
+      patch_data.each do |name_arch, version, _state|
+        # Separate name and architecture
+        next if name_arch.rindex('.').nil?
+        arch = name_arch.slice!(name_arch.rindex('.')..-1).delete('.')
+        # Version/Architecture info not available when only pkg name specified.
+        version = arch = '' if name_arch == pkg
+        # Check for match
+        if pkg.match(name_arch) && pkg.match(version) && pkg.match(arch)
+          return true
         end
       end
-      should_ver = pkg_info[2] if pkg_info && pkg_info[3]
-      ver = query(query_name)
-      if ver.nil? || (!should_ver.nil? && should_ver != ver)
-        fail 'Failed to install the requested rpm'
-      end
+      fail 'Failed to install the requested rpm'
     end
 
     def self.detect_vrf
@@ -61,6 +45,7 @@ module Cisco
       inode = File::Stat.new('/proc/self/ns/net').ino
       # -L reqd for guestshell's find command
       vrfname = File.basename(`find -L /var/run/netns/ -inum #{inode}`.chop)
+
       vrf = 'vrf ' + vrfname unless vrfname.empty?
       vrf
     end
@@ -73,7 +58,7 @@ module Cisco
       # 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(pkg)
+      validate_installed(pkg)
     end
 
     # returns version of package, or false if package doesn't exist
@@ -86,7 +71,15 @@ module Cisco
     end
 
     def self.remove(pkg)
-      config_set('yum', 'remove', pkg)
+      config_set('yum', 'deactivate', pkg)
+      # May not be able to remove the package immediately after
+      # deactivation.
+      while (try ||= 1) < 20
+        o = config_set('yum', 'remove', pkg)
+        break unless o[/operation is in progress, please try again later/]
+        sleep 1
+        try += 1
+      end
     end
   end
 end

data/tests/.rubocop.yml

@@ -13,3 +13,6 @@ Metrics/MethodLength:
 
 Metrics/PerceivedComplexity:
   Max: 17
+
+Metrics/LineLength:
+  Max: 120

data/tests/ciscotest.rb

@@ -16,10 +16,11 @@ require 'ipaddr'
 require 'resolv'
 require_relative 'basetest'
 require_relative 'platform_info'
+require_relative '../lib/cisco_node_utils/bridge_domain'
 require_relative '../lib/cisco_node_utils/interface'
 require_relative '../lib/cisco_node_utils/node'
+require_relative '../lib/cisco_node_utils/platform'
 require_relative '../lib/cisco_node_utils/vlan'
-require_relative '../lib/cisco_node_utils/bridge_domain'
 
 include Cisco
 
@@ -29,7 +30,8 @@ class CiscoTestCase < TestCase
   @@node = nil
   @@interfaces = nil
   @@interfaces_id = nil
-  # rubocop:enable Style/ClassVars
+  @@testcases = []
+  @@testcase_teardowns = 0
 
   # The feature (lib/cisco_node_utils/cmd_ref/<feature>.yaml) that this
   # test case is associated with, if applicable.
@@ -43,6 +45,7 @@ class CiscoTestCase < TestCase
   end
 
   def self.runnable_methods
+    @@testcases = super
     return super if skip_unless_supported.nil?
     return super if node.cmd_ref.supports?(skip_unless_supported)
     # If the entire feature under test is unsupported,
@@ -52,6 +55,20 @@ class CiscoTestCase < TestCase
     [:all_skipped]
   end
 
+  def first_or_last_teardown
+    # Return true if this is the first or last teardown call.
+    # This hack is needed to prevent excessive post-test cleanups from
+    # occurring: e.g. a non-F3 N7k test class may require an expensive setup
+    # and teardown to enable/disable vdc settings; ideally this vdc setup
+    # would occur prior to the first test and vdc teardown only after the
+    # final test. Checks for first test case because we have to handle the
+    # -n option, which filters the list of runnable testcases.
+    # Note that Minitest.after_run is not a solution for this problem.
+    @@testcase_teardowns += 1
+    (@@testcase_teardowns == 1) || (@@testcase_teardowns == @@testcases.size)
+  end
+  # rubocop:enable Style/ClassVars
+
   def all_skipped
     skip("Skipping #{self.class}; feature " \
          "'#{self.class.skip_unless_supported}' is unsupported on this node")
@@ -100,7 +117,7 @@ class CiscoTestCase < TestCase
 
   def config_and_warn_on_match(warn_match, *args)
     if node.client.platform == :ios_xr
-      result = super(warn_match, *args, 'commit best-effort')
+      result = super(warn_match, *args, 'commit')
     else
       result = super
     end
@@ -108,6 +125,11 @@ class CiscoTestCase < TestCase
     result
   end
 
+  # Check exception and only fail if it does not contain message
+  def check_and_raise_error(exception, message)
+    fail exception unless exception.message.include?(message)
+  end
+
   def ip_address?(ip)
     return IPAddr.new(ip).ipv4?
   rescue IPAddr::InvalidAddressError
@@ -139,6 +161,13 @@ class CiscoTestCase < TestCase
     flunk(message)
   end
 
+  def incompatible_interface?(msg)
+    patterns = ['switchport_mode is not supported on this interface',
+                'Configuration does not match the port capability']
+    assert_match(Regexp.union(patterns), msg,
+                 'Msg does not match known incompatibility messages')
+  end
+
   def validate_property_excluded?(feature, property)
     !node.cmd_ref.supports?(feature, property)
   end
@@ -148,13 +177,22 @@ class CiscoTestCase < TestCase
       Utils.nexus_i2_image
   end
 
+  def system_image
+    @image ||= Platform.system_image
+  end
+
+  def skip_legacy_defect?(pattern, msg)
+    msg = "Defect in legacy image: [#{msg}]"
+    skip(msg) if system_image.match(Regexp.new(pattern))
+  end
+
   def interfaces
     unless @@interfaces
       # Build the platform_info, used for interface lookup
       # rubocop:disable Style/ClassVars
       @@interfaces = []
       Interface.interfaces.each do |int, obj|
-        next unless /ethernet/.match(int)
+        next unless int[%r{ethernet[\d/]+$}] # exclude dot1q & non-eth
         next if address_match?(obj.ipv4_address)
         @@interfaces << int
       end
@@ -165,19 +203,6 @@ class CiscoTestCase < TestCase
     @@interfaces
   end
 
-  def interfaces_id
-    unless @@interfaces_id
-      # rubocop:disable Style/ClassVars
-      @@interfaces_id = []
-      interfaces.each do |interface|
-        id = interface.split('ethernet')[1]
-        @@interfaces_id << id
-      end
-      # rubocop:enable Style/ClassVars
-    end
-    @@interfaces_id
-  end
-
   # Remove all router bgps.
   def remove_all_bgps
     require_relative '../lib/cisco_node_utils/bgp'
@@ -202,16 +227,25 @@ class CiscoTestCase < TestCase
   # This testcase will remove all the bds existing in the system
   # specifically in cleanup for minitests
   def remove_all_bridge_domains
-    config 'system bridge-domain none' if /N7/ =~ node.product_id
+    return unless /N7/ =~ node.product_id
     BridgeDomain.bds.each do |_bd, obj|
       obj.destroy
     end
+    config 'system bridge-domain none'
+  end
+
+  def remove_all_svis
+    Interface.interfaces(:vlan).each do |svi, obj|
+      next if svi == 'vlan1'
+      obj.destroy
+    end
   end
 
   # This testcase will remove all the vlans existing in the system
   # specifically in cleanup for minitests
   def remove_all_vlans
     remove_all_bridge_domains
+    remove_all_svis
     Vlan.vlans.each do |vlan, obj|
       # skip reserved vlan
       next if vlan == '1'
@@ -225,6 +259,8 @@ class CiscoTestCase < TestCase
     require_relative '../lib/cisco_node_utils/vrf'
     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/]
       obj.destroy
     end
   end
@@ -235,6 +271,86 @@ class CiscoTestCase < TestCase
     config(*cfg)
   end
 
+  # TBD: -- The following methods are a WIP --
+  #
+  # def find_compatible_intf(feature, opt=:raise_skip)
+  #   # Some platforms require specific linecards before allowing a feature to
+  #   # be enabled. This method will find a compatible interface or optionally
+  #   # raise a skip.
+  #   # TBD: This wants to become a common "compatible interface" checker to
+  #   # eventually replace all of the single-use methods.
+  #   intf = compatible_intf(feature)
+  #   if intf.nil? && opt[/raise_skip/]
+  #     skip("Unable to find compatible interface for 'feature #{feature}'")
+  #   end
+  #   intf
+  # end
+
+  # def compatible_intf(feature)
+  #   # The feat hash contains module restrictions for a given feature.
+  #   #  :mods - (optional) The module ids used in the 'limit-resource' config
+  #   #  :pids - A regex pattern for the line module product IDs (ref: 'sh mod')
+  #   feat = {}
+  #   if node.product_id[/N7K/]
+  #     feat = {
+  #       # nv overlay raises error unless solely F3
+  #       'nv overlay' => { mods: 'f3', pids: 'N7[K7]-F3' }
+  #     }
+  #   end
+  #   patterns = feat[feature]
+  #   return interfaces[0] if patterns.nil? #  No restrictions for this platform
+
+  #   # Check if module is present and usable; i.e. 'ok'
+  #   pids = patterns[:pids]
+  #   sh_mod_string = @device.cmd("show mod | i '^[0-9]+.*#{pids}.*ok'")
+  #   sh_mod = sh_mod_string[/^(\d+)\s.*#{pids}/]
+  #   slot = sh_mod.nil? ? nil : Regexp.last_match[1]
+  #   return nil if slot.nil?
+  #   intf = "ethernet#{slot}/1"
+
+  #   # Check/Set VDC config. VDC platforms restrict module usage per vdc.
+  #   mods = patterns[:mods]
+  #   return intf if mods.nil? || !node.product_id[/N7K/]
+  #   vdc = Vdc.new(Vdc.default_vdc_name)
+  #   unless mods == vdc.limit_resource_module_type
+  #     # Update the allowed module types in this vdc
+  #     vdc.limit_resource_module_type = mods
+  #   end
+
+  #   # Return the first interface found in 'allocate interface' config, or nil
+  #   vdc.allocate_interface[%r{Ethernet#{slot}\/(\d+)}]
+  # end
+
+  def vdc_limit_f3_no_intf_needed(action=:set)
+    # This is a special-use method for N7Ks that don't have a physical F3.
+    #  1) There are some features that refuse to load unless the VDC is
+    #     limited to F3 only, but they will actually load if the config is
+    #     present, despite the fact that there are no physical F3s.
+    #  2) We have some tests that need these features but don't need interfaces.
+    #
+    # action = :set (enable limit F3 config), :clear (default limit config)
+    #
+    # The limit config should be removed after testing if the device does not
+    # have an actual F3.
+    return unless node.product_id[/N7K/]
+    vdc = Vdc.new(Vdc.default_vdc_name)
+    case action
+    when :set
+      return if vdc.limit_resource_module_type == 'f3'
+      vdc.limit_resource_module_type = 'f3'
+
+    when :clear
+      # Remove the config if there are no physical F3 cards
+      pids = 'N7[K7]-F3'
+      sh_mod_string = @device.cmd("show mod | i '^[0-9]+.*#{pids}'")
+      sh_mod = sh_mod_string[/^(\d+)\s.*#{pids}/]
+      if sh_mod.nil?
+        # It's safe to remove the config
+        vdc.limit_resource_module_type = ''
+      end
+    end
+  end
+
   # setup fabricpath env if possible and populate the interfaces array
   # otherwise cause a global skip
   def fabricpath_testenv_setup
@@ -291,9 +407,10 @@ class CiscoTestCase < TestCase
     #   '9  12  10/40 Gbps Ethernet Module  N77-F312FQ-25 ok'
     #   '2   6  Nexus 6xQSFP Ethernet Module  N5K-C5672UP-M6Q ok'
     #   '2   6  Nexus xxQSFP Ethernet Module  N6K-C6004-96Q/EF ok'
+    #   '2   4  Nexus 4xQSFP Ethernet Module  N6K-C6001-M4Q ok'
     if node.product_id[/N(5|6)K/]
       sh_mod_string = @device.cmd("sh mod | i '^[0-9]+.*N[56]K-C[56]'")
-      sh_mod = sh_mod_string[/^(\d+)\s.*N[56]K-C(56|6004)/]
+      sh_mod = sh_mod_string[/^(\d+)\s.*N[56]K-C(56|600[14])/]
       skip('Unable to find compatible interface in chassis') if sh_mod.nil?
     elsif node.product_id[/N7K/]
       mt_full_interface?