cisco_node_utils 0.9.0 → 1.0.0

data/lib/cisco_node_utils/interface.rb

@@ -101,6 +101,24 @@ module Cisco
       @@node.config_get_default("interface", "description")
     end
 
+    def encapsulation_dot1q
+      val = @@node.config_get("interface", "encapsulation_dot1q", @name)
+      return default_encapsulation_dot1q if val.nil?
+      val.shift.strip.to_i
+    end
+
+    def encapsulation_dot1q=(val)
+      val.nil? ?
+        @@node.config_set("interface", "encapsulation_dot1q", @name, "no", "") :
+        @@node.config_set("interface", "encapsulation_dot1q", @name, "", val)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_encapsulation_dot1q
+      @@node.config_get_default("interface", "encapsulation_dot1q")
+    end
+
     def fex_feature
       fex = @@node.config_get("fex", "feature")
       raise "fex_feature not found" if fex.nil?
@@ -215,6 +233,33 @@ module Cisco
       @@node.config_get_default("interface", ipv4_redirects_lookup_string)
     end
 
+    def feature_lacp?
+      not @@node.config_get("interface", "feature_lacp").nil?
+    end
+
+    def feature_lacp_set(val)
+      return if feature_lacp? == val
+      @@node.config_set("interface", "feature_lacp", val ? "" : "no")
+    end
+
+    def mtu
+      mtu = @@node.config_get("interface", "mtu", @name)
+      return default_mtu if mtu.nil?
+      mtu.shift.strip.to_i
+    end
+
+    def mtu=(mtu)
+      mtu.nil? ?
+        @@node.config_set("interface", "mtu", @name, "no", "") :
+        @@node.config_set("interface", "mtu", @name, "", mtu)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_mtu
+      @@node.config_get_default("interface", "mtu")
+    end
+
     def negotiate_auto_lookup_string
       case @name
       when /Ethernet/i
@@ -401,6 +446,48 @@ module Cisco
         @@node.config_get_default("interface", switchport_mode_lookup_string))
     end
 
+    def switchport_trunk_allowed_vlan
+      val = @@node.config_get(
+        "interface", "switchport_trunk_allowed_vlan", @name)
+      return default_switchport_trunk_allowed_vlan if val.nil?
+      val.shift.strip
+    end
+
+    def switchport_trunk_allowed_vlan=(val)
+      val.nil? ?
+        @@node.config_set(
+          "interface", "switchport_trunk_allowed_vlan", @name, "no", "") :
+        @@node.config_set(
+          "interface", "switchport_trunk_allowed_vlan", @name, "", val)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_switchport_trunk_allowed_vlan
+      @@node.config_get_default("interface", "switchport_trunk_allowed_vlan")
+    end
+
+    def switchport_trunk_native_vlan
+      val = @@node.config_get(
+        "interface", "switchport_trunk_native_vlan", @name)
+      return default_switchport_trunk_native_vlan if val.nil?
+      val.shift.strip.to_i
+    end
+
+    def switchport_trunk_native_vlan=(val)
+      val.nil? ?
+        @@node.config_set(
+          "interface", "switchport_trunk_native_vlan", @name, "no", "") :
+        @@node.config_set(
+          "interface", "switchport_trunk_native_vlan", @name, "", val)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_switchport_trunk_native_vlan
+      @@node.config_get_default("interface", "switchport_trunk_native_vlan")
+    end
+
     def system_default_switchport
       # This command is a user-configurable system default.
       sys_def = @@node.config_get("interface", "system_default_switchport")
@@ -497,5 +584,24 @@ module Cisco
       raise "#{caller[0][/`.*'/][1..-2]} cannot be set unless switchport mode" +
         " is disabled" unless switchport_mode == :disabled
     end
+
+    def vrf
+      vrf = @@node.config_get("interface", "vrf", @name)
+      return "" if vrf.nil?
+      vrf.shift.strip
+    end
+
+    def vrf=(vrf)
+      raise TypeError unless vrf.is_a?(String)
+      vrf.empty? ?
+        @@node.config_set("interface", "vrf", @name, "no", "") :
+        @@node.config_set("interface", "vrf", @name, "", vrf)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_vrf
+      @@node.config_get_default("interface", "vrf")
+    end
   end  # Class
 end    # Module

data/lib/cisco_node_utils/interface_ospf.rb

