cisco_node_utils_mgx 2.1.0.1

data/tests/test_ace.rb

@@ -0,0 +1,304 @@
+# Copyright (c) 2015-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/acl'
+require_relative '../lib/cisco_node_utils/ace'
+
+# TestAce - Minitest for Ace node utility class
+class TestAce < CiscoTestCase
+  @skip_unless_supported = 'acl'
+  @@pre_clean_needed = true # rubocop:disable Style/ClassVars
+
+  def setup
+    super
+    remove_all_acls if @@pre_clean_needed
+    @@pre_clean_needed = false # rubocop:disable Style/ClassVars
+  end
+
+  def teardown
+    super
+    remove_all_acls
+  end
+
+  def remove_all_acls
+    Acl.acls.each do |_afis, acls|
+      acls.values.each(&:destroy)
+    end
+  end
+
+  # Helper to create an ACE and return the obj. The test_hash contains
+  # only the minimum properties which can be added to or overwritten as
+  # required for each test.
+  def ace_helper(afi, props=nil)
+    test_hash = {
+      action:   'permit',
+      proto:    'tcp',
+      src_addr: 'any',
+      dst_addr: 'any',
+    }
+    test_hash.merge!(props) unless props.nil?
+
+    a = Ace.new(afi, afi, 10)
+    begin
+      a.ace_set(test_hash)
+      a
+    end
+  rescue CliError => e
+    skip('This property is not supported on this platform') if
+      e.message[/(Invalid parameter detected|Invalid command|Invalid number)/]
+    flunk(e.message)
+  end
+
+  # TESTS
+  def test_remark
+    %w(ipv4 ipv6).each do |afi|
+      a = ace_helper(afi, remark: afi)
+      assert_equal(afi, a.remark)
+      assert_nil(a.log)
+      assert_nil(a.established)
+    end
+  end
+
+  def test_action
+    %w(ipv4 ipv6).each do |afi|
+      %w(permit deny).each do |val|
+        a = ace_helper(afi, action: val)
+        assert_equal(val, a.action)
+      end
+    end
+  end
+
+  def test_proto
+    %w(ipv4 ipv6).each do |afi|
+      # Sampling of proto's
+      %w(ip tcp udp icmp).each do |val|
+        val = 'ipv6' if val[/ip/] && afi[/ipv6/]
+        a = ace_helper(afi, proto: val)
+        assert_equal(val, a.proto)
+      end
+    end
+  end
+
+  def test_addrs
+    val = '10.1.1.1/32'
+    a = ace_helper('ipv4', src_addr: val, dst_addr: val)
+    assert_equal(val, a.src_addr)
+    assert_equal(val, a.dst_addr)
+
+    val = '10.1.1.1 0.0.0.0'
+    exp = '10.1.1.1/32'
+    # This syntax will transform to 10.1.1.1/32
+    a = ace_helper('ipv4', src_addr: val, dst_addr: val)
+    assert_equal(exp, a.src_addr)
+    assert_equal(exp, a.dst_addr)
+
+    val = '10.1.1.1 2.3.4.5'
+    a = ace_helper('ipv4', src_addr: val, dst_addr: val)
+    assert_equal(val, a.src_addr)
+    assert_equal(val, a.dst_addr)
+
+    val = '10:1:1::1/128'
+    a = ace_helper('ipv6', src_addr: val, dst_addr: val)
+    assert_equal(val, a.src_addr)
+    assert_equal(val, a.dst_addr)
+
+    config_no_warn('object-group ip address my_addrgroup_ipv4')
+    config_no_warn('object-group ipv6 address my_addrgroup_ipv6')
+    %w(ipv4 ipv6).each do |afi|
+      val = "addrgroup my_addrgroup_#{afi}"
+      a = ace_helper(afi, src_addr: val, dst_addr: val)
+      assert_equal(val, a.src_addr)
+      assert_equal(val, a.dst_addr)
+    end
+    config_no_warn('no object-group ip address my_addrgroup_ipv4')
+    config_no_warn('no object-group ipv6 address my_addrgroup_ipv6')
+  end
+
+  def test_ports
+    config_no_warn('object-group ip port my_pg')
+    %w(ipv4 ipv6).each do |afi|
+      ['eq 2', 'neq 2', 'gt 2', 'lt 2',
+       'portgroup my_pg'].each do |val|
+        a = ace_helper(afi, src_port: val, dst_port: val)
+        assert_equal(val, a.src_port)
+        assert_equal(val, a.dst_port)
+      end
+    end
+    config_no_warn('no object-group ip port my_pg')
+  end
+
+  def test_dscp
+    %w(ipv4 ipv6).each do |afi|
+      %w(5 60 af11 af12 af13 af21 af22 af23 af31 af32 af33 af41 af42 af43
+         cs1 cs2 cs3 cs4 cs5 cs6 cs7 default ef).each do |val|
+        a = ace_helper(afi, dscp: val)
+        assert_equal(val, a.dscp)
+      end
+    end
+  end
+
+  def test_vlan
+    %w(ipv4 ipv6).each do |afi|
+      %w(10 100).each do |val|
+        a = ace_helper(afi, proto: 'icmp', vlan: val)
+        assert_equal(val, a.vlan)
+      end
+    end
+  end
+
+  def test_tcp_flags
+    %w(ipv4 ipv6).each do |afi|
+      %w(ack fin urg syn psh rst) + [
+        'ack fin', 'ack psh rst'].each do |val|
+        a = ace_helper(afi, tcp_flags: val)
+        assert_equal(val, a.tcp_flags)
+      end
+    end
+  end
+
+  def test_established
+    %w(ipv4 ipv6).each do |afi|
+      refute(ace_helper(afi).established)
+      a = ace_helper(afi, established: true)
+      assert(a.established)
+      a = ace_helper(afi, established: false)
+      refute(a.established)
+    end
+  end
+
+  def test_http_method
+    afi = 'ipv4'
+    %w(connect delete get head post put trace).each do |val|
+      a = ace_helper(afi, http_method: val)
+      assert_equal(val, a.http_method)
+    end
+  end
+
+  def test_log
+    %w(ipv4 ipv6).each do |afi|
+      refute(ace_helper(afi).log)
+      a = ace_helper(afi, log: true)
+      assert(a.log)
+      a = ace_helper(afi, log: false)
+      refute(a.log)
+    end
+  end
+
+  def test_log_proto_option
+    %w(ipv4 ipv6).each do |afi|
+      refute(ace_helper(afi).log)
+      a = ace_helper(afi, proto: 'icmp', proto_option: 'redirect', log: true)
+      assert(a.log)
+    end
+  end
+
+  def test_proto_option
+    %w(ipv4 ipv6).each do |afi|
+      refute(ace_helper(afi).log)
+      a = ace_helper(afi, proto: 'icmp', proto_option: 'time-exceeded')
+      assert_equal(a.proto_option, 'time-exceeded')
+      a = ace_helper(afi, proto: 'icmp', dscp: 'af11', proto_option: 'echo-reply')
+      assert_equal(a.proto_option, 'echo-reply')
+      assert_equal(a.dscp, 'af11')
+    end
+  end
+
+  def test_redirect_proto_option
+    afi = 'ipv4'
+    val = 'port-channel1,port-channel2'
+    a = ace_helper(afi, proto: 'icmp', proto_option: 'redirect',
+                   redirect: val, log: true, set_erspan_dscp: '3', set_erspan_gre_proto: '33')
+    assert_equal(val, a.redirect)
+    assert_equal('redirect', a.proto_option)
+  end
+
+  def test_precedence
+    afi = 'ipv4'
+    %w(critical flash flash-override immediate internet network
+       priority routine).each do |val|
+      a = ace_helper(afi, precedence: val)
+      assert_equal(val, a.precedence)
+    end
+  end
+
+  def test_redirect
+    afi = 'ipv4'
+    val = 'port-channel1,port-channel2'
+    a = ace_helper(afi, redirect: val)
+    assert_equal(val, a.redirect)
+  end
+
+  def test_tcp_option_length
+    afi = 'ipv4'
+    %w(0 16 28).each do |val|
+      a = ace_helper(afi, tcp_option_length: val)
+      assert_equal(val, a.tcp_option_length)
+    end
+  end
+
+  def test_time_range
+    val = 'my_range'
+    %w(ipv4 ipv6).each do |afi|
+      a = ace_helper(afi, time_range: val)
+      assert_equal(val, a.time_range)
+    end
+  end
+
+  def test_packet_length
+    val = 'range 80 1000'
+    %w(ipv4 ipv6).each do |afi|
+      a = ace_helper(afi, packet_length: val)
+      assert_equal(val, a.packet_length)
+    end
+  end
+
+  def test_ttl_ipv4
+    val = '3'
+    afi = 'ipv4'
+    a = ace_helper(afi, ttl: val)
+    skip("This property has a known defect on the platform itself -\n"\
+         'CSCuy47463: access-list ttl does not nvgen') if a.ttl.nil?
+    assert_equal(val, a.ttl)
+  end
+
+  def test_ttl_ipv6
+    val = '3'
+    afi = 'ipv6'
+    a = ace_helper(afi, ttl: val)
+    skip("This property has a known defect on the platform itself -\n"\
+         'CSCuy47463: access-list ttl does not nvgen') if a.ttl.nil?
+    assert_equal(val, a.ttl)
+  end
+
+  def test_set_erspan_dscp
+    afi = 'ipv4'
+    val = 'port-channel1,port-channel2'
+    a = ace_helper(afi, proto: 'icmp', proto_option: 'redirect',
+                   redirect: val, log: true, set_erspan_dscp: '3', set_erspan_gre_proto: '33')
+    assert_equal('redirect', a.proto_option)
+    assert_equal(val, a.redirect)
+    assert_equal('3', a.set_erspan_dscp)
+  end
+
+  def test_set_erspan_gre_proto
+    afi = 'ipv4'
+    val = 'port-channel1,port-channel2'
+    a = ace_helper(afi, proto: 'icmp', proto_option: 'redirect',
+                   redirect: val, log: true, set_erspan_gre_proto: '33')
+    assert_equal('redirect', a.proto_option)
+    assert_equal(val, a.redirect)
+    assert_equal('33', a.set_erspan_gre_proto)
+  end
+end

