cisco_node_utils 1.0.1 → 1.1.0

data/tests/test_command_config.rb

@@ -16,22 +16,23 @@
 # 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_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/configparser_lib'
 require 'timeout'
 require 'yaml'
 
 def load_yaml(test_type=:positive)
   if test_type == :positive
-    path = File.expand_path("../cmd_config.yaml", __FILE__)
+    path = File.expand_path('../cmd_config.yaml', __FILE__)
   elsif test_type == :negative
-    path = File.expand_path("../cmd_config_invalid.yaml", __FILE__)
+    path = File.expand_path('../cmd_config_invalid.yaml', __FILE__)
   else
-    raise TypeError
+    fail TypeError
   end
-  config_hash = YAML.load(File.read(path))
+  YAML.load(File.read(path))
 end
 
+# TestCommandConfig - Minitest for ConfigParser module
 class TestCommandConfig < CiscoTestCase
   include ConfigParser
 
@@ -44,7 +45,7 @@ class TestCommandConfig < CiscoTestCase
   end # remove_whitespace
 
   def compare_with_results(desired_config_str, current_key)
-    retrieve_command = "show running all"
+    retrieve_command = 'show running all'
     running_config_str = node.show(retrieve_command)
 
     begin
@@ -58,36 +59,35 @@ class TestCommandConfig < CiscoTestCase
     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}")
+                 "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|
+      v.each_value do |v1|
         # Send commands
-        cfg_cmd_str = "configure terminal\n#{v1.gsub(/^/, "  ")}\n  end\n"
+        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}"
+          node.config(cfg_string)
           # 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")
+          refute(known_failure, 'ERROR: port channel not present')
           raise
         end
-      end # k1, v1
+      end
     end
   end
 
   def build_int_scale_config(add=true)
-    add ? s = "" : s = "no "
+    add ? s = '' : s = 'no '
     current_interface = 0
     num_interfaces = 1024
-    command_list = ""
+    command_list = ''
     while current_interface < num_interfaces
       command_list += "#{s}interface loopback#{current_interface}\n"
       current_interface += 1
@@ -112,81 +112,84 @@ class TestCommandConfig < CiscoTestCase
 
     # 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}"
+    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" +
+      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)}"
+    cfg_hash_remove['loopback-int-add']['command'] = \
+      "#{build_int_scale_config(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
+      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 " +
+      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_hash = load_yaml(:negative)
+    cfg_hash.each_value do |v|
+      v.each_value do |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
+        assert_raises(CliError) { node.config(cfg_string) }
+      end
     end
   end
 
   def test_indent_with_tab
     assert_raises(RuntimeError,
-                  "Should have caught TAB char in indent area") do
+                  '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}")
+    # 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',
+                    'description 10',
+                    'no interface loopback12',
+                   ].join("\n")
+
+    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

@@ -1,6 +1,5 @@
 #!/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.
@@ -20,9 +19,10 @@
 
 require 'minitest/autorun'
 require 'tempfile'
-require File.expand_path("../../lib/cisco_node_utils/command_reference", __FILE__)
+require_relative '../lib/cisco_node_utils/command_reference'
 
-class TestCmdRef < MiniTest::Unit::TestCase
+# TestCmdRef - Minitest for CommandReference and CmdRef classes.
+class TestCmdRef < MiniTest::Test
   include CommandReference
 
   def setup
@@ -34,7 +34,7 @@ class TestCmdRef < MiniTest::Unit::TestCase
   end
 
   def load_file
-    CommandReference.new("", [@input_file.path])
+    CommandReference.new('', [@input_file.path])
   end
 
   def write(string)
@@ -49,7 +49,7 @@ class TestCmdRef < MiniTest::Unit::TestCase
   end
 
   def test_load_whitespace_only
-    write("   ")
+    write('   ')
     reference = load_file
     assert(reference.empty?)
   end
@@ -65,14 +65,12 @@ class TestCmdRef < MiniTest::Unit::TestCase
 feature\a\e:
   name\b\f:
     default_value:\vtrue")
-    assert_raises(RuntimeError) do
-      load_file
-    end
+    assert_raises(RuntimeError) { load_file }
   end
 
   def test_load_feature_no_name
     # should error out
-    write("feature:")
+    write('feature:')
     assert_raises(RuntimeError) do
       load_file
     end
@@ -83,7 +81,7 @@ feature\a\e:
 feature:
   name:")
     assert_raises(RuntimeError) do
-      reference = load_file
+      load_file
     end
   end
 
@@ -94,7 +92,7 @@ feature:
     default_value: true")
     reference = load_file
     assert(!reference.empty?)
-    ref = reference.lookup("feature", "name")
+    ref = reference.lookup('feature', 'name')
     assert_equal(true, ref.default_value)
   end
 
@@ -107,9 +105,7 @@ feature:
   name:
     config_get: 'show feature'
 ")
-    assert_raises(RuntimeError) do
-      reference = load_file
-    end
+    assert_raises(RuntimeError) { load_file }
   end
 
   def test_load_duplicate_name
