cisco_node_utils 1.6.0 → 1.7.0

data/lib/cisco_node_utils/version.rb

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

@@ -76,7 +76,7 @@ module Cisco
         (result[2]['body'].split(errors) - ['']).each_slice(2).map(&:join)
       error_list.each do |msg|
         next if ignore_message && msg.to_s.include?(ignore_message)
-        fail result[2]['body']
+        fail Cisco::CliError, result[2]['body']
       end
     end
 

data/lib/cisco_node_utils/vpc.rb

@@ -200,6 +200,7 @@ module Cisco
     end
 
     def layer3_peer_routing=(val)
+      return if val == layer3_peer_routing
       set_args_keys(state: val ? '' : 'no')
       # This requires peer_gateway to be set first
       self.peer_gateway = true if !peer_gateway && val
@@ -295,10 +296,49 @@ module Cisco
       config_set('vpc', 'peer_gateway', @set_args)
     end
 
+    def peer_switch
+      config_get('vpc', 'peer_switch')
+    end
+
+    def peer_switch=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'peer_switch', @set_args)
+    end
+
+    def arp_synchronize
+      config_get('vpc', 'arp_synchronize')
+    end
+
+    def arp_synchronize=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'arp_synchronize', @set_args)
+    end
+
+    def nd_synchronize
+      config_get('vpc', 'nd_synchronize')
+    end
+
+    def nd_synchronize=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'nd_synchronize', @set_args)
+    end
+
     def default_peer_gateway
       config_get_default('vpc', 'peer_gateway')
     end
 
+    def default_peer_switch
+      config_get_default('vpc', 'peer_switch')
+    end
+
+    def default_arp_synchronize
+      config_get_default('vpc', 'arp_synchronize')
+    end
+
+    def default_nd_synchronize
+      config_get_default('vpc', 'nd_synchronize')
+    end
+
     def peer_gateway_exclude_bridge_domain
       config_get('vpc', 'peer_gateway_exclude_bridge_domain')
     end

data/lib/cisco_node_utils/yum.rb

@@ -3,7 +3,9 @@
 #
 # April 2015, Alex Hunsberger
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# March 2017, Re-written by Mike Wiebe
+#
+# 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.
@@ -18,6 +20,7 @@
 # limitations under the License.
 
 require_relative 'node_util'
+require_relative 'logger'
 
 module Cisco
   # This Yum class provides cisco package management functions through nxapi.
@@ -52,14 +55,14 @@ module Cisco
 
     def self.install(pkg, vrf=nil)
       vrf = vrf.nil? ? detect_vrf : "vrf #{vrf}"
-
       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.
+        # get package name first
+        name = pkg_name(pkg)
+        # call remove if pkg exists
+        remove(name) unless name.empty?
+        add(pkg, vrf)
+        activate(pkg)
+        commit(pkg_name(pkg))
         validate_installed(pkg)
       rescue Cisco::CliError, RuntimeError => e
         raise Cisco::CliError, "#{e.class}, #{e.message}"
@@ -76,15 +79,135 @@ module Cisco
     end
 
     def self.remove(pkg)
-      config_set('yum', 'deactivate', pkg)
-      # May not be able to remove the package immediately after
-      # deactivation.
+      # get committed state
+      cstate = query_committed(pkg)
+      # get activated state
+      astate = query_activated(pkg)
+
+      if astate && cstate
+        # pkg is active and committed
+        # so deactivate, commit and remove
+        deactivate(pkg)
+        commit_deactivate(pkg)
+        delete(pkg)
+      elsif cstate
+        # pkg is inactive and committed
+        # so commit and remove
+        commit_deactivate(pkg)
+        delete(pkg)
+      elsif astate
+        # pkg is active and not committed
+        # so deactivate and remove
+        deactivate(pkg)
+        delete(pkg)
+      else
+        # pkg is inactive and not committed
+        # so just remove
+        delete(pkg)
+      end
+    rescue Cisco::CliError, RuntimeError => e
+      raise Cisco::CliError, "#{e.class}, #{e.message}"
+    end
+
+    def self.add(pkg, vrf=nil)
+      try_operation('add', pkg, vrf)
       while (try ||= 1) < 20
-        o = config_set('yum', 'remove', pkg)
-        break unless o[/operation is in progress, please try again later/]
+        return if query_added(pkg)
         sleep 1
         try += 1
       end
