cisco_node_utils 1.2.0 → 1.3.0

data/spec/grpc_client_spec.rb

@@ -0,0 +1,23 @@
+require_relative 'spec_helper.rb'
+require 'shared_examples_for_clients'
+require 'cisco_node_utils/client/grpc'
+
+describe Cisco::Client::GRPC do
+  it_behaves_like 'all clients'
+
+  describe '.validate_args' do
+    it 'rejects nil username' do
+      kwargs = { host: '1.1.1.1', username: nil, password: 'bye' }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(TypeError,
+                    'gRPC client creation failure: username must be specified')
+    end
+
+    it 'rejects nil password' do
+      kwargs = { host: '1.1.1.1', username: 'hi', password: nil }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(TypeError,
+                    'gRPC client creation failure: password must be specified')
+    end
+  end
+end

data/spec/isolate/all_clients_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../spec_helper.rb'
+
+context 'when both clients are installed' do
+  it 'should have both clients' do
+    require 'cisco_node_utils'
+    expect(Cisco::Client.clients).to eql [Cisco::Client::NXAPI,
+                                          Cisco::Client::GRPC]
+  end
+end

data/spec/isolate/grpc_only_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../spec_helper.rb'
+
+context 'when only gRPC client is installed' do
+  let(:main_self) { TOPLEVEL_BINDING.eval('self') }
+  before(:example) do
+    allow(main_self).to receive(:require).and_wrap_original do |orig, pkg|
+      fail LoadError, pkg if pkg['cisco_node_utils/client/nxapi']
+      orig.call(pkg)
+    end
+  end
+
+  it 'should have gRPC client' do
+    require 'cisco_node_utils'
+    expect(Cisco::Client.clients).to eql [Cisco::Client::GRPC]
+  end
+end

data/spec/isolate/no_clients_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../spec_helper.rb'
+require 'rspec/core'
+
+context 'when no client implementations are installed' do
+  let(:main_self) { TOPLEVEL_BINDING.eval('self') }
+
+  before(:example) do
+    allow(main_self).to receive(:require).and_wrap_original do |orig, pkg|
+      fail LoadError, pkg if pkg['client/nxapi']
+      fail LoadError, pkg if pkg['client/grpc']
+      orig.call(pkg)
+    end
+  end
+
+  it 'should not have any clients' do
+    require 'cisco_node_utils'
+    expect(Cisco::Client.clients).to eql []
+  end
+
+  it 'should fail Client.create' do
+    require 'cisco_node_utils'
+    expect { Cisco::Client.create }.to \
+      raise_error(RuntimeError, 'No client implementations available!')
+  end
+  # TODO
+end

data/spec/isolate/nxapi_only_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../spec_helper.rb'
+
+context 'when only NXAPI client is installed' do
+  let(:main_self) { TOPLEVEL_BINDING.eval('self') }
+  before(:example) do
+    allow(main_self).to receive(:require).and_wrap_original do |orig, pkg|
+      fail LoadError, pkg if pkg['cisco_node_utils/client/grpc']
+      orig.call(pkg)
+    end
+  end
+
+  it 'should have NXAPI client' do
+    require 'cisco_node_utils/client'
+    expect(Cisco::Client.clients).to eql [Cisco::Client::NXAPI]
+  end
+end

data/spec/nxapi_client_spec.rb

@@ -0,0 +1,42 @@
+require_relative 'spec_helper.rb'
+require 'shared_examples_for_clients'
+require 'cisco_node_utils/client/nxapi'
+
+describe Cisco::Client::NXAPI do
+  it_behaves_like 'all clients'
+
+  describe '.validate_args' do
+    it 'accepts nil host, username, and password together' do
+      described_class.validate_args
+    end
+
+    it 'rejects the combination of nil host with non-nil username' do
+      kwargs = { host: nil, username: 'hi', password: nil }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(ArgumentError)
+    end
+
+    it 'rejects the combination of nil host with non-nil password' do
+      kwargs = { host: nil, username: nil, password: 'bye' }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(ArgumentError)
+    end
+
+    it 'accepts a host with username and password' do
+      kwargs = { host: '1.1.1.1', username: 'hi', password: 'bye' }
+      described_class.validate_args(**kwargs)
+    end
+
+    it 'rejects a host with nil username' do
+      kwargs = { host: '1.1.1.1', username: nil, password: 'bye' }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(TypeError, 'username is required')
+    end
+
+    it 'rejects a host with nil password' do
+      kwargs = { host: '1.1.1.1', username: 'hi', password: nil }
+      expect { described_class.validate_args(**kwargs) }.to \
+        raise_error(TypeError, 'password is required')
+    end
+  end
+end