@@ -119,9 +115,7 @@ feature:
     default_value: false
   name:
     config_get: 'show feature'")
-    assert_raises(RuntimeError) do
-      reference = load_file
-    end
+    assert_raises(RuntimeError) { load_file }
   end
 
   def test_load_duplicate_param
@@ -130,9 +124,7 @@ feature:
   name:
     default_value: false
     default_value: true")
-    assert_raises(RuntimeError) do
-      reference = load_file
-    end
+    assert_raises(RuntimeError) { load_file }
   end
 
   def test_load_unsupported_key
@@ -141,26 +133,20 @@ feature:
   name:
     config_get: 'show feature'
     what_is_this: \"I don't even\"")
-    assert_raises(RuntimeError) do
-      reference = load_file
-    end
+    assert_raises(RuntimeError) { load_file }
   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
+  #   # 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) { load_file }
+  #   end
 
   def type_check(obj, cls)
     assert(obj.is_a?(cls), "#{obj} should be #{cls} but is #{obj.class}")
@@ -177,7 +163,7 @@ feature:
     test_config_get_regex: !ruby/regexp '/hello world/'
 ")
     reference = load_file
-    ref = reference.lookup("feature", "name")
+    ref = reference.lookup('feature', 'name')
     type_check(ref.default_value, TrueClass)
     type_check(ref.config_get, String)
     type_check(ref.config_get_token, Regexp)
@@ -186,18 +172,18 @@ feature:
   end
 
   def test_load_common
-    reference = CommandReference.new("")
+    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)
+    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")
+    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 })
@@ -205,7 +191,7 @@ feature:
   end
 
   def test_load_n7k
-    reference = CommandReference.new("N7K-C7010")
+    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 })
@@ -213,7 +199,7 @@ feature:
   end
 
   def test_load_n3k_3064
-    reference = CommandReference.new("N3K-C3064PQ-10GE")
+    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 })

data/tests/test_dns_domain.rb

@@ -0,0 +1,113 @@
+#
+# Minitest for DnsDomain class
+#
+# 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_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/dns_domain'
+
+# TestDnsDomain - Minitest for DnsDomain node utility.
+class TestDnsDomain < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    no_dnsdomain_tests
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_dnsdomain_tests
+    super
+  end
+
+  def no_dnsdomain_tests
+    # Turn the feature off for a clean test.
+    config('no ip domain-list aoeu.com',
+           'no ip domain-list asdf.com',
+           'no vrf context test')
+  end
+
+  # TESTS
+
+  def test_dnsdomain_create_destroy_single
+    id = 'aoeu.com'
+    refute_includes(Cisco::DnsDomain.dnsdomains, id)
+
+    ns = Cisco::DnsDomain.new(id)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id)
+    assert_equal(Cisco::DnsDomain.dnsdomains[id], ns)
+
+    ns.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains, id)
+  end
+
+  def test_dnsdomain_create_destroy_multiple
+    id1 = 'aoeu.com'
+    id2 = 'asdf.com'
+    refute_includes(Cisco::DnsDomain.dnsdomains, id1)
+    refute_includes(Cisco::DnsDomain.dnsdomains, id2)
+
+    ns1 = Cisco::DnsDomain.new(id1)
+    ns2 = Cisco::DnsDomain.new(id2)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id1)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id2)
+    assert_equal(Cisco::DnsDomain.dnsdomains[id1], ns1)
+    assert_equal(Cisco::DnsDomain.dnsdomains[id2], ns2)
+
+    ns1.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains, id1)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id2)
+    ns2.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains, id2)
+  end
+
+  def test_dnsdomain_create_destroy_single_vrf
+    id = 'aoeu.com'
+    vrf = 'test'
+    non_vrf = Cisco::DnsDomain.new(id)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id)
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id)
+
+    ns = Cisco::DnsDomain.new(id, vrf)
+    assert_includes(Cisco::DnsDomain.dnsdomains(vrf), id)
+    assert_equal(Cisco::DnsDomain.dnsdomains(vrf)[id], ns)
+
+    ns.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id)
+    assert_includes(Cisco::DnsDomain.dnsdomains, id)
+    non_vrf.destroy
+  end
+
+  def test_dnsdomain_create_destroy_multiple_vrf
+    id1 = 'aoeu.com'
+    id2 = 'asdf.com'
+    vrf = 'test'
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id1)
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id2)
+
+    ns1 = Cisco::DnsDomain.new(id1, vrf)
+    ns2 = Cisco::DnsDomain.new(id2, vrf)
+    assert_includes(Cisco::DnsDomain.dnsdomains(vrf), id1)
+    assert_includes(Cisco::DnsDomain.dnsdomains(vrf), id2)
+    assert_equal(Cisco::DnsDomain.dnsdomains(vrf)[id1], ns1)
+    assert_equal(Cisco::DnsDomain.dnsdomains(vrf)[id2], ns2)
+
+    ns1.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id1)
+    assert_includes(Cisco::DnsDomain.dnsdomains(vrf), id2)
+    ns2.destroy
+    refute_includes(Cisco::DnsDomain.dnsdomains(vrf), id2)
+  end
+end