rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/eapilib.rb

@@ -58,8 +58,8 @@ module Rbeapi
       # The EapiError class provides one property for holding the set of
       # commands issued when the error was generated.
       #
-      # @param [String] :message The error message to return from raising
-      #   the exception
+      # @param message [String] The error message to return from raising
+      #   the exception.
       def initalize(message)
         @message = message
         @commands = nil
@@ -77,12 +77,14 @@ module Rbeapi
       ##
       # The exception contains the eAPI error code and error text.
       #
-      # @param [String] :message The error message to return from raising
-      #   this exception
-      # @param [Integer] :code The error code associated with the error
-      #   message to be raised
-      # @param [Array] :commands The list of commands that were used  in the
-      #   eAPI request message
+      # @param message [String] The error message to return from raising
+      #   this exception.
+      #
+      # @param code [Integer] The error code associated with the error
+      #   message to be raised.
+      #
+      # @param commands [Array] The list of commands that were used  in the
+      #   eAPI request message.
       def initialize(message, code, commands = nil)
         @error_code = code
         @error_text = message
@@ -101,12 +103,14 @@ module Rbeapi
       ##
       # The exception contains the eAPI error code and error text.
       #
-      # @param [String] :message The error message to return from raising
-      #   this exception
-      # @param [String] :connection_type The optional connection_type of
-      #   the instance
-      # @param [Array] :commands The list of commands that were used  in the
-      #   eAPI request message
+      # @param message [String] The error message to return from raising
+      #   this exception.
+      #
+      # @param connection_type [String] The optional connection_type of
+      #   the instance.
+      #
+      # @param commands [Array] The list of commands that were used  in the
+      #   eAPI request message.
       def initialize(message, connection_type = nil, commands = nil)
         @connection_type = connection_type
         @commands = commands
@@ -117,16 +121,18 @@ module Rbeapi
     ##
     # The EapiConnection provides a base class for building eAPI connection
     # instances with a specific transport for connecting to Arista EOS
-    # devices.  This class handles sending and receiving eAPI calls using
-    # JSON-RPC.  This class should not need to be directly instantiated.
+    # devices. This class handles sending and receiving eAPI calls using
+    # JSON-RPC. This class should not need to be directly instantiated.
     class EapiConnection
       attr_reader :error
+      attr_reader :open_timeout
+      attr_reader :read_timeout
 
       ##
       # The connection contains the transport.
       #
-      # @param [Net::HTTP] :transport The HTTP transport to use for sending
-      #   and receive eAPI request and response messages
+      # @param transport [Net::HTTP] The HTTP transport to use for sending
+      #   and receive eAPI request and response messages.
       def initialize(transport)
         @transport = transport
         @error = nil
@@ -134,13 +140,16 @@ module Rbeapi
 
       ##
       # Configures the connection authentication values (username and
-      # password).  The authentication values are used to authenticate
-      # the eAPI connection.  Using authentication is only required for
-      # connections that use Http or Https transports
+      # password). The authentication values are used to authenticate
+      # the eAPI connection. Using authentication is only required for
+      # connections that use Http or Https transports.
+      #
+      # @param opts [Hash] The authentication parameters.
       #
-      # @options :opts [String] :username The username to use to
+      # @option opts username [String] The username to use to
       #   authenticate with eAPI. Default is 'admin'.
-      # @options :opts [String] :password The password to use to
+      #
+      # @option opts password [String] The password to use to
       #   authenticate with eAPI. Default is ''.
       def authentication(opts = {})
         @username = opts.fetch(:username, 'admin')
@@ -149,12 +158,13 @@ module Rbeapi
 
       ##
       # Configures the connection timeout values (open_timeout and
-      # read_timeout).  The timeout values are used for the eAPI
+      # read_timeout). The timeout values are used for the eAPI
       # connection.
       #
-      # @option :opts [Float] :open_timeout Number of seconds to wait for the
+      # @option opts open_timeout [Float] Number of seconds to wait for the
       #   eAPI connection to open. Default is DEFAULT_HTTP_OPEN_TIMEOUT.
-      # @option :opts [Float] :read_timeout Number of seconds to wait for one
+      #
+      # @option opts read_timeout [Float] Number of seconds to wait for one
       #   block of eAPI results to be read (via one read(2) call). Default
       #   is DEFAULT_HTTP_READ_TIMEOUT.
       def timeouts(opts = {})