+      fail "Failed to add pkg: #{pkg}, using vrf #{vrf}"
+    end
+
+    def self.activate(pkg)
+      try_operation('activate', pkg)
+      while (try ||= 1) < 20
+        return if query_activated(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to activate pkg: #{pkg}"
+    end
+
+    def self.commit(pkg)
+      try_operation('commit', pkg)
+      while (try ||= 1) < 20
+        return if query_committed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to commit pkg: #{pkg}"
+    end
+
+    def self.commit_deactivate(pkg)
+      try_operation('commit', pkg)
+      while (try ||= 1) < 20
+        return unless query_committed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to commit after deactivate pkg: #{pkg}"
+    end
+
+    def self.deactivate(pkg)
+      try_operation('deactivate', pkg)
+      while (try ||= 1) < 20
+        return if query_inactive(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to deactivate pkg: #{pkg}"
+    end
+
+    def self.delete(pkg)
+      try_operation('remove', pkg)
+      while (try ||= 1) < 20
+        return if query_removed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to delete pkg: #{pkg}"
+    end
+
+    def self.try_operation(operation, pkg, vrf=nil)
+      args = vrf.nil? ? { pkg: pkg } : { pkg: pkg, vrf: vrf }
+      while (try ||= 1) < 20
+        o = config_set('yum', operation, args)
+        break unless o[/Another install operation is in progress/]
+        sleep 1
+        try += 1
+      end
+    end
+
+    def self.pkg_name(pkg)
+      config_get('yum', 'pkg_name', pkg: pkg)
+    end
+
+    def self.query_activated(pkg)
+      config_get('yum', 'query_activated', pkg: pkg)
+    end
+
+    def self.query_added(pkg)
+      config_get('yum', 'query_added', pkg: pkg)
+    end
+
+    def self.query_committed(pkg)
+      o = config_get('yum', 'query_committed', pkg: pkg)
+      return false if o.nil?
+      o.include? pkg
+    end
+
+    def self.query_inactive(pkg)
+      config_get('yum', 'query_inactive', pkg: pkg)
+    end
+
+    def self.query_removed(pkg)
+      val = config_get('yum', 'query_removed', pkg: pkg)
+      val ? false : true
+    end
+
+    def self.query_state(pkg)
+      config_get('yum', 'query_state', pkg: pkg).downcase
     end
   end
 end

data/spec/schema.yaml

@@ -68,6 +68,8 @@ mapping:
         enum: [boolean, int, string, symbol]
       multiple:
         type: bool
+      os_version:
+        type: str
       # Setter-specific attributes
       set_data_format: *data_format
       set_context: *context

data/tests/ciscotest.rb

@@ -172,6 +172,42 @@ class CiscoTestCase < TestCase
     !node.cmd_ref.supports?(feature, property)
   end
 
+  def skip_incompat_version?(feature, property)
+    ov = node.os_version_get(feature, property)
+    return if ov.nil?
+    im = Platform.image_version
+    pid = node.product_id
+
+    ver = nil
+    array = ov.split(';')
+    array.each do |e|
+      break if ver
+      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)/]
+        next unless lkey.downcase.strip == product_tag
+        ver = key_values[1]
+        break if ver
+      end
+    end
+
+    return if ver.nil?
+    over = ver
+    lim = im.split[0].tr('(', '.').tr(')', '.').chomp('.')
+    # due to a bug in Gem::Version, we need to append a letter
+    # to the version field if only one of compared versions
+    # has a letter at the end
+    # For ex:
+    # 7.0.3.I2.2e < 7.0.3.I2.2 is TRUE instead of FALSE
+    # Once we add a letter 'a' to the end,
+    # 7.0.3.I2.2e < 7.0.3.I2.2a is FALSE
+    ver << 'a' if lim[-1, 1] =~ /[[:alpha:]]/
+    skip("The #{feature} #{property} property is only supported on OS version #{over} or later on #{pid}") if
+      Gem::Version.new(lim) < Gem::Version.new(ver)
+  end
+
   def skip_nexus_i2_image?
     skip("This property is not supported on Nexus 'I2' images") if
       Utils.nexus_i2_image

data/tests/test_ace.rb

@@ -112,15 +112,20 @@ class TestAce < CiscoTestCase
     assert_equal(val, a.src_addr)
     assert_equal(val, a.dst_addr)
 
+    config_no_warn('object-group ip address my_addrgroup_ipv4')
+    config_no_warn('object-group ipv6 address my_addrgroup_ipv6')
     %w(ipv4 ipv6).each do |afi|
       val = "addrgroup my_addrgroup_#{afi}"
       a = ace_helper(afi, src_addr: val, dst_addr: val)
       assert_equal(val, a.src_addr)
       assert_equal(val, a.dst_addr)
     end
+    config_no_warn('no object-group ip address my_addrgroup_ipv4')
+    config_no_warn('no object-group ipv6 address my_addrgroup_ipv6')
   end
 
   def test_ports
+    config_no_warn('object-group ip port my_pg')
     %w(ipv4 ipv6).each do |afi|
       ['eq 2', 'neq 2', 'gt 2', 'lt 2',
        'portgroup my_pg'].each do |val|
@@ -129,6 +134,7 @@ class TestAce < CiscoTestCase
         assert_equal(val, a.dst_port)
       end
     end
+    config_no_warn('no object-group ip port my_pg')
   end
 
   def test_dscp

data/tests/test_bfd_global.rb

