cisco_node_utils 0.9.0

data/lib/cisco_node_utils/vtp.rb

@@ -0,0 +1,127 @@
+# VTP provider class
+#
+# Mike Wiebe, November 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.join(File.dirname(__FILE__), 'node')
+
+module Cisco
+class Vtp
+  attr_reader :name
+
+  MAX_VTP_DOMAIN_NAME_SIZE = 32
+  MAX_VTP_PASSWORD_SIZE    = 64
+
+  @@node = Node.instance
+
+  # Constructor for Vtp
+  def initialize(instantiate=true)
+    enable if instantiate and not Vtp.enabled
+  end
+
+  def Vtp.enabled
+    not @@node.config_get("vtp", "feature").nil?
+  end
+
+  def enable
+    @@node.config_set("vtp", "feature", "")
+  end
+
+  # Disable vtp feature
+  def destroy
+    @@node.config_set("vtp", "feature", "no")
+  end
+
+  # Get vtp domain name
+  def Vtp.domain
+    @@node.config_get("vtp", "domain")
+  end
+
+  def domain
+    Vtp.domain
+  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)
+    begin
+      @@node.config_set("vtp", "domain", domain)
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when setting name to same name
+      raise unless e.clierror =~ /ERROR: Domain name already set to /
+    end
+  end
+
+  # 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(/\\/, '')
+  end
+
+  # Set vtp password
+  def password=(password)
+    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)
+  end
+
+  # Get default vtp password
+  def default_password
+    @@node.config_get_default("vtp", "password")
+  end
+
+  # Get vtp filename
+  def filename
+    match = @@node.config_get("vtp", "filename")
+    match.nil? ? default_filename : match.first
+  end
+
+  # Set vtp filename
+  def filename=(uri)
+    raise TypeError if uri.nil?
+    uri.empty? ?
+      @@node.config_set("vtp", "filename", "no", "") :
+      @@node.config_set("vtp", "filename", "", uri)
+  end
+
+  # Get default vtp filename
+  def default_filename
+    @@node.config_get_default("vtp", "filename")
+  end
+
+  # Get vtp version
+  def version
+    match = @@node.config_get("vtp", "version")
+    match.nil? ? default_version : match.first.to_i
+  end
+
+  # Set vtp version
+  def version=(version)
+    @@node.config_set("vtp", "version", "#{version}")
+  end
+
+  # Get default vtp version
+  def default_version
+    @@node.config_get_default("vtp", "version")
+  end
+end
+end

data/lib/cisco_node_utils/yum.rb

@@ -0,0 +1,84 @@
+#
+# NXAPI implementation of Yum class
+#
+# April 2015, Alex Hunsberger
+#
+# Copyright (c) 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.join(File.dirname(__FILE__), 'node')
+
+module Cisco
+  # This Yum class provides cisco package management functions through nxapi.
+  class Yum
+    @@node = Cisco::Node.instance
+
+    def self.decompose_name(file_name)
+      # 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 
+      name_ver_arch_regex_nx = /^(.*)-([\d\.]+-[\d\.]+)\.(\w{4,})\.rpm$/
+
+      # ex: b+z-ip2.x64_64
+      name_arch_regex = /^([\w\-\+]+)\.(\w+)$/
+
+      file_name.match(name_ver_arch_regex) ||
+        file_name.match(name_ver_arch_regex_nx) ||
+        file_name.match(name_arch_regex)
+    end
+
+    def self.validate(pkg)
+      file_name = pkg.strip.gsub(':', '/').split('/').last
+      pkg_info = Yum.decompose_name(file_name)
+      if pkg_info.nil?
+        query_name = file_name
+      else
+        if pkg_info[3].nil?
+          query_name = pkg_info[1]
+        else
+          query_name = "#{pkg_info[1]}.#{pkg_info[3]}"
+        end
+      end
+      should_ver = pkg_info[2] if pkg_info && pkg_info[3]
+      ver = self.query(query_name)
+      if ver.nil? || (!should_ver.nil? && should_ver != ver)
+        raise RuntimeError, "Failed to install the requested rpm"
+      end
+    end
+
+    def self.install(pkg)
+      @@node.config_set("yum", "install", pkg)
+
+      # 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)
+    end
+
+    # returns version of package, or false if package doesn't exist
+    def self.query(pkg)
+      raise TypeError unless pkg.is_a? String
+      raise ArgumentError if pkg.empty?
+      b = @@node.config_get("yum", "query", pkg)
+      raise "Multiple matching packages found for #{pkg}" if b and b.size > 1
+      b.nil? ? nil : b.first
+    end
+
+    def self.remove(pkg)
+      @@node.config_set("yum", "remove", pkg)
+    end
+  end
+end

