rbeapi 0.1.0

data/lib/rbeapi/utils.rb

@@ -0,0 +1,70 @@
+#
+# Copyright (c) 2014, 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.
+#
+
+##
+# Rbeapi toplevel namespace
+module Rbeapi
+  ##
+  # 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
+    #
+    # @return [Hash] An updated hash structure with all keys converted to
+    #   symboles
+    def self.transform_keys_to_symbols(value)
+      return value if not value.kind_of?(Hash)
+      hash = value.inject({}) do |hsh, (k,v)|
+        hsh[k.to_sym] = self.transform_keys_to_symbols(v)
+        hsh
+      end
+      hash
+    end
+
+    ##
+    # Returns a class object from a string capable of being instatiated
+    #
+    # @param [String] :name The name of the class to return a constant for
+    #
+    # @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)
+      end
+    end
+  end
+end
+

data/lib/rbeapi/version.rb

@@ -0,0 +1,37 @@
+#
+# Copyright (c) 2014, 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.
+#
+
+# #
+# Rbeapi toplevel namespace
+module Rbeapi
+  VERSION = '0.1.0'
+end

data/rbeapi.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rbeapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rbeapi'
+  spec.version       = Rbeapi::VERSION
+  spec.authors       = ['Peter Sprygada']
+  spec.email         = ['sprygada@arista.com']
+  spec.description   = 'Arista eAPI Ruby Library'
+  spec.summary       = 'This Gem library provides a Ruby interface '\
+                       'to the Arista EOS command API'
+  spec.homepage      = 'https://github.com/arista-eosplus/rbeapi'
+  spec.license       = 'New BSD'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net_http_unix'
+  spec.add_dependency 'inifile'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rake', '~> 10.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.0.0'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/fixtures/dut.conf

@@ -0,0 +1,5 @@
+[connection:dut]
+host: 192.168.1.16
+username: eapi
+password: password
+transport: http

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/.bundle/'
+end
+
+require 'pry'
+require 'rbeapi'
+
+dir = File.expand_path(File.dirname(__FILE__))
+Dir["#{dir}/support/**/*.rb"].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.include FixtureHelpers
+
+  # rspec configuration
+  config.mock_with :rspec do |rspec_config|
+    rspec_config.syntax = :expect
+  end
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+require 'pathname'
+require 'yaml'
+require 'json'
+
+##
+# Fixtures implements a global container to store fixture data loaded from the
+# filesystem.
+class Fixtures
+  def self.[](name)
+    @fixtures[name]
+  end
+
+  def self.[]=(name, value)
+    @fixtures[name] = value
+  end
+
+  def self.clear
+    @fixtures = {}
+  end
+
+  clear
+
+  ##
+  # save an object and saves it as a fixture in the filesystem.
+  #
+  # @param [Symbol] key The fixture name without the `fixture_` prefix or
+  #   `.json` suffix.
+  #
+  # @param [Object] obj The object to serialize to JSON and write to the
+  #   fixture file.
+  #
+  # @option opts [String] :dir ('/path/to/fixtures') The fixtures directory,
+  #   defaults to the full path of spec/fixtures/ relative to the root of the
+  #   module.
+  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?
+    File.open(file, 'w+') { |f| f.puts YAML.dump(obj) }
+  end
+end
+
+##
+# FixtureHelpers provides instance methods for RSpec test cases that aid in the
+# loading and caching of fixture data.
+module FixtureHelpers
+  ##
+  # fixture loads a JSON fixture from the spec/fixtures/ directory, prefixed
+  # with fixture_.  Given the name 'foo' the file
+  # `spec/fixtures/fixture_foo.json` will be loaded and returned.  This method
+  # is memoized across the life of the process.
+  #
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength,
+  # rubocop:disable Metrics/PerceivedComplexity
+  #
+  # @param [Symbol] key The fixture name without the `fixture_` prefix or
+  #   `.json` suffix.
+  #
+  # @option opts [String] :dir ('/path/to/fixtures') The fixtures directory,
+  #   defaults to the full path of spec/fixtures/ relative to the root of the
+  #   module.
+  #
+  # @option opts [String] :format (:ruby) The format to return the fixture in,
+  #   defaults to native Ruby objects.  :json will return a JSON string.
+  def fixture(key, opts = { format: :ruby })
+    if opts[:format] == :ruby
+      memo = Fixtures[key]
+      return memo if memo
+    end
+    dir = opts[:dir] || fixture_dir
+
+    yaml = Pathname.new(File.join(dir, "fixture_#{key}.yaml"))
+    json = Pathname.new(File.join(dir, "fixture_#{key}.json"))
+
+    data = if yaml.exist?; then YAML.load(File.read(yaml))
+           elsif json.exist?; then JSON.load(File.read(json))
+           else fail "could not load YAML or JSON fixture #{key} "\
+             "tried:\n  #{yaml}\n  #{json}"
+           end
+
+    Fixtures[key] = data
+
+    case opts[:format]
+    when :ruby then data
+    when :json then JSON.pretty_generate(data)
+    when :yaml then YAML.dump(data)
+    else fail ArgumentError, "unknown format #{opts[:format].inspect}"
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+  # rubocop:enable Metrics/PerceivedComplexity
+
+  ##
+  # fixture_dir returns the full path to the fixture directory
+  #
+  # @api public
+  #
+  # @return [String] the full path to the fixture directory
+  def fixture_dir
+    File.expand_path('../../fixtures', __FILE__)
+  end
+
+  ##
+  # fixture_file returns the full path to a file in the fixture directory
+  #
+  # @api public
+  #
+  # @return [String] the full path to the fixture file
+  def fixture_file(name)
+    File.join(fixture_dir, name)
+  end
+end

data/spec/support/shared_examples_for_api_modules.rb

@@ -0,0 +1,124 @@
+RSpec.shared_examples 'a configurable entity' do |opts|
+
+  before(:each) do
+    allow(subject.node).to receive(:config)
+  end
+
+  applies_to = opts.fetch(:applies_to, [])
+  if applies_to.include?(opts[:args[0,2]]) or applies_to.empty?
+    context 'with node#config' do
+      [:create, :delete, :default].each do |action|
+        it "calls #{action} using #{opts[:args]}" do
+          expect(subject.node).to receive(:config).with(opts[action])
+          subject.send(action, *opts[:args])
+        end
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a tristate attr' do |opts|
+
+  before(:each) do
+    allow(subject.node).to receive(:config)
+  end
+
+  applies_to = opts.fetch(:applies_to, [])
+  if applies_to.include?(opts[:args[0,2]]) or applies_to.empty?
+    context 'with node#config' do
+      it "configures with #{opts[:name]}" do
+        expect(subject.node).to receive(:config).with(opts[:config])
+        subject.send(opts[:name], *opts[:args], value: opts[:value])
+      end
+
+      it "negates with #{opts[:name]}" do
+        expect(subject.node).to receive(:config).with(opts[:negate])
+        subject.send(opts[:name], *opts[:args])
+      end
+
+      it "defaults" do
+        expect(subject.node).to receive(:config).with(opts[:default])
+        subject.send(opts[:name], *opts[:args], default: true)
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a settable attr' do |opts|
+
+  before(:each) do
+    allow(subject.node).to receive(:config)
+  end
+
+  context 'with node#config' do
+    it "configures with #{opts[:name]}" do
+      expect(subject.node).to receive(:config).with(opts[:config])
+      subject.send(opts[:name], *opts[:args])
+    end
+  end
+end
+
+RSpec.shared_examples 'a creatable entity' do |args, setup, block|
+
+  before(:each) do
+    subject.node.config(setup)
+  end
+
+  context 'with node#config' do
+    it "calls #create with #{args}" do
+      expect(subject.get_block(block)).to be_nil
+      subject.create(*args)
+      expect(subject.get_block(block)).not_to be_nil
+    end
+  end
+end
+
+RSpec.shared_examples 'a deletable entity' do |args, setup, block|
+
+  before(:each) do
+    subject.node.config(setup)
+  end
+
+  context 'with node#config' do
+    it "calls #delete with #{args}" do
+      expect(subject.get_block(block)).not_to be_nil
+      subject.delete(*args)
+      expect(subject.get_block(block)).to be_nil
+    end
+  end
+end
+
+RSpec.shared_examples 'a configurable attr' do |opts|
+
+  before(:each) do
+    subject.node.config(opts[:setup])
+  end
+
+  context 'with node#config' do
+    it "calls #{opts[:name]} with #{opts[:args]}" do
+      expect(subject.get_block(opts[:block])).to match(opts[:before])
+      subject.send(opts[:name], *opts[:args])
+      expect(subject.get_block(opts[:block])).to match(opts[:after])
+    end
+  end
+end
+
+RSpec.shared_examples 'single entity' do |opts|
+
+  describe 'match entity attributes from node' do
+    let(:entity) { subject.get(opts[:args]) }
+    opts[:entity].each do |key, value|
+      it "has #{key} with #{value}" do
+        binding.pry
+        expect(entity[key]).to eq(value)
+      end
+    end
+  end
+end
+
+
+
+
+
+
+

data/spec/system/api_ospf_interfaces_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+require 'rbeapi/client'
+require 'rbeapi/api/ospf'
+
+describe Rbeapi::Api::OspfInterfaces do
+  subject { described_class.new(node) }
+
+  let(:config) { Rbeapi::Client::Config.new(filename: get_fixture('dut.conf')) }
+  let(:node) { Rbeapi::Client.connect_to('veos02') }
+
+  describe '#get' do
+
+    before { node.config(['default interface Ethernet1', 'interface Ethernet1',
+                          'no switchport', 'ip address 99.99.99.99/24',
+                          'default interface Ethernet2']) }
+
+    it 'returns an ospf interface resource instance' do
+      expect(subject.get('Ethernet1')).not_to be_nil
+    end
+
+    it 'returns nil for a switchport interface' do
+      expect(subject.get('Ethernet2')).to be_nil
+    end
+  end
+
+  describe '#getall' do
+
+    before { node.config(['default interface Ethernet1', 'interface Ethernet1',
+                          'no switchport', 'ip address 99.99.99.99/24',
+                          'default interface Ethernet2']) }
+
+    it 'returns the ospf resource collection' do
+      expect(subject.getall).to be_a_kind_of(Hash)
+    end
+
+    it 'includes an instance of Ethernet1' do
+      expect(subject.getall).to include('Ethernet1')
+    end
+
+    it 'does not include an instance of Ethernet2' do
+      expect(subject.getall).not_to include('Ethernet2')
+    end
+
+  end
+
+  describe '#set_network_type' do
+
+    before { node.config(['default interface Ethernet1', 'interface Ethernet1',
+                          'no switchport', 'ip address 99.99.99.99/24']) }
+
+    it 'configures the ospf interface type to point-to-point' do
+      expect(subject.get('Ethernet1')['network_type']).to eq('broadcast')
+      expect(subject.set_network_type('Ethernet1', value: 'point-to-point')).to be_truthy
+      expect(subject.get('Ethernet1')['network_type']).to eq('point-to-point')
+    end
+  end
+end