@@ -211,13 +211,7 @@ class TestBfdGlobal < CiscoTestCase
   def test_interval
     bg = BfdGlobal.new
     arr = %w(100 100 25)
-    if validate_property_excluded?('bfd_global', 'interval')
-      assert_nil(bg.interval)
-      assert_raises(Cisco::UnsupportedError) do
-        bg.interval = arr
-      end
-      return
-    end
+    skip_incompat_version?('bfd_global', 'interval')
     assert_equal(bg.default_interval, bg.interval)
     bg.interval = arr
     assert_equal(arr, bg.interval)

data/tests/test_bgp_af.rb

@@ -169,9 +169,9 @@ class TestBgpAF < CiscoTestCase
       # triggers a version check below.
       if expect == :runtime
         case Platform.image_version
-        when /8.0/
+        when /8.0|8.1/
           expect = :success
-        when /I5.2/
+        when /I5.2|I5.3|I6/
           expect = :success if test == :maximum_paths || test == :maximum_paths_ibgp
         else
           expect = :CliError

data/tests/test_bgp_af_aa.rb

@@ -0,0 +1,108 @@
+# Copyright (c) 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 'ciscotest'
+require_relative '../lib/cisco_node_utils/bgp_af'
+require_relative '../lib/cisco_node_utils/bgp_af_aggr_addr'
+
+include Cisco
+# TestBgpAfAggrAddr - Minitest for BgpAFAggrAddr class
+class TestBgpAfAggrAddr < CiscoTestCase
+  @@pre_clean_needed = true # rubocop:disable Style/ClassVars
+
+  def setup
+    super
+    config('no feature bgp')
+    remove_all_vrfs if @@pre_clean_needed
+    @@pre_clean_needed = false # rubocop:disable Style/ClassVars
+  end
+
+  def teardown
+    config('no feature bgp')
+    remove_all_vrfs
+    super
+  end
+
+  def test_collection_empty
+    node.cache_flush
+    aas = RouterBgpAFAggrAddr.aas
+    assert_empty(aas, 'BGP AF Aggregate Address collection is not empty')
+  end
+
+  def test_collection_not_empty
+    bgp_af = []
+    bgp_af_aa = []
+    %w(default red).each do |vrf|
+      [%w(ipv4 unicast), %w(ipv6 unicast),
+       %w(ipv4 multicast), %w(ipv6 multicast)].each do |af|
+        bgp_af.push(RouterBgpAF.new(55, vrf, af))
+        if af[0] == 'ipv4'
+          ['1.1.1.0/24', '2.2.2.2/32'].each do |addr|
+            bgp_af_aa.push(RouterBgpAFAggrAddr.new(55, vrf, af, addr))
+          end
+        else
+          ['2001::12/128', '2000::31/128'].each do |addr|
+            bgp_af_aa.push(RouterBgpAFAggrAddr.new(55, vrf, af, addr))
+          end
+        end
+        assert_equal(2, RouterBgpAFAggrAddr.aas[55][vrf][af].size)
+      end
+    end
+  end
+
+  def test_destroy
+    af = %w(ipv4 unicast)
+    RouterBgpAF.new(55, 'red', af)
+    obj = RouterBgpAFAggrAddr.new(55, 'red', af, '1.1.1.0/24')
+    aas = RouterBgpAFAggrAddr.aas[55]['red'][af]
+    assert_equal(1, aas.size)
+    obj.destroy
+    aas = RouterBgpAFAggrAddr.aas[55]['red'][af]
+    assert_empty(aas, 'BGP AF Aggregate Address collection is not empty')
+  end
+
+  def aa_helper(props)
+    af = %w(ipv4 unicast)
+    RouterBgpAF.new(55, 'red', af)
+    obj = RouterBgpAFAggrAddr.new(55, 'red', af, '1.1.1.0/24')
+    test_hash = {
+      advertise_map: obj.default_advertise_map,
+      as_set:        obj.default_as_set,
+      attribute_map: obj.default_attribute_map,
+      summary_only:  obj.default_summary_only,
+      suppress_map:  obj.default_suppress_map,
+    }.merge!(props)
+    obj.aa_set(test_hash)
+    obj
+  end
+
+  def test_aa
+    obj = aa_helper(advertise_map: 'adm',
+                    as_set:        true,
+                    attribute_map: 'atm',
+                    suppress_map:  'sum')
+    assert(obj.as_set)
+    assert_equal('adm', obj.advertise_map)
+    assert_equal('atm', obj.attribute_map)
+    assert_equal('sum', obj.suppress_map)
+    obj = aa_helper(advertise_map: 'adm',
+                    as_set:        true,
+                    attribute_map: 'atm',
+                    summary_only:  true)
+    assert(obj.as_set)
+    assert(obj.summary_only)
+    assert_equal('adm', obj.advertise_map)
+    assert_equal('atm', obj.attribute_map)
+  end
+end