tap-test 0.3.0 → 0.4.0

data/History

@@ -1,3 +1,14 @@
+== 0.4.0 / 2009-19-09
+
+Various improvements to the test modules.  Note that FileTest now will
+cleanup the method_root directory completely by default; to restore
+the old behavior, set cleanup_dirs equal to [:output, :tmp].
+
+* added set_env method to ShellTest
+* added indent stripping to sh_test
+* changed FileTest to cleanup method_root
+  completely by default
+
 == 0.3.0 / 2009-12-05
 
 Updates for Tap-0.19.0

data/README

@@ -33,9 +33,7 @@ can be overlaid.
 
 Sets up a test-specific method_root for working with temporary files. Better
 in most cases than using Tempfile because you can flag temporary files to be
-saved on a failure (using ENV['KEEP_OUTPUTS']='true'). Also provides a new
-assertion to test that all the files in an expected directory are equal to
-those in an output directory.
+saved on a failure (using ENV['KEEP_OUTPUTS']='true').
 
   require 'tap/test/unit'
   class FileTestTest < Test::Unit::TestCase
@@ -63,9 +61,9 @@ Simple testing of shell commands.
     
     def test_echo_with_an_alias
       sh_test %q{
-  % alias goodnight moon
-  goodnight moon
-  }
+      % alias goodnight moon
+      goodnight moon
+      }
     end
   end
     
@@ -102,9 +100,9 @@ Sets up Tap::App.instance for testing tasks.
   class TapTestTest < Test::Unit::TestCase
     acts_as_tap_test
 
-    def test_task
-      t = Tap::Task.intern {|task| "result" }
-      assert_equal "result", t.process
+    def test_node
+      n = app.node { "result" }
+      assert_equal "result", n.call
     end
   end
 

data/lib/tap/test.rb

@@ -50,7 +50,7 @@ module Tap
     # sh_test_options.
     def acts_as_shell_test(options=nil)
       include Tap::Test::ShellTest
-      self.sh_test_options = options
+      self.sh_test_options.merge!(options) if options
     end
     
     # Includes TapTest in the calling class and calls acts_as_file_test with

data/lib/tap/test/file_test.rb

@@ -5,15 +5,15 @@ module Tap
   module Test  
     
     # FileTest facilitates access and utilization of test-specific files and
-    # directories. FileTest provides each test method with a Tap::Root 
-    # (method_root) specific for the method, and defines a new assertion method 
-    # (assert_files) to facilitate tests which involve the production and/or 
-    # modification of files.
+    # directories. FileTest provides each test method with a Tap::Root
+    # (method_root) specific for the method, and defines a new assertion
+    # method (assert_files) to facilitate tests which involve the production
+    # and/or modification of files.
     #
     #   [file_test_doc_test.rb]
     #   class FileTestDocTest < Test::Unit::TestCase
     #     acts_as_file_test
-    # 
+    #  
     #     def test_something
     #       # each test class has a class test root (ctr)
     #       # and each test method has a method-specific
@@ -36,7 +36,7 @@ module Tap
     #       # by the block the expected files, ensuring they
     #       # are the same (see the documentation for the 
     #       # simplest use of assert_files)
-    #       
+    #        
     #       expected_file = method_root.prepare(:expected, 'output.txt') {|file| file << 'expected output' }
     #
     #       # passes
@@ -46,19 +46,39 @@ module Tap
     #     end
     #   end
     #
+    # ==== Cleanup
+    #
+    # By default the method_root directory is cleaned up at the end of the
+    # test, making FileTest very conveient for creating temporary test files. 
+    # To prevent cleanup, either set the KEEP_OUTPUTS or KEEP_FAILURES ENV
+    # variable to 'true'.  The cleanup directories can be specified manually
+    # using cleanup_dirs class variable:
+    #
+    #   class LimitedCleanupTest < Test::Unit::TestCase
+    #
+    #     # only cleanup the method_root[:output] directory
+    #     acts_as_file_test :cleanup_dirs => [:output]
+    #   end
+    #
+    # This technique is useful when you want to keep certain static files
+    # under version control, for instance.
+    #
+    # ==== Requirements
+    #
     # FileTest requires that a method_name method is provided by the including
-    # class, in order to properly set the directory for method_root.
+    # class, in order to properly set the directory for method_root. 
+    # Test::Unit::TestCase satisfies this requirement already.
     module FileTest
       
       def self.included(base) # :nodoc:
         super
         base.extend FileTest::ClassMethods
