rbeapi 1.0 → 1.1

data/lib/rbeapi/client.rb

@@ -42,12 +42,13 @@ module Rbeapi
   # Rbeapi::Client
   module Client
     class << self
-      DEFAULT_TRANSPORT = 'https'
+      DEFAULT_TRANSPORT = 'https'.freeze
 
       TRANSPORTS = { 'http' => 'Rbeapi::Eapilib::HttpEapiConnection',
                      'https' => 'Rbeapi::Eapilib::HttpsEapiConnection',
                      'http_local' => 'Rbeapi::Eapilib::HttpLocalEapiConenction',
                      'socket' => 'Rbeapi::Eapilib::SocketEapiConnection' }
+                   .freeze
 
       ##
       # Returns the currently loaded config object. This function will
@@ -165,7 +166,7 @@ module Rbeapi
     # The Config class holds the loaded configuration file data. It is a
     # subclass of IniFile.
     class Config < IniFile
-      CONFIG_SEARCH_PATH = ['/mnt/flash/eapi.conf']
+      CONFIG_SEARCH_PATH = ['/mnt/flash/eapi.conf'].freeze
 
       ##
       # The Config class will automatically search for a filename to load
@@ -226,10 +227,10 @@ module Rbeapi
 
         # For each section, if the host parameter is omitted then the
         # connection name is used.
-        has_default = self.has_section?('DEFAULT')
+        has_default = has_section?('DEFAULT')
         sections.each do |name|
           next unless name.start_with?('connection:')
-          conn = self["#{name}"]
+          conn = self[name.to_s]
           conn['host'] = name.split(':')[1] unless conn['host']
 
           # Merge in the default values into the connections
@@ -517,13 +518,15 @@ module Rbeapi
         begin
           result = run_commands("show #{config} #{params}", encoding: encoding)
         rescue Rbeapi::Eapilib::CommandError => error
-          if ( error.to_s =~ /'show (running|startup)-config'/ )
+          # rubocop:disable Style/GuardClause
+          if error.to_s =~ /'show (running|startup)-config'/
             return nil
           else
             raise error
           end
+          # rubocop:enable Style/GuardClause
         end
-        if encoding == 'json'
+        if encoding == 'json' # rubocop:disable Style/GuardClause
           return result.first
         else
           return result.first['output'].strip.split("\n") unless as_string

data/lib/rbeapi/eapilib.rb

@@ -46,8 +46,8 @@ module Rbeapi
     DEFAULT_HTTP_LOCAL_PORT = 8080
     DEFAULT_HTTP_OPEN_TIMEOUT = 10
     DEFAULT_HTTP_READ_TIMEOUT = 10
-    DEFAULT_HTTP_PATH = '/command-api'
-    DEFAULT_UNIX_SOCKET = '/var/run/command-api.sock'
+    DEFAULT_HTTP_PATH = '/command-api'.freeze
+    DEFAULT_UNIX_SOCKET = '/var/run/command-api.sock'.freeze
 
     ##
     # Base error class for generating exceptions.  The EapiError class
@@ -283,7 +283,7 @@ module Rbeapi
           if decoded.include?('error')
             code = decoded['error']['code']
             msg = decoded['error']['message']
-            fail CommandError.new(msg, code)
+            raise CommandError.new(msg, code)
           end
         rescue Timeout::Error
           raise ConnectionError, 'unable to connect to eAPI'

data/lib/rbeapi/netdev/snmp.rb

@@ -104,7 +104,7 @@ module Rbeapi
           resource_hash[:security] = sec_match[1] if sec_match
           ver_match = /^(v\d)/.match(auth) # first 2 characters
           resource_hash[:version] = ver_match[1] if ver_match
-          resource_hash[:type] = /trap/.match(type) ? :traps : :informs
+          resource_hash[:type] = type =~ /trap/ ? :traps : :informs
           resource_hash[:username] = username
           resource_hash
         end
@@ -243,7 +243,7 @@ module Rbeapi
           user_s.scan(/^(\w+).*?: (.*)/).each_with_object({}) do |(h, v), m|
             key = SNMP_USER_PARAM[h.downcase.intern] || h.downcase.intern
             m[key] = case key
