rbeapi 1.1 → 1.2

data/lib/rbeapi/api/ntp.rb

@@ -41,13 +41,35 @@ module Rbeapi
     # The Ntp class provides an instance for working with the nodes
     # NTP configuration.
     class Ntp < Entity
+      DEFAULT_TRST_KEY = ''.freeze
       DEFAULT_SRC_INTF = ''.freeze
 
+      # Regular expression to extract a NTP server's attributes from the
+      # running-configuration text.  The explicit [ ] spaces enable line
+      # wrapping and indentation with the /x flag.
+
+      SERVER_REGEXP = /^(?:ntp[ ]server)
+                      (?:(?:[ ]vrf[ ])([^\s]+))?
+                      [ ]([^\s]+)
+                      ([ ]prefer)?
+                      (?:(?:[ ]minpoll[ ])(\d+))?
+                      (?:(?:[ ]maxpoll[ ])(\d+))?
+                      (?:(?:[ ]source[ ])([^\s]+))?
+                      (?:(?:[ ]key[ ])(\d+))?/x
+      ##
+
+      # Regular expression to extract NTP authentication-keys from the
+      # running-configuration text.  The explicit [ ] spaces enable line
+      # wrapping and indentation with the /x flag.
+
+      AUTH_KEY_REGEXP = /^(?:ntp[ ]authentication-key[ ])
+                        (\d+)[ ](\w+)[ ](\d+)[ ](\w+)/x
       ##
       # get returns the nodes current ntp configure as a resource hash.
       #
       # @example
       #   {
+      #     authenticate: [true, false],
       #     source_interface: <string>,
       #     servers: {
       #       prefer: [true, false]
@@ -58,11 +80,52 @@ module Rbeapi
       #   Hash.
       def get
         response = {}
+        response.merge!(parse_authenticate)
         response.merge!(parse_source_interface)
         response.merge!(parse_servers)
+        response.merge!(parse_trusted_key)
+        response.merge!(parse_auth_keys)
         response
       end
 
+      ##
+      # parse_authenticate checks to see if NTP authencation is enabled in conf
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_authenticate
+        mdata = /^(?:ntp authenticate)/.match(config)
+        { authenticate: mdata.nil? ? false : true }
+      end
+      private :parse_authenticate
+
+      ##
+      # parse_auth_keys scans the nodes configuration and parses the configured
+      # authencation keys. This method will also return
+      # the value of prefer. If no keys are configured, the value will be
+      # set to an empty array. The return hash is intended to be merged into
+      # the resource hash.
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_auth_keys
+        tuples = config.scan(AUTH_KEY_REGEXP)
+        hsh = {}
+        tuples.map do |(key, algorithm, mode, password)|
+          hsh[key] = {
+            algorithm: algorithm,
+            mode: mode,
+            password: password
+          }
+          hsh[key]
+        end
+
+        { auth_keys: hsh }
+      end
+      private :parse_auth_keys
+
       ##
       # parse_source_interface scans the nodes configurations and parses
       # the ntp source interface if configured. If the source interface
@@ -89,14 +152,123 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_servers
-        servers = config.scan(/(?:ntp server\s)([^\s]+)\s(prefer)?/)
-        values = servers.each_with_object({}) do |(srv, prefer), hsh|
-          hsh[srv] = { prefer: !prefer.nil? }
+        tuples = config.scan(SERVER_REGEXP)
+        hsh = {}
+        tuples.map do |(vrf, host, prefer, minpoll, maxpoll, sourcei, key)|
+          hsh[host] = {
+            vrf: vrf,
+            prefer: !prefer.nil?,
+            minpoll: minpoll.nil? ? nil : minpoll.to_i,
+            maxpoll: maxpoll.nil? ? nil : maxpoll.to_i,
+            source_interface: sourcei,
+            key: key.nil? ? nil : key.to_i
+          }
+          hsh[host]
         end
-        { servers: values }
+
+        { servers: hsh }
       end
       private :parse_servers
 
