sloe 0.5.4 → 0.6.0

data/lib/sloe/common.rb

@@ -2,12 +2,20 @@ require 'net/scp'
 require 'snmp'
 
 module Sloe
+  # Base class. Inherits from {http://rubydoc.info/gems/netconf/Netconf/SSH Netconf::SSH}
   class Common < Netconf::SSH
 
+    # Provides access to the SNMP object
     attr_reader :snmp
 
+    # Create Sloe::Common object.
+    # Accepts arguments for {http://rubydoc.info/gems/netconf/Netconf/SSH:initialize Netconf::SSH#new} and {http://rubydoc.info/gems/snmp/SNMP/Manager:initialize SNMP::Manager#new}
     def initialize(args, &block)
-      @snmp_args = {:host => args[:target], :mib_dir => args[:mib_dir], :mib_modules => args[:mib_modules]}
+      @snmp_args = {
+        :host        => args[:target], 
+        :mib_dir     => args[:mib_dir], 
+        :mib_modules => args[:mib_modules]
+      }
       @snmp = SNMP::Manager.new(@snmp_args)
       
       if block_given?

data/lib/sloe/device.rb

@@ -2,8 +2,10 @@ require 'net/netconf'
 require 'sloe/common'
 
 module Sloe
+  # Class for working with generic Netconf (i.e. a device that does not support vendor specific extension)
   class Device < Sloe::Common
 
+    # Sloe::Device object for generic Netconf device
     def initialize(args, &block)
 
       # Stop netconf gem from defaulting to :Junos and thus 

data/lib/sloe/junos.rb

@@ -1,17 +1,105 @@
 require 'net/netconf/jnpr'
 require 'sloe/common'
+require 'fileutils'
 
 module Sloe
+  # Class for working with Netconf device that supports Junos specifc Netconf extensions
   class Junos < Sloe::Common
 
+    # Create Sloe::Junos object. It takes the same arguments as Sloe::Common
+    #
+    # @param args [Hash] key value pairs of arguments for object
+    # @param block [Code] code block that will be executed once object created
+    # @return [Sloe::Junos] object that interacts with a Junos device
     def initialize(args, &block)
         super( args, &block )
     end
 
+    # execute CLI commands over NETCONF transport returns plain text, rather than XML, by default
+    # 
+    # @param cmd_str [String] A valid Junos CLI command.
+    # @param attrs [Hash] Supports same attributes as {http://rubydoc.info/gems/netconf/Netconf/RPC/Junos:command Junos#command}
+    # @return nil if command returns no text. Otherwise returns text in format requested (default is plain text)
     def cli(cmd_str, attrs = { :format => 'text' })
       attrs[:format] ||= 'text'
       reply = self.rpc.command(cmd_str, attrs)
       reply.respond_to?(:text) ? reply.text : reply
     end
+
+    # Applies configuration to one or more Junos devices. This method is designed to make it easy to apply a list of configs to a list of Junos devices. Defaults are design for applying new configuration.
+    # The :username and password arguments are used when connecting to the device to apply the configuration
+    # The :glob argument is used to find a list of files containing config to apply. The default looks in ./configs/ for all files whose basename ends with "-apply".
+    # The :match argument is used to find the hostname and configuration format of the config to apply. That file is applied to that host using the format gleaned from the filename suffix.
+    # 
+    # @param args [Hash] Hash of username, password, file glob and regex
+    def setup( args = {
+      :username => 'netconf', 
+      :password => 'netconf', 
+      :glob => "configs/*-apply.*", 
+      :match => /(?<host>\w+)-apply\.(?<format>\w+)/} )
+      _apply_configs( args )
+    end
+
+    # Applies configuration to one or more Junos devices. Defaults are designed for removing configuration.
+    # @see #setup
+    def clearup( args = {
+      :username => 'netconf', 
+      :password => 'netconf', 
+      :glob => "configs/*-delete.*", 
+      :match => /(?<host>\w+)-delete\.(?<format>\w+)/} )
+      _apply_configs( args )      
+    end
+
+    # Simplifies applying configuration to a Junos device.
+    # Uses Junos NETCONF extensions to apply the configuration. It also captures all config error conditions and ensures the config database is returned to the previous committed state.
+    # 
+    # @param config [String] Configuration to be applied the device
+    # @param attrs [Hash] Takes same attributes as {http://rubydoc.info/gems/netconf/Netconf/RPC/Junos:load_configuration Junos#load_configuration}
+    def apply_configuration( config, attrs = { :format => 'text' } )
+      begin
+        rpc.lock_configuration
+        rpc.load_configuration( config, attrs )
+        rpc.commit_configuration
+        rpc.unlock_configuration
+      rescue Netconf::LockError => e
+        rpc.unlock_configuration
+        puts e.message
+      rescue Netconf::EditError => e
+        rpc.discard_changes
+        rpc.unlock_configuration
+        puts e.message
+      rescue Netconf::ValidateError => e
+        rpc.discard_changes
+        rpc.unlock_configuration
+        puts e.message
+      rescue Netconf::CommitError => e
+        rpc.discard_changes
+        rpc.unlock_configuration
+        puts e.message
+      rescue Netconf::RpcError => e
+        rpc.discard_changes
+        rpc.unlock_configuration
+        puts e.message
+      end
+    end
+
+    private
+
+      def _apply_configs( args )
+        raise Errno::ENOENT, "file glob matches no files" if Dir.glob( args[:glob] ).length < 1
+        Dir.glob( args[:glob] ) do |file|
+          param = args[:match].match( file )
+
+          @login = {
+            :target   => param[:host],
+            :username => args[:username],
+            :password => args[:password]
+          }
+          @dut = Sloe::Junos.new( @login )
+          @config = File.read( file )
+          apply_configuration( @config, :format => param[:format] )
+          @dut.close
+        end      
+      end
   end
 end

data/lib/sloe/version.rb

@@ -1,3 +1,4 @@
 module Sloe
-  VERSION = "0.5.4"
+  # Current version
+  VERSION = "0.6.0"
 end

data/lib/sloe.rb

@@ -2,6 +2,7 @@ require 'sloe/version'
 require 'sloe/device'
 require 'sloe/junos'
 
+# Sloe is a module designed to ease interacting with a network device when using NETCONF
 module Sloe
 
 end

data/spec/methods_spec.rb

@@ -81,4 +81,28 @@ describe Sloe do
       lambda { @dut.cli('clear interface statistics fxp0') }.should_not raise_error
     end
   end
+
+  context "Helper methods" do
+    before( :all ) do
+      Dir.mkdir( 'configs' )
+      @apply = File.open( "configs/capella-apply.set", "w" )
+      @apply.write( 'set system location building "In a galaxy far, far, away"' )
+      @apply.close
+
+      @delete = File.open( "configs/capella-delete.set", "w" )
+      @delete.write( 'delete system location')
+      @delete.close
+    end
+
+    it "setup() with default args updates the router config" do
+      lambda { @dut.setup() }.should_not raise_error
+    end
+    it "clearup() with default args updates the router config" do
+      lambda { @dut.clearup() }.should_not raise_error
+    end
+
+    after(:all) do
+      FileUtils.rm_rf( 'configs' )
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sloe
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: snmp