-                     when :privacy  then /AES/.match(v) ? :aes128 : :des
+                     when :privacy  then v =~ /AES/ ? :aes128 : :des
                      when :version  then v.sub('v2c', 'v2').intern
                      when :auth     then v.downcase.intern
                      when :roles    then v.sub(/ \(.*?\)/, '')
@@ -262,7 +262,7 @@ module Rbeapi
         authentication: :auth,
         privacy: :privacy,
         group: :roles
-      }
+      }.freeze
 
       ##
       # snmp_user_set creates or updates an SNMP user account on the target
@@ -290,13 +290,15 @@ module Rbeapi
       #   hash which is idempotent.
       def snmp_user_set(opts = {})
         group = [*opts[:roles]].first
-        fail ArgumentError, 'at least one role is required' unless group
+        raise ArgumentError, 'at least one role is required' unless group
         version = opts[:version].to_s.sub('v2', 'v2c')
         cmd = user_cmd = "snmp-server user #{opts[:name]} #{group} #{version}"
         if opts[:password] && version == 'v3'
           privacy = opts[:privacy].to_s.scan(/aes|des/).first
-          fail ArgumentError,
-               'privacy is required when managing passwords' unless privacy
+          unless privacy
+            raise ArgumentError,
+                  'privacy is required when managing passwords'
+          end
           cmd += " auth #{opts[:auth] || 'sha'} #{opts[:password]} "\
             "priv #{privacy} #{opts[:password]}"
         end

data/lib/rbeapi/switchconfig.rb

@@ -127,7 +127,7 @@ module Rbeapi
       # @return [Section] The Section object contains the portion of self
       #   that is not in section2.
       def compare_r(section2)
-        fail '@line must equal section2.line' if @line != section2.line
+        raise '@line must equal section2.line' if @line != section2.line
 
         # XXX Need to have a list of exceptions of mode commands that
         # support default. If all the commands have been removed from
@@ -180,9 +180,7 @@ module Rbeapi
       #   in section2. The second Section object returned is the portion of
       #   section2 that is not in self.
       def compare(section2)
-        if @line != section2.line
-          fail 'XXX What if @line does not equal section2.line'
-        end
+        raise '@line does not equal section2.line' if @line != section2.line
 
         results = []
         # Compare self with section2