@@ -17,6 +17,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'ipaddr'
 require File.join(File.dirname(__FILE__), 'node')
 require File.join(File.dirname(__FILE__), 'interface')
 # Interestingly enough, interface OSPF configuration can exist completely
@@ -24,7 +25,7 @@ require File.join(File.dirname(__FILE__), 'interface')
 
 module Cisco
   class InterfaceOspf
-    attr_reader :interface, :ospf_name, :area
+    attr_reader :interface, :ospf_name
 
     @@node = Node.instance
 
@@ -42,7 +43,6 @@ module Cisco
       raise "interface #{int_name} does not exist" if @interface.nil?
 
       @ospf_name = ospf_name
-      @area = area
 
       if create
         # enable feature ospf if it isn't
@@ -76,9 +76,23 @@ module Cisco
       ints
     end
 
+    def area
+      match = @@node.config_get("interface_ospf", "area", @interface.name)
+      return nil if match.nil?
+      val = match[0][1]
+      # Coerce numeric area to the expected dot-decimal format.
+      val = IPAddr.new(val.to_i, Socket::AF_INET).to_s unless val.match(/\./)
+      val
+    end
+
+    def area=(a)
+      @@node.config_set("interface_ospf", "area", @interface.name,
+        "", @ospf_name, a)
+    end
+
     def destroy
       @@node.config_set("interface_ospf", "area", @interface.name,
-        "no", @ospf_name, @area)
+        "no", @ospf_name, area)
       # Reset everything else back to default as well:
       self.message_digest = default_message_digest
       message_digest_key_set(default_message_digest_key_id, "", "", "")

data/lib/cisco_node_utils/node.rb

@@ -33,11 +33,11 @@ module Cisco
     attr_reader :command, :clierror, :previous
     def initialize(command, clierror, previous)
       @command = command
-      @clierror = clierror
+      @clierror = clierror.rstrip
       @previous = previous
     end
 
-    def message
+    def to_s
       "CliError: '#{@command}' rejected with message:\n'#{@clierror}'"
     end
   end

data/lib/cisco_node_utils/router_ospf_vrf.rb

@@ -201,6 +201,12 @@ class RouterOspfVrf
     set_args_keys_delete([:start, :hold, :max])
   end
 
+  def default_timer_throttle_lsa
+    [default_timer_throttle_lsa_start,
+     default_timer_throttle_lsa_hold,
+     default_timer_throttle_lsa_max]
+  end
+
   def default_timer_throttle_lsa_start
     @@node.config_get_default("ospf", "timer_throttle_lsa_start")
   end
@@ -243,6 +249,12 @@ class RouterOspfVrf
     set_args_keys_delete([:start, :hold, :max])
   end
 
+  def default_timer_throttle_spf
+    [default_timer_throttle_spf_start,
+     default_timer_throttle_spf_hold,
+     default_timer_throttle_spf_max]
+  end
+
   def default_timer_throttle_spf_start
     @@node.config_get_default("ospf", "timer_throttle_spf_start")
   end

data/lib/cisco_node_utils/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module CiscoNodeUtils
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/cisco_node_utils/vtp.rb

@@ -47,7 +47,7 @@ class Vtp
 
   # Get vtp domain name
   def Vtp.domain
-    @@node.config_get("vtp", "domain")
+    enabled ? @@node.config_get("vtp", "domain") : ""
   end
 
   def domain
@@ -55,11 +55,12 @@ class Vtp
   end
 
   # Set vtp domain name
-  def domain=(domain)
-    raise ArgumentError unless domain and domain.is_a? String and
-                               domain.length.between?(1, MAX_VTP_DOMAIN_NAME_SIZE)
+  def domain=(d)
+    raise ArgumentError unless d and d.is_a? String and
+                               d.length.between?(1, MAX_VTP_DOMAIN_NAME_SIZE)
+    enable unless Vtp.enabled
     begin
-      @@node.config_set("vtp", "domain", domain)
+      @@node.config_set("vtp", "domain", d)
     rescue Cisco::CliError => e
       # cmd will syntax reject when setting name to same name
       raise unless e.clierror =~ /ERROR: Domain name already set to /
@@ -69,9 +70,9 @@ class Vtp
   # Get vtp password
   def password
     # Unfortunately nxapi returns "\\" when the password is not set