+      ##
+      # parse_trusted_key looks for global NTP trusted-key list
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_trusted_key
+        mdata = /^(?:ntp trusted-key (.+))/.match(config)
+        { trusted_key: mdata.nil? ? DEFAULT_TRST_KEY : mdata[1] }
+      end
+      private :parse_trusted_key
+
+      ##
+      # set_authenticate configures ntp authentication in the nodes
+      # running configuration. If the enable keyword is false, then
+      # ntp authentication is configured with the no keyword argument. If the
+      # default keyword argument is provided and set to true, the value is
+      # configured used the default keyword. The default keyword takes
+      # precedence over the enable keyword if both options are specified.
+      #
+      # @since eos_version 4.13.7M
+      #
+      # ===Commands
+      #   ntp authenticate
+      #   no ntp authenticate
+      #   default ntp authenticate
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the ntp source value using
+      #   the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_authenticate(opts = {})
+        cmd = command_builder('ntp authenticate', opts)
+        configure(cmd)
+      end
+
+      ##
+      # set_authentication_key configures the ntp authentication-keys in the
+      # device running configuration. If the enable keyword is false, then
+      # the ntp source is configured with the no keyword argument. If the
+      # default keyword argument is provided and set to true, the value is
+      # configured used the default keyword. The default keyword takes
+      # precedence over the enable keyword if both options are specified.
+      #
+      # @since eos_version 4.13.7M
+      #
+      # ===Commands
+      #   ntp trusted-key <key> <algorithm> <mode> <password>
+      #   no ntp trusted-key <key>
+      #   default ntp trusted-key <key>
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts algorithm [String] Encryption algorithm to use, md5/sha1
+      #
+      # @option opts default [Boolean] Configure the ntp source value using
+      #   the default keyword.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts key [Integer] The authentication-key to configure
+      #
+      # @option opts mode [Integer] Password mode: 0 plain-text, 7 encrypted
+      # default value is 7
+      #
+      # @option opts password [String] Password to use for authentication-key
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_authentication_key(opts = {})
+        cmd = command_builder('ntp authentication-key', opts)
+        configure(cmd)
+
+        algorithm = opts[:algorithm]
+        default = opts[:default] || false
+        enable = opts.fetch(:enable, true)
+        key = opts[:key]
+        mode = opts.fetch(:mode, 7)
+        password = opts[:password]
+
+        case default
+        when true
+          cmds = "default ntp authentication-key #{key}"
+        when false
+          cmds = if enable
+                   "ntp authentication-key #{key} #{algorithm} #{mode} "\
+                   "#{password}"
+                 else
+                   "no ntp authentication-key #{key}"
+                 end
+        end
+        configure cmds
+      end
+
       ##
       # set_source_interface configures the ntp source value in the nodes
       # running configuration. If the enable keyword is false, then
@@ -129,6 +301,37 @@ module Rbeapi
         configure(cmd)
       end
 
+      ##
+      # set_trusted_key configures the ntp trusted-keys in the device
+      # running configuration. If the enable keyword is false, then
+      # the ntp authentication-key is configured with the no keyword argument.
+      # If the default keyword argument is provided and set to true, the value
+      # is configured using the default keyword. The default keyword takes
+      # precedence over the enable keyword if both options are specified.
+      #
+      # @since eos_version 4.13.7M
+      #
+      # ===Commands
+      #   ntp authentication-key <key> <algorithm> <mode> <password>
+      #   no ntp authentication-key <key>
+      #   default ntp trusted-key <key>
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts value [Integer] authentication-key id
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the ntp source value using
+      #   the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_trusted_key(opts = {})
+        cmd = command_builder('ntp trusted-key', opts)
+        configure(cmd)
+      end
+
       ##
       # add_server configures a new ntp server destination hostname or ip
       # address to the list of ntp destinations. The optional prefer argument
@@ -138,14 +341,33 @@ module Rbeapi
       # @param server [String] The IP address or FQDN of the NTP server to
       #   be removed from the configuration.
       #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @param opts vrf [String] The VRF instance this server is bound to
+      #
+      # @param opts minpoll [Integer] The minimum poll interval
+      #
+      # @param opts maxpoll [Integer] The maximum poll interval
+      #
+      # @param opts source [String] The source interface used to reach server
+      #
+      # @param opts key [Integer] The authentication key used to communicate
+      #   with server
+      #
       # @param prefer [Boolean] Appends the prefer keyword argument to the
       #   command if this value is true.
       #
       # @return [Boolean] Returns true if the command completed successfully.