@@ -234,16 +232,17 @@ module Rbeapi
         config.each_line do |line|
           skip = true if @multiline_cmds.any? { |cmd| line =~ /#{cmd}/ }
           if skip
-            if line =~ /^\s*EOF$/
+            if line =~ /^\s*EOF$/ # rubocop:disable Style/GuardClause
               skip = false
             else
               next
             end
           end
           ind = line[/\A */].size
-          if ind % @indent != 0
-            fail ArgumentError, 'SwitchConfig indentation must be multiple of '\
-                                "#{@indent} improper indent #{ind}: #{line}"
+          if (ind % @indent).nonzero? # rubocop:disable Style/Next
+            raise ArgumentError, 'SwitchConfig indentation must be multiple '\
+                                 "of #{@indent} improper indent #{ind}: "\
+                                 "#{line}"
           end
         end
         true
@@ -277,7 +276,7 @@ module Rbeapi
           end
           if combine
             longline << line
-            if line =~ /^\s*EOF$/
+            if line =~ /^\s*EOF$/ # rubocop:disable Style/GuardClause
               line = longline.join
               combine = false
             else
@@ -287,7 +286,7 @@ module Rbeapi
 
           # Ignore comment lines and the end statement if there
           # XXX Fix parsing end
-          next if line.start_with?('!') || line.start_with?('end')
+          next if line.start_with?('!', 'end')
           line.chomp!
           next if line.empty?
           indent_level = line[/\A */].size / @indent

data/lib/rbeapi/version.rb

@@ -33,5 +33,5 @@
 # #
 # Rbeapi toplevel namespace.
 module Rbeapi
-  VERSION = '1.0'
+  VERSION = '1.1'.freeze
 end

data/spec/support/fixtures.rb

@@ -37,7 +37,7 @@ class Fixtures
   def self.save(key, obj, opts = {})
     dir = opts[:dir] || File.expand_path('../../fixtures', __FILE__)
     file = Pathname.new(File.join(dir, "fixture_#{key}.yaml"))
-    fail ArgumentError, "Error, file #{file} exists" if file.exist?
+    raise ArgumentError, "Error, file #{file} exists" if file.exist?
     File.open(file, 'w+') { |f| f.puts YAML.dump(obj) }
   end
 end
@@ -75,9 +75,9 @@ module FixtureHelpers
     text = Pathname.new(File.join(dir, "fixture_#{key}.text"))
 
     data = if yaml.exist?; then YAML.load(File.read(yaml))
-           elsif json.exist?; then JSON.load(File.read(json))
+           elsif json.exist?; then JSON.parse(File.read(json))
            elsif text.exist?; then File.read(text)
-           else fail "could not load YAML, JSON or TEXT fixture #{key} "\
+           else raise "could not load YAML, JSON or TEXT fixture #{key} "\
              "tried:\n  #{yaml}\n  #{json} #{text}"
            end
 
@@ -88,7 +88,7 @@ module FixtureHelpers
     when :json then JSON.pretty_generate(data)
     when :yaml then YAML.dump(data)
     when :text then data
-    else fail ArgumentError, "unknown format #{opts[:format].inspect}"
+    else raise ArgumentError, "unknown format #{opts[:format].inspect}"
     end
   end
   # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength

data/spec/support/matchers/switch_config_sections.rb

@@ -61,12 +61,12 @@ end
 
 RSpec::Matchers.define :section_equal do |expected|
   if expected.class != Rbeapi::SwitchConfig::Section
-    fail 'expected is not a Rbeapi::SwitchConfig::Section class'
+    raise 'expected is not a Rbeapi::SwitchConfig::Section class'
   end
 
   match do |actual|
     if actual.class != Rbeapi::SwitchConfig::Section
-      fail 'actual is not a Rbeapi::SwitchConfig::Section class'
+      raise 'actual is not a Rbeapi::SwitchConfig::Section class'
     end
 
     section_compare(actual, expected)

data/spec/system/rbeapi/api/acl_spec.rb

@@ -34,14 +34,12 @@ describe Rbeapi::Api::Acl do
       '40' => { seqno: '40', action: 'permit', srcaddr: '5.6.7.0',
                 srcprefixlen: '24', log: nil },
       '50' => { seqno: '50', action: 'permit', srcaddr: '9.10.11.0',
-                srcprefixlen: '255.255.255.0', log: 'log' }
-    }
+                srcprefixlen: '255.255.255.0', log: 'log' } }
   end
 
   let(:test2_entries) do
     { '10' => { seqno: '10', action: 'deny', srcaddr: '16.0.0.0',
-                srcprefixlen: '8', log: nil }
-    }
+                srcprefixlen: '8', log: nil } }
   end
 
   describe '#get' do

data/spec/system/rbeapi/api/alias_spec.rb