@@ -162,14 +172,6 @@ module Rbeapi
         @read_timeout = opts.fetch(:read_timeout, DEFAULT_HTTP_READ_TIMEOUT)
       end
 
-      ##
-      # Gets values for open_timeout and read_timeout
-      #
-      # @return [Hash] open_timeout and read_timeout
-      def get_timeouts
-        { open_timeout: @open_timeout, read_timeout: @read_timeout }
-      end
-
       ##
       # Generates the eAPI JSON request message.
       #
@@ -187,18 +189,21 @@ module Rbeapi
       #     "id": <reqid>
       #   }
       #
-      # @param [Array] :commands The ordered set of commands that should
-      #   be included in the eAPI request
-      # @param [Hash] :opts Optional keyword arguments
-      # @option :opts [String] :id The value to use for the eAPI request
-      #   id.  If not provided,the object_id for the connection instance
-      #   will be used
-      # @option :opts [String] :format The encoding formation to pass in
-      #   the eAPI request.  Valid values are json or text.  The default
-      #   value is json
+      # @param commands [Array] The ordered set of commands that should
+      #   be included in the eAPI request.
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts id [String] The value to use for the eAPI request
+      #   id. If not provided,the object_id for the connection instance
+      #   will be used.
+      #
+      # @option opts format [String] The encoding formation to pass in
+      #   the eAPI request. Valid values are json or text. The default
+      #   value is json.
       #
       # @return [Hash] Returns a Ruby hash of the request message that is
-      #   suitable to be JSON encoded and sent to the destination node
+      #   suitable to be JSON encoded and sent to the destination node.
       def request(commands, opts = {})
         id = opts.fetch(:reqid, object_id)
         format = opts.fetch(:format, 'json')
@@ -211,7 +216,7 @@ module Rbeapi
       ##
       # This method will send the request to the node over the specified
       # transport and return a response message with the contents from
-      # the eAPI response.  eAPI responds to request messages with either
+      # the eAPI response. eAPI responds to request messages with either
       # a success message or failure message.
       #
       # @example eAPI Response - success
@@ -248,16 +253,18 @@ module Rbeapi
       #     "id": <reqid>
       #   }
       #
-      # @param [Hash] :data A hash containing the body of the request
-      #   message.  This should be a valid eAPI request message.
-      # @option :opts [Float] :open_timeout Number of seconds to wait for the
+      # @param data [Hash] A hash containing the body of the request
+      #   message. This should be a valid eAPI request message.
+      #
+      # @option opts open_timeout [Float] Number of seconds to wait for the
       #   eAPI connection to open.
-      # @option :opts [Float] :read_timeout Number of seconds to wait for one
+      #
+      # @option opts read_timeout [Float] Number of seconds to wait for one
       #   block of eAPI results to be read (via one read(2) call).
       #
-      # @return [Hash] returns the response message as a Ruby hash object
+      # @return [Hash] Returns the response message as a Ruby hash object.
       #
-      # @raises [CommandError] Raised if an eAPI failure response is return
+      # @raise [CommandError] Raised if an eAPI failure response is return
       #   from the destination node.
       def send(data, opts)
         request = Net::HTTP::Post.new('/command-api')
@@ -289,24 +296,28 @@ module Rbeapi
       # Executes the commands on the destination node and returns the
       # response from the node.
       #
-      # @param [Array] :commands The ordered list of commands to execute
+      # @param commands [Array] The ordered list of commands to execute
       #   on the destination node.
-      # @param [Hash] :opts Optional keyword arguments
-      # @option :opts [String] :encoding Used to specify the encoding to be
-      #   used for the response.  Valid encoding values are json or text
-      # @option :opts [Float] :open_timeout Number of seconds to wait for the
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts encoding [String] Used to specify the encoding to be
+      #   used for the response. Valid encoding values are json or text.
+      #
+      # @option opts open_timeout [Float] Number of seconds to wait for the
       #   eAPI connection to open.
-      # @option :opts [Float] :read_timeout Number of seconds to wait for one
+      #
+      # @option opts read_timeout [Float] Number of seconds to wait for one
       #   block of eAPI results to be read (via one read(2) call).
       #
-      # @returns [Array<Hash>] This method will return the array of responses
+      # @return [Array<Hash>] This method will return the array of responses
       #   for each command executed on the node.
       #
