cisco_node_utils 1.2.0 → 1.3.0

data/tests/ciscotest.rb

@@ -18,11 +18,11 @@ require_relative 'basetest'
 require_relative 'platform_info'
 require_relative '../lib/cisco_node_utils/interface'
 require_relative '../lib/cisco_node_utils/node'
+require_relative '../lib/cisco_node_utils/vlan'
+require_relative '../lib/cisco_node_utils/bridge_domain'
 
 include Cisco
 
-Node.lazy_connect = true # we'll specify the connection info later
-
 # CiscoTestCase - base class for all node utility minitests
 class CiscoTestCase < TestCase
   # rubocop:disable Style/ClassVars
@@ -31,10 +31,37 @@ class CiscoTestCase < TestCase
   @@interfaces_id = nil
   # rubocop:enable Style/ClassVars
 
-  def node
+  # The feature (lib/cisco_node_utils/cmd_ref/<feature>.yaml) that this
+  # test case is associated with, if applicable.
+  # If the YAML file excludes this entire feature for this platform
+  # (top-level _exclude statement, not individual attributes), then
+  # all tests in this test case will be skipped.
+  @skip_unless_supported = nil
+
+  class << self
+    attr_accessor :skip_unless_supported
+  end
+
+  def self.runnable_methods
+    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,
+    # undefine the setup/teardown methods (if any) and skip the whole test case
+    remove_method :setup if instance_methods(false).include?(:setup)
+    remove_method :teardown if instance_methods(false).include?(:teardown)
+    [:all_skipped]
+  end
+
+  def all_skipped
+    skip("Skipping #{self.class}; feature " \
+         "'#{self.class.skip_unless_supported}' is unsupported on this node")
+  end
+
+  def self.node
     unless @@node
-      @@node = Node.instance # rubocop:disable Style/ClassVars
-      @@node.connect(address, username, password)
+      # rubocop:disable Style/ClassVars
+      @@node = Node.instance
+      # rubocop:enable Style/ClassVars
       @@node.cache_enable = true
       @@node.cache_auto = true
       # Record the platform we're running on
@@ -44,12 +71,16 @@ class CiscoTestCase < TestCase
       puts "  - image - #{@@node.system}\n\n"
     end
     @@node
-  rescue CiscoNxapi::HTTPUnauthorized
+  rescue Cisco::AuthenticationFailed
     abort "Unauthorized to connect as #{username}:#{password}@#{address}"
-  rescue StandardError => e
+  rescue Cisco::ClientError, TypeError, ArgumentError => e
     abort "Error in establishing connection: #{e}"
   end
 
+  def node
+    self.class.node
+  end
+
   def setup
     super
     node
@@ -59,8 +90,20 @@ class CiscoTestCase < TestCase
     node.cmd_ref
   end
 
-  def config(*args)
-    result = super
+  def self.platform
+    node.client.platform
+  end
+
+  def platform
+    self.class.platform
+  end
+
+  def config_and_warn_on_match(warn_match, *args)
+    if node.client.platform == :ios_xr
+      result = super(warn_match, *args, 'commit best-effort')
+    else
+      result = super
+    end
     node.cache_flush
     result
   end
@@ -81,7 +124,28 @@ class CiscoTestCase < TestCase
     # Compare the interface address with the current session address.
     # and return true if they match.
     return false if int_ip.nil?
-    int_ip == convert_dns_name(address)
+    int_ip == convert_dns_name(address.split(':')[0])
+  end
+
+  # Some NXOS hardware is not capable of supporting certain features even
+  # though the platform family in general includes support. In these cases
+  # the NU feature setter will raise a RuntimeError.
+  def hardware_supports_feature?(message)
+    patterns = ['Hardware is not capable of supporting',
+                'is unsupported on this node',
+               ]
+    skip('Skip test: Feature is unsupported on this device') if
+      message[Regexp.union(patterns)]
+    flunk(message)
+  end
+
+  def validate_property_excluded?(feature, property)
+    !node.cmd_ref.supports?(feature, property)
+  end
+
+  def skip_nexus_i2_image?
+    skip("This property is not supported on Nexus 'I2' images") if
+      Utils.nexus_i2_image
   end
 
   def interfaces
@@ -96,7 +160,7 @@ class CiscoTestCase < TestCase
       end
       # rubocop:enable Style/ClassVars
     end
-    abort "No suitable interfaces found on #{node} for this test" if
+    skip "No suitable interfaces found on #{node} for this test" if
       @@interfaces.empty?
     @@interfaces
   end
