rbeapi 0.5.1 → 1.0

data/lib/rbeapi/api/prefixlists.rb

@@ -43,22 +43,29 @@ module Rbeapi
     #
     class Prefixlists < Entity
       ##
-      # Returns the static routes configured on the node.
+      # Returns the prefix list configured on the node.
       #
       # @example
-      #   {
-      #     <route>: {
-      #       next_hop: <string>,
-      #       name: <string, nil>
+      #   [
+      #     {
+      #       seq: <string>,
+      #       action: <string>,
+      #       prefix: <string>
+      #     },
+      #     ...,
+      #     {
+      #       seq: <string>,
+      #       action: <string>,
+      #       prefix: <string>
       #     }
-      #   }
+      #   ]
       #
       # @param name [String] The name of the prefix-list to return.
       #
-      # @return [Hash<String, String> The method will return all of the
-      #   configured static routes on the node as a Ruby hash object. If
-      #   there are no static routes configured, this method will return
-      #   an empty hash.
+      # @return [Array<Hash>] The method will return the configured
+      #   prefix list on the node with all its sequences as a Ruby
+      #   array of hashes, where each prefix is a hash object.
+      #   If the prefix list is not found, a nil object is returned.
       def get(name)
         config = get_block("ip prefix-list #{name}")
         return nil unless config
@@ -66,25 +73,48 @@ module Rbeapi
         entries = config.scan(/^\s{3}(?:seq\s)(\d+)\s(permit|deny)\s(.+)$/)
         entries.each_with_object([]) do |entry, arry|
           arry << { 'seq' => entry[0], 'action' => entry[1],
-                    'prefex' => entry[2] }
+                    'prefix' => entry[2] }
         end
       end
 
       ##
-      # Returns the static routes configured on the node.
+      # Returns all prefix lists configured on the node.
       #
       # @example
       #   {
-      #     <route>: {
-      #       next_hop: <string>,
-      #       name: <string, nil>
-      #     }
+      #     <name1>: [
+      #       {
+      #         seq: <string>,
+      #         action: <string>,
+      #         prefix: <string>
+      #       },
+      #       ...
+      #       {
+      #         seq: <string>,
+      #         action: <string>,
+      #         prefix: <string>
+      #       }
+      #     ],
+      #     ...,
+      #     <nameN>: [
+      #       {
+      #         seq: <string>,
+      #         action: <string>,
+      #         prefix: <string>
+      #       },
+      #       ...
+      #       {
+      #         seq: <string>,
+      #         action: <string>,
+      #         prefix: <string>
+      #       }
+      #     ]
       #   }
       #
-      # @return [Hash<String, String> The method will return all of the
-      #   configured static routes on the node as a Ruby hash object. If
-      #   there are no static routes configured, this method will return
-      #   an empty hash.
+      # @return [Hash<String, Array>] The method will return all the
+      #   prefix lists configured on the node as a Ruby hash object.
+      #   If there are no prefix lists configured, an empty hash will
+      #   be returned.
       def getall
         lists = config.scan(/(?<=^ip\sprefix-list\s).+/)
         lists.each_with_object({}) do |name, hsh|
@@ -100,7 +130,7 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def create(name)
-        configure "ip prefix-list #{name}"
+        configure("ip prefix-list #{name}")
       end
 
       ##
@@ -120,7 +150,7 @@ module Rbeapi
         cmd = "ip prefix-list #{name}"
         cmd << " seq #{seq}" if seq
         cmd << " #{action} #{prefix}"
-        configure cmd
+        configure(cmd)
       end
 
       ##
@@ -134,7 +164,7 @@ module Rbeapi
       def delete(name, seq = nil)
         cmd = "no ip prefix-list #{name}"
         cmd << " seq #{seq}" if seq
-        configure cmd
+        configure(cmd)
       end
     end
   end

data/lib/rbeapi/api/routemaps.rb

@@ -304,6 +304,9 @@ module Rbeapi
         if opts.empty?
           cmds = name_commands(name, action, seqno)
         else
+          if opts[:match] && !opts[:match].is_a?(Array)
+            fail ArgumentError, 'opts match must be an Array'
+          end
           cmds = name_commands(name, action, seqno, opts)
           if opts[:description]
             cmds << 'no description'
@@ -343,6 +346,8 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def remove_match_statements(name, action, seqno, cmds)
+        fail ArgumentError, 'cmds must be an Array' unless cmds.is_a?(Array)
+
         entries = parse_entries(name)
         return nil unless entries
         entries.each do |entry|
