cisco_node_utils 0.9.0

data/tests/cmd_config_invalid.yaml

@@ -0,0 +1,16 @@
+# test command config yaml file
+---
+feature-global_bad_syntax:
+  command: |
+          fature ospf
+
+
+feature-nested_bad_syntax:
+  command: > 
+          interface loopback0
+            descrion testloopback
+
+feature-input_too_long:
+  command: |
+          router ospf bluethisoutputistolongwaytoolong
+

data/tests/test_all_cisco.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+#
+# One-stop shop for running all of our current test cases.
+# December 2014, Glenn F. Matthews
+#
+# Copyright (c) 2014-2015 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 'rubygems'
+gem 'minitest', '>= 2.5.1', '< 5.0.0'
+require 'minitest/autorun'
+
+# Basic sanity
+require File.expand_path("../test_command_reference", __FILE__)
+require File.expand_path("../test_node", __FILE__)
+require File.expand_path("../test_node_ext", __FILE__)
+
+# Feature tests - please keep in alphabetical order
+require File.expand_path("../test_command_config", __FILE__)
+require File.expand_path("../test_interface", __FILE__)
+require File.expand_path("../test_interface_ospf", __FILE__)
+require File.expand_path("../test_interface_svi", __FILE__)
+require File.expand_path("../test_interface_switchport", __FILE__)
+require File.expand_path("../test_platform", __FILE__)
+require File.expand_path("../test_router_ospf", __FILE__)
+require File.expand_path("../test_router_ospf_vrf", __FILE__)
+require File.expand_path("../test_snmpcommunity", __FILE__)
+require File.expand_path("../test_snmpgroup", __FILE__)
+require File.expand_path("../test_snmpserver", __FILE__)
+require File.expand_path("../test_snmpuser", __FILE__)
+require File.expand_path("../test_tacacs_server", __FILE__)
+require File.expand_path("../test_tacacs_server_host", __FILE__)
+require File.expand_path("../test_vlan", __FILE__)
+require File.expand_path("../test_vtp", __FILE__)
+require File.expand_path("../test_yum", __FILE__)

data/tests/test_command_config.rb