@@ -106,7 +170,7 @@ class CiscoTestCase < TestCase
       # rubocop:disable Style/ClassVars
       @@interfaces_id = []
       interfaces.each do |interface|
-        id = interface.split('Ethernet')[1]
+        id = interface.split('ethernet')[1]
         @@interfaces_id << id
       end
       # rubocop:enable Style/ClassVars
@@ -127,6 +191,35 @@ class CiscoTestCase < TestCase
     end
   end
 
+  # Remove all router ospfs.
+  def remove_all_ospfs
+    require_relative '../lib/cisco_node_utils/router_ospf'
+    RouterOspf.routers.each do |_, obj|
+      obj.destroy
+    end
+  end
+
+  # 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
+    BridgeDomain.bds.each do |_bd, obj|
+      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
+    Vlan.vlans.each do |vlan, obj|
+      # skip reserved vlan
+      next if vlan == '1'
+      next if node.product_id[/N5K|N6K|N7K/] && (1002..1005).include?(vlan.to_i)
+      obj.destroy
+    end
+  end
+
   # Remove all user vrfs.
   def remove_all_vrfs
     require_relative '../lib/cisco_node_utils/vrf'
@@ -135,4 +228,119 @@ class CiscoTestCase < TestCase
       obj.destroy
     end
   end
+
+  # Remove all configurations from an interface.
+  def interface_cleanup(intf_name)
+    cfg = get_interface_cleanup_config(intf_name)
+    config(*cfg)
+  end
+
+  # setup fabricpath env if possible and populate the interfaces array
+  # otherwise cause a global skip
+  def fabricpath_testenv_setup
+    return unless node.product_id[/N7K/]
+    intf_array = Feature.compatible_interfaces('fabricpath')
+    vdc = Vdc.new(Vdc.default_vdc_name)
+    save_lr = vdc.limit_resource_module_type
+    fabricpath_lr = node.config_get('fabricpath', 'supported_modules')
+    if intf_array.empty? || save_lr != fabricpath_lr
+      # try getting the required modules into the default vdc
+      vdc.limit_resource_module_type = fabricpath_lr
+      intf_array = Feature.compatible_interfaces('fabricpath')
+    end
+    if intf_array.empty?
+      vdc.limit_resource_module_type = save_lr
+      skip('FabricPath compatible interfaces not found in this switch')
+    else
+      # rubocop:disable Style/ClassVars
+      @@interfaces = intf_array
+      # rubocop:enable Style/ClassVars
+    end
+  end
+
+  # Returns an array of commands to remove all configurations from
+  # an interface.
+  def get_interface_cleanup_config(intf_name)
+    if platform == :ios_xr
+      ["no interface #{intf_name}", "interface #{intf_name} shutdown"]
+    else
+      ["default interface #{intf_name}"]
+    end
+  end
+
+  def mt_full_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'
+    #   '9  12  10/40 Gbps Ethernet Module  N77-F312FQ-25 ok'
+    sh_mod_string = @device.cmd("sh mod | i '^[0-9]+.*N7[7K]-F3'")
+    sh_mod = sh_mod_string[/^(\d+)\s.*N7[7K]-F3.*ok/]
+    slot = sh_mod.nil? ? nil : Regexp.last_match[1]
+    skip('Unable to find compatible interface in chassis') if slot.nil?
+
+    "ethernet#{slot}/1"
+  end
+
+  def vxlan_linecard?
+    # n5,6,7k tests require a specific linecard; either because they need a
+    # compatible interface or simply to enable vxlan.
+    # Example 'show mod' output to match against:
+    #   '9  12  10/40 Gbps Ethernet Module  N7K-F312FQ-25 ok'
+    #   '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'
+    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)/]
+      skip('Unable to find compatible interface in chassis') if sh_mod.nil?
+    elsif node.product_id[/N7K/]
+      mt_full_interface?
+    else
+      return
+    end
+  end
+
+  # Wrapper api that can be used to execute bash shell or guestshell
+  # commands.
+  # 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/]
+    unless context == 'bash' || context == 'guestshell'
+      fail "Context must be either 'bash' or 'guestshell'"
+    end
+    config("run #{context} #{command}")
+  end
+
+  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/]
+    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)
+    backup_filename
+  end
+
+  def restore_resolv_file(filename, context='bash')
+    return unless node.product_id[/N3K|N8K|N9K/]
+    shell_command("sudo cp #{filename} /etc/resolv.conf", context)
+    shell_command("rm #{filename}", context)
+  end
+
+  # VDC helper for features that require a specific linecard.
+  # Allows caller to get current state or change it to a new value.
+  def vdc_lc_state(type=nil)
+    return unless node.product_id[/N7/]
+    vxlan_linecard? if type && type[/F3/i]
+    v = Vdc.new('default')
+    if type
+      # This action may be time consuming, use only if necessary.
+      v.limit_resource_module_type = type
+    else
+      v.limit_resource_module_type
+    end
+  end
 end

