cisco_node_utils 1.2.0 → 1.3.0

data/tests/test_node_util.rb

@@ -0,0 +1,119 @@
+# Copyright (c) 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_util'
+
+# TestNodeUtil - Minitest for NodeUtil class
+class TestNodeUtil < CiscoTestCase
+  attr_reader :nu
+  def setup
+    @nu = NodeUtil.new
+  end
+
+  def test_node
+    assert_equal(node, nu.node)
+    assert_equal(node, NodeUtil.node)
+  end
+
+  def test_client
+    assert_equal(node.client, nu.client)
+    assert_equal(node.client, NodeUtil.client)
+  end
+
+  def test_config_get
+    result = node.config_get('show_version', 'system_image')
+    result2 = nu.config_get('show_version', 'system_image')
+    result3 = NodeUtil.config_get('show_version', 'system_image')
+    assert_equal(node.system, result)
+    assert_equal(result, result2)
+    assert_equal(result, result3)
+  end
+
+  def test_config_get_default
+    result = node.config_get_default('bgp', 'graceful_restart_timers_restart')
+    result2 = nu.config_get_default('bgp', 'graceful_restart_timers_restart')
+    result3 = NodeUtil.config_get_default('bgp',
+                                          'graceful_restart_timers_restart')
+    assert_equal(120, result)
+    assert_equal(result, result2)
+    assert_equal(result, result3)
+  end
+
+  def test_config_set_error_handling
+    # The Node error has no context information
+    e = assert_raises(Cisco::CliError) do
+      node.config_set('interface', 'shutdown',
+                      name: interfaces[0], state: 'foobar')
+    end
+    assert_match(/^The command '.*shutdown' was rejected with error:/,
+                 e.message)
+    rejected_input = e.rejected_input
+    clierror = e.clierror
+
+    # The NodeUtil class error just provides the class name by default...
+    e = assert_raises(Cisco::CliError) do
+      NodeUtil.config_set('interface', 'shutdown',
+                          name: interfaces[0], state: 'foobar')
+    end
+    assert_match(
+      /^\[Cisco::NodeUtil\] The command '.*shutdown' was rejected with error:/,
+      e.message)
+    # Make sure error context from the Node was preserved
+    assert_equal(rejected_input, e.rejected_input)
+    assert_equal(clierror, e.clierror)
+
+    # ...but uses self.to_s if implemented
+    def NodeUtil.to_s
+      'Hello world'
+    end
+    e = assert_raises(Cisco::CliError) do
+      NodeUtil.config_set('interface', 'shutdown',
+                          name: interfaces[0], state: 'foobar')
+    end
+    assert_match(
+      /^\[Hello world\] The command '.*shutdown' was rejected with error:/,
+      e.message)
+    # Make sure error context from the Node was preserved
+    assert_equal(rejected_input, e.rejected_input)
+    assert_equal(clierror, e.clierror)
+
+    # Similarly, the nu instance error provides the instance by default...
+    e = assert_raises(Cisco::CliError) do
+      nu.config_set('interface', 'shutdown',
+                    name: interfaces[0], state: 'foobar')
+    end
+    assert_match(
+      /^\[#<Cisco::NodeUtil:0x.*>\] The command '.*shutdown' was rejected/,
+      e.message)
+    # Make sure error context from the Node was preserved
+    assert_equal(rejected_input, e.rejected_input)
+    assert_equal(clierror, e.clierror)
+
+    # ...but is happy to use the instance to_s
+    def nu.to_s
+      'NodeUtil #1'
+    end
+    e = assert_raises(Cisco::CliError) do
+      nu.config_set('interface', 'shutdown',
+                    name: interfaces[0], state: 'foobar')
+    end
+    assert_match(
+      /^\[NodeUtil #1\] The command '.*shutdown' was rejected with error:/,
+      e.message)
+    # Make sure error context from the Node was preserved
+    assert_equal(rejected_input, e.rejected_input)
+    assert_equal(clierror, e.clierror)
+  end
+end

data/tests/test_ntp_config.rb

@@ -28,7 +28,11 @@ class TestNtpConfig < CiscoTestCase
 
   def no_ntpconfig
     # Turn the feature off for a clean test.
-    config("no ntp source-interface #{interfaces[0]}")
+    if platform == :ios_xr
+      config("no ntp source #{interfaces[0]}")
+    else
+      config("no ntp source-interface #{interfaces[0]}")
+    end
   end
 
   # TESTS

data/tests/test_ntp_server.rb

@@ -34,8 +34,8 @@ class TestNtpServer < CiscoTestCase
 
   def no_ntpserver_uk
     # Turn the feature off for a clean test.
-    config('no ntpserver 130.88.203.12',
-           'no ntpserver 2003::5')
+    config('no ntp server 130.88.203.12',
+           'no ntp server 2003::5')
   end
 
   # TESTS

data/tests/test_nxapi.rb

@@ -0,0 +1,221 @@
+# 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 'basetest'
+require_relative '../lib/cisco_node_utils/node'
+
+# TestNxapi - NXAPI client unit tests
+class TestNxapi < TestCase
+  @@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
+    @product_id = Cisco::Node.new.product_id if @product_id.nil?
+    cleanup
+  end
+
+  def teardown
+    cleanup
+    super
+  end
+
+  def cleanup
+    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))
+    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
+  ensure
+    @device.cmd('configure terminal')
+    @device.cmd('feature nxapi')
+    @device.cmd('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
+    def client.hello
+      req('hello', 'world')
+    end
+
+    assert_raises Cisco::RequestNotSupported do
+      client.hello
+    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_overlay_global.rb

@@ -21,82 +21,91 @@ include Cisco
 
 # TestOverlayGlobal - Minitest for OverlayGlobal node utility
 class TestOverlayGlobal < CiscoTestCase
+  @skip_unless_supported = 'overlay_global'
+
   def setup
     super
-    config('no feature fabric forwarding')
-    config('no nv overlay evpn')
-    config('l2rib dup-host-mac-detection default')
+    vxlan_linecard?
+    vdc_lc_state('f3')
+    config_no_warn('no feature fabric forwarding')
+    config_no_warn('no nv overlay evpn')
+    config_no_warn('l2rib dup-host-mac-detection default')
   end
 
   def test_dup_host_ip_addr_detection
-    overlay_global = OverlayGlobal.new
+    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
 
     # Before enabling 'nv overlay evpn', these properties do not exist
-    assert_nil(overlay_global.dup_host_ip_addr_detection_host_moves)
-    assert_nil(overlay_global.dup_host_ip_addr_detection_timeout)
+    assert_nil(o.dup_host_ip_addr_detection_host_moves)
+    assert_nil(o.dup_host_ip_addr_detection_timeout)
 
     # Set them to the default value and they should now be present
-    default = [overlay_global.default_dup_host_ip_addr_detection_host_moves,
-               overlay_global.default_dup_host_ip_addr_detection_timeout]
-    overlay_global.dup_host_ip_addr_detection_set(*default)
-    assert_equal(default[0],
-                 overlay_global.dup_host_ip_addr_detection_host_moves)
-    assert_equal(default[1],
-                 overlay_global.dup_host_ip_addr_detection_timeout)
+    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]
-    overlay_global.dup_host_ip_addr_detection_set(*val)
-    assert_equal(val, overlay_global.dup_host_ip_addr_detection)
-    assert_equal(val[0],
-                 overlay_global.dup_host_ip_addr_detection_host_moves)
-    assert_equal(val[1],
-                 overlay_global.dup_host_ip_addr_detection_timeout)
+    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
-    overlay_global = OverlayGlobal.new
+    o = OverlayGlobal.new
     # These properties always exist, even without 'nv overlay evpn'
