cisco_node_utils 1.5.0 → 1.6.0

data/lib/cisco_node_utils/tacacs_global.rb

@@ -80,8 +80,10 @@ module Cisco
     end
 
     def key
-      match = config_get('tacacs_global', 'key')
-      match.empty? ? TacacsGlobal.default_key : match[1]
+      str = config_get('tacacs_global', 'key')
+      return TacacsGlobal.default_key if str.empty?
+      str = str[1].strip
+      Utils.add_quotes(str)
     end
 
     # Get default encryption password
@@ -90,6 +92,7 @@ module Cisco
     end
 
     def encryption_key_set(key_format, key)
+      key = Utils.add_quotes(key)
       if key_format == TACACS_GLOBAL_ENC_UNKNOWN
         config_set('tacacs_server', 'encryption', state: 'no',
                     option: key_format, key: key)

data/lib/cisco_node_utils/tacacs_server.rb

@@ -145,8 +145,10 @@ module Cisco
 
     # Get encryption password
     def encryption_password
-      match = config_get('tacacs_server', 'encryption_password')
-      match.empty? ? TacacsServer.default_encryption_password : match[1]
+      str = config_get('tacacs_server', 'encryption_password')
+      return TacacsServer.default_encryption_password if str.empty?
+      str = str[1].strip
+      Utils.add_quotes(str)
     end
 
     # Get default encryption password
@@ -156,6 +158,7 @@ module Cisco
 
     # Set encryption type and password
     def encryption_key_set(enctype, password)
+      password = Utils.add_quotes(password)
       # if enctype is TACACS_SERVER_ENC_UNKNOWN, we will unset the key
       if enctype == TACACS_SERVER_ENC_UNKNOWN
         # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we

data/lib/cisco_node_utils/tacacs_server_host.rb

@@ -140,10 +140,15 @@ module Cisco
     end
 
     def encryption_password
-      config_get('tacacs_server_host',
-                 'encryption_password',
-                 ip:   @name,
-                 port: @port)
+      str = config_get('tacacs_server_host',
+                       'encryption_password',
+                       ip:   @name,
+                       port: @port)
+      return str if str.nil? || str.empty?
+      index = str.index('port')
+      str = str[0..index - 2] unless index.nil?
+      str = str.strip
+      Utils.add_quotes(str)
     end
 
     def self.default_encryption_password
@@ -156,6 +161,7 @@ module Cisco
                                           TACACS_SERVER_ENC_CISCO_TYPE_7,
                                           TACACS_SERVER_ENC_UNKNOWN,
                                          ].include?(enctype)
+      password = Utils.add_quotes(password) unless password.empty?
       # if enctype is TACACS_SERVER_ENC_UNKNOWN, we'll unset the key
       if enctype == TACACS_SERVER_ENC_UNKNOWN
         # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we need

data/lib/cisco_node_utils/upgrade.rb