data/tests/basetest.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+#
+# Basic unit test case class.
+# 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'
+require 'net/telnet'
+require 'test/unit'
+begin
+  require 'cisco_nxapi'
+rescue LoadError
+  require File.expand_path("../../../cisco_nxapi/lib/cisco_nxapi")
+end
+
+class TestCase < Test::Unit::TestCase
+  @@address = nil
+  @@username = nil
+  @@password = nil
+
+  def process_arguments
+    if ARGV.length != 3 and ARGV.length != 4
+      puts "Usage:"
+      puts "  ruby test_nxapi.rb [options] -- <address> <username> <password> [debug]"
+      exit
+    end
+
+    # Record the version of Ruby we got invoked with.
+    puts "\nRuby Version - #{RUBY_VERSION}"
+
+    @@address = ARGV[0]
+    @@username = ARGV[1]
+    @@password = ARGV[2]
+
+    if ARGV.length == 4
+        if ARGV[3] == "debug"
+            CiscoLogger.debug_enable
+        else
+            puts "Only 'debug' is allowed"
+            exit
+        end
+    end
+  end
+
+  # setup-once params
+  def address
+    process_arguments unless @@address
+    @@address
+  end
+
+  def username
+    process_arguments unless @@username
+    @@username
+  end
+
+  def password
+    process_arguments unless @@password
+    @@password
+  end
+
+  def setup
+    @device = Net::Telnet.new("Host" => address, "Timeout" => 240)
+    @device.login(username, password)
+  rescue Errno::ECONNREFUSED
+    puts "Connection refused - please check that the IP address is correct"
+    puts "  and that you have enabled 'feature telnet' on the UUT"
+    exit
+  end
+
+  def teardown
+    @device.close unless @device.nil?
+    GC.start
+  end
+
+  def test_placeholder
+    # needed so that we don't get a "no tests were specified" error
+  end
+end

data/tests/ciscotest.rb

