qunited 0.3.1 → 0.4.0

data/test/unit/driver/test_results_collector.rb

@@ -0,0 +1,186 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'stringio'
+
+class TestResultsCollector < MiniTest::Unit::TestCase
+  def setup
+    @io = StringIO.new
+    @results_collector = QUnited::Driver::ResultsCollector.new(@io)
+  end
+
+  def test_must_be_initialized_with_io_object
+    assert_raises(ArgumentError) { QUnited::Driver::ResultsCollector.new }
+    QUnited::Driver::ResultsCollector.new(@io)
+  end
+
+  def test_on_test_result_must_be_given_a_block
+    assert_raises(ArgumentError) { @results_collector.on_test_result }
+    @results_collector.on_test_result { |result| }
+  end
+
+  def test_on_test_result_block_is_called_when_test_results_are_parsed
+    collected_results = []
+    @results_collector.on_test_result { |result| collected_results << result }
+
+    @io.puts two_tests_output
+    @io.rewind
+
+    @results_collector.collect_results
+
+    assert_equal 2, collected_results.size, 'The correct number of results have been collected'
+    assert collected_results.all? {|result| result.is_a? QUnited::QUnitTestResult }, 'Test results are the correct type'
+  end
+
+  def test_results_can_be_collected_with_other_lines_mixed_in
+    collected_results = []
+    @results_collector.on_test_result { |result| collected_results << result }
+
+    @io.puts two_tests_output_with_other_lines_mixed_in
+    @io.rewind
+
+    @results_collector.collect_results
+
+    assert_equal 2, collected_results.size, 'The correct number of results have been collected'
+    assert collected_results.all? {|result| result.is_a? QUnited::QUnitTestResult }, 'Test results are the correct type'
+  end
+
+  def test_one_line_test_results_are_ok
+    output = QUnited::Driver::ResultsCollector::TEST_RESULT_START_TOKEN +
+      %|{ "assertion_data": [{ "actual": 1, "expected": 1, "message": "This is fine", "result": true }], | +
+      %|"assertions": 1, "duration": 0.001, "failed": 0, "file": "", "module_name": "(no module)", | +
+      %|"name": "Just a test", "start": "2013-03-02T21:52:30.000Z", "total": 1 }| +
+      QUnited::Driver::ResultsCollector::TEST_RESULT_END_TOKEN
+
+    collected_results = []
+    @results_collector.on_test_result { |result| collected_results << result }
+
+    @io.puts output
+    @io.rewind
+
+    @results_collector.collect_results
+
+    assert_equal 1, collected_results.size, 'The correct number of results have been collected'
+    assert collected_results.all? {|result| result.is_a? QUnited::QUnitTestResult }, 'Test results are the correct type'
+  end
+
+  def test_on_non_test_result_line_must_be_given_a_block
+    assert_raises(ArgumentError) { @results_collector.on_non_test_result_line }
+    @results_collector.on_non_test_result_line { |line| }
+  end
+
+  def test_non_test_result_lines_can_be_captured
+    stray_lines = []
+    @results_collector.on_non_test_result_line { |line| stray_lines << line }
+
+    @io.puts two_tests_output_with_other_lines_mixed_in
+    @io.rewind
+
+    @results_collector.collect_results
+
+    assert_equal 4, stray_lines.size, 'The correct number of non test result lines have been collected'
+    assert stray_lines.all? {|line| line.is_a? String }, 'Other lines are all strings'
+    assert_equal "This is some other output\n", stray_lines[0], 'Line content is correct'
+    assert_equal "This is another with a blank line after it\n", stray_lines[1], 'Line content is correct'
+    assert_equal "\n", stray_lines[2], 'Can even get blank lines'
+    assert_equal "And another line at the end\n", stray_lines[3], 'Line content is correct'
+  end
+
+  private
+
+  def two_tests_output
+    output = <<RAW_OUTPUT
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_START_TOKEN}
+{
+ "assertion_data": [
+  {
+   "actual": 1,
+   "expected": 1,
+   "message": "This is fine",
+   "result": true
+  }
+ ],
+ "assertions": 1,
+ "duration": 0.001,
+ "failed": 0,
+ "file": "",
+ "module_name": "(no module)",
+ "name": "Just a test",
+ "start": "2013-03-02T21:52:30.000Z",
+ "total": 1
+}
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_END_TOKEN}
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_START_TOKEN}
+{
+ "assertion_data": [
+  {
+   "actual": 1,
+   "expected": 1,
+   "message": "This is also fine",
+   "result": true
+  }
+ ],
+ "assertions": 1,
+ "duration": 0.003,
+ "failed": 0,
+ "file": "",
+ "module_name": "(no module)",
+ "name": "Just another test",
+ "start": "2013-03-02T21:52:33.000Z",
+ "total": 1
+}
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_END_TOKEN}
+RAW_OUTPUT
+
+  output
+  end
+
+  def two_tests_output_with_other_lines_mixed_in
+    output = <<RAW_OUTPUT
+This is some other output
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_START_TOKEN}
+{
+ "assertion_data": [
+  {
+   "actual": 1,
+   "expected": 1,
+   "message": "This is fine",
+   "result": true
+  }
+ ],
+ "assertions": 1,
+ "duration": 0.001,
+ "failed": 0,
+ "file": "",
+ "module_name": "(no module)",
+ "name": "Just a test",
+ "start": "2013-03-02T21:52:30.000Z",
+ "total": 1
+}
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_END_TOKEN}
+This is another with a blank line after it
+
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_START_TOKEN}
+{
+ "assertion_data": [
+  {
+   "actual": 1,
+   "expected": 1,
+   "message": "This is also fine",
+   "result": true
+  }
+ ],
+ "assertions": 1,
+ "duration": 0.003,
+ "failed": 0,
+ "file": "",
+ "module_name": "(no module)",
+ "name": "Just another test",
+ "start": "2013-03-02T21:52:33.000Z",
+ "total": 1
+}
+#{QUnited::Driver::ResultsCollector::TEST_RESULT_END_TOKEN}
+And another line at the end
+RAW_OUTPUT
+
+  output
+  end
+end