@@ -369,6 +374,8 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def remove_set_statements(name, action, seqno, cmds)
+        fail ArgumentError, 'cmds must be an Array' unless cmds.is_a?(Array)
+
         entries = parse_entries(name)
         return nil unless entries
         entries.each do |entry|
@@ -439,6 +446,8 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_match_statements(name, action, seqno, value)
+        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+
         cmds = ["route-map #{name} #{action} #{seqno}"]
         remove_match_statements(name, action, seqno, cmds)
         Array(value).each do |options|
@@ -464,6 +473,8 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_set_statements(name, action, seqno, value)
+        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+
         cmds = ["route-map #{name} #{action} #{seqno}"]
         remove_set_statements(name, action, seqno, cmds)
         Array(value).each do |options|

data/lib/rbeapi/api/stp.rb

@@ -196,15 +196,18 @@ module Rbeapi
 
       ##
       # parse_instances will scan the nodes current configuration and extract
-      # the list of configured mst instances. If no instances are configured
-      # then this method will return an empty array.
+      # the list of configured mst instances. Instances 0 and 1 are defined by
+      # default in the switch config and are always returned, even if not
+      # visible in the 'spanning-tree mst configuration' config section.
       #
       # @api private
       #
       # @return [Array<String>] Returns an Array of configured stp instances.
       def parse_instances
         config = get_block('spanning-tree mst configuration')
-        config.scan(/(?<=^\s{3}instance\s)\d+/)
+        response = config.scan(/(?<=^\s{3}instance\s)\d+/)
+        response.push('0', '1').uniq!
+        response
       end
       private :parse_instances
 

data/lib/rbeapi/api/switchports.rb

@@ -136,12 +136,7 @@ module Rbeapi
         return { trunk_allowed_vlans: [] } unless mdata[1] != 'none'
         vlans = mdata[1].split(',')
         values = vlans.each_with_object([]) do |vlan, arry|
-          if /-/ !~ vlan
-            arry << vlan.to_i
-          else
-            range_start, range_end = vlan.split('-')
-            arry.push(*Array(range_start.to_i..range_end.to_i))
-          end
+          arry << vlan.to_s
         end
         { trunk_allowed_vlans: values }
       end
@@ -264,9 +259,9 @@ module Rbeapi
       #
       # @param opts [Hash] The configuration parameters for the interface.
       #
-      # @option ots value [Array] The list of vlan ids to configure on the
+      # @option opts value [Array] The list of vlan ids to configure on the
       #   switchport to be allowed. This value must be an array of valid vlan
-      #   ids.
+      #   ids or vlan ranges.
       #
       # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
@@ -283,7 +278,7 @@ module Rbeapi
 
         if value
           fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
-          value = value.map(&:inspect).join(',')
+          value = value.map(&:inspect).join(',').tr('"', '')
         end
 
         case default
@@ -293,8 +288,7 @@ module Rbeapi
           if !enable
             cmds = 'no switchport trunk allowed vlan'
           else
-            cmds = ['switchport trunk allowed vlan none',
-                    "switchport trunk allowed vlan #{value}"]
+            cmds = ["switchport trunk allowed vlan #{value}"]
           end
         end
         configure_interface(name, cmds)

data/lib/rbeapi/api/system.rb

@@ -92,7 +92,7 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] The resource hash attribute.
       def parse_iprouting(config)
-        mdata = /no\sip\srouting/.match(config)
+        mdata = /no\sip\srouting$/.match(config)
         { iprouting: mdata.nil? ? true : false }
       end
       private :parse_iprouting

data/lib/rbeapi/api/users.rb

@@ -149,6 +149,8 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_user_entry(user)
+        fail ArgumentError, 'user must be an Array' unless user.is_a?(Array)
+
         hsh = {}
         hsh[:name] = user[0]
         hsh[:privilege] = user[1].to_i

data/lib/rbeapi/api/varp.rb

@@ -199,12 +199,17 @@ module Rbeapi
       # @option opts default [Boolean] The value should be set to default.
       #
       # @return [Boolean] True if the commands succeeds otherwise False.