data/tests/cmd_config.yaml

@@ -1,51 +1,73 @@
 # test command config yaml file
 ---
-feature-enable:
-  command: |
-          feature tacacs+
-          feature ospf
-          feature bgp
-          feature pim
-          feature msdp
-          feature private-vlan
-          feature udld
-          feature interface-vlan
-          feature hsrp
-          feature lacp
-          feature dhcp
-          feature vtp
-
-feature-disable:
-  command: |
-          no feature tacacs+
-          no feature ospf
-          no feature bgp
-          no feature pim
-          no feature msdp
-          no feature private-vlan
-          no feature udld
-          no feature interface-vlan
-          no feature hsrp
-          no feature lacp
-          no feature dhcp
-          no feature vtp
-
-feature-snmp-comm-acl-ro:
-  command: |
-           snmp-server community networkopercom group network-operator
-           snmp-server community networkopercom use-acl SNMP_RO
-
-feature-snmp-comm-acl-rw:
-  command: |
-           snmp-server community admincom group network-admin
-           snmp-server community admincom use-acl SNMP_RW
-
-feature-int-loopback:
-  command: >
-          interface loopback0
-            description testloopback
-
-feature-int-portchannel:
-  command: >
-          interface port-channel100
-            description test-portchannel
+nexus:
+  feature-enable:
+    command: |
+            feature tacacs+
+            feature ospf
+            feature bgp
+            feature pim
+            feature msdp
+            feature udld
+            feature interface-vlan
+            feature hsrp
+            feature lacp
+            feature dhcp
+            feature vtp
+
+  feature-disable:
+    command: |
+            no feature tacacs+
+            no feature ospf
+            no feature bgp
+            no feature pim
+            no feature msdp
+            no feature udld
+            no feature interface-vlan
+            no feature hsrp
+            no feature lacp
+            no feature dhcp
+            no feature vtp
+
+  feature-snmp-comm-acl-ro:
+    command: |
+             snmp-server community networkopercom group network-operator
+             snmp-server community networkopercom use-acl SNMP_RO
+
+  feature-snmp-comm-acl-rw:
+    command: |
+             snmp-server community admincom group network-admin
+             snmp-server community admincom use-acl SNMP_RW
+
+  feature-int-loopback:
+    command: >
+            interface loopback0
+              description testloopback
+
+  feature-int-portchannel:
+    command: >
+            interface port-channel100
+              description test-portchannel
+
+ios_xr:
+  name-server:
+    command: |
+            domain name-server 10.10.10.10
+            domain name-server 10.10.10.11
+            domain name-server 10.10.10.12
+
+  no-name-server:
+    command: |
+            no domain name-server 10.10.10.10
+            no domain name-server 10.10.10.11
+            no domain name-server 10.10.10.12
+
+  lo-intf:
+    command: |
+            interface Loopback0
+              description test description
+              vrf red
+
+  no-lo-intf:
+    command: |
+            no interface Loopback0

data/tests/cmd_config_invalid.yaml

@@ -6,7 +6,7 @@ feature-global_bad_syntax:
 
 
 feature-nested_bad_syntax:
-  command: > 
+  command: >
           interface loopback0
             descrion testloopback
 

data/tests/test_aaa_authentication_login.rb

@@ -17,6 +17,7 @@ require_relative '../lib/cisco_node_utils/aaa_authentication_login'
 
 # Test class for AAA Authentication Login
 class TestAaaAuthenticationLogin < CiscoTestCase
+  @skip_unless_supported = 'aaa_authentication_login'
   # DEFAULT(:ascii_authentication)
   # => false
   # rubocop:disable Style/MethodName

data/tests/test_aaa_authentication_login_service.rb

@@ -21,6 +21,15 @@ AAA_AUTH_LOGIN_SERVICE_METHOD_UNSELECTED = :unselected
 
 # Test class for AAA Authentication Login Service
 class TestAaaAuthenticationLoginService < CiscoTestCase
+  @skip_unless_supported = 'aaa_auth_login_service'
+
+  def setup
+    super
+    # TBD: Remove once CSCuz44696 is resolved.
+    skip('This test is not currently supported on 7.0(3)I3 images') if
+      node.os_version[/7.0\(3\)I3\(/]
+  end
+
   def unconfig_tacacs
     config('no feature tacacs+')
   end