cli_test 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-06-24
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/cli_test.rb
+test/test_cli_test.rb

data/README.rdoc

@@ -0,0 +1,51 @@
+= cli_test
+
+* http://github.com/julik/cli_test
+
+== DESCRIPTION:
+
+Assists in testing commandline applications (run an application qucikly, read out stderr, stdout and status, check option combinations)
+
+== FEATURES/PROBLEMS:
+
+Uses in-process loading on non-forking architectures
+
+== SYNOPSIS:
+
+  @app = CLITest.new("/usr/local/bin/ruby")
+	status, out, err = @app.run("--version")
+	out #=> "ruby 1.9.2p180 (2011-02-18 revision 30909) [i386-darwin9.8.0]\n"
+	assert_match /revision/, out, "Should output revision information"
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 FIX
+
+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/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'cli_test' do | s |
+  s.developer('Julik Tarkhanov', 'me@julik.nl')
+  s.readme_file = 'README.rdoc'
+end
+
+# vim: syntax=ruby

data/lib/cli_test.rb

@@ -0,0 +1,80 @@
+require "stringio"
+
+begin
+  require "open3"
+rescue LoadError
+end
+
+class CLITest
+  VERSION = '1.0.0'
+  
+  def initialize(binary_path)
+    @binary_path = File.expand_path(binary_path)
+  end
+  
+  def run(commandline_arguments)
+    arguments_as_argv = cli_arguments_to_argv(commandline_arguments)
+    (not_unix? || !ruby19?) ? in_process(arguments_as_argv) : in_fork(arguments_as_argv)
+  end
+  
+  def not_unix?
+    RUBY_PLATFORM =~ /mswin|jruby/
+  end
+  
+  
+  def ruby19?
+    !(RUBY_VERSION < "1.9")
+  end
+    
+  # Run the binary under test with passed options, and return [exit_code, stdout_content, stderr_content]
+  # There is a limitation however: your app should be using $stdout and $stdeer and NOT their constant
+  # equivalents.
+  def in_process(commandline_arguments)
+    old_stdout, old_stderr, old_argv = $stdout, $stderr, ARGV.dup
+    os, es = StringIO.new, StringIO.new
+    begin
+      $stdout, $stderr, verbosity = os, es, $VERBOSE
+      ARGV.replace(commandline_arguments)
+      $VERBOSE = false
+      
+      load(@binary_path)
+      
+      return [0, os.string, es.string]
+    rescue SystemExit => boom # The binary uses exit(), we use that to preserve the output code
+      return [boom.status, os.string, es.string]
+    ensure
+      $VERBOSE = verbosity
+      ARGV.replace(old_argv)
+      $stdout, $stderr = old_stdout, old_stderr
+    end
+  end
+  
+  def cli_arguments_to_argv(arguments_string_or_array)
+    return arguments_string_or_array if arguments_string_or_array.is_a?(Array)
+    arguments_string_or_array.split
+  end
+  
+  # Run the binary under test with passed options, and return [exit_code, stdout_content, stderr_content]
+  # There is a limitation however: your app should be using $stdout and $stdeer and NOT their constant
+  # equivalents.
+  def in_fork(args)
+    args.unshift(@binary_path)
+    
+    if ruby19?
+      Open3.popen3(ENV, args.join(' ')) do |stdin, stdout, stderr, wait_thr|
+        # Process::Status object returned in Ruby 1.9
+        [make_signed(wait_thr.value.exitstatus), stdout.read, stderr.read]
+      end
+    else
+      Open3.popen3(args.join(' ')) do |stdin, stdout, stderr|
+        [make_signed($?.to_i), stdout.read, stderr.read]
+      end
+    end
+  end
+  
+  # yuck!
+  def make_signed(retcode)
+    ((retcode > 128)) && ((retcode = retcode - 256))
+    retcode
+  end
+end

data/test/test_cli_test.rb

@@ -0,0 +1,111 @@
+require "test/unit"
+require File.expand_path(File.dirname(__FILE__)) + "/../lib/cli_test"
+require "tempfile"
+
+class TestCliTest < Test::Unit::TestCase
+  class InProcess < CLITest
+    
+    def not_unix?
+      true
+    end
+  end
+  
+  def setup
+    @tfs = []
+  end
+  
+  def make_tempfile
+    tf = Tempfile.new("experiment")
+    @tfs.push(tf)
+    tf
+  end
+  
+  def teardown
+    @tfs.each{|tf| tf.close! }
+  end
+  
+  def test_cli_passes_ARGV
+    f = make_tempfile
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("print ARGV.inspect")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = CLITest.new(f.path)
+    s, o, e = @app.run("--help")
+    assert_equal %w( --help ).inspect, o, "Should be the same STDOUT"
+    assert_equal "",                   e, "Should be the same STDERR"
+  end
+  
+  def test_cli_returns_stderr
+    f = make_tempfile
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("$stderr.write ARGV.inspect")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = CLITest.new(f.path)
+    s, o, e = @app.run("--help")
+    assert_equal %w( --help ).inspect, e, "Should be the same STDERR"
+  end
+  
+  def test_cli_passes_exit_status
+    f = Tempfile.new("experiment")
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("exit(12)")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = CLITest.new(f.path)
+    s, o, e = @app.run("")
+    assert_equal 12, s, "Should pass the proper exit status"
+  end
+  
+  def test_cli_passes_exit_status_with_inprocess
+    f = Tempfile.new("experiment")
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("exit(12)")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = InProcess.new(f.path)
+    s, o, e = @app.run("")
+    assert_equal 12, s, "Should pass the proper exit status"
+  end
+  
+  def test_cli_returns_stderr_with_inprocess
+    f = make_tempfile
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("$stderr.write ARGV.inspect")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = InProcess.new(f.path)
+    s, o, e = @app.run("--help")
+    assert_equal %w( --help ).inspect, e, "Should be the same STDERR"
+  end
+  
+  def test_cli_returns_stdout_with_inprocess
+    f = make_tempfile
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("$stdout.write ARGV.inspect")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = InProcess.new(f.path)
+    s, o, e = @app.run("--help")
+    assert_equal %w( --help ).inspect, o, "Should be the same STDOUT"
+  end
+  
+  def test_cli_passes_negative_exit_status
+    f = Tempfile.new("experiment")
+    f.puts('#!/usr/bin/env ruby')
+    f.puts("exit(-12)")
+    f.chmod(0x777)
+    f.flush
+    
+    @app = CLITest.new(f.path)
+    s, o, e = @app.run("")
+    assert_equal -12, s, "Should pass the proper exit status"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: cli_test
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.9.4
+  type: :development
+  version_requirements: *id001
+description: Assists in testing commandline applications (run an application qucikly, read out stderr, stdout and status, check option combinations)
+email: 
+- me@julik.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/cli_test.rb
+- test/test_cli_test.rb
+- .gemtest
+homepage: http://github.com/julik/cli_test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: cli_test
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Assists in testing commandline applications (run an application qucikly, read out stderr, stdout and status, check option combinations)
+test_files: 
+- test/test_cli_test.rb