cisco_node_utils_mgx 2.1.0.1

data/tests/test_ntp_server.rb

@@ -0,0 +1,146 @@
+#
+# Minitest for NtpServer class
+#
+# 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.
+# 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/ntp_server'
+
+# TestNtpServer - Minitest for NtpServer node utility.
+class TestNtpServer < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    no_ntpserver
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_ntpserver
+    super
+  end
+
+  def no_ntpserver
+    # Turn the feature off for a clean test.
+    config('no ntp server 130.88.203.12',
+           'no ntp server 2003::5',
+           'no ntp server 0.us.pool.ntp.org',
+           'no ntp authentication-key 999 md5 test 7',
+           'no vrf context red')
+  end
+
+  # TESTS
+
+  def test_create_name_invalid
+    assert_raises(ArgumentError) do
+      Cisco::NtpServer.new({ 'name' => '1_com' }, true)
+    end
+  end
+
+  def test_ipv4
+    id = '130.88.203.12'
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+
+    ntp = Cisco::NtpServer.new({ 'name' => id }, true)
+    assert_includes(Cisco::NtpServer.ntpservers, id)
+    assert_equal(ntp, Cisco::NtpServer.ntpservers[id])
+
+    ntp.destroy
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+  end
+
+  def test_ipv6
+    id = '2003::5'
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+
+    ntp = Cisco::NtpServer.new({ 'name' => id }, true)
+    assert_includes(Cisco::NtpServer.ntpservers, id)
+    assert_equal(ntp, Cisco::NtpServer.ntpservers[id])
+
+    ntp.destroy
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+  end
+
+  def test_multiple
+    id1 = '130.88.203.12'
+    id2 = '2003::5'
+    refute_includes(Cisco::NtpServer.ntpservers, id1)
+    refute_includes(Cisco::NtpServer.ntpservers, id2)
+
+    ntp1 = Cisco::NtpServer.new({ 'name' => id1 }, true)
+    ntp2 = Cisco::NtpServer.new({ 'name' => id2 }, true)
+    refute_equal(ntp1, ntp2)
+    assert_includes(Cisco::NtpServer.ntpservers, id1)
+    assert_includes(Cisco::NtpServer.ntpservers, id2)
+    assert_equal(ntp1, Cisco::NtpServer.ntpservers[id1])
+    assert_equal(ntp2, Cisco::NtpServer.ntpservers[id2])
+
+    ntp1.destroy
+    ntp2.destroy
+    refute_includes(Cisco::NtpServer.ntpservers, id1)
+    refute_includes(Cisco::NtpServer.ntpservers, id2)
+  end
+
+  # This test requires DNS resolution be avaabile - leaving for reference
+  # def test_domain_name
+  #   id = '0.us.pool.ntp.org'
+  #   refute_includes(Cisco::NtpServer.ntpservers, id)
+  #
+  #   ntp = Cisco::NtpServer.new({ 'name' => id }, true)
+  #   assert_includes(Cisco::NtpServer.ntpservers, id)
+  #   assert_equal(ntp, Cisco::NtpServer.ntpservers[id])
+  #
+  #   ntp.destroy
+  #   refute_includes(Cisco::NtpServer.ntpservers, id)
+  # end
+
+  def test_defaults
+    id = '130.88.203.12'
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+
+    ntp = Cisco::NtpServer.new({ 'name' => id }, true)
+    assert_includes(Cisco::NtpServer.ntpservers, id)
+    assert_equal('default', Cisco::NtpServer.ntpservers[id].vrf)
+    assert_nil(Cisco::NtpServer.ntpservers[id].key)
+    assert_nil(Cisco::NtpServer.ntpservers[id].maxpoll)
+    assert_nil(Cisco::NtpServer.ntpservers[id].minpoll)
+    refute(Cisco::NtpServer.ntpservers[id].prefer)
+
+    ntp.destroy
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+  end
+
+  def test_create_options
+    id = '130.88.203.12'
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+
+    options = { 'name' => id, 'key' => '999', 'prefer' => 'true',
+                'minpoll' => '5', 'maxpoll' => '8', 'vrf' => 'red' }
+
+    config('vrf context red')
+    config('ntp authentication-key 999 md5 test 7')
+
+    ntp = Cisco::NtpServer.new(options, true)
+    assert_includes(Cisco::NtpServer.ntpservers, id)
+    assert_equal('red', Cisco::NtpServer.ntpservers[id].vrf)
+    assert_equal('999', Cisco::NtpServer.ntpservers[id].key)
+    assert_equal('5', Cisco::NtpServer.ntpservers[id].minpoll)
+    assert_equal('8', Cisco::NtpServer.ntpservers[id].maxpoll)
+    assert(Cisco::NtpServer.ntpservers[id].prefer)
+
+    ntp.destroy
+    refute_includes(Cisco::NtpServer.ntpservers, id)
+  end
+end