-        base.cleanup_dirs = [:output, :tmp]
+        base.cleanup_dirs = [:root]
       end
       
-      # The test-method-specific Tap::Root which may be used to
-      # access test files.  method_root is a duplicate of ctr
-      # reconfigured so that method_root.root is ctr[method_name.to_sym]
+      # The test-method-specific Tap::Root which may be used to access test
+      # files.  method_root is a duplicate of ctr reconfigured so that
+      # method_root.root is ctr[method_name.to_sym]
       attr_reader :method_root
       
       # Sets up method_root and calls cleanup.  Be sure to call super when
@@ -70,9 +90,9 @@ module Tap
       end
       
       # Cleans up the method_root.root directory by removing the class
-      # cleanup_dirs (by default :tmp and :output). The root directory
-      # will also be removed if it is empty.
-      # 
+      # cleanup_dirs (by default :root, ie the method_root directory itself).
+      # The root directory will be removed if it is empty.
+      #  
       # Override as necessary in subclasses.
       def cleanup
         self.class.cleanup_dirs.each do |dir|
@@ -81,15 +101,8 @@ module Tap
         try_remove_dir(method_root.root)
       end
     
-      # Calls cleanup unless flagged otherwise by an ENV variable. To prevent
-      # cleanup (when debugging for example), set the 'KEEP_OUTPUTS' or 
-      # 'KEEP_FAILURES' ENV variables:
-      #
-      #   % rap test KEEP_OUTPUTS=true
-      #   % rap test KEEP_FAILURES=true
-      #
-      # Cleanup is only suppressed for failing tests when KEEP_FAILURES is
-      # specified.  Be sure to call super when overriding this method.
+      # Calls cleanup unless flagged otherwise by an ENV variable (see above).
+      # Be sure to call super when overriding this method.
       def teardown
         # check that method_root still exists (nil may
         # indicate setup was overridden without super)
@@ -116,7 +129,7 @@ module Tap
       
       # Runs a file-based test that compares files created by the block with
       # files in an expected directory.  The block receives files from the
-      # input directory, and should return a list of files relative to the 
+      # input directory, and should return a list of files relative to the
       # output directory.  Only the files returned by the block are compared;
       # additional files in the output directory are effectively ignored.
       #
@@ -126,7 +139,7 @@ module Tap
       #
       #   class FileTestDocTest < Test::Unit::TestCase
       #     acts_as_file_test
-      # 
+      #    
       #     def test_assert_files
       #       assert_files do |input_files|
       #         input_files.collect do |path|
@@ -152,7 +165,7 @@ module Tap
       #   `- input
       #       |- one.txt
       #       `- two.txt
-      # 
+      #    
       #   [input/one.txt]
       #   test input 1
       #
@@ -165,7 +178,7 @@ module Tap
       #   [expected/two.txt]
       #   test output 2
       #
-      # When you run the test, the assert_files passes the input files to the 
+      # When you run the test, the assert_files passes the input files to the
       # block.  When the block completes, assert_files compares the output
       # files returned by the block with the files in the expected directory.
       # In this case, the files are equal and the test passes.
@@ -181,7 +194,7 @@ module Tap
       #
       # === Options
       # A variety of options adjust the behavior of assert_files:
-      # 
+      #    
       #   :input_dir                      specify the directory to glob for input files
       #                                     (default method_root[:input])
       #   :output_dir                     specify the output directory
@@ -195,18 +208,18 @@ module Tap
       #   :include_expected_directories   specifies directories to be included in the
       #                                     expected-output file list comparison 
       #                                     (by default dirs are excluded)  
-      #                  
+      #                     
       # assert_files will fail if <tt>:expected_files</tt> was not specified
-      # in the options and no files were found in <tt>:expected_dir</tt>.  This
-      # check tries to prevent silent false-positive results when you forget to
-      # put expected files in their place.
+      # in the options and no files were found in <tt>:expected_dir</tt>. This
+      # check tries to prevent silent false-positive results when you forget
+      # to put expected files in their place.
       #
       # === File References
       #
-      # Sometimes the same files will get used across multiple tests.  To allow
-      # separate management of test files and prevent duplication, file 
-      # references can be provided in place of test files.  For instance, with a
-      # test directory like:
+      # Sometimes the same files will get used across multiple tests.  To
+      # allow separate management of test files and prevent duplication, file
+      # references can be provided in place of test files.  For instance, with
+      # a test directory like:
       #
       #   method_root
       #   |- expected
@@ -218,7 +231,7 @@ module Tap
       #   `- ref
       #       |- one.txt
       #       `- two.txt