data/spec/schema.yaml

@@ -0,0 +1,75 @@
+# Kwalify schema for cmd_ref YAML files
+
+type: map
+mapping:
+  # List of cases to specifically exclude
+  _exclude: &exclude
+    type: seq
+    sequence:
+      - type: str
+        enum: &filters # Things we can filter by
+          # Platform classes
+          - 'ios_xr'
+          - 'nexus'
+          # Product IDs
+          - 'C3064'
+          - 'C3132'
+          - 'C3172'
+          - 'N3k'
+          - 'N5k'
+          - 'N6k'
+          - 'N7k'
+          - 'N8k'
+          - 'N9k'
+
+  =: &base # default rule - apply to all properties
+    type: map
+    mapping:
+      _exclude: *exclude
+      # Platform and product filters
+      ios_xr: *base
+      nexus: *base
+      C3064: *base
+      C3132: *base
+      C3172: *base
+      N3k: *base
+      N5k: *base
+      N6k: *base
+      N7k: *base
+      N8k: *base
+      N9k: *base
+      # 'else' case if not matching any filter above
+      else: *base
+      # Generally applicable attributes
+      data_format: &data_format
+        type: str
+        enum: [cli, nxapi_structured]
+      context: &context
+        type: seq
+        sequence:
+          - type: str
+      value:
+        type: str
+      default_only:
+        type: any
+      # Getter-specific attributes
+      auto_default:
+        type: bool
+      default_value:
+        type: any
+      get_command:
+        type: str
+      get_data_format: *data_format
+      get_context: *context
+      get_value:
+        type: str
+      kind:
+        type: str
+        enum: [boolean, int, string, symbol]
+      multiple:
+        type: bool
+      # Setter-specific attributes
+      set_data_format: *data_format
+      set_context: *context
+      set_value:
+        type: str

data/spec/shared_examples_for_clients.rb

@@ -0,0 +1,14 @@
+shared_examples_for 'all clients' do
+  describe '.validate_args' do
+    %i(host username password).each do |sym|
+      it "rejects non-String #{sym}" do
+        expect { described_class.validate_args(sym => 12) }.to \
+          raise_error(TypeError)
+      end
+      it "rejects empty #{sym}" do
+        expect { described_class.validate_args(sym => '') }.to \
+          raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+# rubocop:disable Style/BlockComments
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+  # rubocop:enable Style:BlockComments
+end

data/spec/whitespace_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper.rb'
+
+context 'non-ruby files' do
+  # Whitespace in ruby files is managed by Rubocop.
+  # Ignore ems.proto as it's a generated file.
+  failures = `git grep -n -I '\s$' | grep -v .rb | grep -v ems.proto`
+  it 'should have no trailing whitespace' do
+    expect(failures).to be_empty, -> { failures }
+  end
+end

data/spec/yaml_spec.rb

