cisco_node_utils_mgx 2.1.0.1

data/tests/test_node_ext.rb

@@ -0,0 +1,406 @@
+# 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.
+# 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'
+
+# TestNodeExt - Minitest for abstracted Node APIs
+class TestNodeExt < CiscoTestCase
+  def setup
+    super
+    @chassis = (platform == :nexus) ? 'Chassis' : 'Rack 0'
+    @domain = (platform == :nexus) ? 'ip domain-name' : 'domain name'
+  end
+
+  def assert_output_check(command: nil, pattern: nil, msg: nil, check: nil)
+    command += ' | no-more' if platform == :nexus
+    md = assert_show_match(command: command, pattern: pattern, msg: msg)
+    assert_equal(md[1], check, msg)
+  end
+
+  def test_config_get
+    result = node.config_get('show_version', 'system_image')
+    assert_equal(result, node.system)
+  end
+
+  def test_config_get_regexp_tokens
+    node.client.set(context: ['interface loopback0'], values: ['shutdown'])
+    node.client.set(values: ['interface loopback1', 'no shutdown'])
+
+    result = node.config_get('interface', 'shutdown',
+                             name: 'loopback1', show_name: 'loopback1')
+    refute(result)
+  end
+
+  def test_config_get_invalid
+    assert_raises IndexError do # no entry
+      node.config_get('foobar', 'name')
+    end
+    assert_raises IndexError do # entry but no config_get
+      node.config_get('show_system', 'resources')
+    end
+  end
+
+  def test_config_get_default
+    result = node.config_get_default('bgp', 'graceful_restart_timers_restart')
+    assert_equal(120, result)
+  end
+
+  def test_config_get_default_invalid
+    assert_raises IndexError do # no name entry
+      node.config_get_default('show_version', 'foobar')
+    end
+    assert_raises IndexError do # no feature entry
+      node.config_get_default('foobar', 'name')
+    end
+    assert_raises IndexError do # no default_value defined
+      node.config_get_default('show_version', 'version')
+    end
+  end
+
+  def test_config_set
+    node.config_set('interface', 'create', name: 'loopback122')
+    run = node.client.get(command: 'show run | inc interface')
+    val = Client.filter_cli(cli_output: run, value: /interface loopback122/i)
+    assert_match(/interface loopback122/i, val[0])
+
+    node.config_set('interface', 'destroy', name: 'loopback122')
+    run = node.client.get(command: 'show run | inc interface')
+    val = Client.filter_cli(cli_output: run, value: /interface loopback122/i)
+    assert_nil(val)
+  end
+
+  def test_config_set_invalid
+    assert_raises IndexError do
+      node.config_set('foobar', 'name')
+    end
+    assert_raises(IndexError, Cisco::UnsupportedError) do
+      # feature exists but no config_set
+      node.config_set('show_version', 'system_image')
+    end
+    # TODO: none of the supported classes on IOS XR use printf-style args
+    if platform == :nexus # rubocop:disable Style/GuardClause
+      assert_raises ArgumentError do # not enough args
+        node.config_set('vtp', 'domain')
+      end
+      assert_raises ArgumentError do # too many args
+        node.config_set('vtp', 'domain', 'example.com', 'baz')
+      end
+    end
+  end
+
+  def test_cli_caching
+    # don't use config() here because we are testing caching and flushing
+    @device.cmd('conf t')
+    @device.cmd("#{@domain} minitest")
+    @device.cmd('commit') if platform == :ios_xr
+    @device.cmd('end')
+    dom1 = node.domain_name
+    @device.cmd('conf t')
+    @device.cmd("no #{@domain} minitest")
+    @device.cmd('commit') if platform == :ios_xr
+    @device.cmd('end')
+    dom2 = node.domain_name
+    assert_equal(dom1, dom2) # cached output was used for dom2
+
+    node.cache_flush
+    dom3 = node.domain_name
+    refute_equal(dom1, dom3)
+  end
+
+  def test_get_product_description
+    product_description = node.product_description
+
+    command = node.cmd_ref.lookup('show_version', 'description').get_command
+
+    # Hardware
+    #   cisco Nexus9000 C9396PX Chassis
+    #
+    # Other variants for the line of interest:
+    #   cisco Nexus9000 C9504 (4 Slot) Chassis ("Supervisor Module")
+    #                                          ^-module_id-ignore!-^
+    #   cisco Nexus3000 C3132Q Chassis
+    #   cisco N3K-C3048TP-1GE
+    pattern = /Hardware\n  cisco (([^(\n]+|\(\d+ Slot\))+\w+)/ if
+      platform[/nexus/]
+    pattern = /DESCR: "(.*)"/ if platform[/ios_xr/]
+
+    assert_output_check(command: command,
+                        pattern: pattern,
+                        check:   product_description,
+                        msg:     'Error, Product description does not match')
+  end
+
+  def test_get_product_id
+    # N3|9K Fretta product_id gets a '-F' appended so remove it for this check
+    if product_tag[/n(3|9)k-f/]
+      node.client.cache_flush
+      chassis = node.product_id.sub('-F', '')
+    else
+      node.client.cache_flush
+      chassis = node.product_id
+    end
+    assert_output_check(command: 'show inventory',
+                        pattern: /NAME: \"#{@chassis}\".*\nPID: (\S+)/,
+                        check:   chassis,
+                        msg:     'Error, Product id does not match')
+  end
+
+  def test_get_product_version_id
+    assert_output_check(command: 'show inventory',
+                        pattern: /NAME: \"#{@chassis}\".*\n.*VID: (\w+)/,
+                        check:   node.product_version_id,
+                        msg:     'Error, Version id does not match')
+  end
+
+  def test_get_product_serial_number
+    assert_output_check(command: 'show inventory',
+                        pattern: /NAME: \"#{@chassis}\".*\n.*SN: ([-\w]+)/,
+                        check:   node.product_serial_number,
+                        msg:     'Error, Serial number does not match')
+  end
+
+  def test_get_os
+    assert_output_check(command: 'show version',
+                        pattern: /\n(Cisco.*Software)/,
+                        check:   node.os,
+                        msg:     'Error, OS version does not match')
+  end
+
+  def test_get_os_version
+    # /N(5|6|7)/
+    #   system:    version 7.3(0)D1(1) [build 7.3(0)D1(1)]
+    # /N(3|8|9)/
+    #   NXOS: version 7.0(3)I3(1) [build 7.0(3)I3(1)]
+
+    pattern = /(?:system|NXOS):\s+version (.*)\n/ if platform[/nexus/]
+    pattern = /IOS XR.*Version (.*)$/ if platform[/ios_xr/]
+
+    assert_output_check(command: 'show version',
+                        pattern: pattern,
+                        check:   node.os_version,
+                        msg:     'Error, OS version does not match')
+  end
+
+  def test_get_host_name_when_not_set
+    if platform == :nexus
+      s = @device.cmd('show running-config all | no-more')
+    else
+      s = @device.cmd('show running-config all')
+    end
+    pattern = /.*\nhostname (\S+)/
+    md = pattern.match(s)
+    if md
+      configured_name = md[1]
+      switchname = false
+    else
+      # No hostname configured. Lets check if we have switchname instead.
+      pattern = /.*\nswitchname (\S+)/
+      md = pattern.match(s)
+      if md
+        configured_name = md[1]
+        switchname = true
+      else
+        configured_name = nil
+      end
+    end
+
+    switchname ? config('no switchname') : config('no hostname')
+
+    name = node.host_name
+    if platform == :nexus
+      assert_equal('switch', name)
+    else
+      assert_equal('ios', name)
+    end
+
+    return unless configured_name
+    config("hostname #{configured_name}") if switchname == false
+    config("switchname #{configured_name}") if switchname == true
+  end
+
+  def test_get_host_name_when_set
+    if platform == :nexus
+      s = @device.cmd('show running-config all | no-more')
+    else
+      s = @device.cmd('show running-config all')
+    end
+    pattern = /.*\nhostname (\S+)/
+    md = pattern.match(s)
+    if md
+      configured_name = md[1]
+      switchname = false
+    else
+      # No hostname configured. Lets check if we have switchname instead.
+      pattern = /.*\nswitchname (\S+)/
+      md = pattern.match(s)
+      if md
+        configured_name = md[1]
+        switchname = true
+      else
+        configured_name = nil
+        switchname = false
+      end
+    end
+
+    switchname ? config('switchname xyz') : config('hostname xyz')
+
+    host_name = node.host_name
+    assert_equal('xyz', host_name)
+
+    if configured_name
+      config("hostname #{configured_name}") if switchname == false
+      config("switchname #{configured_name}") if switchname == true
+    else
+      switchname ? config('no switchname') : config('no hostname')
+    end
+  end
+
+  def test_get_domain_name_when_not_set
+    # Test with default vrf only
+    s = @device.cmd("show running-config | incl '^#{@domain}'")
+    pattern = /^#{@domain} (\S+)/
+    md = pattern.match(s)
+    if md
+      configured_domain_name = md[1]
+    else
+      configured_domain_name = nil
+    end
+
+    config("no #{@domain} #{configured_domain_name}") unless
+      configured_domain_name.nil?
+
+    domain_name = node.domain_name
+    assert_equal('', domain_name)
+
+    if configured_domain_name
+      config("#{@domain} #{configured_domain_name}")
+    else
+      config("no #{@domain} abc.com")
+    end
+  end
+
+  def test_get_domain_name_when_set
+    s = @device.cmd('show running-config | no-more')
+    pattern = /.*\n#{@domain} (\S+)/
+    md = pattern.match(s)
+    if md
+      configured_domain_name = md[1]
+    else
+      configured_domain_name = nil
+    end
+
+    config("#{@domain} abc.com")
+
+    domain_name = node.domain_name
+    assert_equal('abc.com', domain_name)
+
+    if configured_domain_name
+      config("#{@domain} #{configured_domain_name}")
+    else
+      config("no #{@domain} abc.com")
+    end
+  end
+
+  def test_get_system_uptime
+    node.cache_flush
+
+    cmd = node.cmd_ref.lookup('show_system', 'uptime').get_command
+    pattern = node.cmd_ref.lookup('show_system', 'uptime').get_value
+
+    md = assert_show_match(command: cmd, pattern: pattern)
+    node_uptime = node.system_uptime
+
+    observed_system_uptime = (
+      (md[1].to_i * 86_400) +
+      (md[2].to_i * 3600) +
+      (md[3].to_i * 60) +
+      (md[4].to_i)
+    )
+    delta = node_uptime - observed_system_uptime
+    assert(delta < 10,
+           "Error, System uptime delta is (#{delta}), expected (delta < 10)")
+  end
+
+  def test_get_last_reset_time
+    if validate_property_excluded?('show_version', 'last_reset_time')
+      assert_nil(node.last_reset_time)
+    else
+      refute_nil(node.last_reset_time) unless virtual_platform?
+    end
+  end
+
+  def test_get_last_reset_reason
+    if validate_property_excluded?('show_version', 'last_reset_reason')
+      assert_nil(node.last_reset_reason)
+      return
+    end
+    assert_output_check(command: 'show version',
+                        pattern: /.*\nLast reset.*\n\n?  Reason: (.*)\n/,
+                        check:   node.last_reset_reason,
+                        msg:     'Error, Last reset reason does not match') unless
+      virtual_platform?
+  end
+
+  def test_get_system_cpu_utilization
+    if validate_property_excluded?('system', 'resources')
+      assert_nil(node.system_cpu_utilization)
+    else
+      refute_nil(node.system_cpu_utilization)
+    end
+  end
+
+  def test_get_boot
+    if validate_property_excluded?('show_version', 'boot_image')
+      assert_nil(node.boot)
+      return
+    end
+
+    # /N(5|6|7)/
+    #   kickstart image file is: bootflash:///n7000-s2-kickstart.7.3.0.D1.1.bin
+    # /N(3|8|9)/
+    #   NXOS image file is: bootflash:///nxos.7.0.3.I3.1.bin
+
+    pattern = /(?:kickstart|NXOS) image file is:\s+(.*)$/
+    assert_output_check(command: 'show version',
+                        pattern: pattern,
+                        check:   node.boot,
+                        msg:     'Error, Kickstart Image does not match')
+  end
+
+  def test_get_system
+    if validate_property_excluded?('show_version', 'system_image')
+      assert_nil(node.system)
+      return
+    end
+
+    # /N(5|6|7)/
+    # system image file is: bootflash:///n7000-s2-kickstart.7.3.0.D1.1.bin
+    # /N(3|8|9)/
+    # NXOS image file is: bootflash:///nxos.7.0.3.I3.1.bin
+    # /ios_xr/
+    # xrv9k-xr-6.1.1.19I version=6.1.1.19I [Boot image]
+
+    if platform[/ios_xr/]
+      cmd = 'show install active'
+      pattern = /^\s*(\S*)\s*version.*\[Boot image\]$/
+    else
+      cmd = 'show version'
+      pattern = /(?:system|NXOS) image file is:\s+(.*)$/
+    end
+    assert_output_check(command: cmd,
+                        pattern: pattern,
+                        check:   node.system,
+                        msg:     'Error, System Image does not match')
+  end
+end

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_auth_key.rb

@@ -0,0 +1,77 @@
+#
+# Minitest for NtpAuthKey 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_auth_key'
+
+# TestNtpAuthKey - Minitest for NtpAuthKey node utility.
+class TestNtpAuthKey < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    no_ntpkey
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_ntpkey
+    super
+  end
+
+  def no_ntpkey
+    # Turn the feature off for a clean test.
+    config('no ntp authentication-key 111 md5 test 7',
+           'no ntp authentication-key 999 md5 test 7')
+  end
+
+  # TESTS
+
+  def test_create_defaults
+    id = '111'
+    options = { 'name' => id, 'password' => 'test' }
+    refute_includes(Cisco::NtpAuthKey.ntpkeys, id)
+
+    key = Cisco::NtpAuthKey.new(options, true)
+    assert_includes(Cisco::NtpAuthKey.ntpkeys, id)
+    assert_equal(key, Cisco::NtpAuthKey.ntpkeys[id])
+
+    assert_equal(id, Cisco::NtpAuthKey.ntpkeys[id].name)
+    assert_equal('md5', Cisco::NtpAuthKey.ntpkeys[id].algorithm)
+    assert_equal('7', Cisco::NtpAuthKey.ntpkeys[id].mode)
+
+    key.destroy
+    refute_includes(Cisco::NtpAuthKey.ntpkeys, id)
+  end
+
+  def test_create_options
+    id = '999'
+    options = { 'name' => id, 'password' => 'test', 'algorithm' => 'md5',
+                'mode' => '7' }
+    refute_includes(Cisco::NtpAuthKey.ntpkeys, id)
+
+    key = Cisco::NtpAuthKey.new(options, true)
+    assert_includes(Cisco::NtpAuthKey.ntpkeys, id)
+    assert_equal(key, Cisco::NtpAuthKey.ntpkeys[id])
+
+    assert_equal(id, Cisco::NtpAuthKey.ntpkeys[id].name)
+    assert_equal('md5', Cisco::NtpAuthKey.ntpkeys[id].algorithm)
+    assert_equal('7', Cisco::NtpAuthKey.ntpkeys[id].mode)
+
+    key.destroy
+    refute_includes(Cisco::NtpAuthKey.ntpkeys, id)
+  end
+end

data/tests/test_ntp_config.rb

@@ -0,0 +1,100 @@
+#
+# Minitest for NtpConfig class
+#
+# 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.
+# 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_config'
+
+# TestNtpConfig - Minitest for NtpConfig node utility.
+class TestNtpConfig < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    no_ntpconfig
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_ntpconfig
+    super
+  end
+
+  def no_ntpconfig
+    # Turn the feature off for a clean test.
+    if platform == :ios_xr
+      config("no ntp source #{interfaces[1]}")
+    else
+      config("no ntp source-interface #{interfaces[1]}",
+             'no ntp authentication-key 111 md5 test 7',
+             'no ntp authentication-key 999 md5 test 7',
+             'no ntp trusted-key 111',
+             'no ntp trusted-key 999',
+             'no ntp authenticate')
+    end
+  end
+
+  # TESTS
+
+  def test_source_interface
+    id = 'default'
+
+    ntp = Cisco::NtpConfig.new(id)
+    assert_includes(Cisco::NtpConfig.ntpconfigs, id)
+    assert_equal(Cisco::NtpConfig.ntpconfigs[id], ntp)
+
+    assert_nil(Cisco::NtpConfig.ntpconfigs[id].source_interface)
+    assert_nil(ntp.source_interface)
+
+    ntp.source_interface = interfaces[1]
+    assert_equal(Cisco::NtpConfig.ntpconfigs[id].source_interface,
+                 interfaces[1].downcase)
+    assert_equal(Cisco::NtpConfig.ntpconfigs[id].source_interface,
+                 ntp.source_interface)
+
+    ntp.source_interface = nil
+    assert_nil(Cisco::NtpConfig.ntpconfigs[id].source_interface)
+    assert_nil(ntp.source_interface)
+  end
+
+  def test_authenticate
+    id = 'default'
+
+    ntp = Cisco::NtpConfig.new(id)
+    assert_includes(Cisco::NtpConfig.ntpconfigs, id)
+    assert_equal(Cisco::NtpConfig.ntpconfigs[id], ntp)
+
+    assert_equal(false, Cisco::NtpConfig.ntpconfigs[id].authenticate)
+
+    ntp.authenticate = true
+    assert_equal(true, Cisco::NtpConfig.ntpconfigs[id].authenticate)
+  end
+
+  def test_trusted_key
+    id = 'default'
+
+    ntp = Cisco::NtpConfig.new(id)
+    assert_includes(Cisco::NtpConfig.ntpconfigs, id)
+    assert_equal(Cisco::NtpConfig.ntpconfigs[id], ntp)
+
+    assert_nil(Cisco::NtpConfig.ntpconfigs[id].trusted_key)
+
+    config('ntp authentication-key 111 md5 test 7',
+           'ntp authentication-key 999 md5 test 7')
+    ntp.trusted_key_set(true, 111)
+    ntp.trusted_key_set(true, 999)
+    assert_equal(%w(111 999), Cisco::NtpConfig.ntpconfigs[id].trusted_key)
+  end
+end