expectr 0.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Wuest
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= expectr
+
+Expect (see http://expect.nist.gov/) implementation in Ruby.  This version differs from the included Expect module by providing a more granular method of managing process, output, and implementing Expect's "interact" command.
+
+== Contributing to expectr
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Chris Wuest. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "expectr"
+  gem.homepage = "http://github.com/cwuest/expectr"
+  gem.license = "MIT"
+  gem.summary = %Q{Expect for Ruby}
+  gem.description = %Q{Implementation of NIST Expect in Ruby, allowing for fine-grained control of several aspects of program flow and implementing "interact" mode.}
+  gem.email = "chris.wuest@rackspace.com"
+  gem.authors = ["Chris Wuest"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = Dir.glob('test/**/test_*.rb')
+  #test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "expectr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/expectr.rb

@@ -0,0 +1,265 @@
+# = expectr.rb
+#
+#  Copyright (c) Chris Wuest <chris@chriswuest.com>
+#  Expectr is freely distributable under the terms of an MIT-style license.
+#  See COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+begin
+	require 'pty'
+rescue LoadError
+	require 'popen4'
+end
+
+require 'timeout'
+require 'thread'
+
+# == Description
+# Expectr is an implementation of the Expect library in ruby (see
+# http://expect.nist.gov).
+#
+# Expectr contrasts with Ruby's built-in Expect class by avoiding tying in
+# with IO and instead creating a new object entirely to allow for more
+# fine-grained control over the execution and display of the program being
+# run.
+#
+# == Examples
+# === Simple task automation
+#
+# Connect via telnet to remote.example.com, run my_command, and return the
+# output
+#
+#   exp = Expectr.new "telnet remote.example.com"
+#   exp.expect "username:"
+#   exp.send "example\r"
+#   exp.expect "password:"
+#   exp.send "my_password\r"
+#   exp.expect "%"
+#   exp.send "my_command\r"
+#   exp.expect "%"
+#   exp.send "logout"
+#
+#   output = exp.discard
+#
+# === Interactive control
+# Silently connect via ssh to remote.example.com, log in automatically, then
+# relinquish control to the user.  Expect slow networking, so increase
+# timeout.
+#
+#   exp = Expectr.new "ssh remote.example.com", :timeout=>45, :flush_buffer=>false
+#
+#   match = exp.expect /password|yes\/no/
+#   case match.to_s
+#     when /password/
+#       exp.send "my_password\r"
+#     when /yes\/no/
+#       exp.send "yes\r"
+#       exp.expect /password/
+#       exp.send "my_password\r"
+#     else
+#       puts "Cannot connect to remote.example.com!"
+#       die
+#   end
+#
+#   exp.expect "$"
+#   exp.interact
+#
+class Expectr
+	# Amount of time in seconds a call to +expect+ may last (default 30)
+	attr_accessor :timeout
+	# Size of buffer in bytes to attempt to read in at once (default 8 KiB)
+	attr_accessor :buffer_size
+	# Whether to flush program output to STDOUT (default true)
+	attr_accessor :flush_buffer
+	# PID of running process
+	attr_reader :pid
+	# Active buffer to match against
+	attr_reader :buffer
+	# Buffer passed since last +expect+ match
+	attr_reader :discard
+
+	# 
+	# === Synopsis
+	#
+	#   Expectr.new(cmd, args)
+	#
+	# === Arguments
+	# +cmd+::
+	#   Command to be executed (String)
+	# +args+::
+	#   Hash of modifiers for Expectr.  Meaningful values are:
+	# * :buffer_size::
+	#   Amount of data to read at a time.  Default 8 KiB
+	# * :flush_buffer::
+	#   Flush buffer to STDOUT during execution?  Default true
+	# * :timeout::
+	#   Timeout in seconds for each +expect+ call.  Default 30
+	#
+	# === Description
+	#
+	# Spawn +cmd+ and attach to STDIN and STDOUT for new process.  Fall back
+	# to using Open4 if PTY is not present (this is the case on Windows
+	# implementations of ruby.
+	#
+  # === BUGS
+  #
+  # * Passing a File object to be executed does not work
+  #
+	def initialize(cmd, args={})
+		raise ArgumentError, "String Expected" unless cmd.kind_of?(String)
+		args[0] = {} unless args[0]
+		@buffer = String.new
+		@discard = String.new
+		@timeout = args[:timeout] || 30
+		@flush_buffer = args[:flush_buffer].nil? ? true : args[:flush_buffer]
+		@buffer_size = args[:buffer_size] || 8192
+		@out_mutex = Mutex.new
+		@out_update = false
+
+		[@buffer, @discard].each {|x| x.encode! "UTF-8" }
+
+		if defined? PTY
+			@stdout,@stdin,@pid = PTY.spawn cmd
+		else
+			cmd << " 2>&1" if cmd[/2\s*>/].nil?
+			@pid, @stdin, @stdout, stderr = Open4::popen4 cmd
+		end
+
+		Thread.new do
+			while @pid > 0
+				unless select([@stdout], nil, nil, @timeout).nil?
+					buf = ''
+
+					begin
+						@stdout.sysread(@buffer_size, buf)
+					rescue Errno::EIO #Application went away.
+						Process.wait @pid
+						@pid = 0
+						break
+					end
+
+					buf.encode! "UTF-8"
+					print_buffer buf
+
+					@out_mutex.synchronize do
+						@buffer << buf
+						@out_update = true
+					end
+				end
+			end
+		end
+	end
+
+	# 
+	# Clear output buffer
+	#
+	def clear_buffer
+		@out_mutex.synchronize do
+			@buffer = ''
+			@out_update = false
+		end
+	end
+
+	# 
+	# === Synopsis
+	#
+	#   Expectr#interact
+	# 
+	# === Description
+	#
+	# Relinquish control of the running process to the controlling terminal,
+	# acting simply as a pass-through for the life of the process.
+	#
+	# === Bugs
+	#
+	# * Interrupts are not handled and passed through to the application
+	#
+	def interact
+		@flush_buffer = true
+		old_tty = `stty -g`
+		`stty -icanon min 1 time 0 -echo`
+		
+		in_thread = Thread.new do
+			input = ''
+			while @pid > 0
+				if select([STDIN], nil, nil, 1)
+					@stdin.syswrite(STDIN.getc)
+				end
+			end
+		end
+
+		in_thread.join
+		`stty #{old_tty}`
+		return nil
+	end
+
+	#
+	# Send +str+ to application
+	#
+	def send(str)
+		@stdin.syswrite str
+	end
+
+	# 
+	# === Synopsis
+	#
+	#   Expectr#expect /regexp/, recoverable=false
+	#   Expectr#expect "String", recoverable=true
+	# 
+	# === Arguments
+	#
+	# +pattern+::
+	#   String or regexp to match against
+	# +recoverable+::
+	#   Determines if execution can continue after a timeout
+	#
+	# === Description
+	#
+	# Wait +timeout+ seconds to match +pattern+ in +buffer+.  If timeout is
+	# reached, raise an error unless +recoverable+ is true.
+	#
+	# === Bugs
+	#
+	# * Interrupts are not handled and passed through to the application
+	#
+	def expect(pattern, recoverable = false)
+		match = nil
+
+		case pattern
+			when String
+				pattern = Regexp.new(Regexp.quote(pattern))
+			when Regexp
+			else raise TypeError, "Pattern class should be String or Regexp, passed: #{pattern.class}"
+		end
+
+		begin
+			Timeout::timeout(@timeout) do
+				while match.nil?
+					if @out_update
+						@out_mutex.synchronize do
+							match = pattern.match @buffer
+							@out_update = false
+						end
+					end
+				end
+			end
+
+			@out_mutex.synchronize do
+				@discard = @buffer[0..match.begin(0)-1]
+				@buffer = @buffer[match.end(0)..-1]
+				@out_update = true
+			end
+		rescue Timeout::Error => details
+			raise details unless recoverable
+		end
+
+		return match
+	end
+
+	#
+	# Print buffer to STDOUT only if +flush_buffer+ is true
+	#
+	def print_buffer(buf)
+		print buf if @flush_buffer
+		STDOUT.flush
+	end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'expectr'
+
+class Test::Unit::TestCase
+end

data/test/test_expectr.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestExpectr < Test::Unit::TestCase
+	def setup
+		@exp = Expectr.new "ls /bin", :flush_buffer => false, :timeout => 2, :buffer_size => 4096
+	end
+
+	def test_execution
+		assert_equal @exp.flush_buffer, false
+		assert_equal @exp.timeout, 2
+		assert_equal @exp.buffer_size, 4096
+	end
+
+	def test_match
+		assert_not_equal @exp.expect(/sh/), nil
+		assert_not_equal @exp.discard, ''
+	end
+
+	def test_match_failure
+		assert_raises(Timeout::Error) { @exp.expect /ThisFileShouldNotExist/ }
+		assert_nothing_raised { @exp.expect /ThisFileShouldNotExist/, true }
+	end
+
+	def test_send
+		exp = Expectr.new "bc", :flush_buffer => false
+		exp.send "20+301\n"
+		exp.expect /321/
+	end
+
+	def test_clear_buffer
+		sleep 1
+		assert_not_equal @exp.buffer, ''
+		@exp.clear_buffer
+		assert_equal @exp.buffer, ''
+	end
+
+	def test_pid_set
+		assert @exp.pid > 0
+	end
+
+	def test_interact
+		exp = Expectr.new "bc", :flush_buffer => false
+		[
+			Thread.new {
+				sleep 1
+				exp.interact
+			},
+			Thread.new {
+				sleep 2
+				assert_equal exp.flush_buffer, true
+				exp.flush_buffer = false
+				exp.send "300+21\n"
+				exp.send "quit\n"
+			}
+		].each {|x| x.join}
+
+		assert_not_nil exp.expect /321/
+	end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: expectr
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Wuest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &69922000513180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69922000513180
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &69922000512700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *69922000512700
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &69922000512220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *69922000512220
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &69922000511740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *69922000511740
+description: Implementation of NIST Expect in Ruby, allowing for fine-grained control
+  of several aspects of program flow and implementing "interact" mode.
+email: chris.wuest@rackspace.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/expectr.rb
+- test/helper.rb
+- test/test_expectr.rb
+homepage: http://github.com/cwuest/expectr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1045150250599227842
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Expect for Ruby
+test_files: []