data/tests/test_nxapi.rb

@@ -0,0 +1,236 @@
+# November 2014, Glenn F. Matthews
+#
+# Copyright (c) 2014-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_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/node'
+
+# TestNxapi - NXAPI client unit tests
+class TestNxapi < CiscoTestCase
+  @@client = nil # rubocop:disable Style/ClassVars
+
+  def self.runnable_methods
+    # If we're pointed to a gRPC node (as evidenced by presence of a port num)
+    # then these tests don't apply
+    return [:all_skipped] if Cisco::Environment.environment[:port]
+    super
+  end
+
+  def all_skipped
+    skip 'Node under test does not appear to use the NXAPI client'
+  end
+
+  def setup
+    super
+    @device.cmd('configure terminal')
+    @device.cmd('feature nxapi')
+    @device.cmd('nxapi http port 80')
+    @device.cmd('end')
+    @product_id = Cisco::Node.new.product_id if @product_id.nil?
+    cleanup
+  end
+
+  def teardown
+    @device.cmd('configure terminal')
+    @device.cmd('feature nxapi')
+    @device.cmd('nxapi http port 80')
+    @device.cmd('end')
+    cleanup
+    super
+  end
+
+  def cleanup
+    return if Cisco::Environment.environment[:port]
+    config_no_warn('no interface loopback41', 'no interface loopback42')
+  end
+
+  def client
+    unless @@client
+      client = Cisco::Client::NXAPI.new(Cisco::Environment.environment)
+      client.cache_enable = true
+      client.cache_auto = true
+      @@client = client # rubocop:disable Style/ClassVars
+    end
+    @@client
+  end
+
+  # Test cases for new NXAPI client APIs
+
+  def test_cli_set_string
+    client.set(context: 'interface loopback41', values: 'descr panda')
+    run = client.get(command: 'show run int loopback41')
+    desc = run.match(/description (.*)/)[1]
+    assert_equal(desc, 'panda')
+  end
+
+  def test_cli_set_array
+    client.set(context: ['int loopback41'], values: ['descr elephant'])
+    run = client.get(command: 'show run int loopback41')
+    desc = run.match(/description (.*)/)[1]
+    assert_equal(desc, 'elephant')
+  end
+
+  def test_cli_set_invalid
+    input = ['int loopback41', 'exit', 'int loopback42', 'plover']
+    successful = ['int loopback41', 'exit', 'int loopback42']
+    rejected = 'plover'
+
+    msg = case @product_id
+          when /N(5|6|7)/
+            'Input CLI command error'
+          when /N(3|8|9)/
+            'CLI execution error'
+          end
+
+    e = assert_raises Cisco::CliError do
+      client.set(values: input)
+    end
+
+    cli_rcs = "
+    cli return codes:
+      successful : #{e.successful_input}
+      rejected   : #{e.rejected_input}
+      msg        : #{e.msg}
+      code       : #{e.code}
+      clierror   : #{e.clierror}
+    "
+    assert_equal(successful, e.successful_input, cli_rcs)
+    assert_equal(rejected, e.rejected_input, cli_rcs)
+
+    assert_match(msg, e.msg, cli_rcs)
+    assert_equal('400', e.code, cli_rcs)
+    assert_match('% Invalid command', e.clierror, cli_rcs)
+  end
+
+  def test_get_cli_default
+    result = client.get(command: 'show hostname')
+    s = @device.cmd('show hostname')
+    assert_equal(result.strip, s.split("\n")[1].strip)
+  end
+
+  def test_get_cli_invalid
+    assert_raises Cisco::CliError do
+      client.get(command: 'show plugh')
+    end
+  end
+
+  def test_element_get_cli_incomplete
+    assert_raises Cisco::CliError do
+      client.get(command: 'show ')
+    end
+  end
+
+  def test_get_cli_explicit
+    result = client.get(command: 'show hostname', data_format: :cli)
+    s = @device.cmd('show hostname')
+    assert_equal(result.strip, s.split("\n")[1].strip)
+  end
+
+  def test_get_cli_empty
+    result = client.get(command:     'show hostname | incl foo | excl foo',
+                        data_format: :cli)
+    assert_nil(result)
+  end
+
+  def test_get_nxapi_structured
+    result = client.get(command:     'show hostname',
+                        data_format: :nxapi_structured)
+    s = @device.cmd('show hostname')
+    assert_equal(result['hostname'], s.split("\n")[1].strip)
+  end
+
+  def test_get_nxapi_structured_invalid
+    assert_raises Cisco::CliError do
+      client.get(command: 'show frobozz', data_format: :nxapi_structured)
+    end
+  end
+
+  def test_get_nxapi_structured_unsupported
+    cmd = { command:     'show snmp internal globals',
+            data_format: :nxapi_structured }
+    if @product_id[/N(5|6)/]
+      assert_empty(client.get(cmd).to_s)
+    else
+      assert_raises(Cisco::RequestNotSupported) { client.get(cmd) }
+    end
+  end
+
+  def test_connection_refused
+    @device.cmd('configure terminal')
+    @device.cmd('no feature nxapi')
+    @device.cmd('end')
+    assert_raises Cisco::ConnectionRefused do
+      client.cache_flush
+      client.get(command: 'show version')
+    end
+    assert_raises Cisco::ConnectionRefused do
+      client.set(values: 'interface loopback41')
+    end
+    # On the off chance that things behave differently when NXAPI is
+    # disabled while we're connected, versus trying to connect afresh...
+    @@client = nil # rubocop:disable Style/ClassVars
+    assert_raises Cisco::ConnectionRefused do
+      client.get(command: 'show version')
+    end
+    assert_raises Cisco::ConnectionRefused do
+      client.set(values: 'interface loopback41')
+    end
+  end
+
+  def test_unauthorized
+    def client.password=(new) # rubocop:disable Style/TrivialAccessors
+      @password = new
+    end
+    client.password = 'wrong_password'
+    client.cache_flush
+    assert_raises Cisco::AuthenticationFailed do
+      client.get(command: 'show version')
+    end
+    assert_raises Cisco::AuthenticationFailed do
+      client.set(values: 'interface loopback41')
+    end
+  ensure
+    client.password = password
+  end
+
+  def test_unsupported
+    # Add a method to the NXAPI that sends a request of invalid type
+    if !product_tag[/n(3|9)k-f/]
+      def client.hello
+        req('hello', 'world')
+      end
+
+      assert_raises Cisco::RequestNotSupported do
+        client.hello
+      end
+    else
+      def client.hello
+        req('hello', 'world')
+      end
+
+      assert_raises Cisco::ClientError do
+        client.hello
+      end
+    end
+  end
+
+  def test_smart_create
+    autoclient = Cisco::Client.create
+    assert_equal(Cisco::Client::NXAPI, autoclient.class)
+    assert(autoclient.supports?(:cli))
+    assert(autoclient.supports?(:nxapi_structured))
+    assert_equal(:nexus, autoclient.platform)
+  end
+end

