tap 0.8.0 → 0.9.0

data/test/test/env_vars_test.rb

@@ -2,47 +2,47 @@ require File.join(File.dirname(__FILE__), '../tap_test_helper.rb')
 
 class EnvVarsTest < Test::Unit::TestCase
   include Tap::Test::EnvVars
-	
-	def setup
-	  @env_hold = {}
-	  ENV.each_pair do |key, value|
-	    @env_hold[key] = value
-	  end
-		ENV.clear
-	end
-	
-	def teardown
-	  ENV.clear
-	  @env_hold.each_pair do |key, value|
-	    ENV[key] = value
-	  end
-	end
-	
-	#
-	# env test
-	#
-	
-	def test_env_access_is_case_insensitive
-		ENV['key1'] = "value"
-		assert_equal 'value', env('key1')
-		assert_equal 'value', env('KEY1')
-		
-		ENV['KEY2'] = "VALUE"
-		assert_equal 'VALUE', env('key2')
-		assert_equal 'VALUE', env('KEY2')
-	end
-	
-	def test_env_raises_error_if_multiple_values_can_be_selected
-		ENV['key'] = "value"
-		ENV['KEY'] = "VALUE"
-    
-    # Some platforms (ex Windows) already make ENV case-independent
-    # Filter for the platforms that do not by checking that ENV has both
-    # expected keys
+  
+  def setup
+    @env_hold = {}
+    ENV.each_pair do |key, value|
+      @env_hold[key] = value
+    end
+    ENV.clear
+  end
+  
+  def teardown
+    ENV.clear
+    @env_hold.each_pair do |key, value|
+      ENV[key] = value
+    end
+  end
+  
+  #
+  # env test
+  #
+  
+  def test_env_access_is_case_insensitive
+    ENV['key1'] = "value"
+    assert_equal 'value', env('key1')
+    assert_equal 'value', env('KEY1')
+    
+    ENV['KEY2'] = "VALUE"
+    assert_equal 'VALUE', env('key2')
+    assert_equal 'VALUE', env('KEY2')
+  end
+  
+  def test_env_raises_error_if_multiple_values_can_be_selected
+    ENV['key'] = "value"
+    ENV['KEY'] = "VALUE"
+    
+    # Some platforms (ex Windows) already make ENV case-independent
+    # Filter for the platforms that do not by checking that ENV has both
+    # expected keys
     if ENV.length == 2
-		  assert_raise(RuntimeError) { env('key') }
-		  assert_raise(RuntimeError) { env('Key') }
+      assert_raise(RuntimeError) { env('key') }
+      assert_raise(RuntimeError) { env('Key') }
     end
-	end
+  end
 
 end

data/test/test/file_methods/test_assert_files_fails_for_different_content/expected/one.txt

@@ -0,0 +1 @@
+processed file FLUNK

data/test/test/file_methods/test_assert_files_fails_for_different_content/input/one.txt

@@ -0,0 +1 @@
+file one

data/test/test/file_methods/test_assert_files_fails_for_different_content/input/two.txt

@@ -0,0 +1 @@
+file two

data/test/test/file_methods/test_assert_files_fails_for_missing_expected_file/input/one.txt

@@ -0,0 +1 @@
+file one

data/test/test/file_methods/test_assert_files_fails_for_missing_expected_file/input/two.txt

@@ -0,0 +1 @@
+file two

data/test/test/file_methods/test_assert_files_fails_for_missing_output_file/expected/one.txt

@@ -0,0 +1 @@
+processed file one

data/test/test/file_methods/test_assert_files_fails_for_missing_output_file/expected/two.txt

@@ -0,0 +1 @@
+processed file two

data/test/test/file_methods/test_assert_files_fails_for_missing_output_file/input/one.txt

@@ -0,0 +1 @@
+file one

data/test/test/file_methods/test_assert_files_fails_for_missing_output_file/input/two.txt

@@ -0,0 +1 @@
+file two

data/test/test/file_methods/test_assert_files_fails_for_no_expected_files/input/one.txt

@@ -0,0 +1 @@
+file one

data/test/test/file_methods/test_assert_files_fails_for_no_expected_files/input/two.txt

@@ -0,0 +1 @@
+file two

data/test/test/file_methods_doc/test_sub/expected/one.txt

@@ -0,0 +1 @@
+test output 1

data/test/test/file_methods_doc/test_sub/expected/two.txt

@@ -0,0 +1 @@
+test output 2

data/test/test/file_methods_doc/test_sub/input/one.txt

@@ -0,0 +1 @@
+test input 1

data/test/test/file_methods_doc/test_sub/input/two.txt

@@ -0,0 +1 @@
+test input 2