@@ -0,0 +1,118 @@
+# October 2016, Michael G Wiebe and Rahul Shenoy
+#
+# Copyright (c) 2016-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.
+# 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 'node_util'
+require_relative 'logger'
+
+module Cisco
+  # Upgrade - node util class for upgrading Cisco devices
+  class Upgrade < NodeUtil
+    # Delete install logs from previous installation
+    def self.clear_status
+      config_set('upgrade', 'clear_status')
+    end
+
+    # Deletes 'image' from 'uri'
+    def self.delete(image, uri='bootflash:')
+      config_set('upgrade', 'delete', image: image, uri: uri)
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Deletes currently booted image
+    def self.delete_boot(uri='bootflash:')
+      # Incase of a N9K, N3K and N9Kv the system and kickstart images are
+      # the same.
+      # Incase of a N5K, N6K and N7K the system and kickstart images are
+      # different.
+      system_image = config_get('show_version', 'system_image').split('/')[-1]
+      kickstart_image = config_get('show_version', 'boot_image').split('/')[-1]
+      if kickstart_image == system_image
+        config_set('upgrade', 'delete_boot', image: system_image, uri: uri)
+      else
+        config_set('upgrade', 'delete_boot', image: system_image,
+                                             uri:   uri)
+        config_set('upgrade', 'delete_boot', image: kickstart_image,
+                                             uri:   uri)
+      end
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Returns version of the 'image'
+    def self.image_version(image=nil, uri=nil)
+      # Returns version of currently booted image by default
+      if image && uri
+        config_get('upgrade', 'image_version', image: image, uri: uri)
+      else
+        config_get('show_version', 'version').split(' ')[0]
+      end
+    end
+
+    # Return true if box is online and config mode is ready to be used
+    def self.box_online?
+      output = config_set('upgrade', 'is_box_online')
+      output[0]['body'] == {}
+    end
+
+    def self.save_config
+      config_set('upgrade', 'save_config')
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Returns True if device upgraded
+    def self.upgraded?
+      return false unless config_get('upgrade', 'upgraded')
+      (0..500).each do
+        sleep 1
+        return true if box_online?
+      end
+      fail 'Configuration is still blocked'
+    end
+
+    # Attempts to upgrade the device to 'image'
+    def self.upgrade(version, image, uri='bootflash:', del_boot=false,
+                     force_all=false)
+      # Only 'bootflash:' is a supported URI. Fail otherwise.
+      fail "The Uri #{uri} is not supported" unless uri == 'bootflash:'
+      # IMPORTANT - Check if version of image equals the version provided.
+      # This is to avoid entering a loop with the Programmability Agent
+      # continuously trying to reload the device if versions don't match.
+      image_ver = image_version(image, uri)
+      err_str = "Version Mismatch.\n
+                 The version of the image:#{image_ver}\n
+                 The version provided:#{version}\n
+                 Aborting upgrade."
+      fail err_str unless image_ver.to_s.strip == version.to_s.strip
+      delete_boot(uri) if del_boot
+      force_all ? upgrade_str = 'upgrade_force' : upgrade_str = 'upgrade'
+      begin
+        Cisco::Logger.debug("Upgrading to version: #{image}")
+        config_set('upgrade', upgrade_str, image: image, uri: uri)
+      rescue Cisco::RequestFailed
+        # Catch 'Backend Processing Error'. Install continues inspite of the
+        # error thrown. Resend install command and expect a CliError.
+        begin
+          config_set('upgrade', upgrade_str, image: image, uri: uri)
+        rescue Cisco::CliError => e
+          raise e unless
+            e.message.include?('Another install procedure may be in progress')
+        end
+      end
+    end
+  end
+end

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.5.0'
+  VERSION = '1.6.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/spec/environment_spec.rb

@@ -47,6 +47,7 @@ describe Cisco::Environment do
         port:     57_799,
         username: nil,
         password: nil,
+        cookie:   nil,
       } }
       expect(Cisco::Environment).to receive(:data_from_file).and_return(
         'hello' => { host: '1.1.1.1' }, 'goodbye' => { password: 'foo' })
@@ -56,12 +57,14 @@ describe Cisco::Environment do
           port:     57_799,
           username: nil,
           password: nil,
+          cookie:   nil,
         },
         'goodbye' => {
           host:     nil,
           port:     nil,
           username: nil,
           password: 'foo',
+          cookie:   nil,
         },
       )
     end
@@ -78,12 +81,14 @@ describe Cisco::Environment do
 
     global_config = {
       'default' => {
-        host: '127.0.0.1',
-        port: 57_400,
+        host:   '127.0.0.1',
+        port:   57_400,
+        cookie: nil,
       },
       'global'  => {
         username: 'global',
         password: 'global',
+        cookie:   nil,
       },
     }
 
@@ -91,10 +96,12 @@ describe Cisco::Environment do
       'default' => {
         port:     57_799,
         username: 'user',
+        cookie:   nil,
       },
       'user'    => {
         username: 'user',
         password: 'user',
+        cookie:   nil,
       },
     }
 
@@ -137,18 +144,21 @@ describe Cisco::Environment do
           port:     57_799, # user overrides global
           username: 'user', # user config
           password: nil, # auto-populated with nil
+          cookie:   nil,
         },
         'global'  => { # global config
           host:     nil,
           port:     nil,
           username: 'global',
           password: 'global',
+          cookie:   nil,
         },
         'user'    => { # user config
           host:     nil,
           port:     nil,
           username: 'user',
           password: 'user',
+          cookie:   nil,
         },
       )
     end
@@ -185,6 +195,7 @@ describe Cisco::Environment do
           port:     nil,
           username: nil,
           password: nil,
+          cookie:   nil,
         }
         it 'can be loaded explicitly by name' do
           expect(Cisco::Environment.environment('nxapi_local')).to eq(expected)
@@ -205,6 +216,7 @@ describe Cisco::Environment do
           port:     nil,
           username: 'devops',
           password: 'devops',