@@ -0,0 +1,42 @@
+require_relative 'spec_helper.rb'
+require 'kwalify'
+require 'yaml'
+
+files = Dir.glob(__dir__ + '/../lib/cisco_node_utils/cmd_ref/*.yaml')
+
+def print_errors(errors)
+  str = "Schema validation errors:\n"
+  error_str_list = errors.map do |e|
+    "line #{e.linenum}, column #{e.column}: [#{e.path}] #{e.message}"
+  end
+  str + error_str_list.join("\n")
+end
+
+# Use the MetaValidator to make sure the schema itself is sane
+metavalidator = Kwalify::MetaValidator.instance
+
+schema_file = File.join(__dir__, 'schema.yaml')
+
+metaparser = Kwalify::Yaml::Parser.new(metavalidator)
+context 'schema.yaml' do
+  it 'should have no schema metavalidation errors' do
+    metaparser.parse_file(schema_file)
+    errors = metaparser.errors()
+    expect(errors).to be_empty, -> { print_errors(errors) }
+  end
+end
+
+# Then use the Validator to make sure our files comply with the schema
+schema = Kwalify::Yaml.load_file(schema_file)
+validator = Kwalify::Validator.new(schema)
+parser = Kwalify::Yaml::Parser.new(validator)
+
+files.each do |file|
+  context file.split('/')[-1] do
+    it 'should have no schema validation errors' do
+      parser.parse_file(file)
+      errors = parser.errors()
+      expect(errors).to be_empty, -> { print_errors(errors) }
+    end
+  end
+end

data/tests/.rubocop.yml

@@ -3,13 +3,13 @@ inherit_from: ../.rubocop.yml
 # Code complexity metrics for the tests/ subdirectory
 
 Metrics/AbcSize:
-  Enabled: false
+  Max: 158 # ouch!
 
 Metrics/CyclomaticComplexity:
   Max: 15
 
 Metrics/MethodLength:
-  Max: 91
+  Max: 100
 
 Metrics/PerceivedComplexity:
   Max: 17

data/tests/basetest.rb

@@ -17,6 +17,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Minitest needs to have this path in order to discover our logging plugin
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
 require 'simplecov'
 SimpleCov.start do
   # Don't calculate coverage of our test code itself!
@@ -27,7 +30,10 @@ require 'rubygems'
 gem 'minitest', '~> 5.0'
 require 'minitest/autorun'
 require 'net/telnet'
-require 'cisco_nxapi'
+require_relative '../lib/cisco_node_utils/client'
+require_relative '../lib/cisco_node_utils/environment'
+require_relative '../lib/cisco_node_utils/command_reference'
+require_relative '../lib/cisco_node_utils/logger'
 
 # rubocop:disable Style/ClassVars
 # We *want* the address/username/password class variables to be shared
@@ -36,22 +42,12 @@ require 'cisco_nxapi'
 # 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 address
-    @@address ||= ARGV[0]
-    @@address ||= ENV['NODE'].split(' ')[0] if ENV['NODE']
+  def self.address
+    @@address ||= Cisco::Environment.environment[:host]
     unless @@address
       print 'Enter address or hostname of node under test: '
       @@address = gets.chomp
@@ -59,9 +55,12 @@ class TestCase < Minitest::Test
     @@address
   end
 
-  def username
-    @@username ||= ARGV[1]
-    @@username ||= ENV['NODE'].split(' ')[1] if ENV['NODE']
+  def address
+    self.class.address
+  end
+
+  def self.username
+    @@username ||= Cisco::Environment.environment[:username]
     unless @@username
       print 'Enter username for node under test:           '
       @@username = gets.chomp
@@ -69,9 +68,12 @@ class TestCase < Minitest::Test
     @@username
   end
 
-  def password
-    @@password ||= ARGV[2]
-    @@password ||= ENV['NODE'].split(' ')[2] if ENV['NODE']
+  def username
+    self.class.username
+  end
+
+  def self.password
+    @@password ||= Cisco::Environment.environment[:password]
     unless @@password
       print 'Enter password for node under test:           '
       @@password = gets.chomp
@@ -79,38 +81,94 @@ class TestCase < Minitest::Test
     @@password
   end
 
+  def password
+    self.class.password
+  end
+
   def setup