data/test/test/file_methods_doc_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), '../tap_test_helper.rb') 
+require 'tap/test/file_methods'
+
+# documentation test
+class FileMethodsDocTest < Test::Unit::TestCase
+  acts_as_file_test
+
+  def test_something
+    dir = File.expand_path( File.dirname(__FILE__) )
+    assert_equal dir + "/file_methods_doc", trs.root
+    assert_equal dir + "/file_methods_doc/test_something", method_root
+    assert_equal dir + "/file_methods_doc/test_something/input", method_dir(:input)  
+  end
+  
+  def test_sub
+    assert_files do |input_files|
+      input_files.collect do |filepath|
+        input = File.read(filepath)
+        output_file = method_filepath(:output, File.basename(filepath))
+
+        File.open(output_file, "w") do |f|
+          f << input.gsub(/input/, "output")
+        end 
+        
+        output_file
+      end
+    end
+  end
+end

data/test/test/file_methods_test.rb

@@ -6,21 +6,21 @@ class FileMethodsTest < Test::Unit::TestCase
   acts_as_file_test
   
   def test_method_name_returns_test_method_name1
-    assert_equal "test_method_name_returns_test_method_name1", method_name  
+    assert_equal "test_method_name_returns_test_method_name1", method_name_str  
   end
   
   def test_method_name_returns_test_method_name2
-    assert_equal "test_method_name_returns_test_method_name2", method_name  
+    assert_equal "test_method_name_returns_test_method_name2", method_name_str  
   end
   
-	def test_make_test_directories 
+  def test_make_test_directories 
     root = File.expand_path(File.join(File.dirname(__FILE__), "file_methods"))
     begin
-		  assert_equal root, trs[:root]
-		  assert_equal({
-				  :input => 'input', 
-				  :output => 'output', 
-				  :expected => 'expected'}, trs.directories)
+      assert_equal root, trs[:root]
+      assert_equal({
+          :input => 'input', 
+          :output => 'output', 
+          :expected => 'expected'}, trs.directories)
       
       trs.directories.values.each do |dir|
         assert !File.exists?(File.join(root, "test_make_test_directories", dir.to_s)), dir
@@ -35,133 +35,95 @@ class FileMethodsTest < Test::Unit::TestCase
       dir =  File.join(File.join(root, "test_make_test_directories"))
       FileUtils.rm_r dir if File.exists?(dir)
     end
-	end
+  end
 
-	#
-	# method filepath tests
-	#
+  #
+  # method filepath tests
+  #
 
-	def test_method_dir_adds_method_to_path	
-		assert_equal File.join(trs.root, method_name, "input"), method_dir(:input)
-	end
-	
-	def test_method_filepath_adds_method_to_path
-    input_root = File.join(trs.root, method_name, "input")
-		assert_equal File.join(input_root, "file.txt"), method_filepath(:input, 'file.txt')
-		assert_equal File.join(input_root, "folder/file.txt"), method_filepath(:input, 'folder', 'file.txt')
-	end
+  def test_method_dir_adds_method_to_path  
+    assert_equal File.join(trs.root, method_name_str, "input"), method_dir(:input)
+  end
+  
+  def test_method_filepath_adds_method_to_path
+    input_root = File.join(trs.root, method_name_str, "input")
+    assert_equal File.join(input_root, "file.txt"), method_filepath(:input, 'file.txt')
+    assert_equal File.join(input_root, "folder/file.txt"), method_filepath(:input, 'folder', 'file.txt')
+  end
 
-	#
-	# method relative filepath tests
-	#
+  #
+  # method relative filepath tests
+  #
 
-	def test_method_relative_filepath_removes_method_dir	
-    input_root = File.join(trs.root, method_name, "input")
-		assert_equal 'file.txt', method_relative_filepath(:input,  File.join(input_root, "file.txt"))
-		assert_equal 'folder/file.txt', method_relative_filepath(:input, File.join(input_root, "folder/file.txt"))
-	end
+  def test_method_relative_filepath_removes_method_dir  
+    input_root = File.join(trs.root, method_name_str, "input")
+    assert_equal 'file.txt', method_relative_filepath(:input,  File.join(input_root, "file.txt"))
+    assert_equal 'folder/file.txt', method_relative_filepath(:input, File.join(input_root, "folder/file.txt"))
+  end
 