-    default = [overlay_global.default_dup_host_mac_detection_host_moves,
-               overlay_global.default_dup_host_mac_detection_timeout]
-    assert_equal(default, overlay_global.dup_host_mac_detection)
+    default = [o.default_dup_host_mac_detection_host_moves,
+               o.default_dup_host_mac_detection_timeout]
+    assert_equal(default, o.dup_host_mac_detection)
     refute(Feature.nv_overlay_evpn_enabled?)
 
     # Set to a non-default value
     val = [160, 16]
-    overlay_global.dup_host_mac_detection_set(*val)
-    assert_equal(val, overlay_global.dup_host_mac_detection)
+    o.dup_host_mac_detection_set(*val)
+    assert_equal(val, o.dup_host_mac_detection)
     refute(Feature.nv_overlay_evpn_enabled?)
 
     # Use the special defaulter method
-    overlay_global.dup_host_mac_detection_default
-    assert_equal(default, overlay_global.dup_host_mac_detection)
+    o.dup_host_mac_detection_default
+    assert_equal(default, o.dup_host_mac_detection)
     refute(Feature.nv_overlay_evpn_enabled?)
 
     # Set explicitly to default too
-    overlay_global.dup_host_mac_detection_set(*default)
-    assert_equal(default, overlay_global.dup_host_mac_detection)
+    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
-    overlay_global = OverlayGlobal.new
+    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
+
     # Before enabling 'nv overlay evpn', this property does not exist
-    assert_nil(overlay_global.anycast_gateway_mac)
+    assert_nil(o.anycast_gateway_mac)
 
     # Explicitly set to default and it should be enabled
-    overlay_global.anycast_gateway_mac = \
-      overlay_global.default_anycast_gateway_mac
-    assert_equal(overlay_global.default_anycast_gateway_mac,
-                 overlay_global.anycast_gateway_mac)
+    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|
-      overlay_global.anycast_gateway_mac = mac
-      assert_equal(Utils.zero_pad_macaddr(mac),
-                   overlay_global.anycast_gateway_mac)
+      o.anycast_gateway_mac = mac
+      assert_equal(Utils.zero_pad_macaddr(mac), o.anycast_gateway_mac)
     end
   end
 end