-      # @raises [CommandError] Raises a CommandError if rescued from the
-      #   send method and adds the list of commands to the exception message
+      # @raise [CommandError] Raises a CommandError if rescued from the
+      #   send method and adds the list of commands to the exception message.
       #
-      # @raises [ConnectionError] Raises a ConnectionError if rescued and
-      #   adds the list of commands to the exception message
+      # @raise [ConnectionError] Raises a ConnectionError if rescued and
+      #   adds the list of commands to the exception message.
       def execute(commands, opts = {})
         @error = nil
         request = request(commands, opts)

data/lib/rbeapi/utils.rb

@@ -33,19 +33,19 @@
 require 'syslog'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Utils module
+  # Utils module.
   module Utils
     ##
     # Iterates through a hash structure and converts all of the keys
     # to symbols.
     #
-    # @param [Hash] :value The hash structure to convert the keys
+    # @param value [Hash] The hash structure to convert the keys.
     #
     # @return [Hash] An updated hash structure with all keys converted to
-    #   symboles
+    #   symboles.
     def self.transform_keys_to_symbols(value)
       return value unless value.is_a?(Hash)
       hash = value.each_with_object({}) do |(k, v), hsh|
@@ -56,11 +56,11 @@ module Rbeapi
     end
 
     ##
-    # Returns a class object from a string capable of being instatiated
+    # Returns a class object from a string capable of being instatiated.
     #
-    # @param [String] :name The name of the class to return a constant for
+    # @param name [String] The name of the class to return a constant for.
     #
-    # @return [Object] Returns a a class object that can be instatiated
+    # @return [Object] Returns a a class object that can be instatiated.
     def self.class_from_string(name)
       name.split('::').inject(Object) do |mod, cls|
         mod.const_get(cls)
@@ -70,7 +70,7 @@ module Rbeapi
     ##
     # Syslogs a warning message.
     #
-    # @param [String] :message The message to log.
+    # @param message [String] The message to log.
     def self.syslog_warning(message)
       Syslog.open('rbeapi', Syslog::LOG_PID) { |s| s.warning message }
     end

data/lib/rbeapi/version.rb

@@ -31,7 +31,7 @@
 #
 
 # #
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/fixtures/test.conf

@@ -1,6 +1,8 @@
-[connection:veos01]
+[DEFAULT]
 username: eapi
 password: password
+
+[connection:veos01]
 transport: http
 host: veos01
 
@@ -14,8 +16,6 @@ host: veos03
 
 [connection:veos04]
 host: 172.16.10.1
-username: eapi
-password: password
 enablepwd: itsasecret
 port: 1234
 transport: https

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

@@ -13,10 +13,14 @@ describe Rbeapi::Api::System do
 
   describe '#get' do
     let(:entity) do
-      { hostname: 'localhost', iprouting: true }
+      { hostname: 'localhost', iprouting: true, banner_motd: '',
+        banner_login: '' }
     end
 
-    before { node.config(['hostname localhost', 'ip routing']) }
+    before do
+      node.config(['hostname localhost', 'ip routing', 'no banner motd',
+                   'no banner login'])
+    end
 
     it 'returns the snmp resource' do
       expect(subject.get).to eq(entity)
@@ -88,4 +92,44 @@ describe Rbeapi::Api::System do
       end
     end
   end
+
+  describe '#set_banner' do
+    before { node.config(['no banner login', 'no banner motd']) }
+
+    it 'configures the login value' do
+      expect(subject.get[:banner_login]).to eq('')
+      expect(subject.set_banner('login', value: 'foo')).to be_truthy
+      expect(subject.get[:banner_login]).to eq('foo')
+    end
+
+    it 'negates the login value' do
+      expect(subject.get[:banner_login]).to eq('')
+      expect(subject.set_banner('login', enable: false)).to be_truthy
+      expect(subject.get[:banner_login]).to eq('')
+    end
+
+    it 'defaults the login value' do
+      expect(subject.get[:banner_login]).to eq('')
+      expect(subject.set_banner('login', default: true)).to be_truthy
+      expect(subject.get[:banner_login]).to eq('')
+    end
+
+    it 'configures the motd value' do
+      expect(subject.get[:banner_motd]).to eq('')
+      expect(subject.set_banner('motd', value: 'foo')).to be_truthy
+      expect(subject.get[:banner_motd]).to eq('foo')
+    end
+
+    it 'negates the motd value' do
+      expect(subject.get[:banner_motd]).to eq('')
+      expect(subject.set_banner('motd', enable: false)).to be_truthy
+      expect(subject.get[:banner_motd]).to eq('')
+    end
+
+    it 'defaults the motd value' do
+      expect(subject.get[:banner_motd]).to eq('')
+      expect(subject.set_banner('motd', default: true)).to be_truthy
+      expect(subject.get[:banner_motd]).to eq('')
+    end
+  end
 end

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