-      def add_server(server, prefer = false)
-        cmd = "ntp server #{server}"
-        cmd << ' prefer' if prefer
-        configure cmd
+      def add_server(server, prefer = false, opts = {})
+        cmd = 'ntp server '
+        cmd << "vrf #{opts[:vrf]} " if opts[:vrf]
+        cmd << server.to_s
+        cmd << ' prefer' if prefer || opts[:prefer].to_s == 'true'
+        cmd << " minpoll #{opts[:minpoll]} " if opts[:minpoll]
+        cmd << " maxpoll #{opts[:maxpoll]} " if opts[:maxpoll]
+        cmd << " source #{opts[:source_interface]} " if opts[:source_interface]
+        cmd << " key #{opts[:key]} " if opts[:key]
+        configure(cmd)
       end
 
       ##
@@ -156,9 +378,12 @@ module Rbeapi
       # @param server [String] The IP address or FQDN of the NTP server to
       #   be removed from the configuration.
       #
+      # @param vrf [String] The VRF of the NTP server to be removed from
+      #   the configuration.
+      #
       # @return [Boolean] Returns true if the command completed successfully.
-      def remove_server(server)
-        configure("no ntp server #{server}")
+      def remove_server(server, vrf = nil)
+        configure("no ntp server #{vrf.nil? ? '' : "vrf #{vrf} "}#{server}")
       end
 
       ##

data/lib/rbeapi/api/snmp.rb

@@ -137,7 +137,7 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] Returns the resource Hash attribute.
       def parse_source_interface
-        mdata = /snmp-server source-interface (.+)$/.match(config)
+        mdata = /snmp-server (?:vrf .+ )?source-interface (.+)$/.match(config)
         { source_interface: mdata.nil? ? '' : mdata[1] }
       end
       private :parse_source_interface

data/lib/rbeapi/api/system.rb

@@ -63,6 +63,7 @@ module Rbeapi
         response = {}
         response.merge!(parse_hostname(config))
         response.merge!(parse_iprouting(config))
+        response.merge!(parse_timezone(config))
         response.merge!(parse_banners(config))
         response
       end
@@ -97,6 +98,21 @@ module Rbeapi
       end
       private :parse_iprouting
 
+      ##
+      # parse_timezone parses the value of clock timezone.
+      #
+      # @api private
+      #
+      # @param config [String] The configuration block returned
+      #   from the node's running configuration.
+      #
+      # @return [Hash<Symbol, Object>] The resource hash attribute.
+      def parse_timezone(config)
+        mdata = /(?<=^clock timezone\s)(.+)$/.match(config)
+        { timezone: mdata.nil? ? '' : mdata[1] }
+      end
+      private :parse_timezone
+
       ##
       # Parses the global config and returns the value for both motd
       # and login banners.
@@ -158,6 +174,25 @@ module Rbeapi
         configure(cmd)
       end
 
+      ##
+      # Configures the value of clock timezone in the running-config.
+      #
+      # @param opts [Hash] The configuration parameters.
+      #
+      # @option opts value [string] The value to set the clock timezone to.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] If true configure the command using
+      #   the default keyword. Default is false.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_timezone(opts = {})
+        cmd = command_builder('clock timezone', opts)
+        configure(cmd)
+      end
+
       ##
       # Configures system banners.
       #

data/lib/rbeapi/version.rb

@@ -33,5 +33,5 @@
 # #
 # Rbeapi toplevel namespace.
 module Rbeapi
-  VERSION = '1.1'.freeze
+  VERSION = '1.2'.freeze
 end

data/spec/fixtures/dut.conf

@@ -1,5 +1,8 @@
+#[connection:puppet-dev-dut]
 [connection:dut]
-host: 192.168.1.16
-username: eapi
-password: password
+host: localhost
 transport: http
+port: 61080
+#port: 61443
+username: eapiuser
+password: icanttellyou

data/spec/support/fixtures.rb

@@ -74,7 +74,7 @@ module FixtureHelpers
     json = Pathname.new(File.join(dir, "fixture_#{key}.json"))
     text = Pathname.new(File.join(dir, "fixture_#{key}.text"))
 