data/test/unit/driver_common_tests.rb

@@ -1,6 +1,16 @@
+require 'stringio'
+
 # Common driver tests that should pass for any implementation of
 # QUnited::Driver::Base. There are also a few utility methods included.
 module QUnited::DriverCommonTests
+  def setup
+    start_capture_streams
+  end
+
+  def teardown
+    stop_capture_streams
+  end
+
   def test_driver_available
     assert driver_class.available?, 'Driver should be available - if it is not then ' +
       'either the available? method has a bug or you do not have the proper environment ' +
@@ -9,39 +19,58 @@ module QUnited::DriverCommonTests
   end
 
   def test_running_basic_tests
-    results = run_for_project('basic_project')
-    assert_equal 3, results.total_tests, 'Correct number of tests run'
-    assert_equal 4, results.total_assertions, 'Correct number of assertions executed'
-    assert_equal 0, results.total_failures, 'Correct number of failures given'
+    @results = run_tests_for_project('basic_project')
+    assert_equal 3, total_tests, 'Correct number of tests run'
+    assert_equal 4, total_assertions, 'Correct number of assertions executed'
+    assert_equal 0, total_failed_tests, 'Correct number of failures given'
   end
 
   # Make sure we can run tests with DOM operations
   def test_running_dom_tests
-    results = run_for_project('dom_project')
-    assert_equal 1, results.total_tests, 'Correct number of tests run'
-    assert_equal 2, results.total_assertions, 'Correct number of assertions executed'
-    assert_equal 0, results.total_failures, 'Correct number of failures given'
+    @results = run_tests_for_project('dom_project')
+    assert_equal 1, total_tests, 'Correct number of tests run'
+    assert_equal 2, total_assertions, 'Correct number of assertions executed'
+    assert_equal 0, total_failed_tests, 'Correct number of failures given'
   end
 
   def test_failures_are_recorded_correctly
-    results = run_for_project('failures_project')
-    assert_equal 4, results.total_tests, 'Correct number of tests run'
+    @results = run_tests_for_project('failures_project')
+    assert_equal 4, total_tests, 'Correct number of tests run'
     # QUnit calls the log callback (the same it calls for assertions) every time there
     # is a failed expect(num). So add one to this total.
-    assert_equal 5 + 1, results.total_assertions, 'Correct number of assertions executed'
-    assert_equal 4, results.total_failures, 'Correct number of failures given'
+    assert_equal 5 + 1, total_assertions, 'Correct number of assertions executed'
+    assert_equal 3, total_failed_tests, 'Correct number of failed tests given'
+    assert_equal 4, total_failed_assertions, 'Correct number of failed assertions given'
+
+    # JavaScript null values should be properly serialized as null by the driver. If they are
+    # they will be deserialized as Ruby nil in QUnitTestResult. Then they can be converted back
+    # into null when displayed by the formatter. Make sure the result has nil.
+    math_test = @results.find { |result| result.name == 'Addition is hard' }
+    null_assertion = math_test.assertions.find { |assertion| assertion.message == 'This expected null' }
+    assert_equal nil, null_assertion.expected
   end
 
   def test_syntax_error_in_test