-	def test_method_relative_filepath_expands_filepaths
-    input_root = File.join(trs.root, method_name, "input")
-		assert_equal 'file.txt', method_relative_filepath(:input, File.join(input_root, "folder/.././file.txt") )
-	end
-	
-	def test_method_relative_filepath_raises_error_unless_filepath_begins_with_method_dir
-		assert_raise(RuntimeError) { method_relative_filepath(:input, File.join('some/path', trs[:input], 'file.txt') ) }
-	end
-	
-	#
-	# method translate tests
-	#
-	
-	def test_method_translate
-		['file.txt', 'folder/file.txt'].each do |path|
-			filepath = File.join(trs.root, method_name, "input", path)
-			expected = File.join(trs.root, method_name, "output", path)
-		
-			assert_equal expected, method_translate(filepath, :input, :output)
-		end
-	end	
-	
-	#
-	# method glob tests
-	#
-	
-	def test_method_glob
-		{
-			[:expected] => ["file.yml", "file_1.txt", "file_2.txt"],
-			[:expected, "*"] => ["file.yml", "file_1.txt", "file_2.txt"],
-			[:expected, "*.txt"] => ["file_1.txt", "file_2.txt"],
-			[:expected, "*.txt", "*.yml"] => ["file.yml", "file_1.txt", "file_2.txt"]
-		}.each_pair do |testcase, expected|
-			expected.collect! { |file| method_filepath(:expected, file) }
-			
-			assert_equal expected.sort, method_glob(*testcase).sort
-		end
-	end	
-	
-	#
-	# tempfile test
-	#
-	
-	def test_tempfile_returns_new_file_in_output_dir
-    output_root = File.join(trs.root, method_name, "output")
+  def test_method_relative_filepath_expands_filepaths
+    input_root = File.join(trs.root, method_name_str, "input")
+    assert_equal 'file.txt', method_relative_filepath(:input, File.join(input_root, "folder/.././file.txt") )
+  end
+  
+  def test_method_relative_filepath_raises_error_unless_filepath_begins_with_method_dir
+    assert_raise(RuntimeError) { method_relative_filepath(:input, File.join('some/path', trs[:input], 'file.txt') ) }
+  end
+  
+  #
+  # method translate tests
+  #
+  
+  def test_method_translate
+    ['file.txt', 'folder/file.txt'].each do |path|
+      filepath = File.join(trs.root, method_name_str, "input", path)
+      expected = File.join(trs.root, method_name_str, "output", path)
+    
+      assert_equal expected, method_translate(filepath, :input, :output)
+    end
+  end  
+  
+  #
+  # method glob tests
+  #
+  
+  def test_method_glob
+    {
+      [:expected] => ["file.yml", "file_1.txt", "file_2.txt"],
+      [:expected, "*"] => ["file.yml", "file_1.txt", "file_2.txt"],
+      [:expected, "*.txt"] => ["file_1.txt", "file_2.txt"],
+      [:expected, "*.txt", "*.yml"] => ["file.yml", "file_1.txt", "file_2.txt"]
+    }.each_pair do |testcase, expected|
+      expected.collect! { |file| method_filepath(:expected, file) }
+      
+      assert_equal expected.sort, method_glob(*testcase).sort
+    end
+  end  
+  
+  #
+  # output_tempfile test
+  #
+  
+  def test_output_tempfile_returns_new_file_in_output_dir
+    output_root = File.join(trs.root, method_name_str, "output")
+    
+    filepath =File.join(output_root, "file#{$$}.0")
+    assert_equal filepath, output_tempfile('file')
+    
+    filepath = File.join(output_root,  "file#{$$}.0")
+    assert_equal filepath, output_tempfile('file')
     
-		filepath =File.join(output_root, "file#{$$}.0")
-		assert_equal filepath, tempfile('file')
-		
-		filepath = File.join(output_root,  "file#{$$}.0")
-		assert_equal filepath, tempfile('file')
-		
-		FileUtils.touch filepath
-		filepath = File.join(output_root,  "file#{$$}.1")
-		assert_equal filepath, tempfile('file')
-		
-		FileUtils.touch filepath
-		filepath = File.join(output_root,  "file#{$$}.2")
-		assert_equal filepath, tempfile('file')
-	end
-	
-	#
-	# files equal test
-	#
-	
-	def test_file_compare
-		count = 0
-		each_pair(method_glob(:input, "*1*"), method_glob(:expected, "*1*") ) do |a, b|
-			assert files_equal?(a, b)
-			count += 1
-		end
-		assert_equal 1, count
-		
-		each_pair(method_glob(:input, "*2*"), method_glob(:expected, "*2*") ) do |a, b|
-			assert !files_equal?(a, b)
-			count += 1
-		end
-		assert_equal 2, count
-	end
-	
-	#
-	# yml equal test
-	#
-	
-	def test_yml_compare
-		count = 0
-		each_pair(method_glob(:input, "*1*"), method_glob(:expected, "*1*") ) do |a, b|
-			assert yml_equal?(a, b)
-			count += 1
-		end
-		assert_equal 1, count
-		
-		each_pair(method_glob(:input, "*2*"), method_glob(:expected, "*2*") ) do |a, b|
-			assert !yml_equal?(a, b)
-			count += 1
-		end
-		assert_equal 2, count
-	end
+    FileUtils.touch filepath
+    filepath = File.join(output_root,  "file#{$$}.1")
+    assert_equal filepath, output_tempfile('file')
+    
+    FileUtils.touch filepath
+    filepath = File.join(output_root,  "file#{$$}.2")
+    assert_equal filepath, output_tempfile('file')
+  end
   
   #