-    password = @@node.config_get("vtp", "password")
-    return '' if password.nil?
-    password.gsub(/\\/, '')
+    password = @@node.config_get("vtp", "password") if Vtp.enabled
+    return '' if password.nil? or password == "\\"
+    password
   end
 
   # Set vtp password
@@ -79,9 +80,15 @@ class Vtp
     raise TypeError if password.nil?
     raise TypeError unless password.is_a? String
     raise ArgumentError if password.length > MAX_VTP_PASSWORD_SIZE
-    password == default_password ?
-      @@node.config_set("vtp", "password", "no", "") :
-      @@node.config_set("vtp", "password", "", password)
+    enable unless Vtp.enabled
+    begin
+      password == default_password ?
+        @@node.config_set("vtp", "password", "no", "") :
+        @@node.config_set("vtp", "password", "", password)
+    rescue Cisco::CliError => e
+      raise unless e.clierror =~ /password cannot be set for NULL domain/
+      raise "Setting VTP password requires first setting VTP domain" unless password == default_password
+    end
   end
 
   # Get default vtp password
@@ -98,6 +105,7 @@ class Vtp
   # Set vtp filename
   def filename=(uri)
     raise TypeError if uri.nil?
+    enable unless Vtp.enabled
     uri.empty? ?
       @@node.config_set("vtp", "filename", "no", "") :
       @@node.config_set("vtp", "filename", "", uri)
@@ -110,12 +118,13 @@ class Vtp
 
   # Get vtp version
   def version
-    match = @@node.config_get("vtp", "version")
+    match = @@node.config_get("vtp", "version") if Vtp.enabled
     match.nil? ? default_version : match.first.to_i
   end
 
   # Set vtp version
   def version=(version)
+    enable unless Vtp.enabled
     @@node.config_set("vtp", "version", "#{version}")
   end
 

data/lib/cisco_node_utils/yum.rb

@@ -28,7 +28,7 @@ module Cisco
       # ex: chef-12.0.0alpha.2+20150319.git.1.b6f-1.el5.x86_64.rpm
       name_ver_arch_regex = /^([\w\-\+]+)-(\d+\..*)\.(\w{4,})(?:\.rpm)?$/
 
-      # ex n9000_sample-1.0.0-7.0.3.x86_64.rpm 
+      # ex n9000_sample-1.0.0-7.0.3.x86_64.rpm
       name_ver_arch_regex_nx = /^(.*)-([\d\.]+-[\d\.]+)\.(\w{4,})\.rpm$/
 
       # ex: b+z-ip2.x64_64
@@ -52,20 +52,30 @@ module Cisco
         end
       end
       should_ver = pkg_info[2] if pkg_info && pkg_info[3]
-      ver = self.query(query_name)
+      ver = query(query_name)
       if ver.nil? || (!should_ver.nil? && should_ver != ver)
-        raise RuntimeError, "Failed to install the requested rpm"
+        raise "Failed to install the requested rpm"
       end
     end
 
-    def self.install(pkg)
-      @@node.config_set("yum", "install", pkg)
+    def self.get_vrf
+      # Detect current namespace from agent environment
+      inode = File::Stat.new("/proc/self/ns/net").ino
+      # -L reqd for guestshell's find command
+      vrfname = File.basename(`find -L /var/run/netns/ -inum #{inode}`.chop)
+      vrf = "vrf " + vrfname unless vrfname.empty?
+      vrf
+    end
+
+    def self.install(pkg, vrf = nil)
+      vrf = vrf.nil? ? get_vrf : "vrf #{vrf}"
+      @@node.config_set("yum", "install", pkg, vrf)
 
       # HACK: The current nxos host installer is a multi-part command
       # which may fail at a later stage yet return a false positive;
       # therefore a post-validation check is needed here to verify the
       # actual outcome.
-      self.validate(pkg)
+      validate(pkg)
     end
 
     # returns version of package, or false if package doesn't exist

data/tests/test_interface.rb

@@ -28,6 +28,7 @@ class TestInterface < CiscoTestCase
   @@debug_validate_ipv4_address = "validate_ipv4_address"
   @@debug_validate_ipv4_proxy_arp = "validate_ipv4_proxy_arp"
   @@debug_validate_ipv4_redirects = "validate_ipv4_redirects"
+  @@debug_validate_vrf = "validate_vrf"
   @@debug_test_interface_ipv4_all_interfaces = "test_interface_ipv4_all_interfaces"
 
   # Debug flags, globally defined