-    @device = Net::Telnet.new('Host' => address, 'Timeout' => 240)
-    @device.login(username, password)
-    CiscoLogger.debug_enable if ARGV[3] == 'debug' || ENV['DEBUG'] == '1'
+    # Hack - populate environment from user-entered values from basetest.rb
+    if Cisco::Environment.environments.empty?
+      class << Cisco::Environment
+        attr_writer :environments
+      end
+      Cisco::Environment.environments['default'] = {
+        host:     address.split(':')[0],
+        port:     address.split(':')[1],
+        username: username,
+        password: password,
+      }
+    end
+    @device = Net::Telnet.new('Host'    => address.split(':')[0],
+                              'Timeout' => 240,
+                              # NX-OS has a space after '#', IOS XR does not
+                              'Prompt'  => /[$%#>] *\z/n,
+                             )
+    begin
+      @device.login('Name'        => username,
+                    'Password'    => password,
+                    # NX-OS uses 'login:' while IOS XR uses 'Username:'
+                    'LoginPrompt' => /(?:[Ll]ogin|[Uu]sername)[: ]*\z/n,
+                   )
+    rescue Errno::ECONNRESET
+      @device.close
+      # TODO
+      puts 'Connection reset by peer? Try again'
+      sleep 1
+      @device = Net::Telnet.new('Host'    => address.split(':')[0],
+                                'Timeout' => 240,
+                                # NX-OS has a space after '#', IOS XR does not
+                                'Prompt'  => /[$%#>] *\z/n,
+                               )
+      @device.login('Name'        => username,
+                    'Password'    => password,
+                    # NX-OS uses 'login:' while IOS XR uses 'Username:'
+                    'LoginPrompt' => /(?:[Ll]ogin|[Uu]sername)[: ]*\z/n,
+                   )
+    end
+    @device.cmd('term len 0')
   rescue Errno::ECONNREFUSED
     puts 'Telnet login refused - please check that the IP address is correct'
-    puts "  and that you have enabled 'feature telnet' on the UUT"
+    puts "  and that you have configured 'feature telnet' (NX-OS) or "
+    puts "  'telnet ipv4 server...' (IOS XR) on the UUT"
     exit
   end
 
   def teardown
     @device.close unless @device.nil?
-    GC.start
+    @device = nil
   end
 
-  # Extend standard Minitest error handling to report UnsupportedError as skip
-  def capture_exceptions
-    super do
-      begin
-        yield
-      rescue Cisco::UnsupportedError => e
-        skip(e.to_s)
-      end
-    end
+  # Execute the specified config commands and warn if the
+  # output matches the default "warning" regex.
+  def config(*args)
+    config_and_warn_on_match(/^invalid|^%/i, *args)
   end
 
-  def config(*args)
+  # Execute the specified config commands. Use this version
+  # of the config method if you expect possible config errors
+  # and do not wish to log them as a warning.
+  def config_no_warn(*args)
+    config_and_warn_on_match(nil, *args)
+  end
+
+  # Execute the specified config commands and warn if the
+  # ouput matches the specified regex.  Specifying nil for
+  # warn_match means "do not warn".
+  def config_and_warn_on_match(warn_match, *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)
+    result = @device.cmd(
+      'String' => "configure terminal\n" + args.join("\n") + "\nend",
+      # NX-OS has a space after '#', IOS XR does not
+      'Match'  => /^[^()]+[$%#>] *\z/n)
+
+    if warn_match && warn_match.match(result)
+      Cisco::Logger.warn("Config result:\n#{result}")
+    else
+      Cisco::Logger.debug("Config result:\n#{result}")
+    end
+    result
   rescue Net::ReadTimeout => e
     raise "Timeout when configuring:\n#{args.join("\n")}\n\n#{e}"
   end
@@ -118,6 +176,7 @@ class TestCase < Minitest::Test
   def assert_show_match(pattern: nil, command: nil, msg: nil)
     pattern ||= @default_output_pattern
     refute_nil(pattern)
+    pattern = Cisco::Client.to_regexp(pattern)
     command ||= @default_show_command
     refute_nil(command)
 
@@ -133,6 +192,7 @@ class TestCase < Minitest::Test
   def refute_show_match(pattern: nil, command: nil, msg: nil)
     pattern ||= @default_output_pattern
     refute_nil(pattern)
+    pattern = Cisco::Client.to_regexp(pattern)
     command ||= @default_show_command
     refute_nil(command)