data/tests/test_object_group.rb

@@ -0,0 +1,122 @@
+# 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/object_group'
+require_relative '../lib/cisco_node_utils/object_group_entry'
+
+# TestObject_group - Minitest for Object_group
+# node utility class
+class TestObjectGroup < CiscoTestCase
+  @skip_unless_supported = 'object_group'
+  @@pre_clean_needed = true # rubocop:disable Style/ClassVars
+
+  def setup
+    super
+    @og_name_v4 = 'test-my-v4'
+    @og_name_v6 = 'test-my-v6'
+    @og_name_port = 'test-my-port'
+    remove_all_object_groups if @@pre_clean_needed
+    @@pre_clean_needed = false # rubocop:disable Style/ClassVars
+  end
+
+  def teardown
+    remove_all_object_groups
+    super
+  end
+
+  def remove_all_object_groups
+    ObjectGroup.object_groups.each do |_afis, types|
+      types.each do |_type, grps|
+        grps.values.each(&:destroy)
+      end
+    end
+  end
+
+  def test_create_object_group
+    %w(ipv4 ipv6).each do |afi|
+      og_name = afi[/ipv6/] ? @og_name_v6 : @og_name_v4
+      og = ObjectGroup.new(afi, 'address', og_name)
+      assert(ObjectGroup.object_groups[afi]['address'].key?(og_name))
+      og.destroy
+      assert_nil(ObjectGroup.object_groups[afi])
+    end
+    og_name = @og_name_port
+    og = ObjectGroup.new('ipv4', 'port', og_name)
+    assert(ObjectGroup.object_groups['ipv4']['port'].key?(og_name))
+    og.destroy
+    assert_nil(ObjectGroup.object_groups['ipv4'])
+  end
+
+  def entry_helper(afi, type, name, props=nil)
+    test_hash = {
+      address: 'host 1.1.1.1',
+      port:    'eq 200',
+    }
+    test_hash.merge!(props) unless props.nil?
+
+    ObjectGroup.new(afi, type, name)
+    e = ObjectGroupEntry.new(afi, type, name, 10)
+    e.entry_set(test_hash)
+    e
+  end
+
+  def test_ipv4_address_host
+    e = entry_helper('ipv4', 'address', @og_name_v4, port: nil)
+    assert_equal('host 1.1.1.1', e.address)
+    e = entry_helper('ipv4', 'address', @og_name_v4, address: 'host 2.2.2.2', port: nil)
+    assert_equal('host 2.2.2.2', e.address)
+  end
+
+  def test_ipv4_address_prefix
+    e = entry_helper('ipv4', 'address', @og_name_v4, address: '2.2.2.2/17', port: nil)
+    assert_equal('2.2.2.2/17', e.address)
+    e = entry_helper('ipv4', 'address', @og_name_v4, address: '3.3.3.3/31', port: nil)
+    assert_equal('3.3.3.3/31', e.address)
+  end
+
+  def test_ipv4_address_netmask
+    e = entry_helper('ipv4', 'address', @og_name_v4, address: '2.2.2.2 255.255.255.0', port: nil)
+    assert_equal('2.2.2.2 255.255.255.0', e.address)
+    e = entry_helper('ipv4', 'address', @og_name_v4, address: '3.3.3.3 10.11.12.13', port: nil)
+    assert_equal('3.3.3.3 10.11.12.13', e.address)
+  end
+
+  def test_ipv6_address_host
+    e = entry_helper('ipv6', 'address', @og_name_v6, address: 'host 2000::1', port: nil)
+    assert_equal('host 2000::1', e.address)
+    e = entry_helper('ipv6', 'address', @og_name_v6, address: 'host 2001::2', port: nil)
+    assert_equal('host 2001::2', e.address)
+  end
+
+  def test_ipv6_address_prefix
+    e = entry_helper('ipv6', 'address', @og_name_v6, address: '2000::1/127', port: nil)
+    assert_equal('2000::1/127', e.address)
+    e = entry_helper('ipv6', 'address', @og_name_v6, address: '2001::10/64', port: nil)
+    assert_equal('2001::10/64', e.address)
+  end
+
+  def test_ipv4_port
+    e = entry_helper('ipv4', 'port', @og_name_port, address: nil)
+    assert_equal('eq 200', e.port)
+    e = entry_helper('ipv4', 'port', @og_name_port, port: 'lt 100', address: nil)
+    assert_equal('lt 100', e.port)
+    e = entry_helper('ipv4', 'port', @og_name_port, port: 'neq 150', address: nil)
+    assert_equal('neq 150', e.port)
+    e = entry_helper('ipv4', 'port', @og_name_port, port: 'gt 350', address: nil)
+    assert_equal('gt 350', e.port)
+    e = entry_helper('ipv4', 'port', @og_name_port, port: 'range 400 1000', address: nil)
+    assert_equal('range 400 1000', e.port)
+  end
+end