-    runner = driver_class.new(
+    driver = driver_class.new(
       [File.join(FIXTURES_DIR, 'errors_project/app/assets/javascripts/no_error.js')],
       [File.join(FIXTURES_DIR, 'errors_project/test/javascripts/this_test_has_syntax_error.js'),
         File.join(FIXTURES_DIR, 'errors_project/test/javascripts/this_test_has_no_errors_in_it.js')])
 
-    stderr = capture_stderr { runner.run }
+    driver.run
+    stderr = captured_stderr
     assert stderr.size > 10, 'Got some stderr output to describe the crash'
-    results = runner.results
-    assert runner.results.failed?, 'Should fail if syntax error in test'
+    @results = driver.results
+    assert total_failed_tests.size > 0, 'Should fail if syntax error in test'
+  end
+
+  def test_proper_formatter_methods_are_called_when_tests_pass
+    mock_formatter = mock
+    mock_formatter.expects(:start)
+    mock_formatter.expects(:test_passed).times(3)
+    mock_formatter.expects(:stop)
+    mock_formatter.expects(:summarize)
+
+    run_tests_for_project 'basic_project', :formatter => mock_formatter
   end
 
   protected
@@ -50,21 +79,53 @@ module QUnited::DriverCommonTests
     raise 'Must implement driver_class and return the driver class being tested'
   end
 
-  def run_for_project(project_name)
-    runner = runner_for_project(project_name)
-    runner.run
+  def run_tests_for_project(project_name, driver_opts={})
+    driver = driver_for_project(project_name, driver_opts)
+    driver.run
   end
 
-  def runner_for_project(project_name)
+  def driver_for_project(project_name, opts={})
     Dir.chdir File.join(FIXTURES_DIR, project_name)
-    driver_class.new("app/assets/javascripts/*.js", "test/javascripts/*.js")
+    driver = driver_class.new("app/assets/javascripts/*.js", "test/javascripts/*.js")
+    driver.formatter = opts[:formatter] if opts[:formatter]
+    driver
+  end
+
+  def start_capture_streams
+    @original_stdout, $stdout = $stdout, StringIO.new
+    @original_stderr, $stderr = $stderr, StringIO.new
+  end
+
+  def stop_capture_streams
+    $stdout, $stderr = @original_stdout, @original_stderr
   end
 
-  def capture_stderr
-    previous_stderr, $stderr = $stderr, StringIO.new
-    yield
+  def captured_stdout
+    $stdout.string
+  end
+
+  def captured_stderr
     $stderr.string
-  ensure
-    $stderr = previous_stderr
+  end
+
+
+  def total_tests
+    @results.size
+  end
+
+  def total_failed_tests
+    @results.select { |tr| tr.failed? }.size
+  end
+
+  def total_error_tests
+    @results.select { |tr| tr.error? }.size
+  end
+
+  def total_assertions
+    @results.inject(0) { |total, result| total += result.assertions.size}
+  end
+
+  def total_failed_assertions
+    @results.inject(0) { |total, result| total += result.assertions.select { |a| a.failed? }.size }
   end
 end

data/test/unit/formatter/test_dots.rb

@@ -0,0 +1,250 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'date'
+require 'stringio'
+
+# Test running tests with the Rhino driver.
+class TestDots < MiniTest::Unit::TestCase
+  def setup
+    @output = StringIO.new
+    @formatter = ::QUnited::Formatter::Dots.new({:driver_name => 'FakeDriver', :output => @output})
+  end
+
+  def test_basic_output
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    @formatter.test_passed create_result([
+      create_assertion(:message => 'good assertion 1'),
+      create_assertion(:message => 'good assertion 2')
+    ])
+    assert_output_equals '.'
+
+    @formatter.test_passed create_result([
+      create_assertion({ :result => true, :message => "doesn't matter" })
+    ])
+    assert_output_equals '.'
+
+    @formatter.stop
+    @formatter.summarize
+
+    seconds = 0.02
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (2 / seconds)} tests/s, #{'%.6g' % (3 / seconds)} assertions/s.
+
+2 tests, 3 assertions, 0 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+  def test_ok_failure_output
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    msg = "This should be true"
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg })
+    ])
+    assert_output_equals 'F'
+
+    @formatter.stop
+    @formatter.summarize
+
+    seconds = 0.01
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (1 / seconds)} tests/s, #{'%.6g' % (1 / seconds)} assertions/s.
+
+  1) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg}
+
+1 tests, 1 assertions, 1 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+  def test_equal_failure_output
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    msg = "These strings match"
+    expected, actual = "String here", "Other string here"
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg,
+                :expected => expected, :actual => actual })
+    ])
+    assert_output_equals 'F'
+
+    @formatter.stop
+    @formatter.summarize
+
+    seconds = 0.01
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (1 / seconds)} tests/s, #{'%.6g' % (1 / seconds)} assertions/s.
+
+  1) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg}
+Expected: "#{expected}"
+  Actual: "#{actual}"
+
+1 tests, 1 assertions, 1 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+  def test_equal_with_null_failure_output
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    msg = "These strings match"
+    expected, actual = 1, nil
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg,
+                :expected => expected, :actual => actual })
+    ])
+    assert_output_equals 'F'
+
+    @formatter.stop
+    @formatter.summarize
+
+    seconds = 0.01
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (1 / seconds)} tests/s, #{'%.6g' % (1 / seconds)} assertions/s.
+
+  1) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg}
+Expected: 1
+  Actual: null
+
+1 tests, 1 assertions, 1 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+   def test_failure_output_with_no_file
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    msg = "This should be true"
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg })
+    ], {:file => nil})
+    assert_output_equals 'F'
+
+    @formatter.stop
+    @formatter.summarize
+    
+    seconds = 0.01
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (1 / seconds)} tests/s, #{'%.6g' % (1 / seconds)} assertions/s.
+
+  1) Failure:
+This stuff should work (My Tests)
+#{msg}
+
+1 tests, 1 assertions, 1 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+  def test_multiple_failure_output
+    @formatter.start
+    assert_output_equals "\n# Running JavaScript tests with FakeDriver:\n\n"
+
+    msg1 = "This should be true"
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg1 })
+    ])
+    assert_output_equals 'F'
+
+    msg2 = "These strings match"
+    msg3 = "Another thing that should be true"
+    expected, actual = "String here", "Other string here"
+    @formatter.test_failed create_result([
+      create_assertion({ :result => false, :message => msg2,
+        :expected => expected, :actual => actual }),
+      create_assertion({ :result => false, :message => msg3 })
+    ])
+    assert_output_equals 'F'
+
+    @formatter.stop
+    @formatter.summarize
+
+    seconds = 0.01 * 2
+
+    expected = <<EXPECTED_OUTPUT
+
+
+Finished in #{'%.6g' % seconds} seconds, #{'%.6g' % (2 / seconds)} tests/s, #{'%.6g' % (3 / seconds)} assertions/s.
+
+  1) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg1}
+
+  2) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg2}
+Expected: "#{expected}"
+  Actual: "#{actual}"
+
+  3) Failure:
+This stuff should work (My Tests) [something_test.js]
+#{msg3}
+
+2 tests, 3 assertions, 2 failures, 0 errors
+EXPECTED_OUTPUT
+
+    assert_output_equals expected
+  end
+
+  private
+
+  def assert_output_equals(string)
+    assert_equal string, @output.string
+    clear_output
+  end
+
+  def clear_output
+    @output.truncate(@output.rewind)
+  end
+
+  def create_result(assertions=nil, data={})
+    assertions ||= [create_assertion]
+    QUnited::QUnitTestResult.new({
+      :assertion_data => assertions,
+      :assertions => assertions.size,
+      :duration => 0.010,
+      :failed => assertions.select {|a| !a[:result]}.size,
+      :file => "something_test.js",
+      :module_name => "My Tests",
+      :name => "This stuff should work",
+      :start => DateTime.now,
+      :total => assertions.size
+    }.merge(data))
+  end
+
+  def create_assertion(data={})
+    { :message => 'This is the message', :result => true }.merge(data)
+  end
+end

data/test/unit/test_phantomjs_driver.rb

@@ -1,6 +1,5 @@
 require File.expand_path('../../test_helper', __FILE__)
 require File.expand_path('../driver_common_tests', __FILE__)
-require 'stringio'
 
 # Test running tests with the PhantomJs driver.
 class TestPhantomJsDriver < MiniTest::Unit::TestCase
@@ -9,7 +8,7 @@ class TestPhantomJsDriver < MiniTest::Unit::TestCase
   private
 
   def driver_class
-    QUnited::Driver::PhantomJs
+    ::QUnited::Driver::PhantomJs
   end
 
 end