cmd_line_test 0.1.4

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+doc
+Manifest
+cmd_line_test/**
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009, Fedor Kocherga <fkocherga@gmail.com>
+
+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,28 @@
+= cmd_line_test - Extends Shoulda or Test::Unit with macros for testing command line apps
+
+= Basic Usage
+
+== Installation
+  $ sudo gem install cmd_line_test --source=http://gemcutter.org
+
+== Example
+If you are about to start writing new command line utility MyCommandLineApp, you probably want to specify its options and behavior, likely in form of tests. This gem is aimed to simplify creation of such tests:
+
+
+  requrie 'cmd_line_test'
+
+  class CliTest < Test::Unit::TestCase
+    run_command_line_as {MyCommandLineApp.run}
+  
+    run_with_argv "--help" do
+      assert_successful_run
+      assert_out_contains /Usage:/
+    end
+  end
+
+= Shortcumings
+Only tested on the 1.8.7 Ruby implementation and with Shoulda 2.10.1
+
+= License
+cmd_line_test is released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/shoulda/cli_test.rb', 'test/unit/cli_test.rb']
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  gemspec = Gem::Specification.new do |s|
+
+    s.name = "cmd_line_test"
+    s.summary = "Extends Shoulda or Test::Unit with macros for testing command line apps."
+    s.email = "fkocherga@gmail.com"
+    s.homepage = "http://github.com/fkocherga/cmd_line_test"
+    s.description = <<END
+Macros specific to command line Ruby apps testing. Works with Test::Unit or Shoulda.
+END
+    s.authors = ["Fedor Kocherga"]
+    s.test_files = ['test/shoulda/cli_test.rb', 'test/unit/cli_test.rb']
+  end
+  Jeweler::Tasks.new gemspec
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 0
+:minor: 1

data/cmd_line_test.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cmd_line_test}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fedor Kocherga"]
+  s.date = %q{2009-10-03}
+  s.description = %q{Macros specific to command line Ruby apps testing. Works with Test::Unit or Shoulda.
+}
+  s.email = %q{fkocherga@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "cmd_line_test.gemspec",
+     "lib/cmd_line_test.rb",
+     "test/cli_app.rb",
+     "test/shoulda/cli_test.rb",
+     "test/test.rb",
+     "test/test_helper.rb",
+     "test/unit/cli_test.rb"
+  ]
+  s.homepage = %q{http://github.com/fkocherga/cml_line_test}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Extends Shoulda or Test::Unit with macros for testing command line apps.}
+  s.test_files = [
+    "test/shoulda/cli_test.rb",
+     "test/unit/cli_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/cmd_line_test.rb

@@ -0,0 +1,128 @@
+module CmdLineTest
+  module ClassMethods
+    attr_accessor :cli_exit_status, :cli_output, :cli_error, :cli_error_stack, :cli_block, :show_output
+    
+    def run_command_line_as(options = nil, &block)
+      self.show_output = options && options[:show_output] || false
+      self.cli_block = block
+    end
+  end #ClassMethods
+  
+  module InstanceMethods
+    def run_with_argv(*args)
+      with_ARGV_set_to(*args) {execute}
+    end
+    
+    private
+    def execute
+      self.class.cli_block.call
+    end
+    
+    def with_ARGV_set_to(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      ignore_assignment_to_const_warning { Object.const_set(:ARGV, args) }
+      yield args, options
+    end
+
+    def ignore_assignment_to_const_warning 
+      warnings_option = $-w
+      $-w = nil
+      begin
+        yield
+      ensure
+        $-w = warnings_option
+      end
+    end
+  end #InstanceMethods
+  
+  module Macros
+    def run_with_argv(*args, &block)
+      raise RuntimeError, "Command is not defined: 'run_command_line_as()' must be called first." unless 
+        self.cli_block
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      argv = args
+      test_name = options[:name] || "after running with arguments '#{argv.join(', ')}'"
+      generate_test test_name do 
+        with_ARGV_set_to *argv do
+          begin 
+            self.class.cli_exit_status = 0
+            self.class.cli_error = ""
+            self.class.cli_error_stack = ""
+            self.class.cli_output = ""
+            $test_class = self.class
+            #It used to be $stdout = StringIO.new(...), but it does not work well with rdebug
+            class <<$stdout
+              alias_method :original_write, :write
+              def write(*s)
+                original_write(s) if $test_class.show_output 
+                $test_class.cli_output << s.to_s if $test_class.cli_output
+              end
+            end
+            execute
+          rescue SystemExit => exit_error
+            self.class.cli_exit_status = exit_error.status
+          rescue Exception => error
+            self.class.cli_error_stack = error.backtrace.join("\n")
+            self.class.cli_error = error.message
+          ensure
+            class <<$stdout
+              remove_method :write, :original_write
+            end
+          end
+          instance_eval(&block)
+        end
+      end
+    end
+    
+    def run_and_succeed(*args, &block)
+      run_with_argv(*args) do
+        assert_successful_run
+        instance_eval(&block) if block
+      end
+    end
+
+    def run_and_fail(*args, &block)
+      run_with_argv(*args) do
+        assert_failed_run
+        instance_eval(&block) if block
+      end
+    end
+    
+    private
+    def generate_test(name, &block)
+      if defined? Shoulda 
+        should(name, &block)
+      else
+        test_name = ("test_".concat name).strip.to_sym
+        self.send(:define_method, test_name, &block)
+      end
+    end
+  end #Macros
+  
+  module Assertions
+    def assert_successful_run
+      expect_message = "Should run successfully, but"
+      assert_equal 0, self.class.cli_exit_status, "#{expect_message} exit status is #{self.class.cli_exit_status}"
+      assert self.class.cli_error.empty?, "#{expect_message} exception '#{self.class.cli_error}' has been thrown. Exception stack:\n" + self.class.cli_error_stack
+    end
+    
+    def assert_failed_run
+      flunk "Expects either thrown error or exit status not 0." if 0 == self.class.cli_exit_status && self.class.cli_error.empty?
+    end
+
+    def assert_out_contains regex
+      assert_match regex, self.class.cli_output
+    end
+  end #Assertions
+end
+
+module Test 
+  module Unit
+    class TestCase
+      extend CmdLineTest::ClassMethods
+      include CmdLineTest::InstanceMethods
+      extend CmdLineTest::Macros
+      include CmdLineTest::Assertions
+    end
+  end
+end

data/test/cli_app.rb

@@ -0,0 +1,31 @@
+require 'optparse'
+
+module CliApp
+  class CliException < StandardError
+  end
+  class <<self
+    def run
+      OptionParser.new do |opts|
+        opts.banner = "Usage: cli.rb [options]\nCommand line test app."
+        
+        opts.on( "--option OPTIONIAL", "run with OPTIONIAL") do |option|
+          puts option
+        end
+        
+        opts.on( "--raise", "raise CliException") do
+          raise CliException, "CLI exception"
+        end
+        
+        opts.on_tail("-h", "--help", "show help") do
+          puts opts
+          #exit NB!
+        end      
+      end.parse!
+    end
+  end
+end
+
+
+if $0 == __FILE__
+  CliApp.run
+end

data/test/shoulda/cli_test.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'shoulda'
+require File.dirname(__FILE__) + '/../test'
+
+class CliShouldaSpecificTest < Test::Unit::TestCase
+  run_command_line_as {CliApp.run}
+  
+  context "outer" do
+    run_with_argv "--option", "OUTER" do 
+      assert_out_contains /OUTER/
+    end
+    context "inner" do
+      run_with_argv "--option", "INNER" do 
+        assert_out_contains /INNER/
+      end
+    end
+  end
+end
+
+

data/test/test.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CliUsageTest < Test::Unit::TestCase
+  run_command_line_as {CliApp.run}
+  
+  run_with_argv :name => 'no argv' do
+    assert_successful_run
+  end
+  
+  run_and_succeed :name => 'no argv, shorter form'
+  
+  run_and_succeed "--help" do
+    assert_out_contains /Usage:/
+  end
+  
+  run_and_succeed "--option", "PRINT_THIS" do
+    assert_out_contains /PRINT_THIS/
+  end
+  
+  run_and_succeed :name => "run_with_argv could be used within block" do
+    run_with_argv 
+  end
+
+  run_and_fail "--invalid-option", :name => "running with invalid option" do
+    exception_raised = false
+    begin
+      assert_successful_run
+    rescue Exception 
+      exception_raised = true
+    end
+    assert(exception_raised)
+  end
+  
+  run_and_fail "--raise", :name => "raise exception" do
+    exception_raised = false
+    begin
+      assert_successful_run
+    rescue StandardError => error
+      assert error.to_s =~ /CLI exception/
+      exception_raised = true
+    end
+    assert(exception_raised)
+  end
+end
+
+class CliTestNoCommandLineDefined < Test::Unit::TestCase
+  def test_failure_when_command_line_defined
+    assert_raise(RuntimeError) {self.class.run_with_argv}
+  end
+end
+
+class CliTestShowOutput < Test::Unit::TestCase
+  
+  run_command_line_as(:show_output => true) {CliApp.run}
+
+  @@captured_out = ""
+  @@original_stdout = $stdout
+  @@string_out = StringIO.new(@@captured_out)
+  $stdout = @@string_out
+  run_and_succeed "--help" do
+    $stdout.flush
+    $stdout = @@original_stdout
+    assert_match /Usage:/, @@captured_out
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/cmd_line_test'
+require File.dirname(__FILE__) + '/cli_app'

data/test/unit/cli_test.rb

@@ -0,0 +1,3 @@
+#If Shoulda still has been loaded - unload it
+Object.send(:remove_const, :Shoulda) rescue nil
+require File.dirname(__FILE__) + '/../test'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: cmd_line_test
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Fedor Kocherga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: |
+  Macros specific to command line Ruby apps testing. Works with Test::Unit or Shoulda.
+
+email: fkocherga@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- cmd_line_test.gemspec
+- lib/cmd_line_test.rb
+- test/cli_app.rb
+- test/shoulda/cli_test.rb
+- test/test.rb
+- test/test_helper.rb
+- test/unit/cli_test.rb
+has_rdoc: true
+homepage: http://github.com/fkocherga/cml_line_test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Extends Shoulda or Test::Unit with macros for testing command line apps.
+test_files: 
+- test/shoulda/cli_test.rb
+- test/unit/cli_test.rb