@@ -0,0 +1,168 @@
+#
+# Copyright (c) 2016, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+require 'spec_helper'
+
+require 'rbeapi/client'
+require 'rbeapi/api/alias'
+
+describe Rbeapi::Api::Alias do
+  subject { described_class.new(node) }
+
+  let(:node) do
+    Rbeapi::Client.config.read(fixture_file('dut.conf'))
+    Rbeapi::Client.connect_to('dut')
+  end
+
+  let(:command) do
+    'my command'
+  end
+
+  let(:test) do
+    { name: 'test1',
+      command: 'my command' }
+  end
+
+  let(:test_multi) do
+    { name: 'desc',
+      command: "1 conf\n   2 int %1\n   3 descr %2\n   4 end" }
+  end
+
+  describe '#getall' do
+    let(:resource) { subject.getall }
+
+    let(:test1_entries) do
+      { 'test1' => { name: 'test1', command: 'my command' },
+        'test2' => { name: 'test2', command: 'my command 2' },
+        'test3' => { name: 'test3', command: 'my command 3' },
+        'desc' => { name: 'desc',
+                    command: "1 conf\n   2 int %1\n   3 descr %2\n   4 end" } }
+    end
+
+    before do
+      node.config(['no alias test1',
+                   'no alias test2',
+                   'no alias test3.domain',
+                   'no alias desc',
+                   'alias test1 my command',
+                   'alias test2 my command 2',
+                   'alias test3 my command 3',
+                   'alias desc',
+                   '1 conf',
+                   '2 int %1',
+                   '3 descr %2',
+                   '4 end',
+                   'end'])
+    end
+
+    it 'returns the alias collection' do
+      expect(subject.getall).to include(test1_entries)
+    end
+
+    it 'returns a hash collection' do
+      expect(subject.getall).to be_a_kind_of(Hash)
+    end
+  end
+
+  describe '#get' do
+    before do
+      node.config(['no alias test1',
+                   'no alias test2',
+                   'no alias test3.domain',
+                   'no alias desc',
+                   'alias test1 my command',
+                   'alias test2 my command 2',
+                   'alias test3 my command 3',
+                   'alias desc',
+                   '1 conf',
+                   '2 int %1',
+                   '3 descr %2',
+                   '4 end',
+                   'end'])
+    end
+    it 'returns the alias name and body' do
+      expect(subject.get('test1')).to eq(test)
+    end
+
+    it 'returns the alias name and body for multiline entry' do
+      expect(subject.get('desc')).to eq(test_multi)
+    end
+
+    it 'returns a hash' do
+      expect(subject.get('test1')).to be_a_kind_of(Hash)
+    end
+
+    it 'has 2 entries' do
+      expect(subject.get('test1').size).to eq(2)
+    end
+  end
+
+  describe '#create' do
+    before do
+      node.config(['no alias test1'])
+    end
+
+    it 'create a new alias name' do
+      expect(subject.get('test1')).to eq(nil)
+      expect(subject.create('test1', command: 'my command')).to be_truthy
+      expect(subject.get('test1')[:command]).to eq('my command')
+    end
+
+    it 'raises ArgumentError for create without required args ' do
+      expect { subject.create('test1') }.to \
+        raise_error ArgumentError
+    end
+  end
+
+  describe '#delete' do
+    before do
+      node.config(['alias test12 a command'])
+    end
+
+    it 'delete an alias resource' do
+      expect(subject.get('test12')[:name]).to eq('test12')
+      expect(subject.delete('test12')).to be_truthy
+      expect(subject.get('test12')).to eq(nil)
+    end
+  end
+
+  describe '#set_command' do
+    before do
+      node.config(['no alias test13'])
+    end
+
+    it 'change the command alias' do
+      expect(subject.create('test13', command: 'my command')).to be_truthy
+      expect(subject.create('test13', command: 'my command 2')).to be_truthy
+      expect(subject.get('test13')[:command]).to eq('my command 2')
+    end
+  end
+end

data/spec/system/rbeapi/api/bgp_spec.rb

@@ -68,8 +68,7 @@ describe Rbeapi::Api::Bgp do
           shutdown: true, description: nil, next_hop_self: true,
           route_map_in: nil, route_map_out: nil
         }
-      }
-    }
+      } }
   end
 
   let(:response) do

data/spec/system/rbeapi/api/interfaces_base_spec.rb

@@ -20,8 +20,8 @@ describe Rbeapi::Api::Interfaces do
   describe '#get' do
     context 'with interface Loopback' do
       let(:entity) do
-        { name: 'Loopback0', type: 'generic', description: '', shutdown: false,
-          load_interval: '' }
+        { name: 'Loopback0', type: 'generic', description: '',
+          encapsulation: '', shutdown: false, load_interval: '' }
       end
 
       before { node.config(['no interface Loopback0', 'interface Loopback0']) }
@@ -34,9 +34,9 @@ describe Rbeapi::Api::Interfaces do
     context 'with interface Port-Channel' do
       let(:entity) do
         { name: 'Port-Channel1', type: 'portchannel', description: '',
-          shutdown: false, load_interval: '', members: [], lacp_mode: 'on',
-          minimum_links: '0',
-          lacp_fallback: 'disabled', lacp_timeout: '90' }
+          encapsulation: '', shutdown: false, load_interval: '', members: [],
+          lacp_mode: 'on', minimum_links: '0', lacp_fallback: 'disabled',
+          lacp_timeout: '90' }
       end
 
       before do
@@ -51,10 +51,9 @@ describe Rbeapi::Api::Interfaces do
 
     context 'with interface Vxlan' do
       let(:entity) do
-        { name: 'Vxlan1', type: 'vxlan', description: '',
+        { name: 'Vxlan1', type: 'vxlan', description: '', encapsulation: '',
           shutdown: false, load_interval: '', source_interface: '',
-          multicast_group: '',
-          udp_port: 4789, flood_list: [], vlans: {} }
+          multicast_group: '', udp_port: 4789, flood_list: [], vlans: {} }
       end
 
       before do