@@ -0,0 +1,136 @@
+# Copyright (c) 2013-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.join(File.dirname(__FILE__), 'basetest')
+require File.expand_path("../../lib/cisco_node_utils/platform_info", __FILE__)
+require File.expand_path("../../lib/cisco_node_utils/node", __FILE__)
+
+include Cisco
+
+Node.lazy_connect = true # we'll specify the connection info later
+
+class CiscoTestCase < TestCase
+  @@node = nil
+  @@interfaces = nil
+  @@interfaces_id = nil
+
+  def node
+    unless @@node
+      @@node = Node.instance
+      @@node.connect(@@address, @@username, @@password)
+      @@node.cache_enable = true
+      @@node.cache_auto = true
+      puts "Node in CiscoTestCase Class: #{@@node}"
+    end
+    @@node
+  end
+
+  def process_arguments
+    super
+    node # Connect to device
+    # Record the platform we're running on
+    puts "Platform:"
+    puts "  - name  - #{@@node.host_name}"
+    puts "  - type  - #{@@node.product_id}"
+    puts "  - image - #{@@node.system}\n\n"
+  end
+
+  def cmd_ref
+    node.cmd_ref
+  end
+
+  def interfaces
+    unless @@interfaces
+      # Build the platform_info, used for interface lookup
+      begin
+        platform_info = PlatformInfo.new(node.host_name)
+        @@interfaces = platform_info.get_value_from_key("interfaces")
+      rescue Exception => e
+        # If there is a problem reading platform_info.yaml, assign default values
+        default_interfaces = ["Ethernet1/1", "Ethernet1/2", "Ethernet1/10"]
+        puts "Caught exception: #{e}, assigning interfaces to default - #{default_interfaces}"
+        @@interfaces = default_interfaces
+      end
+    end
+    @@interfaces
+  end
+
+  def interfaces_id
+    unless @@interfaces_id
+      @@interfaces_id = []
+      interfaces.each { |interface|
+        id = interface.split("Ethernet")[1]
+        @@interfaces_id << id
+      }
+    end
+    @@interfaces_id
+  end
+
+  # Class method method to set the class variable 'debug_flag'
+  # Can be true or false.
+  def self.debug_flag=(flag)
+    @@debug_flag = flag
+  end
+
+  # Class method to set the class variable 'debug_method'
+  # Can be name of the method or "all"
+  def self.debug_method=(name)
+    @@debug_method = name
+  end
+
+  # Class method to set the class variable 'debug_group'
+  # Can be the name of the method or "all"
+  def self.debug_group=(group)
+    @@debug_group = group
+  end
+
+  # Class method to set the class variable 'debug_detail'
+  # Can be true or false
+  def self.debug_detail=(detail)
+    @@debug_detail = detail
+  end
+
+  # Class method to dump debug data.
+  # The passed in parameters will control what is printed and how.
+  # Parameters:
+  #   method - Name of the method the debug belongs to.
+  #   group -  Name of the group the debug belongs to.
+  #   indent - Indent controls the display of the data.
+  #   detail - Detail controls if detail debugs should be displayed.
+  #   data -   Data to be displayed. Must be a fully formatted string.
+  def self.debug(method, group, indent, data)
+    if (@@debug_flag) &&
+       (((@@debug_method == method) || (@@debug_method == "all")) ||
+       ((@@debug_group == group) || (@@debug_group == "all")))
+      indent_spaces = " " * indent
+      puts "#{indent_spaces}#{method} - #{data}"
+    end
+  end
+
+  # Class method to dump detailed debug data.
+  # The passed in parameters will control what is printed and how.
+  # Parameters:
+  #   method - Name of the method the debug belongs to.
+  #   group -  Name of the group the debug belongs to.
+  #   indent - Indent controls the display of the data.
+  #   data -   Data to be displayed. Must be a fully formatted string.
+  def self.debug_detail(method, group, indent, data)
+    if (@@debug_detail) &&
+       (((@@debug_method == method) || (@@debug_method == "all")) ||
+       ((@@debug_group == group) || (@@debug_group == "all")))
+      indent_spaces = " " * indent
+      puts "#{indent_spaces}#{method} - #{data}"
+    end
+  end
+end

data/tests/cmd_config.yaml

@@ -0,0 +1,51 @@
+# test command config yaml file
+---
+feature-enable:
+  command: |
+          feature tacacs+
+          feature ospf
+          feature bgp
+          feature pim
+          feature msdp
+          feature private-vlan
+          feature udld
+          feature interface-vlan
+          feature hsrp
+          feature lacp
+          feature dhcp
+          feature vtp
+
+feature-disable:
+  command: |
+          no feature tacacs+
+          no feature ospf
+          no feature bgp
+          no feature pim
+          no feature msdp
+          no feature private-vlan
+          no feature udld
+          no feature interface-vlan
+          no feature hsrp
+          no feature lacp
+          no feature dhcp
+          no feature vtp
+
+feature-snmp-comm-acl-ro:
+  command: |
+           snmp-server community networkopercom group network-operator
+           snmp-server community networkopercom use-acl SNMP_RO
+
+feature-snmp-comm-acl-rw:
+  command: |
+           snmp-server community admincom group network-admin
+           snmp-server community admincom use-acl SNMP_RW
+
+feature-int-loopback:
+  command: > 
+          interface loopback0
+            description testloopback
+
+feature-int-portchannel:
+  command: > 
+          interface port-channel100
+            description test-portchannel