@@ -14,10 +14,13 @@ describe Rbeapi::Api::Vlans do
   context '#get' do
     describe 'with defaults' do
       let(:entity) do
-        { name: 'default', state: 'active', trunk_groups: [] }
+        { name: 'default', state: 'active', trunk_groups: %w(mlag test) }
       end
 
-      before { node.config(['no vlan 1-4094', 'vlan 1']) }
+      before do
+        node.config(['no vlan 1-4094', 'vlan 1', 'trunk group mlag',
+                     'trunk group test'])
+      end
 
       it 'returns the vlan resource' do
         expect(subject.get('1')).to eq(entity)

data/spec/system/rbeapi/client_spec.rb

@@ -348,8 +348,8 @@ describe Rbeapi::Client do
 
   describe 'test timeouts' do
     it 'loads default timeout values' do
-      expect(node.connection.get_timeouts).to eq(open_timeout: 10,
-                                                 read_timeout: 10)
+      expect(node.connection.open_timeout).to eq(10)
+      expect(node.connection.read_timeout).to eq(10)
     end
 
     describe 'loads veos05' do
@@ -359,8 +359,8 @@ describe Rbeapi::Client do
       end
 
       it 'loads timeout values from conf file' do
-        expect(node.connection.get_timeouts).to eq(open_timeout: 12,
-                                                   read_timeout: 12)
+        expect(node.connection.open_timeout).to eq(12)
+        expect(node.connection.read_timeout).to eq(12)
       end
     end
   end

data/spec/unit/rbeapi/api/system/default_spec.rb

@@ -41,7 +41,9 @@ describe Rbeapi::Api::System do
   let(:node) { double('node') }
 
   let(:test) do
-    { hostname: 'localhost', iprouting: true }
+    { hostname: 'localhost', iprouting: true,
+      banner_motd: "MOTD Banner\nSecond Line\nEOF \n*\\v1?",
+      banner_login: "Login Banner\nSecond Line\n123456\n EOF" }
   end
 
   def system
@@ -56,15 +58,15 @@ describe Rbeapi::Api::System do
 
   describe '#get' do
     it 'returns the username collection' do
-      expect(subject.get).to include(test)
+      expect(subject.get).to eq(test)
     end
 
     it 'returns a hash collection' do
       expect(subject.get).to be_a_kind_of(Hash)
     end
 
-    it 'has two entries' do
-      expect(subject.get.size).to eq(2)
+    it 'has four entries' do
+      expect(subject.get.size).to eq(4)
     end
   end
 
@@ -99,4 +101,38 @@ describe Rbeapi::Api::System do
       expect(subject.set_iprouting(enable: false)).to be_truthy
     end
   end
+
+  describe '#set_banner' do
+    it 'sets the login banner' do
+      expect(node).to receive(:config).with([{ cmd: 'banner login',
+                                               input: "login banner\n" }])
+      expect(subject.set_banner('login', value: 'login banner')).to be_truthy
+    end
+
+    it 'negates the login banner' do
+      expect(node).to receive(:config).with('no banner login')
+      expect(subject.set_banner('login', enable: false)).to be_truthy
+    end
+
+    it 'defaults the login banner' do
+      expect(node).to receive(:config).with('default banner login')
+      expect(subject.set_banner('login', default: true)).to be_truthy
+    end
+
+    it 'sets the motd banner' do
+      expect(node).to receive(:config).with([{ cmd: 'banner motd',
+                                               input: "motd banner\n" }])
+      expect(subject.set_banner('motd', value: 'motd banner')).to be_truthy
+    end
+
+    it 'negates the motd banner' do
+      expect(node).to receive(:config).with('no banner motd')
+      expect(subject.set_banner('motd', enable: false)).to be_truthy
+    end
+
+    it 'defaults the motd banner' do
+      expect(node).to receive(:config).with('default banner motd')
+      expect(subject.set_banner('motd', default: true)).to be_truthy
+    end
+  end
 end