cisco_node_utils_mgx 2.1.0.1

data/tests/test_feature.rb

@@ -0,0 +1,272 @@
+# 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/feature'
+require_relative '../lib/cisco_node_utils/vdc'
+
+include Cisco
+
+# TestFeature - Minitest for feature class
+class TestFeature < CiscoTestCase
+  @skip_unless_supported = 'feature'
+
+  def teardown
+    # f3 cleanup for non-f3 N7k's
+    vdc_limit_f3_no_intf_needed(:clear) if first_or_last_teardown
+
+    ['no nv overlay evpn',
+     'no feature bfd',
+     'no feature bgp',
+     'no feature dhcp',
+     'no feature fabric forwarding',
+     'no feature hsrp',
+     'no feature itd',
+     'no feature nv overlay',
+     'no feature ospf',
+     'no feature pim',
+     'no feature private-vlan',
+     'no feature tacacs',
+     'no feature vn-segment-vlan-based',
+     'no feature vni',
+     'no feature vtp'].each { |f| config_no_warn(f) }
+
+    # Special case for 'no feature-set fex'
+    # Some image versions prompt y/n to remove the feature-set.
+    config_no_warn('terminal dont-ask')
+    config_no_warn('no feature-set fex')
+  end
+
+  ###########
+  # Helpers #
+  ###########
+
+  # feature test helper
+  def feature(feat)
+    # Get the feature name string from the yaml
+    ref = cmd_ref.lookup('feature', feat).to_s[/set_value:.*feature (.*)/]
+
+    if ref
+      feat_str = Regexp.last_match[1]
+      refute_nil(feat_str)
+    else
+      skip("'feature','#{feat}' is unsupported on this node")
+    end
+
+    # Get current state of feature, then disable it
+    pre_clean_enabled = Feature.send("#{feat}_enabled?")
+    config("no feature #{feat_str}") if pre_clean_enabled
+    refute_show_match(
+      command: "show running | i '#{feat_str}'",
+      pattern: /^#{feat_str}$/,
+      msg:     "#{feat} (#{feat_str}) is still enabled",
+    )
+
+    Feature.send("#{feat}_enable")
+    # Some features (BGP on n5k!) are slow starters...
+    unless Feature.send("#{feat}_enabled?")
+      sleep 1
+      node.cache_flush
+    end
+    assert(Feature.send("#{feat}_enabled?"),
+           "Feature #{feat} (#{feat_str}) is not enabled")
+
+    # Return testbed to pre-clean state
+    config("no feature #{feat_str}") unless pre_clean_enabled
+  rescue RuntimeError => e
+    hardware_supports_feature?(e.message)
+  end
+
+  ###################
+  # Feature tests   #
+  ###################
+
+  def test_bfd
+    feature('bfd')
+  end
+
+  def test_bgp
+    feature('bgp')
+  end
+
+  def test_dhcp
+    feature('dhcp')
+  end
+
+  def test_hsrp
+    feature('hsrp')
+  end
+
+  def test_fabric_forwarding
+    if node.product_id[/N(3)/] && !node.product_id.include?('-F')
+      assert_nil(Feature.fabric_forwarding_enabled?)
+      assert_raises(Cisco::UnsupportedError) do
+        Feature.fabric_forwarding_enable
+      end
+      return
+    end
+    skip('This feature is only supported on 7.0(3)I2 images') unless
+      node.os_version[/7.0\(3\)I2\(/]
+    feature('fabric_forwarding')
+  end
+
+  def test_nv_overlay
+    if validate_property_excluded?('feature', 'nv_overlay')
+      assert_nil(Feature.nv_overlay_enabled?)
+      assert_raises(Cisco::UnsupportedError) { Feature.nv_overlay_enable }
+      return
+    end
+    vdc_limit_f3_no_intf_needed(:set)
+    feature('nv_overlay')
+  end
+
+  def test_nv_overlay_evpn
+    if node.product_id[/N(3)/] && !node.product_id.include?('-F')
+      assert_nil(Feature.nv_overlay_evpn_enabled?)
+      assert_raises(Cisco::UnsupportedError) { Feature.nv_overlay_evpn_enable }
+      return
+    end
+
+    vdc_limit_f3_no_intf_needed(:set)
+    # nv_overlay_evpn can't use the 'feature' helper so test it explicitly here
+    # Get current state of feature, then disable it
+    pre_clean_enabled = Feature.nv_overlay_evpn_enabled?
+    feat_str = 'nv overlay evpn'
+    config("no #{feat_str}") if pre_clean_enabled
+
+    refute_show_match(
+      command: "show running | i #{feat_str}",
+      pattern: /^#{feat_str}$/,
+      msg:     "(#{feat_str}) is still enabled",
+    )
+    Feature.nv_overlay_evpn_enable
+    assert(Feature.nv_overlay_evpn_enabled?,
+           "(#{feat_str}) is not enabled")
+  end
+
+  def test_ospf
+    feature('ospf')
+  end
+
+  def test_pim
+    feature('pim')
+  end
+
+  def test_private_vlan
+    feature('private_vlan')
+  end
+
+  def test_tacacs
+    feature('tacacs')
+  end
+
+  def test_vn_segment_vlan_based
+    vxlan_linecard?
+    Feature.fabricpath_enable if node.product_id[/N(5|6)/]
+    Feature.nv_overlay_enable unless node.product_id[/N(3|5|6)/]
+    feature('vn_segment_vlan_based')
+  rescue RuntimeError => e
+    hardware_supports_feature?(e.message)
+  end
+
+  def test_vni
+    # 7k: 'feature vni'; All others: 'feature vn-segment-vlan-based'.
+    # Dependencies: 5/6k: feature-set fabricpath; 3/9k: feature nv overlay
+    if node.product_id[/N7/]
+      # vni can't be removed if nv overlay is present
+      config_no_warn('no feature nv overlay')
+      vdc_limit_f3_no_intf_needed(:set)
+    end
+    Feature.fabricpath_enable if node.product_id[/N(5|6)/]
+    feature('vni')
+  rescue RuntimeError => e
+    hardware_supports_feature?(e.message)
+  end
+
+  def test_vtp
+    feature('vtp')
+  end
+
+  #####################
+  # Feature-set tests #
+  #####################
+
+  def test_feature_set_fabric
+    if node.product_id[/N(3|8|9)/]
+      assert_nil(Feature.fabric_enabled?)
+      assert_raises(Cisco::UnsupportedError) { Feature.fabric_enable }
+      return
+    end
+    vdc_limit_f3_no_intf_needed(:set)
+    fs = 'feature-set fabric'
+    # Get current state of the feature-set
+    feature_set_installed = Feature.fabric_installed?
+
+    config("no #{fs} ; no install #{fs}") if feature_set_installed
+    refute_show_match(
+      command: "show running | i '^install #{fs}$'",
+      pattern: /^install #{fs}$/,
+      msg:     "(#{fs}) is still configured",
+    )
+
+    Feature.fabric_enable
+    assert(Feature.fabric_enabled?, "(#{fs}) is not enabled")
+  end
+
+  def test_feature_set_fabricpath
+    if node.product_id[/N(3|8|9)/]
+      assert_nil(Feature.fabricpath_enabled?)
+      assert_raises(Cisco::UnsupportedError) { Feature.fabricpath_enable }
+      return
+    end
+    vdc_limit_f3_no_intf_needed(:set)
+    fs = 'feature-set fabricpath'
+    # Get current state of the feature-set
+    feature_set_installed = Feature.fabricpath_installed?
+
+    config("no #{fs} ; no install #{fs}") if feature_set_installed
+    refute_show_match(
+      command: "show running | i '^install #{fs}$'",
+      pattern: /^install #{fs}$/,
+      msg:     "(#{fs}) is still configured",
+    )
+
+    Feature.fabricpath_enable
+    assert(Feature.fabricpath_enabled?, "(#{fs}) is not enabled")
+  end
+
+  def test_feature_set_fex
+    if validate_property_excluded?('feature', 'fex')
+      assert_nil(Feature.fex_enabled?)
+      assert_raises(Cisco::UnsupportedError) { Feature.fex_enable }
+      return
+    end
+    fs = 'feature-set fex'
+
+    # clean
+    if Feature.fex_installed?
+      config_no_warn('terminal dont-ask')
+      config_no_warn("no #{fs}")
+      config_no_warn("no install #{fs}")
+    end
+    refute_show_match(
+      command: "show running | i '^install #{fs}$'",
+      pattern: /^install #{fs}$/,
+      msg:     "(#{fs}) is still configured",
+    )
+
+    Feature.fex_enable
+    assert(Feature.fex_enabled?, "(#{fs}) is not enabled")
+  end
+end

data/tests/test_grpc.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+#
+# October 2015, Glenn F. Matthews
+#
+# Copyright (c) 2015-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'
+
+# Test case for Cisco::Client::GRPC::Client class
+class TestGRPC < TestCase
+  @@client = nil # rubocop:disable Style/ClassVars
+
+  def self.runnable_methods
+    # If we're pointed to an NXAPI node (as evidenced by lack of a port num)
+    # then these tests don't apply
+    return [:all_skipped] unless Cisco::Environment.environment[:port]
+    super
+  end
+
+  def all_skipped
+    skip 'Node under test does not appear to use the gRPC client'
+  end
+
+  def client
+    unless @@client
+      client = Cisco::Client::GRPC.new(Cisco::Environment.environment)
+      client.cache_enable = true
+      client.cache_auto = true
+      @@client = client # rubocop:disable Style/ClassVars
+    end
+    @@client
+  end
+
+  def test_auth_failure
+    env = Cisco::Environment.environment.merge(password: 'wrong password')
+    e = assert_raises Cisco::AuthenticationFailed do
+      Cisco::Client::GRPC.new(**env)
+    end
+    assert_equal('gRPC client creation failure: Failed authentication',
+                 e.message)
+  end
+
+  def test_connection_failure
+    # Failure #1: connecting to a port that's listening for a non-gRPC protocol
+    env = Cisco::Environment.environment.merge(port: 23)
+    e = assert_raises Cisco::ConnectionRefused do
+      Cisco::Client::GRPC.new(**env)
+    end
+    assert_equal('gRPC client creation failure: Connection refused: ',
+                 e.message)
+    # Failure #2: Connecting to a port that's not listening at all
+    env = Cisco::Environment.environment.merge(port: 0)
+    e = assert_raises Cisco::ConnectionRefused do
+      Cisco::Client::GRPC.new(**env)
+    end
+    assert_equal('gRPC client creation failure: ' \
+                 'timed out during initial connection: Deadline Exceeded',
+                 e.message)
+  end
+
+  def test_set_cli_string
+    client.set(context: 'int gi0/0/0/0',
+               values:  'description panda')
+    run = client.get(command: 'show run int gi0/0/0/0')
+    assert_match(/description panda/, run)
+  end
+
+  def test_set_cli_array
+    client.set(context: ['int gi0/0/0/0'],
+               values:  ['description elephant'])
+    run = client.get(command: 'show run int gi0/0/0/0')
+    assert_match(/description elephant/, run)
+  end
+
+  def test_set_cli_invalid
+    e = assert_raises Cisco::CliError do
+      client.set(context: ['int gi0/0/0/0'],
+                 values:  ['wark', 'bark bark'])
+    end
+    # rubocop:disable Style/TrailingWhitespace
+    assert_equal('The following commands were rejected:
+  int gi0/0/0/0 wark
+  int gi0/0/0/0 bark bark
+with error:
+
+!! SYNTAX/AUTHORIZATION ERRORS: This configuration failed due to
+!! one or more of the following reasons:
+!!  - the entered commands do not exist,
+!!  - the entered commands have errors in their syntax,
+!!  - the software packages containing the commands are not active,
+!!  - the current user is not a member of a task-group that has 
+!!    permissions to use the commands.
+
+int gi0/0/0/0 wark
+int gi0/0/0/0 bark bark
+
+', e.message)
+    # rubocop:enable Style/TrailingWhitespace
+    # Unlike NXAPI, a gRPC config command is always atomic
+    assert_empty(e.successful_input)
+    assert_equal(['int gi0/0/0/0 wark', 'int gi0/0/0/0 bark bark'],
+                 e.rejected_input)
+  end
+
+  def test_get_cli_default
+    result = client.get(command: 'show debug')
+    s = @device.cmd('show debug')
+    # Strip the leading timestamp and trailing prompt from the telnet output
+    s = s.split("\n")[2..-2].join("\n")
+    assert_equal(s, result)
+  end
+
+  def test_get_cli_invalid
+    assert_raises Cisco::CliError do
+      client.get(command: 'show fuzz')
+    end
+  end
+
+  def test_get_cli_incomplete
+    assert_raises Cisco::CliError do
+      client.get(command: 'show ')
+    end
+  end
+
+  def test_get_cli_explicit
+    result = client.get(command: 'show debug', data_format: :cli)
+    s = @device.cmd('show debug')
+    # Strip the leading timestamp and trailing prompt from the telnet output
+    s = s.split("\n")[2..-2].join("\n")
+    assert_equal(s, result)
+  end
+
+  def test_get_cli_empty
+    result = client.get(command:     'show debug | include foo | exclude foo',
+                        data_format: :cli)
+    assert_nil(result)
+  end
+
+  def test_get_cli_cache
+    result = client.get(command: 'show clock', data_format: :cli)
+    sleep 2
+    assert_equal(result, client.get(command: 'show clock', data_format: :cli))
+  end
+
+  # TODO: add structured output test cases (when supported on XR)
+
+  def test_smart_create
+    autoclient = Cisco::Client.create
+    assert_equal(Cisco::Client::GRPC, autoclient.class)
+    assert(autoclient.supports?(:cli))
+    refute(autoclient.supports?(:nxapi_structured))
+    assert_equal(:ios_xr, autoclient.platform)
+  end
+end

data/tests/test_hostname.rb

@@ -0,0 +1,64 @@
+#
+# Minitest for HostName class
+#
+# Copyright (c) 2014-2018 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/hostname'
+
+# TestHostname - Minitest for SyslogSetting node utility.
+class TestHostName < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    hostname_setup
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    hostname_teardown
+    super
+  end
+
+  @current_hostname = ''
+
+  def hostname_setup
+    hostname_output = Cisco::Client.filter_cli(
+      cli_output: config('show running-config | include ^hostname'),
+      value:      /hostname (.*)/)
+    @current_hostname = hostname_output.first unless hostname_output.nil?
+    # Turn the feature off for a clean test.
+    config('no hostname')
+  end
+
+  def hostname_teardown
+    if @current_hostname != ''
+      config("hostname #{@current_hostname}")
+    else
+      config('no hostname')
+    end
+  end
+
+  # TESTS
+
+  def test_hostname_name
+    hostname_setting = Cisco::HostName.new('testhost')
+    assert_equal(Cisco::HostName.hostname['testhost'], hostname_setting)
+    hostname_setting = Cisco::HostName.new('testhost2')
+    assert_equal(Cisco::HostName.hostname['testhost2'], hostname_setting)
+    hostname_setting.send('hostname=', nil)
+    assert_nil(Cisco::HostName.hostname['testhost2'])
+  end
+end

data/tests/test_hsrp_global.rb

@@ -0,0 +1,79 @@
+# 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/hsrp_global'
+
+include Cisco
+# TestHsrpGlobal - Minitest for general functionality
+# of the HsrpGlobal class.
+class TestHsrpGlobal < CiscoTestCase
+  @skip_unless_supported = 'hsrp_global'
+
+  # Tests
+  def setup
+    super
+    config_no_warn('no feature hsrp')
+  end
+
+  def teardown
+    config_no_warn('no feature hsrp') if first_or_last_teardown
+    super
+  end
+
+  def test_collection_empty
+    hg = HsrpGlobal.globals
+    assert_empty(hg)
+  end
+
+  def test_destroy
+    hg = HsrpGlobal.new
+    assert_equal(true, Feature.hsrp_enabled?)
+
+    hg.destroy
+    [:bfd_all_intf,
+     :extended_hold,
+    ].each do |prop|
+      assert_equal(hg.send("default_#{prop}"), hg.send("#{prop}")) if
+        hg.send("#{prop}")
+    end
+  end
+
+  def test_bfd_all_intf
+    hg = HsrpGlobal.new
+    if validate_property_excluded?('hsrp_global', 'bfd_all_intf')
+      assert_nil(hg.bfd_all_intf)
+      assert_raises(Cisco::UnsupportedError) do
+        hg.bfd_all_intf = true
+      end
+      return
+    end
+    assert_equal(hg.default_bfd_all_intf, hg.bfd_all_intf)
+    hg.bfd_all_intf = true
+    assert_equal(true, hg.bfd_all_intf)
+    hg.bfd_all_intf = hg.default_bfd_all_intf
+    assert_equal(hg.default_bfd_all_intf, hg.bfd_all_intf)
+  end
+
+  def test_extended_hold
+    hg = HsrpGlobal.new
+    assert_equal(hg.default_extended_hold, hg.extended_hold)
+    hg.extended_hold = '100'
+    assert_equal('100', hg.extended_hold)
+    hg.extended_hold = '10'
+    assert_equal('10', hg.extended_hold)
+    hg.extended_hold = hg.default_extended_hold
+    assert_equal(hg.default_extended_hold, hg.extended_hold)
+  end
+end