cisco_node_utils 1.0.1 → 1.1.0

data/lib/cisco_node_utils/yum.rb

@@ -17,13 +17,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.join(File.dirname(__FILE__), 'node')
+require_relative 'node_util'
 
 module Cisco
   # This Yum class provides cisco package management functions through nxapi.
-  class Yum
-    @@node = Cisco::Node.instance
-
+  class Yum < NodeUtil
     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)?$/
@@ -40,7 +38,7 @@ module Cisco
     end
 
     def self.validate(pkg)
-      file_name = pkg.strip.gsub(':', '/').split('/').last
+      file_name = pkg.strip.tr(':', '/').split('/').last
       pkg_info = Yum.decompose_name(file_name)
       if pkg_info.nil?
         query_name = file_name
@@ -54,22 +52,22 @@ module Cisco
       should_ver = pkg_info[2] if pkg_info && pkg_info[3]
       ver = query(query_name)
       if ver.nil? || (!should_ver.nil? && should_ver != ver)
-        raise "Failed to install the requested rpm"
+        fail 'Failed to install the requested rpm'
       end
     end
 
-    def self.get_vrf
+    def self.detect_vrf
       # Detect current namespace from agent environment
-      inode = File::Stat.new("/proc/self/ns/net").ino
+      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 = '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)
+    def self.install(pkg, vrf=nil)
+      vrf = vrf.nil? ? detect_vrf : "vrf #{vrf}"
+      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;
@@ -80,15 +78,15 @@ module Cisco
 
     # 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
+      fail TypeError unless pkg.is_a? String
+      fail ArgumentError if pkg.empty?
+      b = config_get('yum', 'query', pkg)
+      fail "Multiple matching packages found for #{pkg}" if b && b.size > 1
       b.nil? ? nil : b.first
     end
 
     def self.remove(pkg)
-      @@node.config_set("yum", "remove", pkg)
+      config_set('yum', 'remove', pkg)
     end
   end
 end

data/tests/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from: ../.rubocop.yml
+
+# Code complexity metrics for the tests/ subdirectory
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 86
+
+Metrics/PerceivedComplexity:
+  Max: 17

data/tests/basetest.rb

@@ -17,67 +17,78 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'simplecov'
+SimpleCov.start do
+  # Don't calculate coverage of our test code itself!
+  add_filter '/tests/'
+end
+
 require 'rubygems'
-gem 'minitest', '>= 2.5.1', '< 5.0.0'
+gem 'minitest', '~> 5.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")
+  require File.expand_path('../../../cisco-nxapi/lib/cisco_nxapi')
 end
 
-class TestCase < Test::Unit::TestCase
+# rubocop:disable Style/ClassVars
+# We *want* the address/username/password class variables to be shared
+# with all child classes, so that we only need to initialize them once.
+
+# TestCase - common base class for all minitest cases in this module.
+#   Most node utility tests should inherit from CiscoTestCase instead.
+class TestCase < Minitest::Test
+  # These variables can be set in one of three ways:
+  # 1) ARGV:
+  #   $ ruby basetest.rb -- address username password
+  # 2) NODE environment variable
+  #   $ export NODE="address username password"
+  #   $ rake test
+  # 3) At run time:
+  #   $ rake test
+  #   Enter address or hostname of node under test:
   @@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 ||= ARGV[0]
+    @@address ||= ENV['NODE'].split(' ')[0] if ENV['NODE']
+    unless @@address
+      print 'Enter address or hostname of node under test: '
+      @@address = gets.chomp
+    end
     @@address
   end
 
   def username
-    process_arguments unless @@username
+    @@username ||= ARGV[1]
+    @@username ||= ENV['NODE'].split(' ')[1] if ENV['NODE']
+    unless @@username
+      print 'Enter username for node under test:           '
+      @@username = gets.chomp
+    end
     @@username
   end
 
   def password
-    process_arguments unless @@password
+    @@password ||= ARGV[2]
+    @@password ||= ENV['NODE'].split(' ')[2] if ENV['NODE']
+    unless @@password
+      print 'Enter password for node under test:           '
+      @@password = gets.chomp
+    end
     @@password
   end
 
   def setup
-    @device = Net::Telnet.new("Host" => address, "Timeout" => 240)
+    @device = Net::Telnet.new('Host' => address, 'Timeout' => 240)
     @device.login(username, password)
+    CiscoLogger.debug_enable if ARGV[3] == 'debug' || ENV['DEBUG'] == '1'
   rescue Errno::ECONNREFUSED
-    puts "Connection refused - please check that the IP address is correct"
+    puts 'Connection refused - please check that the IP address is correct'
     puts "  and that you have enabled 'feature telnet' on the UUT"
     exit
   end
@@ -87,7 +98,41 @@ class TestCase < Test::Unit::TestCase
     GC.start
   end
 
-  def test_placeholder
-    # needed so that we don't get a "no tests were specified" error
+  def config(*args)
+    # Send the entire config as one string but be sure not to return until
+    # we are safely back out of config mode, i.e. prompt is
+    # 'switch#' not 'switch(config)#' or 'switch(config-if)#' etc.
+    @device.cmd('String' => "configure terminal\n" + args.join("\n") + "\nend",
+                'Match'  => /^[^()]+[$%#>] \z/n)
+  end
+
+  def assert_show_match(pattern: nil, command: nil, msg: nil)
+    pattern ||= @default_output_pattern
+    refute_nil(pattern)
+    command ||= @default_show_command
+    refute_nil(command)
+
+    output = @device.cmd(command)
+    msg = message(msg) do
+      "Expected #{mu_pp pattern} to match " \
+      "output of '#{mu_pp command}':\n#{output}"
+    end
+    assert pattern =~ output, msg
+    pattern.match(output)
+  end
+
+  def refute_show_match(pattern: nil, command: nil, msg: nil)
+    pattern ||= @default_output_pattern
+    refute_nil(pattern)
+    command ||= @default_show_command
+    refute_nil(command)
+
+    output = @device.cmd(command)
+    msg = message(msg) do
+      "Expected #{mu_pp pattern} to NOT match " \
+      "output of '#{mu_pp command}':\n#{output}"
+    end
+    refute pattern =~ output, msg
   end
 end
+# rubocop:enable Style/ClassVars

data/tests/ciscotest.rb

@@ -12,125 +12,85 @@
 # 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__)
+require_relative 'basetest'
+require_relative 'platform_info'
+require_relative '../lib/cisco_node_utils/node'
 
 include Cisco
 
 Node.lazy_connect = true # we'll specify the connection info later
 
+# CiscoTestCase - base class for all node utility minitests
 class CiscoTestCase < TestCase
+  # rubocop:disable Style/ClassVars
   @@node = nil
   @@interfaces = nil
   @@interfaces_id = nil
+  # rubocop:enable Style/ClassVars
 
   def node
     unless @@node
-      @@node = Node.instance
-      @@node.connect(@@address, @@username, @@password)
+      @@node = Node.instance # rubocop:disable Style/ClassVars
+      @@node.connect(address, username, password)
       @@node.cache_enable = true
       @@node.cache_auto = true
-      puts "Node in CiscoTestCase Class: #{@@node}"
+      # Record the platform we're running on
+      puts "\nNode under test:"
+      puts "  - name  - #{@@node.host_name}"
+      puts "  - type  - #{@@node.product_id}"
+      puts "  - image - #{@@node.system}\n\n"
     end
     @@node
+  rescue CiscoNxapi::HTTPUnauthorized
+    puts "Unauthorized to connect as #{username}:#{password}@#{address}"
+    exit
   end
 
-  def process_arguments
+  def setup
     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"
+    node
   end
 
   def cmd_ref
     node.cmd_ref
   end
 
+  def config(*args)
+    result = super
+    node.cache_flush
+    result
+  end
+
   def interfaces
     unless @@interfaces
       # Build the platform_info, used for interface lookup
+      # rubocop:disable Style/ClassVars
       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 = platform_info.get_value_from_key('interfaces')
+      rescue RuntimeError => e
+        # If there is a problem reading platform_info.yaml,
+        # assign default values
+        default_interfaces = ['Ethernet1/1', 'Ethernet1/2', 'Ethernet1/3']
+        puts "Caught exception: #{e}, assigning interfaces to default " \
+             "- #{default_interfaces}"
         @@interfaces = default_interfaces
       end
+      # rubocop:enable Style/ClassVars
     end
     @@interfaces
   end
 
   def interfaces_id
     unless @@interfaces_id
+      # rubocop:disable Style/ClassVars
       @@interfaces_id = []
-      interfaces.each { |interface|
-        id = interface.split("Ethernet")[1]
+      interfaces.each do |interface|
+        id = interface.split('Ethernet')[1]
         @@interfaces_id << id
-      }
+      end
+      # rubocop:enable Style/ClassVars
     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/{lib/cisco_node_utils → tests}/platform_info.rb

@@ -15,7 +15,7 @@
 require 'yaml'
 
 # Class: PlatformInfo
-# This class reads device specific details from the yaml file - platform_info.yaml
+# This class reads device specific details from platform_info.yaml
 # These details can be used to customize unit tests for a device
 class PlatformInfo
   # Default constructor for the PlatformInfo class. This class
@@ -28,17 +28,21 @@ class PlatformInfo
   #                             UTs are to be run
   #
   def initialize(device_name)
-    raise "device name must be specified in PlatformInfo constructor." if device_name.nil? or device_name.empty?
+    if device_name.nil? || device_name.empty?
+      fail 'device name must be specified in PlatformInfo constructor.'
+    end
     @platform_info_hash = {}
 
     begin
-      project_info_hash = YAML.load_file(File.join(File.dirname(__FILE__), "platform_info.yaml"))
-    rescue Exception => e
-      raise "Error - could not open platform file - platform_info.yaml"
+      project_info_hash = YAML.load_file(File.join(File.dirname(__FILE__),
+                                                   'platform_info.yaml'))
+    rescue RuntimeError
+      raise 'Error - could not open platform file - platform_info.yaml'
     end
 
     @platform_info_hash = project_info_hash[device_name]
-    raise "Error - could not find #{device_name} device specific information in platform_info.yaml" if @platform_info_hash.nil?
+    fail "Error - could not find #{device_name} device specific information " \
+         'in platform_info.yaml' if @platform_info_hash.nil?
   end
 
   # The following instance method will return the value associated with
@@ -48,10 +52,10 @@ class PlatformInfo
   #                 in @platform_info_hash
   #
   def get_value_from_key(key)
-    raise "key must be specified in the method get_value_from_key" if key.nil?
+    fail 'key must be specified in the method get_value_from_key' if key.nil?
 
     value = @platform_info_hash[key]
-    raise "no value exists for the key #{key}" if value.nil?
+    fail "no value exists for the key #{key}" if value.nil?
 
     value
   end