cisco_node_utils 1.7.0 → 1.8.0

data/lib/cisco_node_utils/syslog_settings.rb

@@ -2,7 +2,7 @@
 #
 # Jonathan Tripathy et al., September 2015
 #
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-2017 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.
@@ -42,14 +42,82 @@ module Cisco
       name == other.name
     end
 
+    def default_console
+      config_get_default('syslog_settings', 'console')
+    end
+
+    def console
+      console = config_get('syslog_settings', 'console')
+      if console.is_a?(Array)
+        console = console[0] == 'no' ? 'unset' : console[1]
+      end
+      console
+    end
+
+    def console=(severity)
+      if severity
+        config_set(
+          'syslog_settings', 'console',
+          state: '', severity: severity)
+      else
+        config_set(
+          'syslog_settings', 'console',
+          state: 'no', severity: '')
+      end
+    end
+
+    def default_monitor
+      config_get_default('syslog_settings', 'monitor')
+    end
+
+    def monitor
+      monitor = config_get('syslog_settings', 'monitor')
+      if monitor.is_a?(Array)
+        monitor = monitor[0] == 'no' ? 'unset' : monitor[1]
+      end
+      monitor
+    end
+
+    def monitor=(severity)
+      if severity
+        config_set(
+          'syslog_settings', 'monitor',
+          state: '', severity: severity)
+      else
+        config_set(
+          'syslog_settings', 'monitor',
+          state: 'no', severity: '')
+      end
+    end
+
+    def default_source_interface
+      config_get_default('syslog_settings', 'source_interface')
+    end
+
+    def source_interface
+      i = config_get('syslog_settings', 'source_interface')
+      i.nil? ? default_source_interface : i.downcase
+    end
+
+    def source_interface=(name)
+      if name
+        config_set(
+          'syslog_settings', 'source_interface',
+          state: '', source_interface: name)
+      else
+        config_set(
+          'syslog_settings', 'source_interface',
+          state: 'no', source_interface: '')
+      end
+    end
+
     def timestamp
       config_get('syslog_settings', 'timestamp')
     end
 
     def timestamp=(val)
-      fail TypeError unless val.is_a?(String)
       fail TypeError \
-        unless %w(seconds milliseconds).include?(val)
+        unless %w(seconds milliseconds).include?(val.to_s)
 
       # There is no unset version as timestamp has a default value
       config_set('syslog_settings',
@@ -57,5 +125,8 @@ module Cisco
                  state: '',
                  units: val)
     end
+
+    alias_method :time_stamp_units, :timestamp
+    alias_method :time_stamp_units=, :timestamp=
   end # class
 end # module

data/lib/cisco_node_utils/tacacs_global.rb

@@ -1,8 +1,8 @@
 # Tacacs Global provider class
 
-# TP HONEY et al., June 2014-2016
+# TP HONEY et al., June 2014-2017
 
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-2017 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.
@@ -20,10 +20,6 @@ require_relative 'node_util'
 
 # Tacacs Global configuration management
 module Cisco
-  TACACS_GLOVAL_ENC_NONE = 0
-  TACACS_GLOBAL_ENC_CISCO_TYPE_7 = 7
-  TACACS_GLOBAL_ENC_UNKNOWN = 8
-
   # TacacsGlobal - node utility class for
   class TacacsGlobal < NodeUtil
     attr_reader :name
@@ -33,7 +29,6 @@ module Cisco
       fail ArgumentError,
            "This provider only accepts an id of 'default'" \
            unless name.eql?('default')
-      Feature.tacacs_enable unless Feature.tacacs_enabled?
       @name = name
     end
 
@@ -48,6 +43,7 @@ module Cisco
     end
 
     def timeout
+      return nil unless Feature.tacacs_enabled?
       config_get('tacacs_global', 'timeout')
     end
 
@@ -62,11 +58,11 @@ module Cisco
       end
 
       if val.nil?
-        config_set('tacacs_global',
-                   'timeout',
-                   state:   'no',
-                   timeout: timeout)
+        fail ArgumentError, 'timeout cannot be unset if TACACS enabled - ' \
+        "use default value #{default_timeout}" \
+          if Feature.tacacs_enabled?
       else
+        Feature.tacacs_enable
         config_set('tacacs_global',
                    'timeout',
                    state:   '',
@@ -80,6 +76,7 @@ module Cisco
     end
 
     def key
+      return nil unless Feature.tacacs_enabled?
       str = config_get('tacacs_global', 'key')
       return TacacsGlobal.default_key if str.empty?
       str = str[1].strip
@@ -92,14 +89,50 @@ module Cisco
     end
 
     def encryption_key_set(key_format, key)
-      key = Utils.add_quotes(key)
-      if key_format == TACACS_GLOBAL_ENC_UNKNOWN
+      # If we get an empty key - remove default if configured
+      if key.nil? || key.to_s.empty?
+        key = self.key
+        return if key.empty?
+        key_format = self.key_format
         config_set('tacacs_server', 'encryption', state: 'no',
                     option: key_format, key: key)
       else
-        config_set('tacacs_server', 'encryption', state: '', option: key_format,
+        Feature.tacacs_enable
+        key = Utils.add_quotes(key)
+        if key_format.nil? || key_format.to_s.empty?
+          config_set('tacacs_server', 'encryption', state: '', option: '',
                     key: key)
+        else
+          config_set('tacacs_server', 'encryption', state: '',
+                    option: key_format, key: key)
+        end
+      end
+    end
+
+    # Get default source interface
+    def default_source_interface
+      config_get_default('tacacs_global', 'source_interface')
+    end
+
+    # Set source interface
+    def source_interface=(name)
+      if name
+        Feature.tacacs_enable
+        config_set(
+          'tacacs_global', 'source_interface',
+          state: '', source_interface: name)
+      else
+        config_set(
+          'tacacs_global', 'source_interface',
+          state: 'no', source_interface: '')
       end
     end
+
+    # Get source interface
+    def source_interface
+      return nil unless Feature.tacacs_enabled?
+      i = config_get('tacacs_global', 'source_interface')
+      i.nil? ? default_source_interface : i.downcase
+    end
   end # class
 end # module

data/lib/cisco_node_utils/tacacs_server.rb

@@ -30,11 +30,7 @@ module Cisco
 
     # Check feature enablement
     def self.enabled
-      config_get('tacacs_server', 'feature')
-    rescue Cisco::CliError => e
-      # cmd will syntax reject when feature is not enabled
-      raise unless e.clierror =~ /Syntax error/
-      return false
+      Feature.tacacs_enabled?
     end
 
     # Enable tacacs_server feature

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.7.0'
+  VERSION = '1.8.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/vpc.rb

@@ -35,13 +35,10 @@ module Cisco
 
     def self.domains
       hash = {}
+      return hash unless Vpc.enabled
       my_domain = config_get('vpc', 'domain')
       hash[my_domain] = Vpc.new(my_domain, false) unless my_domain.nil?
       hash
-    rescue Cisco::CliError => e
-      # cmd will syntax reject when feature is not enabled
-      raise unless e.clierror =~ /Syntax error/
-      return {}
     end
 
     def self.enabled

data/lib/cisco_node_utils/vtp.rb

@@ -32,10 +32,12 @@ module Cisco
 
     # Get vtp domain name
     def self.domain
+      dom_def = config_get_default('vtp', 'domain')
       if Feature.vtp_enabled?
-        config_get('vtp', 'domain')
+        dom = config_get('vtp', 'domain')
+        return dom == '-' ? dom_def : dom
       else
-        config_get_default('vtp', 'domain')
+        dom_def
       end
     end
 

data/spec/schema.yaml

@@ -15,7 +15,9 @@ mapping:
           - 'C3064'
           - 'C3132'
           - 'C3172'
+          - 'N35'
           - 'N3k'
+          - 'N3k-F'
           - 'N5k'
           - 'N6k'
           - 'N7k'
@@ -33,6 +35,7 @@ mapping:
       C3132: *base
       C3172: *base
       N3k: *base
+      N3k-F: *base
       N5k: *base
       N6k: *base
       N7k: *base

data/tests/ciscotest.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2016 Cisco and/or its affiliates.
+# Copyright (c) 2013-2017 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.
@@ -185,8 +185,12 @@ class CiscoTestCase < TestCase
       key_values = e.split(':')
       larr = key_values[0].split(',')
       larr.each do |lkey|
-        fail "Unrecognized product_id: #{lkey}" unless
-          lkey.downcase[/n(3|5|6|7|9)/]
+        if lkey.to_s == 'C3548'
+          # Special case N3k Platform
+        else
+            fail "Unrecognized product_id: #{lkey}" unless
+              lkey.downcase[/n(3|5|6|7|9)/]
+        end
         next unless lkey.downcase.strip == product_tag
         ver = key_values[1]
         break if ver
@@ -219,7 +223,7 @@ class CiscoTestCase < TestCase
 
   def skip_legacy_defect?(pattern, msg)
     msg = "Defect in legacy image: [#{msg}]"
-    skip(msg) if system_image.match(Regexp.new(pattern))
+    skip(msg) if Utils.image_version?(Regexp.new(pattern))
   end
 
   def interfaces
@@ -296,7 +300,8 @@ 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[/N9K.*-F/]
+      config 'vrf context ' + vrf if
+        node.product_id[/N9K.*-F/] || node.product_id[/N3K.*-F/]
       obj.destroy
     end
   end
@@ -460,7 +465,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|N9K.*-F|N9K/]
+      node.product_id[/N3K|N3K.*-F|N9K.*-F|N9K/]
     unless context == 'bash' || context == 'guestshell'
       fail "Context must be either 'bash' or 'guestshell'"
     end
@@ -470,7 +475,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|N9K.*-F|N9K/]
+    return unless node.product_id[/N3K|N3K.*-F|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)
@@ -478,7 +483,7 @@ class CiscoTestCase < TestCase
   end
 
   def restore_resolv_file(filename, context='bash')
