sshexpect 0.0.2

data/README

@@ -0,0 +1,2 @@
+This is a module for using expect and ssh for automation. 
+It contains a simple wrapper class for now that will take an expect sequence as input and return the output.

data/lib/sshexpect.rb

@@ -0,0 +1,219 @@
+require 'expect'
+require 'pty'
+
+module SshExpect
+#Signal.trap( 'CHLD', 'IGNORE')
+  
+  # A class for interacting with ssh through pty and expect.
+  # Useful for when sshv2 isnt supported or extended login prompts are used.
+  class Client 
+
+    attr_reader :hostname, :timeout, :command, :ignore, :quiet, :port, :cipher, :username, :output, :error
+
+    #==============================================================================#
+    # initialize()
+    #==============================================================================#
+
+    #===Synopsis
+    #Create a new SshExpect::Single object.
+    #
+    #===Usage
+    # SshExpect.new(options)
+    #
+    #===Arguments
+    #Hash with the following fields:
+    # :hostname => [String] -- ip/hostname the device.
+    # :username => [String] -- username to connect with.  
+    # :verbose => [TrueClass|FalseClass] -- Suppress output and warnings if set True. 
+    # :noverify => [TrueClass|FalseClass] -- Ignore changed host keys if set True.
+    # :timeout => [Integer] -- timeout for device to respond on any given sequence step.
+    # :port => [Integer] -- TCP port to connect with.
+    # :cipher => [String] -- encryption cipher.
+    # :command => [String] -- full path to ssh including the binary.
+    
+    def initialize(options)
+   
+      @hostname = nil
+      @username = nil
+      @verbose = true
+      @noverify = true
+      @timeout = 30
+      @port = 22
+      @cipher = "des"    
+      @command = "/usr/bin/ssh"
+      @cmd = nil
+      @output = Array.new
+      @error = nil
+      
+
+      if (!options.kind_of?(Hash))
+        raise ArgumentError, "Expected Hash, but #{options.class} provided."
+      end
+
+      if (options.has_key?(:hostname))
+        @hostname = options[:hostname]
+        if (!@hostname.kind_of?(String))
+          raise ArgumentError, "Expected String for :hostname, but #{@server.class} provided."
+        end
+      else
+        raise ArgumentError, "Missing argument :hostname."
+      end
+      
+      if (options.has_key?(:username))
+        @username = options[:username]
+        if (!@username.kind_of?(String))
+          raise ArgumentError, "Expected String for :username, but #{@server.class} provided."
+        end
+      else
+        raise ArgumentError, "Missing argument :username."
+      end      
+
+      if (options.has_key?(:verbose))
+        @verbose = options[:verbose] 
+        if (!@verbose.kind_of?(TrueClass) && !@verbose.kind_of?(FalseClass))
+          raise ArgumentError, "Expected True or False for :verbose, but was #{@verbose.class}"
+        end
+      end
+      
+      if (options.has_key?(:noverify))
+        @noverify = options[:noverify] 
+        if (!@noverify.kind_of?(TrueClass) && !@noverify.kind_of?(FalseClass))
+          raise ArgumentError, "Expected True or False for :noverify, but was #{@ignore.class}"
+        end
+      end      
+
+      if (options.has_key?(:timeout))
+        @timeout = options[:timeout]
+        if (!@timeout.kind_of?(Integer)) 
+          raise ArgumentError, "Expected Integer for :timeout, but #{@timeout.class} provided."
+        end
+      end
+
+      if (options.has_key?(:port))
+        @port = options[:port]
+        if (!@port.kind_of?(Integer)) 
+          raise ArgumentError, "Expected Integer for :port, but #{@port.class} provided."
+        end
+        if (@port >= 2**16)
+          raise ArgumentError, "#{@port} is not a valid TCP port."
+        end
+      end
+      
+      #Build the command line for PTY
+      @cmd = @command + " #{@username}@#{@hostname} -p #{@port}"
+      
+      if(@verbose)
+        @cmd = @cmd + " -q"
+      end
+      
+      if(@noverify)  
+        @cmd = @cmd + " -o StrictHostKeyChecking=no"
+      end
+       
+    end
+
+    #==============================================================================#
+    # exec()
+    #==============================================================================#
+
+    #===Synopsis
+    #Iterate through a sequence of send/expect statements.
+    #
+    #===Usage
+    # SshExpect.exec(sequence)
+    #
+    #===Arguments
+    #Array of Hashes with the following format:
+    #sequence = []
+    #sequence[0] = {}
+    #sequence[0]["expect"] = "word:"
+    #sequence[0]["send"] = "mypassword\n"
+    #sequence[1] = {}
+    #sequence[1]["expect"] = ">"
+    #sequence[1]["send"] = "en\n"
+    #sequence[2] = {}
+    #sequence[2]["expect"] = "word:"
+    #sequence[2]["send"] = "enable\n"
+    #sequence[3] = {}
+    #sequence[3]["expect"] = "#"
+    #sequence[3]["send"] = "conf t\n"
+    #sequence[4] = {}
+    #sequence[4]["expect"] = "#"
+    #sequence[4]["send"] = "no pager\n sho run\n"
+    #sequence[5] = {}
+    #sequence[5]["expect"] = "#"
+    #sequence[5]["send"] = "exit\n"
+    #sequence[6] = {}
+    #sequence[6]["expect"] = "#"
+    #sequence[6]["send"] = "exit\n"
+    
+    
+    def exec(sequence)
+
+      reader = nil
+      writer = nil
+      pid = nil
+
+      begin
+        PTY.spawn(@cmd) do |reader,writer,pid|
+          
+          sleep 0.1
+
+          PTY.protect_signal do
+
+            $expect_verbose = @verbose  
+            sequence.each do |step|
+              exp = step["expect"]
+              snd = step["send"]
+                 
+              begin
+                reader.expect(exp,@timeout) do |receive|
+                  if receive == nil then
+                    @output.push("Exception: Timeout talking to device")
+                                
+                    writer.close 
+                    reader.close
+                    return @output
+                  else 
+                    writer.puts(snd)
+                    @output.push(receive)
+                  end
+                end
+
+              rescue Exception => ee
+                @output.push "Exception trying to handle IO #{ee.to_s}\n"
+                return @output
+              end
+            end
+
+            writer.close
+            reader.close
+                
+            begin
+              Process.kill(9,@pid)
+            rescue Exception => ee
+              @output.push "Exception trying to kill process #{@pid} #{ee.to_s} \n"
+              return @output
+            end    
+          end
+        end
+        return @output  
+
+
+      rescue PTY::ChildExited => ee
+        @output.push "Exception child died early #{ee.to_s}\n"
+        return @output
+       
+      rescue Errno::EIO => ee
+        @output.push "Exception connection closed early #{ee.to_s}\n"
+        return @output
+
+      rescue Exception => ee
+        @output.push "Exception #{ee.to_s}\n"
+        return @output
+      end
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: sshexpect
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- David Lister
+autorequire: sshexpect
+bindir: bin
+cert_chain: []
+
+date: 2009-02-25 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: david @nospam@ lister.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/sshexpect.rb
+- README
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: This is a module for using expect and ssh for automation.
+test_files: []
+