-  # assert_output_files_equal
+  # assert_files
   #
   
   def setup_file(dir, path, content)
@@ -173,32 +135,141 @@ class FileMethodsTest < Test::Unit::TestCase
     path
   end
   
-  def test_assert_output_files_equal
+  def test_assert_files
+    setup_file :input, "one.txt", "file one"
+    setup_file :input, "two.txt", "file two"
+    setup_file :expected, "one.txt", "processed file one"
+    setup_file :expected, "two.txt", "processed file two"
+    
+    assert_files do |input_files|
+      input_files.collect do |input_file|
+        target = method_filepath(:output, File.basename(input_file))
+        File.open(target, "w") do |file|
+          file << "processed "
+          file << File.read(input_file)
+        end
+        target
+      end
+    end
+  end
+  
+  def test_assert_files_fails_for_missing_expected_file
+    setup_file :input, "one.txt", "file one"
+    setup_file :input, "two.txt", "file two"
+    setup_file :expected, "one.txt", "processed file one"
+    
+    failed = false
+    begin
+      assert_files do |input_files|
+        input_files.collect do |input_file|
+          target = method_filepath(:output, File.basename(input_file))
+          File.open(target, "w") do |file|
+            file << "processed "
+            file << File.read(input_file)
+          end
+          target
+        end
+      end
+    rescue
+      failed = true 
+    end
+    
+    assert failed
+  end
+  
+  def test_assert_files_fails_for_missing_output_file
     setup_file :input, "one.txt", "file one"
     setup_file :input, "two.txt", "file two"
     setup_file :expected, "one.txt", "processed file one"
     setup_file :expected, "two.txt", "processed file two"
+     
+    failed = false
+    begin
+      assert_files do |input_files|
+        input_files.collect do |input_file|
+          target = method_filepath(:output, File.basename(input_file))
+          File.open(target, "w") do |file|
+            file << "processed "
+            file << File.read(input_file)
+          end
+          target
+        end.first
+      end
+    rescue
+      failed = true 
+    end
+    
+    assert failed
+  end
+  
+  def test_assert_files_fails_for_different_content
+    setup_file :input, "one.txt", "file one"
+    setup_file :input, "two.txt", "file two"
+    setup_file :expected, "one.txt", "processed file FLUNK"
+    setup_file :expected, "two.txt", "processed file two"
     
-    assert_output_files_equal(:iterate_inputs => true) do |input_file|
-      target = method_filepath(:output, File.basename(input_file))
-      File.open(target, "w") do |file|
-        file << "processed "
-        file << File.read(input_file)
+    failed = false
+    begin
+      assert_files do |input_files|
+        input_files.collect do |input_file|
+          target = method_filepath(:output, File.basename(input_file))
+          File.open(target, "w") do |file|
+            file << "processed "
+            file << File.read(input_file)
+          end
+          target
+        end
+      end
+    rescue
+      failed = true 
+    end
+    
+    assert failed
+  end
+  
+  def test_assert_files_fails_for_no_expected_files
+    setup_file :input, "one.txt", "file one"
+    setup_file :input, "two.txt", "file two"
+   
+    was_in_block = false
+    failed = false
+    begin
+      assert_files do |input_files| 
+        was_in_block = true
+        []
       end
-      target
+    rescue
+      failed = true 
     end
+    
+    assert failed
+    assert !was_in_block
+  end
+  
+  def test_assert_files_can_have_no_expected_files_if_specified
+    setup_file :input, "one.txt", "file one"
+    setup_file :input, "two.txt", "file two"
+   
+    was_in_block = false
+    assert_files :expected_files => [] do |input_files| 
+      assert_equal 2, input_files.length
+      was_in_block = true
+      []
+    end
+
+    assert was_in_block
   end
 end
 
 class FileTestTestWithOptions < Test::Unit::TestCase
-	acts_as_file_test :root => "some/root/dir"
-	
-	def test_test_setup
-		assert_equal File.expand_path("some/root/dir"), trs[:root]
-		assert_equal({
-				:input => 'input', 
-				:output => 'output', 
-				:expected => 'expected'}, trs.directories)
-	end
+  acts_as_file_test :root => "some/root/dir"
+  
+  def test_test_setup
+    assert_equal File.expand_path("some/root/dir"), trs[:root]
+    assert_equal({
+        :input => 'input', 
+        :output => 'output', 
+        :expected => 'expected'}, trs.directories)
+  end
 end