-      #   
+      #      
       # The input and expected files (all references in this case) can be
       # dereferenced to the 'ref' paths like so:
       #
@@ -236,21 +249,10 @@ module Tap
       # configurations; a reference_dir must be specified for dereferencing to
       # occur (see Utils.dereference for more details).
       #
-      # === Keeping Outputs
-      #
-      # By default FileTest cleans up everything under method_root except the
-      # input and expected directories. For ease in debugging, ENV variable
-      # flags can be specified to prevent cleanup for all tests (KEEP_OUTPUTS)
-      # or just tests that fail (KEEP_FAILURES).  These flags can be specified
-      # from the command line if you're running the tests with rake or rap:
-      #
-      #   % rake test keep_outputs=true
-      #   % rap test keep_failures=true
-      #
       #--
       # TODO:
-      # * add debugging information to indicate, for instance,  
-      #   when dereferencing is going on.
+      # * add debugging information to indicate, for instance,  when
+      #   dereferencing is going on.
       def assert_files(options={}, &block) # :yields: input_files
         transform_test(block, options) do |expected_file, output_file|
           unless FileUtils.cmp(expected_file, output_file) 

data/lib/tap/test/shell_test.rb

@@ -71,27 +71,37 @@ module Tap
         quiet && quiet =~ /^true$/i ? true : false
       end
       
-      # Sets the specified ENV variables for the duration of the block.
+      # Sets the specified ENV variables and returns the *current* env.
       # If replace is true, current ENV variables are replaced; otherwise
       # the new env variables are simply added to the existing set.
-      def with_env(env={}, replace=false)
+      def set_env(env={}, replace=false)
         current_env = {}
         ENV.each_pair do |key, value|
           current_env[key] = value
         end
         
+        ENV.clear if replace
+        
+        env.each_pair do |key, value|
+          ENV[key] = value
+        end if env
+        
+        current_env
+      end
+      
+      # Sets the specified ENV variables for the duration of the block.
+      # If replace is true, current ENV variables are replaced; otherwise
+      # the new env variables are simply added to the existing set.
+      #
+      # Returns the block return.
+      def with_env(env={}, replace=false)
+        current_env = nil
         begin
-          ENV.clear if replace
-          env.each_pair do |key, value|
-            ENV[key] = value
-          end if env
-          
+          current_env = set_env(env, replace)
           yield
-          
         ensure
-          ENV.clear
-          current_env.each_pair do |key, value|
-            ENV[key] = value
+          if current_env
+            set_env(current_env, true)
           end
         end
       end
@@ -160,6 +170,29 @@ module Tap
       #   ["hello", "world"]
       #   }, opts
       #
+      # ==== Indents
+      #
+      # To improve the readability of tests, sh_test will lstrip each line in the
+      # expected output to the same degree as the command line.  So for instance
+      # these all pass:
+      #
+      #   sh_test %Q{
+      #   % argv_inspect hello world
+      #   ["hello", "world"]
+      #   }, opts
+      #
+      #   sh_test %Q{
+      #       % argv_inspect hello world
+      #       ["hello", "world"]
+      #   }, opts
+      #
+      #       sh_test %Q{
+      #       % argv_inspect hello world
+      #       ["hello", "world"]
+      #       }, opts
+      #
+      # Turn off indent stripping by specifying :indent => false.
+      #
       # ==== ENV variables
       #
       # Options may specify a hash of env variables that will be set in the
@@ -179,8 +212,15 @@ module Tap
       def sh_test(cmd, options={})
         options = sh_test_options.merge(options)
         
-        cmd, expected = cmd.lstrip.split(/^/, 2)
-        cmd.strip!
+        if cmd =~ /\A\s*?\n?(\s*)(.*?\n)(.*)\z/m
+          indent, cmd, expected = $1, $2, $3
+          cmd.strip!
+          
+          if indent.length > 0 && options[:indents]
+            expected.gsub!(/^\s{0,#{indent.length}}/, '')
+          end
+        end
+        
         result = sh(cmd, options)
         
         assert_equal(expected, result, cmd) if expected

data/lib/tap/test/shell_test/class_methods.rb

@@ -11,7 +11,8 @@ module Tap
         def sh_test_options
           @sh_test_options ||= {
             :cmd_pattern => '% ',
-            :cmd => '2>&1 '
+            :cmd => '2>&1 ',
+            :indents => true
           }
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap-test
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-05 00:00:00 -07:00
+date: 2009-12-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency