rbeapi 0.4.0 → 0.5.0

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

@@ -96,7 +96,7 @@ describe Rbeapi::Api::Users do
       expect(subject.getall).to be_a_kind_of(Hash)
     end
 
-    it 'has two entries' do
+    it 'has three entries' do
       expect(subject.getall.size).to eq(3)
     end
   end

data/spec/unit/rbeapi/client_spec.rb

@@ -0,0 +1,211 @@
+#
+# 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'
+
+include FixtureHelpers
+
+describe Rbeapi::Client do
+  subject { described_class }
+
+  def dut_conf
+    fixture_file('dut.conf')
+  end
+
+  def test_conf
+    fixture_file('test.conf')
+  end
+
+  def empty_conf
+    fixture_file('empty.conf')
+  end
+
+  def yaml_conf
+    fixture_file('eapi.conf.yaml')
+  end
+
+  def wildcard_conf
+    fixture_file('wildcard.conf')
+  end
+
+  let(:dut) do
+    File.read(dut_conf)
+  end
+
+  let(:test) do
+    File.read(test_conf)
+  end
+
+  let(:veos01) do
+    {
+      'username' => 'eapi',
+      'password' => 'password',
+      'transport' => 'http',
+      'host' => 'veos01'
+    }
+  end
+
+  let(:veos05) do
+    {
+      'host' => '172.16.131.40',
+      'username' => 'admin',
+      'password' => 'admin',
+      'enablepwd' => 'password',
+      'transport' => 'https',
+      'port' => 1234,
+      'open_timeout' => 12,
+      'read_timeout' => 12
+    }
+  end
+
+  let(:wildcard) do
+    {
+      'username' => 'foo',
+      'password' => 'bar',
+      'host' => '*'
+    }
+  end
+
+  let(:test_data) do
+    [
+      '[connection:veos01]'
+    ]
+  end
+
+  let(:default_entry) { "[connection:localhost]\ntransport : socket\n" }
+
+  # Client class methods
+  describe '#config_for' do
+    # Verify that the EAPI_CONF env variable path is used by default
+    # when the Config class is instantiated/reload-ed.
+    it 'env path to config file' do
+      # Store env path for the eapi conf file and reload the class
+      conf = fixture_dir + '/env_path.conf'
+      ENV.store('EAPI_CONF', conf)
+      subject.config.reload
+
+      # Verify env_path.conf file was loaded
+      expect(subject.config.to_s).to include('[connection:env_path]')
+    end
+
+    it 'returns the configuration options for the connection' do
+      expect(subject.load_config(test_conf)).to eq(nil)
+      expect(subject.config_for('veos01')).to eq(veos01)
+    end
+  end
+
+  describe '#connect_to' do
+    it 'retrieves the node config' do
+      expect(subject.connect_to('veos01')).to be_truthy
+    end
+
+    it 'check connection wildcard host name' do
+      expect(subject.load_config(wildcard_conf)).to eq(nil)
+      expect(subject.connect_to('host1')).to be_truthy
+      expect(subject.config.get_connection('host1')) .to eq(wildcard)
+      expect(subject.connect_to('host2')).to be_truthy
+      expect(subject.config.get_connection('host2')) .to eq(wildcard)
+    end
+  end
+
+  describe '#load_config' do
+    it 'overrides the default conf file loaded in the config' do
+      expect(subject.load_config(test_conf)).to eq(nil)
+      expect(subject.config_for('dut')).to eq(nil)
+      expect(subject.config_for('veos01')).to eq(veos01)
+    end
+  end
+
+  # Config class methods
+  describe 'config' do
+    it 'gets the loaded configuration file data' do
+      expect(subject.load_config(test_conf)).to eq(nil)
+      expect(subject.config.to_s).to include(test_data[0])
+    end
+
+    it 'loading empty config file does not fail' do
+      expect(subject.load_config(empty_conf)).to eq(nil)
+      expect(subject.config.to_s).to eq(default_entry)
+    end
+
+    it 'does not load bad config file data' do
+      expect(subject.load_config(yaml_conf)).to eq(nil)
+      expect(subject.config.to_s).to eq('')
+    end
+  end
+
+  describe '#read' do
+    it 'read the specified filename and load it' do
+      expect(subject.load_config(dut_conf)).to eq(nil)
+      expect(subject.config.read(test_conf)).to eq(nil)
+      expect(subject.config.to_s).to include(test_data[0])
+    end
+  end
+
+  describe '#get_connection' do
+    it 'get connection dut' do
+      expect(subject.config.get_connection('veos01')).to eq(veos01)
+    end
+
+    it 'connection wildcard works' do
+      expect(subject.load_config(wildcard_conf)).to eq(nil)
+      expect(subject.config.get_connection('host1')) .to eq(wildcard)
+      expect(subject.config.get_connection('host2')) .to eq(wildcard)
+    end
+  end
+
+  describe '#reload' do
+    it 'reloads the configuration file' do
+      expect(subject.config.get_connection('veos01')).to eq(veos01)
+      expect(subject.config.reload(filename: [dut_conf])).to eq(nil)
+      expect(subject.config.get_connection('veos01')).to eq(nil)
+      expect(subject.config.get_connection('dut')).not_to be_nil
+    end
+  end
+
+  describe '#add_connection' do
+    it 'adds a new connection section' do
+      expect(subject.config.add_connection('test2',
+                                           username: 'test2',
+                                           password: 'test',
+                                           transport: 'http',
+                                           host: 'test2'
+                                          )).to eq(nil)
+      expect(subject.config.get_connection('test2'))
+        .to eq(username: 'test2',
+               password: 'test',
+               transport: 'http',
+               host: 'test2')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbeapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -211,6 +211,23 @@ files:
 - gems/net_http_unix/net_http_unix.spec.tmpl
 - gems/netaddr/README.rst
 - gems/netaddr/netaddr.spec.tmpl