+          cookie:   nil,
         }
         it 'can be loaded explicitly by name' do
           expect(Cisco::Environment.environment('nxapi_remote')).to eq(expected)
@@ -225,6 +237,7 @@ describe Cisco::Environment do
           port:     57_999,
           username: 'admin',
           password: 'admin',
+          cookie:   nil,
         }
         it 'can be loaded explicitly by name' do
           expect(Cisco::Environment.environment('grpc_local')).to eq(expected)
@@ -245,6 +258,7 @@ describe Cisco::Environment do
           port:     nil,
           username: 'admin',
           password: 'admin',
+          cookie:   nil,
         }
         it 'can be loaded explicitly by name' do
           expect(Cisco::Environment.environment('grpc_remote')).to eq(expected)

data/tests/test_bgp_af.rb

@@ -168,7 +168,14 @@ class TestBgpAF < CiscoTestCase
       # 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
+        case Platform.image_version
+        when /8.0/
+          expect = :success
+        when /I5.2/
+          expect = :success if test == :maximum_paths || test == :maximum_paths_ibgp
+        else
+          expect = :CliError
+        end
       end
       return expect if expect == :success || expect == :skip
 

data/tests/test_dhcp_relay_global.rb

@@ -212,8 +212,9 @@ class TestDhcpRelayGlobal < CiscoTestCase
       return
     end
     assert_equal(drg.default_ipv4_sub_option_circuit_id_string, drg.ipv4_sub_option_circuit_id_string)