data/tests/test_acl.rb

@@ -0,0 +1,185 @@
+# 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 'ciscotest'
+require_relative '../lib/cisco_node_utils/acl'
+
+# test client for acl creation and deletion
+class TestAcl < CiscoTestCase
+  @skip_unless_supported = 'acl'
+  def setup
+    # setup runs at the beginning of each test
+    super
+    @acl_name_v4 = 'test-foo-v4-1'
+    @acl_name_v6 = 'test-foo-v6-1'
+    @permit = 'permit-all'
+    @deny = 'deny-all'
+    no_access_list_foo
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_access_list_foo
+    super
+  end
+
+  def no_access_list_foo
+    # Remove the test ACLs
+    %w(ipv4 ipv6).each do |afi|
+      acl_name = afi[/ipv6/] ? @acl_name_v6 : @acl_name_v4
+      config('no ' + Acl.afi_cli(afi) + ' access-list ' + acl_name)
+    end
+  end
+
+  # TESTS
+  def create_acl(afi, acl_name)
+    rtr = Acl.new(afi, acl_name)
+    afi_cli = Acl.afi_cli(afi)
+
+    assert(Acl.acls[afi].key?(acl_name),
+           "ACL #{afi_cli} #{acl_name} is not configured")
+
+    @default_show_command =
+      "show runn aclmgr | i '#{afi_cli} access-list #{acl_name}'"
+    assert_show_match(pattern: /^#{afi_cli} access-list #{acl_name}$/,
+                      msg:     "failed to create acl '#{afi_cli} #{acl_name}'")
+    rtr.destroy
+    refute_show_match(pattern: /^#{afi} access-list #{acl_name}$/,
+                      msg:     "failed to destroy acl '#{afi_cli} #{acl_name}")
+  end
+
+  def test_create_acl
+    %w(ipv4 ipv6).each do |afi|
+      acl_name = afi[/ipv6/] ? @acl_name_v6 : @acl_name_v4
+      create_acl(afi, acl_name)
+    end
+  end
+
+  def stats_enable(afi, acl_name)
+    rtr = Acl.new(afi, acl_name)
+    afi_cli = Acl.afi_cli(afi)
+
+    @default_show_command =
+      "show runn aclmgr | sec '#{afi_cli} access-list #{acl_name}'"
+    assert_show_match(pattern: /^#{afi_cli} access-list #{acl_name}$/,
+                      msg:     "failed to create acl #{acl_name}")
+
+    # set to true
+    rtr.stats_per_entry = true
+    assert_show_match(pattern: /statistics per-entry/,
+                      msg:     'failed to enable stats')
+
+    assert(rtr.stats_per_entry)
+
+    # set to false
+    rtr.stats_per_entry = false
+    refute_show_match(pattern: /statistics per-entry/,
+                      msg:     'failed to disable stats')
+    refute(rtr.stats_per_entry)
+
+    # default getter function
+    refute(rtr.default_stats_per_entry)
+
+    rtr.destroy
+    refute_show_match(pattern: /^#{afi_cli} access-list #{acl_name}$/,
+                      msg:     "failed to destroy acl #{acl_name}")
+  end
+
+  def test_stats_enable
+    %w(ipv4 ipv6).each do |afi|
+      acl_name = afi[/ipv6/] ? @acl_name_v6 : @acl_name_v4
+      stats_enable(afi, acl_name)
+    end
+  end
+
+  def set_fragments(rtr, afi, acl_name, option)
+    afi_cli = Acl.afi_cli(afi)
+    @default_show_command =
+      "show runn aclmgr | sec '#{afi_cli} access-list #{acl_name}'"
+
+    # setter function
+    rtr.fragments = option
+    assert_show_match(pattern: /fragments #{option}/,
+                      msg:     'failed to set fragments #{option} ' + option)
+
+    # getter function
+    assert_equal(option, rtr.fragments)
+  end
+
+  def unset_fragments(rtr, afi, acl_name)
+    afi_cli = Acl.afi_cli(afi)
+    @default_show_command =
+      "show runn aclmgr | sec '#{afi_cli} access-list #{acl_name}'"
+
+    # setter function
+    rtr.fragments = nil
+    refute_show_match(pattern: /fragments #{@permit}|fragments #{@deny}/,
+                      msg:     'failed to unset set fragments')
+
+    # getter function
+    val = rtr.fragments
+    assert_nil(val)
+  end
+
+  def fragments(afi, acl_name)
+    rtr = Acl.new(afi, acl_name)
+    afi_cli = Acl.afi_cli(afi)
+
+    @default_show_command =
+      "show runn aclmgr | sec '#{afi_cli} access-list #{acl_name}'"
+    assert_show_match(pattern: /^#{afi_cli} access-list #{acl_name}$/,
+                      msg:     "failed to create acl #{acl_name}")
+
+    # set 'no fragments ...'
+    unset_fragments(rtr, afi, acl_name)
+
+    # set 'fragments permit-all' from nothing set
+    set_fragments(rtr, afi, acl_name, @permit)
+
+    # set 'no fragments ...'
+    unset_fragments(rtr, afi, acl_name)
+
+    # set 'fragments deny-all' from nothing set
+    set_fragments(rtr, afi, acl_name, @deny)
+
+    # set 'fragments permit-all' from 'fragments deny-all'
+    set_fragments(rtr, afi, acl_name, @permit)
+
+    # set 'fragments deny-all' from 'fragments permit-all'
+    set_fragments(rtr, afi, acl_name, @deny)
+
+    # default getter function
+    val = rtr.default_stats_per_entry
+    refute_equal(val, nil, 'value is not nil')
+
+    rtr.destroy
+    refute_show_match(pattern: /^#{afi_cli} access-list #{acl_name}$/,
+                      msg:     "failed to destroy acl #{acl_name}")
+  end
+
+  def test_fragments
+    if product_tag[/n(3k-f|5k|6k|9k-f)/]
+      a = Acl.new('ipv4', 'acl_fragments')
+      assert_nil(a.fragments)
+      assert_nil(a.default_fragments)
+      assert_raises(Cisco::UnsupportedError) { a.fragments = 'permit-all' }
+      return
+    end
+
+    %w(ipv4 ipv6).each do |afi|
+      acl_name = afi[/ipv6/] ? @acl_name_v6 : @acl_name_v4
+      fragments(afi, acl_name)
+    end
+  end
+end