data/tests/test_overlay_global.rb

@@ -0,0 +1,108 @@
+# Copyright (c) 2013-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_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/cisco_cmn_utils'
+require_relative '../lib/cisco_node_utils/feature'
+require_relative '../lib/cisco_node_utils/overlay_global'
+
+include Cisco
+
+# TestOverlayGlobal - Minitest for OverlayGlobal node utility
+class TestOverlayGlobal < CiscoTestCase
+  @skip_unless_supported = 'overlay_global'
+
+  def setup
+    super
+    vdc_limit_f3_no_intf_needed(:set)
+    config_no_warn('no feature fabric forwarding')
+    config_no_warn('no nv overlay evpn')
+  end
+
+  def teardown
+    config_no_warn('no feature fabric forwarding')
+    config_no_warn('no nv overlay evpn')
+    vdc_limit_f3_no_intf_needed(:clear) if first_or_last_teardown
+  end
+
+  def test_dup_host_ip_addr_detection
+    o = OverlayGlobal.new
+    if validate_property_excluded?('overlay_global',
+                                   'dup_host_ip_addr_detection')
+      assert_raises(Cisco::UnsupportedError) do
+        o.dup_host_ip_addr_detection_set(200, 20)
+      end
+      return
+    end
+
+    assert_equal(o.default_dup_host_ip_addr_detection_host_moves,
+                 o.dup_host_ip_addr_detection_host_moves)
+    assert_equal(o.default_dup_host_ip_addr_detection_timeout,
+                 o.dup_host_ip_addr_detection_timeout)
+
+    # Set them to the default value and they should now be present
+    default = [o.default_dup_host_ip_addr_detection_host_moves,
+               o.default_dup_host_ip_addr_detection_timeout]
+    o.dup_host_ip_addr_detection_set(*default)
+    assert_equal(default[0], o.dup_host_ip_addr_detection_host_moves)
+    assert_equal(default[1], o.dup_host_ip_addr_detection_timeout)
+    assert(Feature.nv_overlay_evpn_enabled?)
+
+    # Set them to non-default values
+    val = [200, 20]
+    o.dup_host_ip_addr_detection_set(*val)
+    assert_equal(val, o.dup_host_ip_addr_detection)
+    assert_equal(val[0], o.dup_host_ip_addr_detection_host_moves)
+    assert_equal(val[1], o.dup_host_ip_addr_detection_timeout)
+  end
+
+  def test_dup_host_mac_detection
+    o = OverlayGlobal.new
+
+    skip_incompat_version?('overlay_global', 'dup_host_mac_detection')
+    # Set to a non-default value
+    val = [160, 16]
+    o.dup_host_mac_detection_set(*val)
+    assert_equal(val, o.dup_host_mac_detection)
+    refute(Feature.nv_overlay_evpn_enabled?)
+
+    # These properties always exist, even without 'nv overlay evpn'
+    default = [o.default_dup_host_mac_detection_host_moves,
+               o.default_dup_host_mac_detection_timeout]
+    o.dup_host_mac_detection_set(*default)
+    assert_equal(default, o.dup_host_mac_detection)
+    refute(Feature.nv_overlay_evpn_enabled?)
+  end
+
+  def test_anycast_gateway_mac
+    o = OverlayGlobal.new
+    if validate_property_excluded?('overlay_global', 'anycast_gateway_mac')
+      assert_raises(Cisco::UnsupportedError) { o.anycast_gateway_mac = '1.1.1' }
+      return
+    end
+
+    assert_equal(o.default_anycast_gateway_mac, o.anycast_gateway_mac)
+
+    # Explicitly set to default and it should be enabled
+    o.anycast_gateway_mac = o.default_anycast_gateway_mac
+    assert_equal(o.default_anycast_gateway_mac, o.anycast_gateway_mac)
+    assert(Feature.nv_overlay_evpn_enabled?)
+
+    # Set to various non-default values
+    %w(1.1.1 55.a10.ffff 1223.3445.5668).each do |mac|
+      o.anycast_gateway_mac = mac
+      assert_equal(Utils.zero_pad_macaddr(mac), o.anycast_gateway_mac)
+    end
+  end
+end