@@ -0,0 +1,192 @@
+#!/usr/bin/env ruby
+#
+# Michael Wiebe, December 2014
+#
+# Copyright (c) 2014-2015 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 File.expand_path("../ciscotest", __FILE__)
+require File.expand_path("../../lib/cisco_node_utils/configparser_lib", __FILE__)
+require 'timeout'
+require 'yaml'
+
+def load_yaml(test_type=:positive)
+  if test_type == :positive
+    path = File.expand_path("../cmd_config.yaml", __FILE__)
+  elsif test_type == :negative
+    path = File.expand_path("../cmd_config_invalid.yaml", __FILE__)
+  else
+    raise TypeError
+  end
+  config_hash = YAML.load(File.read(path))
+end
+
+class TestCommandConfig < CiscoTestCase
+  include ConfigParser
+
+  # ---------------------------------------------------------------------------
+  # Helper Methods
+  # ---------------------------------------------------------------------------
+
+  def remove_whitespace(commands)
+    commands.gsub(/^\s*$\n/, '')
+  end # remove_whitespace
+
+  def compare_with_results(desired_config_str, current_key)
+    retrieve_command = "show running all"
+    running_config_str = node.show(retrieve_command)
+
+    begin
+      should_config = ConfigParser::Configuration.new(desired_config_str)
+      running_config = ConfigParser::Configuration.new(running_config_str)
+      existing = should_config.compare_with(running_config)
+    rescue StopIteration => e
+      puts e.what
+    rescue ArgumentError => e
+      puts e.what
+    end
+    # puts "Existing command block:\n#{existing}"
+    assert_equal(existing.empty?, false,
+                 "Error: Expected configuration \n'#{desired_config_str}'\n does not exist.\
+                 \nHash Key: #{current_key}")
+  end
+
+  def send_device_config(config_cmd_hash)
+    config_cmd_hash.each do |k, v|
+      v.each do |k1, v1|
+        # Send commands
+        cfg_cmd_str = "configure terminal\n#{v1.gsub(/^/, "  ")}\n  end\n"
+        cfg_string = remove_whitespace(cfg_cmd_str)
+        # puts "cfg_string: \n||\n#{cfg_string}||\n"
+        begin
+          output = node.config(cfg_string)
+          # puts "output : #{output}"
+          # make sure config is present in success case
+          compare_with_results(v1, k)
+        rescue CliError => e
+          known_failure = e.message[/ERROR:.*port channel not present/]
+          refute(known_failure, "ERROR: port channel not present")
+          raise
+        end
+      end # k1, v1
+    end
+  end
+
+  def build_int_scale_config(add=true)
+    add ? s = "" : s = "no "
+    current_interface = 0
+    num_interfaces = 1024
+    command_list = ""
+    while current_interface < num_interfaces
+      command_list += "#{s}interface loopback#{current_interface}\n"
+      current_interface += 1
+    end
+    command_list
+  end
+
+  # ---------------------------------------------------------------------------
+  # Test Case Methods
+  # ---------------------------------------------------------------------------
+
+  def test_valid_config
+    cfg_hash = load_yaml
+    begin
+      send_device_config(cfg_hash)
+    end
+  end
+
+  def test_valid_scale
+    show_int_count = "show int brief | i '^\S+\s+--' | count"
+    pre = @device.cmd(show_int_count)[/^(\d+)$/]
+
+    # Add 1024 loopback interfaces
+    cfg_hash_add = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+    cfg_hash_add ["loopback-int-add"]["command"] = "#{build_int_scale_config}"
+    begin
+      send_device_config(cfg_hash_add)
+    rescue Timeout::Error
+      puts "\n -- Long-running command, extending timeout +30 sec"
+      sleep 30 # long-running command
+      curr = @device.cmd("show int brief | count")[/^(\d+)$/]
+      flunk("Timeout while creating 1024 loopback interfaces" +
+            "(pre:#{pre} curr:#{curr}") unless (pre == curr - 1024)
+    end
+
+    # Remove 1024 loopback interfaces
+    cfg_hash_remove = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+    cfg_hash_remove ["loopback-int-add"]["command"] = "#{build_int_scale_config(add=false)}"
+    begin
+      send_device_config(cfg_hash_remove)
+    rescue Timeout::Error
+      puts "\n -- Long-running command, extending timeout +30 sec"
+      sleep 30  # long-running: n95 can take 70+ sec to remove all of these
+      curr = @device.cmd(show_int_count)[/^(\d+)$/]
+      flunk("Timeout while deleting 1024 loopback interfaces " +
+            "(pre:#{pre} curr:#{curr}") unless (pre == curr)
+    end
+  end
+
+  def test_invalid_config
+    cfg_hash = load_yaml(test_type=:negative)
+    cfg_hash.each do |k, v|
+      v.each do |k1, v1|
+        cfg_cmd_str = "configure terminal\n#{v1.gsub(/^/, "  ")}\n  end\n"
+        cfg_string = remove_whitespace(cfg_cmd_str)
+        assert_raises(CliError) do
+          output = node.config(cfg_string)
+        end
+      end # k1, v1
+    end
+  end
+
+  def test_indent_with_tab
+    assert_raises(RuntimeError,
+                  "Should have caught TAB char in indent area") do
+      Configuration.new("  \t  interface loopback10")
+    end
+  end
+
+  def test_build_min_config_hash
+      # 1. Get superset of running-config and agent-config
+      # 2. From superset derive minimum needed for parity with running
+      runn_str = "
+       \ninterface loopback10
+       \n  description foo
+       \ninterface loopback11
+       \ninterface loopback12
+       \ninterface loopback13"
+      runn_hash = Configuration.new(runn_str)
+
+      agent_str = "
+       \ninterface loopback10
+       \n  description 10
+       \ninterface loopback11
+       \nno interface loopback12
+       \ninterface loopback13"
+      agent_hash = Configuration.new(agent_str)
+
+      min_expected = "interface loopback10\ndescription 10\nno interface loopback12"
+
+      superset_str = agent_hash.compare_with(runn_hash)
+      superset_hash = Configuration.new(superset_str)
+
+      min_config_hash =
+        Configuration.build_min_config_hash(superset_hash.configuration,
+                                            agent_hash.configuration)
+      min_config_str = Configuration.config_hash_to_str(min_config_hash)
+
+      assert_equal(min_config_str.include?(min_expected), true,
+                   "Error:\nExpected:\n#{min_expected}\n\nFound:\n#{min_config_str}")
+  end
+end

data/tests/test_command_reference.rb