+- guide/Makefile
+- guide/_static/arista_logo_11-trans-w.png
+- guide/_static/arista_logo_jpg-11.jpg
+- guide/_static/favicon.ico
+- guide/conf.py
+- guide/cookbook.rst
+- guide/developing.rst
+- guide/faq.rst
+- guide/index.rst
+- guide/installation.rst
+- guide/license.rst
+- guide/overview.rst
+- guide/quickstart.rst
+- guide/release-notes-0.5.0.rst
+- guide/release-notes.rst
+- guide/testing.rst
+- guide/troubleshooting.rst
 - lib/rbeapi.rb
 - lib/rbeapi/api.rb
 - lib/rbeapi/api/aaa.rb
@@ -244,12 +261,19 @@ files:
 - rbeapi.gemspec
 - rbeapi.spec.tmpl
 - spec/fixtures/dut.conf
+- spec/fixtures/eapi.conf.yaml
+- spec/fixtures/empty.conf
+- spec/fixtures/env_path.conf
+- spec/fixtures/test.conf
+- spec/fixtures/wildcard.conf
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/shared_examples_for_api_modules.rb
-- spec/system/api_acl_spec.rb
-- spec/system/api_ospf_interfaces_spec.rb
-- spec/system/api_ospf_spec.rb
+- spec/system/rbeapi/api/aaa_groups_spec.rb
+- spec/system/rbeapi/api/aaa_spec.rb
+- spec/system/rbeapi/api/acl_spec.rb
+- spec/system/rbeapi/api/bgp_neighbors_spec.rb
+- spec/system/rbeapi/api/bgp_spec.rb
 - spec/system/rbeapi/api/dns_spec.rb
 - spec/system/rbeapi/api/interfaces_base_spec.rb
 - spec/system/rbeapi/api/interfaces_ethernet_spec.rb
@@ -260,16 +284,25 @@ files:
 - spec/system/rbeapi/api/mlag_interfaces_spec.rb
 - spec/system/rbeapi/api/mlag_spec.rb
 - spec/system/rbeapi/api/ntp_spec.rb
+- spec/system/rbeapi/api/ospf_interfaces_spec.rb
+- spec/system/rbeapi/api/ospf_spec.rb
 - spec/system/rbeapi/api/routemaps_spec.rb
 - spec/system/rbeapi/api/snmp_spec.rb
+- spec/system/rbeapi/api/staticroutes_spec.rb
 - spec/system/rbeapi/api/stp_instances_spec.rb
 - spec/system/rbeapi/api/stp_interfaces_spec.rb
 - spec/system/rbeapi/api/stp_spec.rb
 - spec/system/rbeapi/api/switchports_spec.rb
 - spec/system/rbeapi/api/system_spec.rb
+- spec/system/rbeapi/api/users_spec.rb
 - spec/system/rbeapi/api/varp_interfaces_spec.rb
 - spec/system/rbeapi/api/varp_spec.rb
 - spec/system/rbeapi/api/vlans_spec.rb
+- spec/system/rbeapi/api/vrrp_spec.rb
+- spec/system/rbeapi/client_spec.rb
+- spec/unit/rbeapi/api/aaa/aaa_groups_spec.rb
+- spec/unit/rbeapi/api/aaa/aaa_spec.rb
+- spec/unit/rbeapi/api/aaa/fixture_aaa.text
 - spec/unit/rbeapi/api/acl/default_spec.rb
 - spec/unit/rbeapi/api/acl/fixture_acl_standard.text
 - spec/unit/rbeapi/api/bgp/bgp_neighbors_spec.rb
@@ -286,6 +319,8 @@ files:
 - spec/unit/rbeapi/api/routemaps/fixture_routemaps.text
 - spec/unit/rbeapi/api/staticroutes/default_spec.rb
 - spec/unit/rbeapi/api/staticroutes/fixture_staticroutes.text