@@ -63,7 +64,9 @@ SWITCHPORT_SHUTDOWN_HASH = {
   DEFAULT_IF_IP_NETMASK_LEN = nil
   DEFAULT_IF_IP_PROXY_ARP = false
   DEFAULT_IF_IP_REDIRECTS = true
+  DEFAULT_IF_VRF = ""
   IF_DESCRIPTION_SIZE = 243 # SIZE = VSH Max 255 - "description " keyword
+  IF_VRF_MAX_LENGTH = 32
 
   def interface_ipv4_config(ifname, address, length,
                             config = true, secip = false)
@@ -225,16 +228,16 @@ SWITCHPORT_SHUTDOWN_HASH = {
 
       # check of description
       assert_equal(v[:description], interface.description,
-                   "Error: Description not configured")
+                   "Error: [#{interface.name}] Description is not configured")
 
       # change description
       interface.description = v[:description_new]
       assert_equal(v[:description_new], interface.description,
-                   "Error: Description not configured")
+                   "Error: [#{interface.name}] Description is not changed")
 
       # get_default check
       assert_equal(v[:default_description], interface.default_description,
-                   "Error: Description, default, not configured")
+                   "Error: [#{interface.name}] Default description is not configured")
     end
   end
 
@@ -413,6 +416,31 @@ SWITCHPORT_SHUTDOWN_HASH = {
     end
   end
 
+  def validate_vrf(inttype_h)
+    # Validate the vrf
+    inttype_h.each do | k, v |
+      CiscoTestCase.debug(@@debug_validate_vrf,
+                     @@debug_group_ipv4_all_interfaces,
+                     2,
+                     "Interface: #{k}")
+      interface = v[:interface]
+
+      CiscoTestCase.debug_detail(@@debug_validate_vrf,
+                            @@debug_group_ipv4_all_interfaces,
+                            4,
+                            "Value - #{v[:vrf]}")
+
+      # change vrf
+      interface.vrf = v[:vrf_new]
+      assert_equal(v[:vrf_new], interface.vrf,
+                   "Error: [#{interface.name}] vrf is not changed")
+
+      # set to default vrf
+      assert_equal(v[:default_vrf], interface.default_vrf,
+                   "Error: [#{interface.name}] vrf config found. Should be default vrf")
+    end
+  end
+
   def test_interface_create_name_nil
     assert_raises(TypeError) do
       Interface.new(nil)
@@ -473,6 +501,62 @@ SWITCHPORT_SHUTDOWN_HASH = {
     interface_ethernet_default(interfaces_id[0])
   end
 
+  def test_interface_encapsulation_dot1q_change
+    interface = Interface.new(interfaces[0])
+    interface.switchport_mode = :disabled
+    subif = Interface.new(interfaces[0] + ".1")
+
+    subif.encapsulation_dot1q = 20
+    assert_equal(20, subif.encapsulation_dot1q)
+    subif.encapsulation_dot1q = 25
+    assert_equal(25, subif.encapsulation_dot1q)
+    interface_ethernet_default(interfaces_id[0])
+  end
+
+  def test_interface_encapsulation_dot1q_invalid
+    interface = Interface.new(interfaces[0])
+    interface.switchport_mode = :disabled
+    subif = Interface.new(interfaces[0] + ".1")
+
+    assert_raises(RuntimeError) {
+      subif.encapsulation_dot1q = "hello"
+    }
+    interface_ethernet_default(interfaces_id[0])
+  end
+
+  def test_interface_encapsulation_dot1q_valid
+    interface = Interface.new(interfaces[0])
+    interface.switchport_mode = :disabled
+    subif = Interface.new(interfaces[0] + ".1")
+
+    subif.encapsulation_dot1q = 20
+    assert_equal(20, subif.encapsulation_dot1q)
+    interface_ethernet_default(interfaces_id[0])
+  end
+
+  def test_interface_mtu_change
+    interface = Interface.new(interfaces[0])
+    interface.mtu = 1490
+    assert_equal(1490, interface.mtu)
+    interface.mtu = 580
+    assert_equal(580, interface.mtu)
+    interface_ethernet_default(interfaces_id[0])
+  end
+
+  def test_interface_mtu_invalid
+    interface = Interface.new(interfaces[0])
+    assert_raises(RuntimeError) {
+      interface.mtu = "hello"
+    }
+  end
+
+  def test_interface_mtu_valid
+    interface = Interface.new(interfaces[0])
+    interface.mtu = 1490
+    assert_equal(1490, interface.mtu)
+    interface_ethernet_default(interfaces_id[0])
+  end
+
   def test_interface_shutdown_valid
     interface = Interface.new(interfaces[0])
     interface.shutdown = true
@@ -906,7 +990,9 @@ SWITCHPORT_SHUTDOWN_HASH = {
       :switchport => :disabled,
       :default_switchport => :disabled,
       :access_vlan => DEFAULT_IF_ACCESS_VLAN,
-      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN
+      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN,
+      :vrf_new => "test2",
+      :default_vrf => DEFAULT_IF_VRF,
     }
     inttype_h["Vlan45"] = {
       :address_len => "9.7.1.1/15",
@@ -921,7 +1007,9 @@ SWITCHPORT_SHUTDOWN_HASH = {
       :switchport => :disabled,
       :default_switchport => :disabled,
       :access_vlan => DEFAULT_IF_ACCESS_VLAN,
-      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN
+      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN,
+      :vrf_new => "test2",
+      :default_vrf => DEFAULT_IF_VRF,
     }
     inttype_h["port-channel48"] = {
       :address_len => "10.7.1.1/15",
@@ -936,7 +1024,9 @@ SWITCHPORT_SHUTDOWN_HASH = {
       :switchport => :disabled,
       :default_switchport => :disabled,
       :access_vlan => DEFAULT_IF_ACCESS_VLAN,
-      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN
+      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN,
+      :vrf_new => "test2",
+      :default_vrf => DEFAULT_IF_VRF,
     }
     inttype_h["loopback0"] = {
       :address_len => "11.7.1.1/15",
@@ -950,7 +1040,9 @@ SWITCHPORT_SHUTDOWN_HASH = {
       :switchport => :disabled,
       :default_switchport => :disabled,
       :access_vlan => DEFAULT_IF_ACCESS_VLAN,
-      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN
+      :default_access_vlan => DEFAULT_IF_ACCESS_VLAN,
+      :vrf_new => "test2",
+      :default_vrf => DEFAULT_IF_VRF,
     }
     # Skipping mgmt0 interface since that interface is our 'path' to
     # master should revisit this later
@@ -999,6 +1091,7 @@ SWITCHPORT_SHUTDOWN_HASH = {
     validate_ipv4_proxy_arp(inttype_h)
     validate_ipv4_redirects(inttype_h)
     validate_interface_shutdown(inttype_h)
+    validate_vrf(inttype_h)
 
     # Cleanup the preload configuration
     s = @device.cmd("configure terminal")
@@ -1014,4 +1107,53 @@ SWITCHPORT_SHUTDOWN_HASH = {
     s = @device.cmd("end")
     node.cache_flush
   end
+
+  def test_interface_vrf_default
+    @device.cmd("conf t ; interface loopback1 ; vrf member foo")
+    node.cache_flush
+    interface = Interface.new("loopback1")
+    interface.vrf = interface.default_vrf
+    assert_equal(DEFAULT_IF_VRF, interface.vrf)
+  end
+
+  def test_interface_vrf_empty
+    @device.cmd("conf t ; interface loopback1 ; vrf member foo")
+    node.cache_flush
+    interface = Interface.new("loopback1")
+    interface.vrf = DEFAULT_IF_VRF
+    assert_equal(DEFAULT_IF_VRF, interface.vrf)
+  end
+
+  def test_interface_vrf_invalid_type
+    interface = Interface.new("loopback1")
+    assert_raises(TypeError) {
+      interface.vrf = 1
+    }
+  end
+
+  def test_interface_vrf_exceeds_max_length
+    interface = Interface.new("loopback1")
+    long_string = "a" * (IF_VRF_MAX_LENGTH + 1)
+    assert_raises(RuntimeError) {
+      interface.vrf = long_string
+    }
+  end
+
+  def test_interface_vrf_override
+    interface = Interface.new("loopback1")
+    vrf1 = "test1"
+    vrf2 = "test2"
+    interface.vrf = vrf1
+    interface.vrf = vrf2
+    assert_equal(vrf2, interface.vrf)
+    interface.destroy
+  end
+
+  def test_interface_vrf_valid
+    interface = Interface.new("loopback1")
+    vrf = "test"
+    interface.vrf = vrf
+    assert_equal(vrf, interface.vrf)
+    interface.destroy
+  end
 end