rbeapi 0.4.0 → 0.5.0

data/lib/rbeapi/client.rb

@@ -90,7 +90,7 @@ module Rbeapi
       end
 
       ##
-      # Retrieves the node config form the loaded configuration file and
+      # Retrieves the node config from the loaded configuration file and
       # returns a Rbeapi::Node instance for working with the remote node.
       #
       # @param [String] :name The named configuration to use for creating the
@@ -99,21 +99,23 @@ module Rbeapi
       # @return [Rbeapi::Node, nil] Returns an instance of Rbeapi::Node.  If
       #   the named configuration is not found then nil is returned
       def connect_to(name)
-        config = config_for(name)
-        return nil unless config
+        config_entry = config_for(name)
+        return nil unless config_entry
+        config = config_entry.dup
         config['host'] = name if config['host'] == '*'
         config = Rbeapi::Utils.transform_keys_to_symbols(config)
         connection = connect config
         Node.new(connection)
+        node = Node.new(connection)
+        enablepwd = config.fetch(:enablepwd, nil)
+        node.enable_authentication(enablepwd) if enablepwd
+        node
       end
 
       ##
       # Builds a connection object to a remote node using the specified
       # options and return an instance of Rbeapi::Connection.  All
-      # configuration options can be passed via the :opts param or can be
-      # overridden using environment variables.  Environment variables are
-      # specified by prepending EAPI to the option name.  For instance to
-      # override the host param use EAPI_HOST.
+      # configuration options can be passed via the :opts param.
       #
       # @param [Hash] :opts the options to create a message with
       # @option :opts [String] :host The IP address or hostname of the remote
@@ -122,7 +124,7 @@ module Rbeapi
       #   the eAPI connection with
       # @option :opts [String] :password The password to use to authenticate
       #   the eAPI connection with
-      # @option :opts [String] :enable_pwd The enable password (if defined) to
+      # @option :opts [String] :enablepwd The enable password (if defined) to
       #   pass to the remote node to enter privilege mode
       # @option :opts [String] :use_ssl Specifies whether or not to use the
       #   HTTP or HTTPS protocol
@@ -205,7 +207,12 @@ module Rbeapi
       #
       # @param [String] :filename The full path to the filename to load
       def read(filename)
-        super(filename: filename)
+        begin
+          super(filename: filename)
+        rescue IniFile::Error => exc
+          Rbeapi::Utils.syslog_warning("#{exc}: in eapi conf file: #{filename}")
+          return
+        end
 
         # For each section, if the host parameter is omitted then the
         # connection name is used
@@ -252,13 +259,14 @@ module Rbeapi
       end
 
       ##
-      # Adds a new connection section  to the current configuration
+      # Adds a new connection section to the current configuration
       #
       # @param [String] :name The name of the connection to add to the
       #   configuration.
       # @param [Hash] :values The properties for the connection
       def add_connection(name, values)
         self["connection:#{name}"] = values
+        nil
       end
     end
 
@@ -332,7 +340,7 @@ module Rbeapi
       def config(commands, opts = {})
         commands = [*commands] unless commands.respond_to?('each')
 
-        commands.insert(0, 'configure')
+        commands.insert(0, 'configure terminal')
 
         if @dry_run
           puts '[rbeapi dry-run commands]'

data/lib/rbeapi/eapilib.rb

@@ -162,6 +162,14 @@ 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.
       #

data/lib/rbeapi/utils.rb

@@ -30,6 +30,8 @@
 # IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+require 'syslog'
+
 ##
 # Rbeapi toplevel namespace
 module Rbeapi
@@ -64,5 +66,13 @@ module Rbeapi
         mod.const_get(cls)
       end
     end
+
+    ##
+    # Syslogs a warning message.
+    #
+    # @param [String] :message The message to log.
+    def self.syslog_warning(message)
+      Syslog.open('rbeapi', Syslog::LOG_PID) { |s| s.warning message }
+    end
   end
 end

data/lib/rbeapi/version.rb

@@ -33,5 +33,5 @@
 # #
 # Rbeapi toplevel namespace
 module Rbeapi
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/fixtures/eapi.conf.yaml

@@ -0,0 +1,6 @@
+---
+:username: admin
+:password: admin
+:use_ssl: true
+:port: 199
+:hostname: bogus

data/spec/fixtures/env_path.conf

@@ -0,0 +1,5 @@
+[connection:env_path]
+host: 172.16.131.40
+username: admin
+password: admin
+transport: https

data/spec/fixtures/test.conf

@@ -0,0 +1,39 @@
+[connection:veos01]
+username: eapi
+password: password
+transport: http
+host: veos01
+
+[connection:veos02]
+transport: http
+host: veos02
+
+[connection:veos03]
+transport: socket
+host: veos03
+
+[connection:veos04]
+host: 172.16.10.1
+username: eapi
+password: password
+enablepwd: itsasecret
+port: 1234
+transport: https
+
+[connection:veos05]
+host: 172.16.131.40
+username: admin
+password: admin
+enablepwd: password
+transport: https
+port: 1234
+open_timeout: 12
+read_timeout: 12
+
+[connection: localhost]
+transport: http_local
+host: localhost
+
+[connection:localhost]
+transport: socket
+host: localhost