+- spec/unit/rbeapi/api/switchports/default_spec.rb
+- spec/unit/rbeapi/api/switchports/fixture_switchports.text
 - spec/unit/rbeapi/api/system/default_spec.rb
 - spec/unit/rbeapi/api/system/fixture_system.text
 - spec/unit/rbeapi/api/users/default_spec.rb
@@ -294,6 +329,7 @@ files:
 - spec/unit/rbeapi/api/vlans/fixture_vlans.text
 - spec/unit/rbeapi/api/vrrp/default_spec.rb
 - spec/unit/rbeapi/api/vrrp/fixture_vrrp.text
+- spec/unit/rbeapi/client_spec.rb
 homepage: https://github.com/arista-eosplus/rbeapi
 licenses:
 - New BSD
@@ -309,7 +345,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4459754643006695547
+      hash: -1152048949229311589
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -318,7 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4459754643006695547
+      hash: -1152048949229311589
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -327,12 +363,19 @@ specification_version: 3
 summary: This Gem library provides a Ruby interface to the Arista EOS command API
 test_files:
 - spec/fixtures/dut.conf
+- spec/fixtures/eapi.conf.yaml
+- spec/fixtures/empty.conf
+- spec/fixtures/env_path.conf
+- spec/fixtures/test.conf
+- spec/fixtures/wildcard.conf
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/shared_examples_for_api_modules.rb
-- spec/system/api_acl_spec.rb
-- spec/system/api_ospf_interfaces_spec.rb
-- spec/system/api_ospf_spec.rb
+- spec/system/rbeapi/api/aaa_groups_spec.rb
+- spec/system/rbeapi/api/aaa_spec.rb
+- spec/system/rbeapi/api/acl_spec.rb
+- spec/system/rbeapi/api/bgp_neighbors_spec.rb
+- spec/system/rbeapi/api/bgp_spec.rb
 - spec/system/rbeapi/api/dns_spec.rb
 - spec/system/rbeapi/api/interfaces_base_spec.rb
 - spec/system/rbeapi/api/interfaces_ethernet_spec.rb
@@ -343,16 +386,25 @@ test_files:
 - spec/system/rbeapi/api/mlag_interfaces_spec.rb
 - spec/system/rbeapi/api/mlag_spec.rb
 - spec/system/rbeapi/api/ntp_spec.rb
+- spec/system/rbeapi/api/ospf_interfaces_spec.rb
+- spec/system/rbeapi/api/ospf_spec.rb
 - spec/system/rbeapi/api/routemaps_spec.rb
 - spec/system/rbeapi/api/snmp_spec.rb
+- spec/system/rbeapi/api/staticroutes_spec.rb
 - spec/system/rbeapi/api/stp_instances_spec.rb
 - spec/system/rbeapi/api/stp_interfaces_spec.rb
 - spec/system/rbeapi/api/stp_spec.rb
 - spec/system/rbeapi/api/switchports_spec.rb
 - spec/system/rbeapi/api/system_spec.rb
+- spec/system/rbeapi/api/users_spec.rb
 - spec/system/rbeapi/api/varp_interfaces_spec.rb
 - spec/system/rbeapi/api/varp_spec.rb
 - spec/system/rbeapi/api/vlans_spec.rb
+- spec/system/rbeapi/api/vrrp_spec.rb
+- spec/system/rbeapi/client_spec.rb
+- spec/unit/rbeapi/api/aaa/aaa_groups_spec.rb
+- spec/unit/rbeapi/api/aaa/aaa_spec.rb
+- spec/unit/rbeapi/api/aaa/fixture_aaa.text
 - spec/unit/rbeapi/api/acl/default_spec.rb
 - spec/unit/rbeapi/api/acl/fixture_acl_standard.text
 - spec/unit/rbeapi/api/bgp/bgp_neighbors_spec.rb
@@ -369,6 +421,8 @@ test_files:
 - spec/unit/rbeapi/api/routemaps/fixture_routemaps.text
 - spec/unit/rbeapi/api/staticroutes/default_spec.rb
 - spec/unit/rbeapi/api/staticroutes/fixture_staticroutes.text
+- spec/unit/rbeapi/api/switchports/default_spec.rb
+- spec/unit/rbeapi/api/switchports/fixture_switchports.text
 - spec/unit/rbeapi/api/system/default_spec.rb
 - spec/unit/rbeapi/api/system/fixture_system.text
 - spec/unit/rbeapi/api/users/default_spec.rb
@@ -377,4 +431,5 @@ test_files:
 - spec/unit/rbeapi/api/vlans/fixture_vlans.text
 - spec/unit/rbeapi/api/vrrp/default_spec.rb
 - spec/unit/rbeapi/api/vrrp/fixture_vrrp.text
+- spec/unit/rbeapi/client_spec.rb
 has_rdoc: