rbeapi 0.4.0 → 0.5.0

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

@@ -0,0 +1,354 @@
+#
+# 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/bgp'
+
+describe Rbeapi::Api::BgpNeighbors do
+  subject { described_class.new(node) }
+
+  let(:node) do
+    Rbeapi::Client.config.read(fixture_file('dut.conf'))
+    Rbeapi::Client.connect_to('dut')
+  end
+
+  describe '#get' do
+    let(:entity) do
+      { peer_group: nil,
+        remote_as: nil,
+        send_community: false,
+        shutdown: false,
+        description: nil,
+        next_hop_self: false,
+        route_map_in: nil,
+        route_map_out: nil }
+    end
+
+    before do
+      node.config(['no router bgp 64600', 'router bgp 64600',
+                   'neighbor eBGP_GROUP peer-group'])
+    end
+
+    it 'returns the BGP neighbor resource' do
+      expect(subject.get('eBGP_GROUP')).to eq(entity)
+    end
+  end
+
+  describe '#getall' do
+    let(:entity) do
+      {
+        'eBGP_GROUP' => {
+          peer_group: nil, remote_as: nil, send_community: false,
+          shutdown: false, description: nil, next_hop_self: false,
+          route_map_in: nil, route_map_out: nil
+        },
+        '192.168.255.1' => {
+          peer_group: 'eBGP_GROUP', remote_as: '65000', send_community: true,
+          shutdown: true, description: nil, next_hop_self: true,
+          route_map_in: nil, route_map_out: nil
+        },
+        '192.168.255.3' => {
+          peer_group: 'eBGP_GROUP', remote_as: '65001', send_community: true,
+          shutdown: true, description: nil, next_hop_self: true,
+          route_map_in: nil, route_map_out: nil
+        }
+      }
+    end
+
+    before do
+      node.config(['no router bgp 64600', 'router bgp 64600',
+                   'neighbor 192.168.255.1 peer-group eBGP_GROUP',
+                   'neighbor 192.168.255.1 remote-as 65000',
+                   'neighbor 192.168.255.3 peer-group eBGP_GROUP',
+                   'neighbor 192.168.255.3 remote-as 65001'])
+    end
+
+    it 'returns all the neighbors' do
+      expect(subject.getall).to eq(entity)
+    end
+
+    it 'returns a hash collection' do
+      expect(subject.getall).to be_a_kind_of(Hash)
+    end
+
+    it 'has three entries' do
+      expect(subject.getall.size).to eq(3)
+    end
+  end
+
+  describe '#create' do
+    let(:before) do
+      { peer_group: nil,
+        remote_as: nil,
+        send_community: true,
+        shutdown: true,
+        description: nil,
+        next_hop_self: true,
+        route_map_in: nil,
+        route_map_out: nil }
+    end
+
+    let(:after) do
+      { peer_group: nil,
+        remote_as: nil,
+        send_community: false,
+        shutdown: true,
+        description: nil,
+        next_hop_self: false,
+        route_map_in: nil,
+        route_map_out: nil }
+    end
+
+    before { node.config(['no router bgp 64600', 'router bgp 64600']) }
+
+    it 'create a new BGP neighbor' do
+      expect(subject.get('edge')).to eq(before)
+      expect(subject.create('edge')).to be_truthy
+
+      expect(subject.get('edge')).to eq(after)
+    end
+  end
+
+  describe '#delete' do
+    let(:before) do
+      { peer_group: nil,
+        remote_as: nil,
+        send_community: false,
+        shutdown: true,
+        description: nil,
+        next_hop_self: false,
+        route_map_in: nil,
+        route_map_out: nil }
+    end
+
+    let(:after) do
+      { peer_group: nil,
+        remote_as: nil,
+        send_community: true,
+        shutdown: true,
+        description: nil,
+        next_hop_self: true,
+        route_map_in: nil,
+        route_map_out: nil }
+    end
+
+    it 'delete a BGP resource' do
+      expect(subject.get('edge')).to eq(before)
+      expect(subject.delete('edge')).to be_truthy
+
+      expect(subject.get('edge')).to eq(after)
+    end
+  end
+
+  describe '#set_peer_group' do
+    before do
+      node.config(['no router bgp 64600', 'router bgp 64600',
+                   'neighbor eBGP_GROUP peer-group'])
+    end
+
+    it 'set the peer group' do
+      expect(subject.get('192.168.255.1')[:peer_group]).to eq(nil)
+      expect(subject.set_peer_group('192.168.255.1', value: 'eBGP_GROUP'))
+        .to be_truthy
+      expect(subject.get('192.168.255.1')[:peer_group]).to eq('eBGP_GROUP')
+    end
+
+    it 'remove the peer group value' do
+      expect(subject.set_peer_group('192.168.255.1', value: 'eBGP_GROUP'))
+        .to be_truthy
+      expect(subject.get('192.168.255.1')[:peer_group]).to eq('eBGP_GROUP')
+      expect(subject.set_peer_group('192.168.255.1', enable: false))
+        .to be_truthy
+      expect(subject.get('192.168.255.1')[:peer_group]).to eq(nil)
+    end
+
+    it 'defaults the peer group value' do
+      expect(subject.set_peer_group('192.168.255.1', value: 'eBGP_GROUP'))
+        .to be_truthy
+      expect(subject.set_peer_group('192.168.255.1', default: true))
+        .to be_truthy
+      expect(subject.get('192.168.255.1')[:peer_group]).to eq(nil)
+    end
+  end
+
+  describe '#set_remote_as' do
+    it 'set the remote AS value' do
+      expect(subject.get('eng')[:remote_as]).to eq(nil)
+      expect(subject.set_remote_as('eng', value: '10')).to be_truthy
+      expect(subject.get('eng')[:remote_as]).to eq('10')
+    end
+
+    it 'remove the remote AS value' do
+      expect(subject.get('eng')[:remote_as]).to eq('10')
+      expect(subject.set_remote_as('eng', enable: false))
+        .to be_truthy
+      expect(subject.get('eng')[:remote_as]).to eq(nil)
+    end
+
+    it 'defaults the remote AS value' do
+      expect(subject.set_remote_as('eng', value: '10')).to be_truthy
+      expect(subject.set_remote_as('eng', default: true))
+        .to be_truthy
+      expect(subject.get('eng')[:remote_as]).to eq(nil)
+    end
+  end
+
+  describe '#set_shutdown' do
+    it 'shutdown neighbor' do
+      expect(subject.get('eng')[:shutdown]).to eq(false)
+      expect(subject.set_shutdown('eng')).to be_truthy
+      expect(subject.get('eng')[:shutdown]).to eq(true)
+    end
+
+    it 'negate shutdown neighbor' do
+      expect(subject.get('eng')[:shutdown]).to eq(true)
+      expect(subject.set_shutdown('eng', enable: false)).to be_truthy
+      expect(subject.get('eng')[:shutdown]).to eq(true)
+    end
+
+    it 'default shutdown neighbor' do
+      expect(subject.get('eng')[:shutdown]).to eq(true)
+      expect(subject.set_shutdown('eng', default: true)).to be_truthy
+      expect(subject.get('eng')[:shutdown]).to eq(false)
+    end
+  end
+
+  describe '#set_send_community' do
+    it 'enable neighbor send community' do
+      expect(subject.get('eng')[:send_community]).to eq(false)
+      expect(subject.set_send_community('eng')).to be_truthy
+      expect(subject.get('eng')[:send_community]).to eq(true)
+    end
+
+    it 'negate neighbor send community' do
+      expect(subject.get('eng')[:send_community]).to eq(true)
+      expect(subject.set_send_community('eng', enable: false)).to be_truthy
+      expect(subject.get('eng')[:send_community]).to eq(false)
+    end
+
+    it 'default neighbor send community' do
+      expect(subject.set_send_community('eng')).to be_truthy
+      expect(subject.get('eng')[:send_community]).to eq(true)
+      expect(subject.set_send_community('eng', default: true)).to be_truthy
+      expect(subject.get('eng')[:send_community]).to eq(false)
+    end
+  end
+
+  describe '#set_next_hop_self' do
+    it 'enable neighbor next hop self' do
+      expect(subject.get('eng')[:next_hop_self]).to eq(false)
+      expect(subject.set_next_hop_self('eng')).to be_truthy
+      expect(subject.get('eng')[:next_hop_self]).to eq(true)
+    end
+
+    it 'negate neighbor next hop self' do
+      expect(subject.get('eng')[:next_hop_self]).to eq(true)
+      expect(subject.set_next_hop_self('eng', enable: false)).to be_truthy
+      expect(subject.get('eng')[:next_hop_self]).to eq(false)
+    end
+
+    it 'default neighbor next hop self' do
+      expect(subject.set_next_hop_self('eng')).to be_truthy
+      expect(subject.get('eng')[:next_hop_self]).to eq(true)
+      expect(subject.set_next_hop_self('eng', default: true)).to be_truthy
+      expect(subject.get('eng')[:next_hop_self]).to eq(false)
+    end
+  end
+
+  describe '#set_route_map_in' do
+    it 'set route map in value' do
+      expect(subject.get('eng')[:route_map_in]).to eq(nil)
+      expect(subject.set_route_map_in('eng', value: 'edge')).to be_truthy
+      expect(subject.get('eng')[:route_map_in]).to eq('edge')
+    end
+
+    it 'negate route map in value' do
+      expect(subject.get('eng')[:route_map_in]).to eq('edge')
+      expect(subject.set_route_map_in('eng', value: 'edge', enable: false))
+        .to be_truthy
+      expect(subject.get('eng')[:route_map_in]).to eq(nil)
+    end
+
+    it 'default route map in value' do
+      expect(subject.set_route_map_in('eng', value: 'edge')).to be_truthy
+      expect(subject.get('eng')[:route_map_in]).to eq('edge')
+      expect(subject.set_route_map_in('eng', value: 'edge', default: true))
+        .to be_truthy
+      expect(subject.get('eng')[:route_map_in]).to eq(nil)
+    end
+  end
+
+  describe '#set_route_map_out' do
+    it 'set route map out value' do
+      expect(subject.get('eng')[:route_map_out]).to eq(nil)
+      expect(subject.set_route_map_out('eng', value: 'edge')).to be_truthy
+      expect(subject.get('eng')[:route_map_out]).to eq('edge')
+    end
+
+    it 'negate route map out value' do
+      expect(subject.get('eng')[:route_map_out]).to eq('edge')
+      expect(subject.set_route_map_out('eng', value: 'edge', enable: false))
+        .to be_truthy
+      expect(subject.get('eng')[:route_map_out]).to eq(nil)
+    end
+
+    it 'default route map out value' do
+      expect(subject.set_route_map_out('eng', value: 'edge')).to be_truthy
+      expect(subject.get('eng')[:route_map_out]).to eq('edge')
+      expect(subject.set_route_map_out('eng', value: 'edge', default: true))
+        .to be_truthy
+      expect(subject.get('eng')[:route_map_out]).to eq(nil)
+    end
+  end
+
+  describe '#set_description' do
+    it 'set the description value' do
+      expect(subject.get('eng')[:description]).to eq(nil)
+      expect(subject.set_description('eng', value: 'text')).to be_truthy
+      expect(subject.get('eng')[:description]).to eq('text')
+    end
+
+    it 'negate the description value' do
+      expect(subject.get('eng')[:description]).to eq('text')
+      expect(subject.set_description('eng', enable: false)).to be_truthy
+      expect(subject.get('eng')[:description]).to eq(nil)
+    end
+
+    it 'defaults the description value' do
+      expect(subject.set_description('eng', value: 'text')).to be_truthy
+      expect(subject.get('eng')[:description]).to eq('text')
+      expect(subject.set_description('eng', default: true)).to be_truthy
+      expect(subject.get('eng')[:description]).to eq(nil)
+    end
+  end
+end

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

@@ -0,0 +1,275 @@
+#
+# 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/bgp'
+
+describe Rbeapi::Api::Bgp 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
+    { bgp_as: '64600',
+      router_id: '192.168.254.1',
+      shutdown: false,
+      maximum_paths: 32,
+      maximum_ecmp_paths: 32,
+      networks: [
+        { prefix: '192.168.254.1', masklen: 32, route_map: nil },
+        { prefix: '192.168.254.2', masklen: 32, route_map: 'rmap' }
+      ],
+      neighbors: {
+        'eBGP_GROUP' => {
+          peer_group: nil, remote_as: nil, send_community: false,
+          shutdown: false, description: nil, next_hop_self: false,
+          route_map_in: nil, route_map_out: nil
+        },
+        '192.168.255.1' => {
+          peer_group: 'eBGP_GROUP', remote_as: '65000', send_community: true,
+          shutdown: true, description: nil, next_hop_self: true,
+          route_map_in: nil, route_map_out: nil
+        },
+        '192.168.255.3' => {
+          peer_group: 'eBGP_GROUP', remote_as: '65001', send_community: true,
+          shutdown: true, description: nil, next_hop_self: true,
+          route_map_in: nil, route_map_out: nil
+        }
+      }
+    }
+  end
+
+  let(:response) do
+    {
+      bgp_as: '1000',
+      router_id: nil,
+      shutdown: false,
+      maximum_paths: 1,
+      maximum_ecmp_paths: 128,
+      networks: [],
+      neighbors: {}
+    }
+  end
+
+  describe '#get' do
+    before do
+      node.config(['no router bgp 64600', 'router bgp 64600',
+                   'router-id 192.168.254.1', 'maximum-paths 32 ecmp 32',
+                   'neighbor 192.168.255.1 peer-group eBGP_GROUP',
+                   'neighbor 192.168.255.1 remote-as 65000',
+                   'neighbor 192.168.255.3 peer-group eBGP_GROUP',
+                   'neighbor 192.168.255.3 remote-as 65001',
+                   'network 192.168.254.1/32',
+                   'network 192.168.254.2/32 route-map rmap',
+                   'aggregate-address 192.168.255.0/28 summary-only'])
+    end
+
+    it 'returns the BGP resource' do
+      expect(subject.get).to eq(test)
+    end
+  end
+
+  describe '#create' do
+    before do
+      node.config(['no router bgp 64600'])
+    end
+
+    it 'create a new BGP resource' do
+      expect(subject.get).to eq(nil)
+      expect(subject.create('1000')).to be_truthy
+      expect(subject.get).to eq(response)
+    end
+
+    it 'create with enable' do
+      expect(subject.get).to eq(nil)
+      expect(subject.create('1000', enable: true)).to be_truthy
+      expect(subject.get).to eq(response)
+    end
+
+    it 'create with router_id' do
+      expect(subject.get).to eq(nil)
+      expect(subject.create('1000', router_id: '1.2.3.4')).to be_truthy
+      expect(subject.get[:router_id]).to eq('1.2.3.4')
+    end
+
+    it 'create with maximum paths' do
+      expect(subject.get).to eq(nil)
+      expect(subject.create('1000', maximum_paths: 3)).to be_truthy
+      expect(subject.get[:maximum_paths]).to eq(3)
+    end
+
+    it 'create with maximum paths and ecmp paths' do
+      expect(subject.get).to eq(nil)
+      expect(subject.create('1000', maximum_paths: 13,
+                                    maximum_ecmp_paths: 13)).to be_truthy
+      expect(subject.get[:maximum_paths]).to eq(13)
+      expect(subject.get[:maximum_ecmp_paths]).to eq(13)
+    end
+
+    it 'raises ArgumentError for create with ecmp paths only' do
+      expect { subject.create('1000', maximum_ecmp_paths: 13) }.to \
+        raise_error ArgumentError
+    end
+
+    it 'create with all options set' do
+      expect(subject.create('1000', enable: true, router_id: '1.2.3.4',
+                                    maximum_paths: 13,
+                                    maximum_ecmp_paths: 13)).to be_truthy
+      expect(subject.get[:router_id]).to eq('1.2.3.4')
+      expect(subject.get[:maximum_paths]).to eq(13)
+      expect(subject.get[:maximum_ecmp_paths]).to eq(13)
+    end
+  end
+
+  describe '#delete' do
+    before do
+      node.config(['no router bgp 1000', 'router bgp 1000'])
+    end
+
+    it 'delete a BGP resource' do
+      expect(subject.get).to eq(response)
+      expect(subject.delete).to be_truthy
+      expect(subject.get).to eq(nil)
+    end
+  end
+
+  describe '#default' do
+    before do
+      node.config(['no router bgp 1000', 'router bgp 1000',
+                   'maximum-paths 13 ecmp 15'])
+    end
+
+    let(:before) do
+      {
+        bgp_as: '1000',
+        router_id: nil,
+        shutdown: false,
+        maximum_paths: 13,
+        maximum_ecmp_paths: 15,
+        networks: [],
+        neighbors: {}
+      }
+    end
+
+    it 'sets router to default value' do
+      expect(subject.get).to eq(before)
+      expect(subject.default).to be_truthy
+      expect(subject.get).to eq(nil)
+    end
+  end
+
+  describe '#set_router_id' do
+    before do
+      node.config(['no router bgp 1000', 'router bgp 1000'])
+    end
+
+    it 'set the router id' do
+      expect(subject.set_router_id(value: '1.2.3.4')).to be_truthy
+      expect(subject.get[:router_id]).to eq('1.2.3.4')
+    end
+
+    it 'remove the router-id without a value' do
+      expect(subject.set_router_id(enable: false)).to be_truthy
+      expect(subject.get[:router_id]).to eq(nil)
+    end
+
+    it 'remove the router-id with a value' do
+      expect(subject.set_router_id(value: '1.2.3.4', enable: false))
+        .to be_truthy
+      expect(subject.get[:router_id]).to eq(nil)
+    end
+
+    it 'defaults the router-id without a value' do
+      expect(subject.set_router_id(value: '1.2.3.4')).to be_truthy
+      expect(subject.set_router_id(default: true)).to be_truthy
+      expect(subject.get[:router_id]).to eq(nil)
+    end
+
+    it 'defaults the router-id with a value' do
+      expect(subject.set_router_id(value: '1.2.3.4', default: true))
+        .to be_truthy
+      expect(subject.get[:router_id]).to eq(nil)
+    end
+  end
+
+  describe '#set_shutdown' do
+    it 'enable BGP routing process' do
+      expect(subject.set_shutdown(enable: true)).to be_truthy
+    end
+
+    it 'disable BGP routing process' do
+      expect(subject.set_shutdown(enable: false)).to be_truthy
+    end
+
+    it 'default BGP routing process state' do
+      expect(subject.set_shutdown(default: true)).to be_truthy
+    end
+  end
+
+  describe '#set_maximum_paths' do
+    it 'set the maximum paths and ecmp paths' do
+      expect(subject.set_maximum_paths(13, 16)).to be_truthy
+    end
+
+    it 'remove the maximum paths' do
+      expect(subject.set_maximum_paths(0, 0, enable: false)).to be_truthy
+    end
+
+    it 'defaults the maximum paths' do
+      expect(subject.set_maximum_paths(0, 0, default: true)).to be_truthy
+    end
+  end
+
+  describe '#add_network' do
+    it 'add a BGP network with a route map' do
+      expect(subject.add_network('1.2.3.0', 24, 'eng')).to be_truthy
+    end
+
+    it 'add a BGP network without a route map' do
+      expect(subject.add_network('1.2.3.0', 24)).to be_truthy
+    end
+  end
+
+  describe '#remove_network' do
+    it 'remove a BGP network with a route map' do
+      expect(subject.remove_network('1.2.3.0', 24, 'eng')).to be_truthy
+    end
+
+    it 'remove a BGP network without a route map' do
+      expect(subject.remove_network('1.2.3.0', 24)).to be_truthy
+    end
+  end
+end