-    return unless node.product_id[/N3K|N9K.*-F|N9K/]
+    return unless node.product_id[/N3K|N3K.*-F|N9K.*-F|N9K/]
     shell_command("sudo cp #{filename} /etc/resolv.conf", context)
     shell_command("rm #{filename}", context)
   end
@@ -502,8 +507,10 @@ class CiscoTestCase < TestCase
   def product_tag
     @product_id ||= node.product_id
     case @product_id
+    when /N3K-C35/
+      tag = 'n35'
     when /N3/
-      tag = 'n3k'
+      tag = Utils.image_version?(/7.0.3.F/) ? 'n3k-f' : 'n3k'
     when /N5/
       tag = 'n5k'
     when /N6/

data/tests/test_ace.rb

@@ -66,6 +66,8 @@ class TestAce < CiscoTestCase
     %w(ipv4 ipv6).each do |afi|
       a = ace_helper(afi, remark: afi)
       assert_equal(afi, a.remark)
+      assert_nil(a.log)
+      assert_nil(a.established)
     end
   end
 

data/tests/test_bgp_af.rb

@@ -4,7 +4,7 @@
 #
 # Richard Wellum, August, 2015
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-2017 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.
@@ -124,6 +124,7 @@ 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_receive,      :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],
@@ -169,10 +170,17 @@ class TestBgpAF < CiscoTestCase
       # triggers a version check below.
       if expect == :runtime
         case Platform.image_version
-        when /8.0|8.1/
+        when /8.0|8.1|8.2|F3.2/
           expect = :success
+          expect = :runtime if test == :additional_paths_receive && Platform.image_version[/8.0|8.1/]
         when /I5.2|I5.3|I6/
           expect = :success if test == :maximum_paths || test == :maximum_paths_ibgp
+        when /I7/
+          expect = :success if test == :maximum_paths ||
+                               test == :maximum_paths_ibgp ||
+                               test == :additional_paths_send ||
+                               test == :additional_paths_receive ||
+                               test == :additional_paths_selection
         else
           expect = :CliError
         end

data/tests/test_bgp_neighbor_af.rb

@@ -429,8 +429,10 @@ class TestBgpNeighborAF < CiscoTestCase
 
     # Test false with value
     af.allowas_in_set(false)
+    # skip setting this to false due to bug CSCve58319
     refute(af.allowas_in,
-           "Test 3. #{dbg} Failed to set state to False")
+           "Test 3. #{dbg} Failed to set state to False") unless
+      Platform.image_version[/I5|I6|F3.3/]
 
     # Test true with value, from false
     af.allowas_in_set(true, 4)
@@ -440,8 +442,10 @@ class TestBgpNeighborAF < CiscoTestCase
 
     # Test default_state
     af.allowas_in_set(af.default_allowas_in)
+    # skip setting this to false due to bug CSCve58319
     refute(af.allowas_in,
-           "Test 5. #{dbg} Failed to set state to default")
+           "Test 5. #{dbg} Failed to set state to default") unless
+      Platform.image_version[/I5|I6|F3.3/]
 
     # Test true with value set to default
     af.allowas_in_set(true, af.default_allowas_in_max)

data/tests/test_bridge_domain.rb

@@ -101,6 +101,8 @@ class TestBridgeDomain < CiscoTestCase
     refute(bd.shutdown)
     bd.shutdown = true
     assert(bd.shutdown)
+    bd.shutdown = false
+    refute(bd.shutdown)
     bd.destroy
   end
 
@@ -114,6 +116,11 @@ class TestBridgeDomain < CiscoTestCase
     assert_equal(name, bd.bd_name,
                  'Error: Bridge-Domain name not updated to #{name}')
 
+    name = ''
+    bd.bd_name = name
+    assert_equal(bd.default_bd_name, bd.default_bd_name,
+                 'Error: Bridge-Domain name not updated to default')
+
     bd.bd_name = bd.default_bd_name
     assert_equal(bd.default_bd_name, bd.bd_name,
                  'Error: Bridge-Domain name not restored to default')