-    data = if yaml.exist?; then YAML.load(File.read(yaml))
+    data = if yaml.exist?; then YAML.safe_load(File.read(yaml))
            elsif json.exist?; then JSON.parse(File.read(json))
            elsif text.exist?; then File.read(text)
            else raise "could not load YAML, JSON or TEXT fixture #{key} "\

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

@@ -0,0 +1,142 @@
+#
+# Copyright (c) 2017, 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/iphosts'
+
+describe Rbeapi::Api::Iphosts do
+  subject { described_class.new(node) }
+
+  let(:node) do
+    Rbeapi::Client.config.read(fixture_file('dut.conf'))
+    Rbeapi::Client.connect_to('dut')
+  end
+
+  let(:ipaddress) do
+    '192.168.0.1'
+  end
+
+  let(:test) do
+    {
+      name: 'test1',
+      ipaddress: ['192.168.0.1']
+    }
+  end
+
+  describe '#getall' do
+    let(:resource) { subject.getall }
+
+    let(:test1_entries) do
+      {
+        'test1' => { name: 'test1', ipaddress: ['192.168.0.1'] },
+        'test2' => { name: 'test2', ipaddress: ['10.0.0.1', '10.0.1.1'] },
+        'test3.domain' => { name: 'test3.domain', ipaddress: ['172.16.0.1'] }
+      }
+    end
+
+    before do
+      node.config(['no ip host test1',
+                   'no ip host test2',
+                   'no ip host test3.domain',
+                   'ip host test1 192.168.0.1',
+                   'ip host test2 10.0.0.1 10.0.1.1',
+                   'ip host test3.domain 172.16.0.1'])
+    end
+
+    it 'returns the ip host collection' do
+      expect(subject.getall).to include(test1_entries)
+    end
+
+    it 'returns a hash collection' do
+      expect(subject.getall).to be_a_kind_of(Hash)
+    end
+
+    it 'returns the ip host resource for given host' do
+      expect(subject.get('test1')).to eq(test)
+    end
+
+    it 'returns a hash' do
+      expect(subject.get('test1')).to be_a_kind_of(Hash)
+    end
+
+    it 'has 2 entries' do
+      expect(subject.get('test1').size).to eq(2)
+    end
+  end
+
+  describe '#create' do
+    before do
+      node.config(['no ip host test1'])
+    end
+
+    it 'create a new ip host name' do
+      expect(subject.get('test1')).to eq(nil)
+      expect(subject.create('test1', ipaddress: ['192.168.0.1'])).to be_truthy
+      expect(subject.get('test1')[:ipaddress]).to eq(['192.168.0.1'])
+    end
+
+    it 'raises ArgumentError for create without required args ' do
+      expect { subject.create('test1') }.to \
+        raise_error ArgumentError
+    end
+
+    it 'raises ArgumentError for invalid ipaddress value' do
+      expect { subject.create('test1', ipaddress: ['bogus']) }.to \
+        raise_error ArgumentError
+    end
+  end
+
+  describe '#delete' do
+    before do
+      node.config(['ip host test12 172.16.0.12'])
+    end
+
+    it 'delete an ip host resource' do
+      expect(subject.get('test12')[:name]).to eq('test12')
+      expect(subject.delete('test12')).to be_truthy
+      expect(subject.get('test12')).to eq(nil)
+    end
+  end
+
+  describe '#set_ipaddress' do
+    before do
+      node.config(['no ip host test13'])
+    end
+
+    it 'change the ip address' do
+      expect(subject.create('test13', ipaddress: ['192.168.0.1'])).to be_truthy
+      expect(subject.create('test13', ipaddress: ['172.16.0.13'])).to be_truthy
+      expect(subject.get('test13')[:ipaddress]).to eq(['172.16.0.13'])
+    end
+  end
+end

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

@@ -23,6 +23,7 @@ describe Rbeapi::Api::Managementdefaults do
     before { node.config(['management defaults', 'default secret hash']) }
 
     it 'configures the management defaults secret hash value' do
+      expect(subject.set_secret_hash(value: 'md5')).to be_truthy
       expect(subject.get[:secret_hash]).to eq('md5')
       expect(subject.set_secret_hash(value: 'sha512')).to be_truthy
       expect(subject.get[:secret_hash]).to eq('sha512')