+      # rubocop:disable Metrics/MethodLength
       def set_addresses(name, opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
         default = opts[:default] || false
         cmds = ["interface #{name}"]
 
+        if value
+          fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+        end
+
         case default
         when true
           cmds << 'default ip virtual-router address'
@@ -220,6 +225,7 @@ module Rbeapi
         end
         configure(cmds)
       end
+      # rubocop:enable Metrics/MethodLength
 
       ##
       # The add_address method assigns one virtual IPv4 address.

data/lib/rbeapi/api/vlans.rb

@@ -333,6 +333,50 @@ module Rbeapi
       def remove_trunk_group(id, value)
         configure(["vlan #{id}", "no trunk group #{value}"])
       end
+
+      ##
+      # Configures the trunk groups for the specified vlan.
+      # Trunk groups not currently set are added and trunk groups
+      # currently configured but not in the passed in value array are removed.
+      #
+      # @param name [String] The name of the vlan to configure.
+      #
+      # @param opts [Hash] The configuration parameters for the vlan.
+      #
+      # @option opts value [string] Set of values to configure the trunk group.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] The value should be set to default
+      #   Default takes precedence over enable.
+      #
+      # @return [Boolean] Returns True if the commands succeed otherwise False.
+      def set_trunk_groups(name, opts = {})
+        default = opts.fetch(:default, false)
+        return configure(["vlan #{name}", 'default trunk group']) if default
+
+        enable = opts.fetch(:enable, true)
+        return configure(["vlan #{name}", 'no trunk group']) unless enable
+
+        value = opts.fetch(:value, [])
+        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+
+        value = Set.new value
+        current_value = Set.new get(name)[:trunk_groups]
+
+        cmds = ["vlan #{name}"]
+        # Add trunk groups that are not currently in the list.
+        value.difference(current_value).each do |group|
+          cmds << "trunk group #{group}"
+        end
+
+        # Remove trunk groups that are not in the new list.
+        current_value.difference(value).each do |group|
+          cmds << "no trunk group #{group}"
+        end
+        configure(cmds) if cmds.length > 1
+      end
     end
   end
 end

data/lib/rbeapi/api/vrrp.rb

@@ -510,8 +510,19 @@ module Rbeapi
       #   of the tracked interface, and the amount to decrement the priority.
       #
       # @return [Boolean] Returns true if the command completed successfully.
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize,
+      # rubocop:disable Metrics/PerceivedComplexity
       def create(name, vrid, opts = {})
         fail ArgumentError, 'create has no options set' if opts.empty?
+
+        if opts[:secondary_ip] && !opts[:secondary_ip].is_a?(Array)
+          fail ArgumentError, 'opts secondary_ip must be an Array'
+        end
+
+        if opts[:track] && !opts[:track].is_a?(Array)
+          fail ArgumentError, 'opts track must be an Array'
+        end
+
         cmds = []
         if opts.key?(:enable)
           if opts[:enable]
@@ -561,6 +572,8 @@ module Rbeapi
         cmds += build_tracks_cmd(name, vrid, opts[:track]) if opts.key?(:track)
         configure_interface(name, cmds)
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize,
+      # rubocop:enable Metrics/PerceivedComplexity
 
       ##
       # delete will delete the virtual router ID on the interface from the

data/lib/rbeapi/client.rb

@@ -506,14 +506,29 @@ module Rbeapi
       #     interfaces  Filter config to include only the given interfaces
       #     section     Display sections containing matching commands
       #
-      # @return [String] The specified configuration as text.
+      # @return [String] The specified configuration as text or nil if no
+      #                  config is found.  When encoding is set to json, returns
+      #                  a hash.
       def get_config(opts = {})
         config = opts.fetch(:config, 'running-config')
         params = opts.fetch(:params, '')
+        encoding = opts.fetch(:encoding, 'text')
         as_string = opts.fetch(:as_string, false)
-        result = run_commands("show #{config} #{params}", encoding: 'text')
-        return result.first['output'].strip.split("\n") unless as_string
-        result.first['output'].strip
+        begin
+          result = run_commands("show #{config} #{params}", encoding: encoding)
+        rescue Rbeapi::Eapilib::CommandError => error
+          if ( error.to_s =~ /'show (running|startup)-config'/ )
+            return nil
+          else
+            raise error
+          end
+        end
+        if encoding == 'json'
+          return result.first
+        else
+          return result.first['output'].strip.split("\n") unless as_string
+          result.first['output'].strip
+        end
       end
 
       ##

data/lib/rbeapi/switchconfig.rb

@@ -0,0 +1,330 @@
+#
+# Copyright (c) 2016, 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
+  ##
+  # Rbeapi::SwitchConfig
+  module SwitchConfig
+    ##
+    # Section class
+    #
+    # A switch configuration section consists of the command line that
+    # enters into the configuration mode, an array of command strings
+    # that are executed in the current configuration mode, a reference
+    # to the parent section, and an array of refereces to all sub-sections
+    # contained within this section. A sub-section is a nested configuration
+    # mode.
+    #
+    # Read Accessors for following class instance variables:
+    #   line: <string>,
+    #   parent: <Section>,
+    #   cmds: array<strings>,
+    #   children: array<Section>
+    #
+    class Section
+      attr_reader :line
+      attr_reader :parent
+      attr_reader :cmds
+      attr_reader :children
+
+      ##
+      # The Section class contains a parsed section of switch config.
+      #
+      # @param config [String] A string containing the switch configuration.
+      #
+      # @return [Section] Returns an instance of Section
+
+      def initialize(line, parent)
+        @line = line
+        @parent = parent
+        @cmds = []
+        @children = []
+      end
+
+      ##
+      # Add a child to the end of the children array.
+      #
+      # @param child [Section] A Section class instance.
+      def add_child(child)
+        @children.push(child)
+      end
+
+      ##
+      # Add a cmd to the end of the cmds array if it is not already in
+      # the cmd array.
+      #
+      # @param cmd [String] A command string that is added to the cmds array.
+      def add_cmd(cmd)
+        @cmds.push(cmd) unless @cmds.include?(cmd)
+      end
+
+      ##
+      # Return the child that has the specified line (command mode).
+      #
+      # @param line [String] The mode command for this section.
+      def get_child(line)
+        @children.each do |child|
+          return child if child.line == line
+        end
+        nil
+      end
+
+      ##
+      # Private campare method to compare the commands between two Section
+      # classes.
+      #
+      # @param cmds2 [Array<String>] An array of commands.
+      #
+      # @return [Array<String>] The array of commands in @cmds that are not
+      #   in cmds2. The array is empty if @cmds equals cmds2.
+      def _compare_cmds(cmds2)
+        c1 = Set.new(@cmds)
+        c2 = Set.new(cmds2)
+        # Compare the commands and return the difference as an array of strings
+        c1.difference(c2).to_a
+      end
+      private :_compare_cmds
+
+      ##
+      # Campare method to compare two Section classes.
+      # The comparison will recurse through all the children in the Sections.
+      # The parent is ignored at the top level section. Only call this
+      # method if self and section2 have the same line.
+      #
+      # @param section2 [Section] An instance of a Section class to compare.
+      #
+      # @return [Section] The Section object contains the portion of self
+      #   that is not in section2.
+      def compare_r(section2)
+        fail '@line must equal section2.line' if @line != section2.line
+
+        # XXX Need to have a list of exceptions of mode commands that
+        # support default. If all the commands have been removed from
+        # that section in the new config then the old config just wants
+        # to default the mode command.
+        # ex: spanning-tree mst configuration
+        #       instance 1 vlan  1
+        # Currently generates this error:
+        # '   default instance 1 vlan  1' failed: invalid command
+
+        results = Section.new(@line, nil)
+
+        # Compare the commands
+        diff_cmds = _compare_cmds(section2.cmds)
+        diff_cmds.each do |cmd|
+          results.add_cmd(cmd)
+        end
+
+        # Using a depth first search to recursively descend through the
+        # children doing a comparison.
+        @children.each do |s1_child|
+          s2_child = section2.get_child(s1_child.line)
+          if s2_child
+            # Sections Match based on the line. Compare the children
+            # and if there are differences add them to the results.
+            res = s1_child.compare_r(s2_child)
+            if !res.children.empty? || !res.cmds.empty?
+              results.add_child(res)
+              results.add_cmd(s1_child.line)
+            end
+          else
+            # Section 1 has child, but section 2 does not, add to results
+            results.add_child(s1_child.clone)
+            results.add_cmd(s1_child.line)
+          end
+        end
+
+        results
+      end
+
+      ##
+      # Campare a Section class to the current section.
+      # The comparison will recurse through all the children in the Sections.
+      # The parent is ignored at the top level section.
+      #
+      # @param section2 [Section] An instance of a Section class to compare.
+      #
+      # @return [Array<Section>] Returns an array of 2 Section objects. The
+      #   first Section object contains the portion of self that is not
+      #   in section2. The second Section object returned is the portion of
+      #   section2 that is not in self.
+      def compare(section2)
+        if @line != section2.line
+          fail 'XXX What if @line does not equal section2.line'
+        end
+
+        results = []
+        # Compare self with section2
+        results[0] = compare_r(section2)
+        # Compare section2 with self
+        results[1] = section2.compare_r(self)
+        results
+      end
+    end
+
+    ##
+    # SwitchConfig class
+    class SwitchConfig
+      attr_accessor :name
+      attr_reader :global
+
+      ##
+      # The SwitchConfig class will parse a string containing a switch
+      # configuration and return an instance of a SwitchConfig. The
+      # SwitchConfig contains the global section which contains
+      # references to all sub-sections (children).
+      #
+      # {
+      #   global: <Section>,
+      # }
+      #
+      # @param config [String] A string containing the switch configuration.
+      #
+      # @return [Section] Returns an instance of Section
+      def initialize(config)
+        @indent = 3
+        @multiline_cmds = ['^banner', '^\s*ssl key', '^\s*ssl certificate',
+                           '^\s*protocol https certificate']
+        chk_format(config)
+        parse(config)
+      end
+
+      ##
+      # Check format on a switch configuration string.
+      #
+      # Verify that the indentation is correct on the switch configuration.
+      #
+      # @param config [String] A string containing the switch configuration.
+      #
+      # @return [boolean] Returns true if format is good, otherwise raises
+      #  an argument error.
+      def chk_format(config)
+        skip = false
+        config.each_line do |line|
+          skip = true if @multiline_cmds.any? { |cmd| line =~ /#{cmd}/ }
+          if skip
+            if line =~ /^\s*EOF$/
+              skip = false
+            else
+              next
+            end
+          end
+          ind = line[/\A */].size
+          if ind % @indent != 0
+            fail ArgumentError, 'SwitchConfig indentation must be multiple of '\
+                                "#{@indent} improper indent #{ind}: #{line}"
+          end
+        end
+        true
+      end
+      private :chk_format
+
+      ##
+      # Parse a switch configuration into sections.
+      #
+      # Parse a switch configuration and return a Config class.
+      # A switch configuration consists of the global section that contains
+      # a reference to all switch configuration sub-sections (children).
+      # Lines starting with '!' (comments) are ignored
+      #
+      # @param config [String] A string containing the switch configuration.
+      # rubocop:disable Metrics/MethodLength
+      def parse(config)
+        # Setup global section
+        section = Section.new('', nil)
+        @global = section
+
+        prev_indent = 0
+        prev_line = ''
+        combine = false
+        longline = []
+
+        config.each_line do |line|
+          if @multiline_cmds.any? { |cmd| line =~ /#{cmd}/ }
+            longline = []
+            combine = true
+          end
+          if combine
+            longline << line
+            if line =~ /^\s*EOF$/
+              line = longline.join
+              combine = false
+            else
+              next
+            end
+          end
+
+          # Ignore comment lines and the end statement if there
+          # XXX Fix parsing end
+          next if line.start_with?('!') || line.start_with?('end')
+          line.chomp!
+          next if line.empty?
+          indent_level = line[/\A */].size / @indent
+          if indent_level > prev_indent
+            # New section
+            section = Section.new(prev_line, section)
+            section.parent.add_child(section)
+            prev_indent = indent_level
+          elsif indent_level < prev_indent
+            # XXX This has a bug if we pop more than one section
+            # XXX Bug if we have 2 subsections with intervening commands
+            # End of current section
+            section = section.parent
+            prev_indent = indent_level
+          end
+          # Add the line to the current section
+          section.add_cmd(line)
+          prev_line = line
+        end
+      end
+      private :parse
+      # rubocop:enable Metrics/MethodLength
+
+      ##
+      # Campare the current SwitchConfig class with another SwitchConfig class.
+      #
+      # @param switch_config [SwitchConfig] An instance of a SwitchConfig
+      #   class to compare with the current instance.
+      #
+      # @return [Array<Sections>] Returns an array of 2 Section objects. The
+      #   first Section object contains the portion of the current
+      #   SwitchConfig instance that is not in the passed in switch_config. The
+      #   second Section object is the portion of the passed in switch_config
+      #   that is not in the current SwitchConfig instance.
+      def compare(switch_config)
+        @global.compare(switch_config.global)
+      end
+    end
+  end
+end