@@ -0,0 +1,222 @@
+#!/usr/bin/env ruby
+#
+# Unit testing for CommandReference and CmdRef classes.
+# November 2014, Glenn F. Matthews
+#
+# Copyright (c) 2014-2015 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 'minitest/autorun'
+require 'tempfile'
+require File.expand_path("../../lib/cisco_node_utils/command_reference", __FILE__)
+
+class TestCmdRef < MiniTest::Unit::TestCase
+  include CommandReference
+
+  def setup
+    @input_file = Tempfile.new('test.yaml')
+  end
+
+  def teardown
+    @input_file.close!
+  end
+
+  def load_file
+    CommandReference.new("", [@input_file.path])
+  end
+
+  def write(string)
+    @input_file.write(string + "\n")
+    @input_file.flush
+  end
+
+  def test_load_empty_file
+    # should load successfully but yield an empty hash
+    reference = load_file
+    assert(reference.empty?)
+  end
+
+  def test_load_whitespace_only
+    write("   ")
+    reference = load_file
+    assert(reference.empty?)
+  end
+
+  def test_load_not_valid_yaml
+    # The control characters embedded below are not permitted in YAML.
+    # Syck (in older Ruby versions) will incorrectly accept these
+    # while parsing the file, but our CmdRef constructor will eventually
+    # reject the data.
+    # Psych (in newer Ruby versions) will correctly reject
+    # this data at parse time.
+    write("
+feature\a\e:
+  name\b\f:
+    default_value:\vtrue")
+    assert_raises(RuntimeError) do
+      load_file
+    end
+  end
+
+  def test_load_feature_no_name
+    # should error out
+    write("feature:")
+    assert_raises(RuntimeError) do
+      load_file
+    end
+  end
+
+  def test_load_feature_name_no_data
+    write("
+feature:
+  name:")
+    assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+
+  def test_load_feature_name_default
+    write("
+feature:
+  name:
+    default_value: true")
+    reference = load_file
+    assert(!reference.empty?)
+    ref = reference.lookup("feature", "name")
+    assert_equal(true, ref.default_value)
+  end
+
+  def test_load_duplicate_feature
+    write("
+feature:
+  name:
+    default_value: false
+feature:
+  name:
+    config_get: 'show feature'
+")
+    assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+
+  def test_load_duplicate_name
+    write("
+feature:
+  name:
+    default_value: false
+  name:
+    config_get: 'show feature'")
+    assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+
+  def test_load_duplicate_param
+    write("
+feature:
+  name:
+    default_value: false
+    default_value: true")
+    assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+
+  def test_load_unsupported_key
+    write("
+feature:
+  name:
+    config_get: 'show feature'
+    what_is_this: \"I don't even\"")
+    assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+
+=begin
+  # Alphabetization of features is not enforced at this time.
+  def test_load_features_unalphabetized
+    write("
+zzz:
+  name:
+    default_value: true
+zzy:
+  name:
+    default_value: false")
+    self.assert_raises(RuntimeError) do
+      reference = load_file
+    end
+  end
+=end
+
+  def type_check(obj, cls)
+    assert(obj.is_a?(cls), "#{obj} should be #{cls} but is #{obj.class}")
+  end
+
+  def test_load_types
+    write("
+feature:
+  name:
+    default_value: true
+    config_get: show hello
+    config_get_token: !ruby/regexp '/hello world/'
+    config_set: [ \"hello\", \"world\" ]
+    test_config_get_regex: !ruby/regexp '/hello world/'
+")
+    reference = load_file
+    ref = reference.lookup("feature", "name")
+    type_check(ref.default_value, TrueClass)
+    type_check(ref.config_get, String)
+    type_check(ref.config_get_token, Regexp)
+    type_check(ref.config_set, Array)
+    type_check(ref.test_config_get_regex, Regexp)
+  end
+
+  def test_load_common
+    reference = CommandReference.new("")
+    assert(reference.files.any? { |filename| /common.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n9k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n7k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n3064.yaml/ =~ filename })
+    # Some spot checks
+    type_check(reference.lookup("vtp", "feature").config_get_token, String)
+    type_check(reference.lookup("vtp", "version").default_value, Integer)
+  end
+
+  def test_load_n9k
+    reference = CommandReference.new("N9K-C9396PX")
+    assert(reference.files.any? { |filename| /common.yaml/ =~ filename })
+    assert(reference.files.any? { |filename| /n9k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n7k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n3064.yaml/ =~ filename })
+  end
+
+  def test_load_n7k
+    reference = CommandReference.new("N7K-C7010")
+    assert(reference.files.any? { |filename| /common.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n9k.yaml/ =~ filename })
+    assert(reference.files.any? { |filename| /n7k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n3064.yaml/ =~ filename })
+  end
+
+  def test_load_n3k_3064
+    reference = CommandReference.new("N3K-C3064PQ-10GE")
+    assert(reference.files.any? { |filename| /common.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n9k.yaml/ =~ filename })
+    refute(reference.files.any? { |filename| /n7k.yaml/ =~ filename })
+    assert(reference.files.any? { |filename| /n3064.yaml/ =~ filename })
+  end
+end