-    drg.ipv4_sub_option_circuit_id_string = '%p%p'
-    assert_equal('%p%p', drg.ipv4_sub_option_circuit_id_string)
+    str = '%p%p'
+    drg.ipv4_sub_option_circuit_id_string = str
+    assert_match(/#{str}/, drg.ipv4_sub_option_circuit_id_string)
     drg.ipv4_sub_option_circuit_id_string = drg.default_ipv4_sub_option_circuit_id_string
     assert_equal(drg.default_ipv4_sub_option_circuit_id_string, drg.ipv4_sub_option_circuit_id_string)
   end

data/tests/test_evpn_vni.rb

@@ -75,7 +75,7 @@ class TestEvpnVni < CiscoTestCase
     vni = EvpnVni.new(4096)
     opts = [:both, :import, :export]
 
-    # 'route_target_both' has limited support with I3 and later images.
+    # 'route_target_both' has limited support with I2.5 and later images.
     # The Puppet README states:
     # Caveat: The route_target_both property is discouraged due to the
     # inconsistent behavior of the property across Nexus platforms and image
@@ -86,7 +86,7 @@ class TestEvpnVni < CiscoTestCase
     # in the configuration it causes an idempotency problem for puppet. For
     # this reason it is recommended to use explicit 'route_target_export' and
     # 'route_target_import' properties instead of route_target_both.
-    opts.delete(:both) unless Utils.nexus_i2_image
+    opts.delete(:both)
 
     # Master list of communities to test against
     master = ['1.2.3.4:55', '2:2', '55:33', 'auto']

data/tests/test_feature.rb

@@ -225,7 +225,10 @@ class TestFeature < CiscoTestCase
     fs = 'feature-set fex'
 
     # clean
-    config("no #{fs} ; no install #{fs}") if Feature.fex_installed?
+    if Feature.fex_installed?
+      config_no_warn("no #{fs}")
+      config_no_warn("no install #{fs}")
+    end
     refute_show_match(
       command: "show running | i '^install #{fs}$'",
       pattern: /^install #{fs}$/,

data/tests/test_interface.rb

@@ -629,6 +629,7 @@ class TestInterface < CiscoTestCase
   end
 
   def test_speed
+    skip_legacy_defect?('7.0.3.I5.2', 'CSCvd41419')
     interface = Interface.new(interfaces[0])
     if validate_property_excluded?('interface', 'speed')
       assert_nil(interface.speed)
@@ -664,6 +665,7 @@ class TestInterface < CiscoTestCase
   end
 
   def test_duplex
+    skip_legacy_defect?('7.0.3.I5.2', 'CSCvd41419')
     interface = Interface.new(interfaces[0])
     if validate_property_excluded?('interface', 'duplex')
       assert_nil(interface.duplex)
@@ -818,6 +820,7 @@ class TestInterface < CiscoTestCase
   end
 
   def test_negotiate_auto_ethernet
+    skip_legacy_defect?('7.0.3.I5.2', 'CSCvd41419')
     inf_name = interfaces[0]
     interface = Interface.new(inf_name)
 
@@ -1740,4 +1743,94 @@ class TestInterface < CiscoTestCase
     interface.pim_bfd = interface.default_pim_bfd
     assert_equal(interface.default_pim_bfd, interface.pim_bfd)
   end
+
+  def test_load_interval_counter_1_delay
+    inf_name = interfaces[0]
+    interface = Interface.new(inf_name)
+    if validate_property_excluded?('interface',
+                                   'load_interval_counter_1_delay')
+      assert_nil(interface.load_interval_counter_1_delay)
+      assert_raises(Cisco::UnsupportedError) do
+        interface.load_interval_counter_1_delay = 100
+      end
+      return
+    end
+    assert_equal(interface.default_load_interval_counter_1_delay,
+                 interface.load_interval_counter_1_delay)
+    interface.load_interval_counter_1_delay = 100
+    assert_equal(100, interface.load_interval_counter_1_delay)
+    interface.load_interval_counter_1_delay =
+      interface.default_load_interval_counter_1_delay
+    assert_equal(interface.default_load_interval_counter_1_delay,
+                 interface.load_interval_counter_1_delay)
+    # check nil for subintf and loopback
+    subif = Interface.new(interfaces[0] + '.1')
+    assert_nil(subif.load_interval_counter_1_delay)
+    assert_raises(ArgumentError) { subif.load_interval_counter_1_delay = 100 }
+    lb = Interface.new('loopback0')
+    assert_nil(lb.load_interval_counter_1_delay)
+    assert_raises(ArgumentError) { lb.load_interval_counter_1_delay = 100 }
+    subif.destroy
+    lb.destroy
+  end
+
+  def test_load_interval_counter_2_delay
+    inf_name = interfaces[0]
+    interface = Interface.new(inf_name)
+    if validate_property_excluded?('interface',
+                                   'load_interval_counter_2_delay')
+      assert_nil(interface.load_interval_counter_2_delay)
+      assert_raises(Cisco::UnsupportedError) do
+        interface.load_interval_counter_2_delay = 200
+      end
+      return
+    end
+    assert_equal(interface.default_load_interval_counter_2_delay,
+                 interface.load_interval_counter_2_delay)
+    interface.load_interval_counter_2_delay = 200
+    assert_equal(200, interface.load_interval_counter_2_delay)
+    interface.load_interval_counter_2_delay =
+      interface.default_load_interval_counter_2_delay
+    assert_equal(interface.default_load_interval_counter_2_delay,
+                 interface.load_interval_counter_2_delay)
+    # check nil for subintf and loopback
+    subif = Interface.new(interfaces[0] + '.1')
+    assert_nil(subif.load_interval_counter_2_delay)
+    assert_raises(ArgumentError) { subif.load_interval_counter_2_delay = 100 }
+    lb = Interface.new('loopback0')
+    assert_nil(lb.load_interval_counter_2_delay)
+    assert_raises(ArgumentError) { lb.load_interval_counter_2_delay = 100 }
+    subif.destroy
+    lb.destroy
+  end
+
+  def test_load_interval_counter_3_delay
+    inf_name = interfaces[0]
+    interface = Interface.new(inf_name)
+    if validate_property_excluded?('interface',
+                                   'load_interval_counter_3_delay')
+      assert_nil(interface.load_interval_counter_3_delay)
+      assert_raises(Cisco::UnsupportedError) do
+        interface.load_interval_counter_3_delay = 150
+      end
+      return
+    end
+    assert_equal(interface.default_load_interval_counter_3_delay,
+                 interface.load_interval_counter_3_delay)
+    interface.load_interval_counter_3_delay = 150
+    assert_equal(150, interface.load_interval_counter_3_delay)
+    interface.load_interval_counter_3_delay =
+      interface.default_load_interval_counter_3_delay
+    assert_equal(interface.default_load_interval_counter_3_delay,
+                 interface.load_interval_counter_3_delay)
+    # check nil for subintf and loopback
+    subif = Interface.new(interfaces[0] + '.1')
+    assert_nil(subif.load_interval_counter_3_delay)
+    assert_raises(ArgumentError) { subif.load_interval_counter_3_delay = 100 }
+    lb = Interface.new('loopback0')
+    assert_nil(lb.load_interval_counter_3_delay)
+    assert_raises(ArgumentError) { lb.load_interval_counter_3_delay = 100 }
+    subif.destroy
+    lb.destroy
+  end
 end