data/tests/test_banner.rb

@@ -0,0 +1,85 @@
+#
+# Minitest for Banner 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/banner'
+
+# TestBanner - Minitest for Banner node utility.
+class TestBanner < CiscoTestCase
+  def setup
+    # setup runs at the beginning of each test
+    super
+    no_motd
+  end
+
+  def teardown
+    # teardown runs at the end of each test
+    no_motd
+    super
+  end
+
+  def no_motd
+    # Turn the feature off for a clean test.
+    config('no banner motd')
+  end
+
+  # TESTS
+
+  def test_single_motd
+    id = 'default'
+
+    banner = Cisco::Banner.new(id)
+    assert_includes(Cisco::Banner.banners, id)
+    assert_equal(Cisco::Banner.banners[id], banner)
+
+    assert_equal(banner.default_motd, Cisco::Banner.banners['default'].motd)
+    assert_equal(banner.default_motd, banner.motd)
+
+    banner.motd = 'Test banner!'
+    assert_equal(Cisco::Banner.banners['default'].motd,
+                 'Test banner!')
+    assert_equal(Cisco::Banner.banners['default'].motd,
+                 banner.motd)
+
+    banner.motd = nil
+    assert_equal(banner.default_motd, Cisco::Banner.banners['default'].motd)
+    assert_equal(banner.default_motd, banner.motd)
+  end
+
+  def test_multiline_motd
+    skip_versions = ['7.0.3.I[2-6]', '7.0.3.I7.[1-3]', '7.3', '8.[1-3]']
+    skip_legacy_defect?(skip_versions, 'multiline banner configuration using nxapi not supported')
+    id = 'default'
+
+    banner = Cisco::Banner.new(id)
+    assert_includes(Cisco::Banner.banners, id)
+    assert_equal(Cisco::Banner.banners[id], banner)
+
+    assert_equal(banner.default_motd, Cisco::Banner.banners['default'].motd)
+    assert_equal(banner.default_motd, banner.motd)
+
+    banner.motd = 'This is\na sweet\n\nmultiline\nbanner!\n'
+    assert_equal(Cisco::Banner.banners['default'].motd,
+                 "This is\na sweet\n\nmultiline\nbanner!\n")
+    assert_equal(Cisco::Banner.banners['default'].motd,
+                 banner.motd)
+
+    banner.motd = nil
+    assert_equal(banner.default_motd, Cisco::Banner.banners['default'].motd)
+    assert_equal(banner.default_motd, banner.motd)
+  end
+end