data/spec/fixtures/wildcard.conf

@@ -0,0 +1,43 @@
+[connection:veos01]
+username: eapi
+password: password
+transport: http
+host: veos01
+
+[connection:veos02]
+transport: http
+host: veos02
+
+[connection:veos03]
+transport: socket
+host: veos03
+
+[connection:veos04]
+host: 172.16.10.1
+username: eapi
+password: password
+enablepwd: itsasecret
+port: 1234
+transport: https
+
+[connection:veos05]
+host: 172.16.131.40
+username: admin
+password: admin
+enablepwd: password
+transport: https
+port: 1234
+open_timeout: 12
+read_timeout: 12
+
+[connection: localhost]
+transport: http_local
+host: localhost
+
+[connection:localhost]
+transport: socket
+host: localhost
+
+[connection:*]
+username: foo
+password: bar

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

@@ -0,0 +1,122 @@
+#
+# Copyright (c) 2015, 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/aaa'
+
+describe Rbeapi::Api::AaaGroups do
+  subject { described_class.new(node) }
+
+  let(:node) do
+    Rbeapi::Client.config.read(fixture_file('dut.conf'))
+    Rbeapi::Client.connect_to('dut')
+  end
+
+  let(:all) do
+    {
+      'blah' => {
+        type: 'radius',
+        servers: []
+      },
+      'blahtwo' => {
+        type: 'radius',
+        servers: []
+      }
+    }
+  end
+
+  let(:blah) do
+    {
+      type: 'radius',
+      servers: []
+    }
+  end
+
+  let(:blahthree) do
+    {
+      type: 'tacacs+',
+      servers: []
+    }
+  end
+
+  let(:servers) do
+    [{
+      name: 'localhost',
+      auth_port: '1812',
+      acct_port: '1813'
+    }]
+  end
+
+  describe '#get' do
+    before do
+      node.config(['no aaa group server radius blah',
+                   'no aaa group server radius blahtwo',
+                   'no aaa group server tacacs+ blahthree',
+                   'aaa group server radius blah', 'exit',
+                   'aaa group server radius blahtwo', 'exit'])
+    end
+
+    it 'returns the resource for given name' do
+      expect(subject.get('blah')).to eq(blah)
+    end
+  end
+
+  describe '#getall' do
+    it 'returns all of the aaa group resources' do
+      expect(subject.getall).to eq(all)
+    end
+  end
+
+  describe '#create' do
+    it 'adds a new aaa group' do
+      expect(subject.create('blahthree', 'tacacs+')).to eq(true)
+      expect(subject.get('blahthree')).to eq(blahthree)
+    end
+  end
+
+  describe '#delete' do
+    it 'removes specified aaa group' do
+      expect(subject.get('blahthree')).to eq(blahthree)
+      expect(subject.delete('blahthree')).to eq(true)
+      expect(subject.get('blahthree')).to eq(nil)
+    end
+  end
+
+  describe '#set_servers' do
+    it 'removes all servers and then adds one' do
+      expect(subject.set_servers('blahtwo', [{ name: 'localhost' }]))
+        .to eq(true)
+      expect(subject.get('blahtwo')[:servers]).to eq(servers)
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+#
+# Copyright (c) 2015, 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/aaa'
+
+describe Rbeapi::Api::Aaa do
+  subject { described_class.new(node) }
+
+  let(:node) do
+    Rbeapi::Client.config.read(fixture_file('dut.conf'))
+    Rbeapi::Client.connect_to('dut')
+  end
+
+  let(:test) do
+    {
+      groups: {
+        'blah' => {
+          type: 'radius',
+          servers: []
+        },
+        'blahtwo' => {
+          type: 'radius',
+          servers: []
+        }
+      }
+    }
+  end
+
+  describe '#get' do
+    before do
+      node.config(['no aaa group server radius blah',
+                   'no aaa group server radius blahtwo',
+                   'aaa group server radius blah', 'exit',
+                   'aaa group server radius blahtwo', 'exit'])
+    end
+
+    it 'returns the resource for given name' do
+      expect(subject.get).to eq(test)
+    end
+
+    it 'returns a hash' do
+      expect(subject.get).to be_a_kind_of(Hash)
+    end
+
+    it 'has two entries' do
+      expect(subject.get[:groups].size).to eq(2)
+    end
+  end
+
+  describe '#groups' do
+    it 'returns new node instance' do
+      expect(subject.groups).to be_a_kind_of(Rbeapi::Api::AaaGroups)
+    end
+
+    it 'returns a hash' do
+      expect(subject.groups).to be_a_kind_of(Object)
+    end
+  end
+end