Merge pull request #11 from kenichiice/capture-stdout

kenichiice · web-flow · commit cf418ba0e9d2 · 2022-01-12T10:57:46.000+09:00
&lt;system-out&gt;, &lt;system-err&gt;をサポートする
diff --git a/README.ja.md b/README.ja.md
@@ -22,6 +22,7 @@ require "test/unit/runner/junitxml"
 
 class MyTest < Test::Unit::TestCase
   def test_1
+    print("hello")
     assert_equal(1, 2)
   end
 end
@@ -32,20 +33,28 @@ $ ruby test.rb --runner=junitxml --junitxml-output-file=result.xml
 $ cat result.xml
 <?xml version="1.0" encoding="UTF-8" ?>
 <testsuites>
-	<testsuite name="MyTest" tests="1" errors="0" failures="1" skipped="0" time="0.0027089">
-		<testcase classname="MyTest" name="test_1(MyTest)" time="0.0026767" assertions="1">
+	<testsuite name="MyTest" tests="1" errors="0" failures="1" skipped="0" time="0.0047083">
+		<testcase classname="MyTest" name="test_1(MyTest)" time="0.0046712" assertions="1">
 			<failure message="&lt;1&gt; expected but was
 &lt;2&gt;.">
 Failure:
-test_1(MyTest) [test.rb:6]:
+test_1(MyTest) [test.rb:7]:
 &lt;1&gt; expected but was
 &lt;2&gt;.
 			</failure>
+			<system-out>hello</system-out>
 		</testcase>
 	</testsuite>
 </testsuites>
 ```
 
+## オプション
+
+* --junitxml-output-file=FILE_NAME
+  * XMLを、標準出力ではなく指定したファイルへ出力します。
+* --junitxml-disable-output-capture
+  * 標準出力と標準エラー出力のキャプチャを行わないようになります。
+
 ## ライセンス
 
 [MIT License](https://opensource.org/licenses/MIT)
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ require "test/unit/runner/junitxml"
 
 class MyTest < Test::Unit::TestCase
   def test_1
+    print("hello")
     assert_equal(1, 2)
   end
 end
@@ -32,20 +33,28 @@ $ ruby test.rb --runner=junitxml --junitxml-output-file=result.xml
 $ cat result.xml
 <?xml version="1.0" encoding="UTF-8" ?>
 <testsuites>
-	<testsuite name="MyTest" tests="1" errors="0" failures="1" skipped="0" time="0.0027089">
-		<testcase classname="MyTest" name="test_1(MyTest)" time="0.0026767" assertions="1">
+	<testsuite name="MyTest" tests="1" errors="0" failures="1" skipped="0" time="0.0047083">
+		<testcase classname="MyTest" name="test_1(MyTest)" time="0.0046712" assertions="1">
 			<failure message="&lt;1&gt; expected but was
 &lt;2&gt;.">
 Failure:
-test_1(MyTest) [test.rb:6]:
+test_1(MyTest) [test.rb:7]:
 &lt;1&gt; expected but was
 &lt;2&gt;.
 			</failure>
+			<system-out>hello</system-out>
 		</testcase>
 	</testsuite>
 </testsuites>
 ```
 
+## Options
+
+* --junitxml-output-file=FILE_NAME
+  * Output XML to the specified file instead of the standard output.
+* --junitxml-disable-output-capture
+  * Disable capture of standard output and standard error.
+
 ## License
 
 [MIT License](https://opensource.org/licenses/MIT)
diff --git a/lib/test/unit/runner/junitxml.rb b/lib/test/unit/runner/junitxml.rb
@@ -12,6 +12,10 @@ module Unit
               "Outputs to FILE_NAME") do |name|
         auto_runner.runner_options[:junitxml_output_file] = name
       end
+      opts.on("--junitxml-disable-output-capture",
+              "Disable output capture") do |b|
+        auto_runner.runner_options[:junitxml_disable_output_capture] = b
+      end
     end
   end
 end
diff --git a/lib/test/unit/ui/junitxml/testrunner.rb b/lib/test/unit/ui/junitxml/testrunner.rb
@@ -1,4 +1,5 @@
 require 'erb'
+require 'stringio'
 require 'test/unit/ui/testrunner'
 require 'test/unit/ui/testrunnermediator'
 
@@ -48,12 +49,22 @@ def test_suite_finished(suite)
           end
 
           def test_started(test)
-            @junit_test_suites.last << JUnitTestCase.new(test.class.name,
-                                                         test.description)
+            test_case = JUnitTestCase.new(test.class.name, test.description)
+            @junit_test_suites.last << test_case
+            unless @options[:junitxml_disable_output_capture]
+              @stdout_org = $stdout
+              @stderr_org = $stderr
+              $stdout = test_case.stdout
+              $stderr = test_case.stderr
+            end
           end
 
           def test_finished(test)
             @junit_test_suites.last.test_cases.last.time = test.elapsed_time
+            unless @options[:junitxml_disable_output_capture]
+              $stdout = @stdout_org
+              $stderr = @stderr_org
+            end
           end
 
           def result_pass_assertion(result)
@@ -116,15 +127,16 @@ def errors
         class JUnitTestCase
           attr_reader :class_name, :name
           attr_reader :failure, :error, :omission, :pending
+          attr_reader :stdout, :stderr
           attr_accessor :assertion_count, :time
 
           def initialize(class_name, name)
             @class_name = class_name
             @name = name
+            @stdout = StringIO.new
+            @stderr = StringIO.new
             @assertion_count = 0
             @time = 0
-            @omission = nil
-            @pending = nil
           end
 
           def <<(fault)
diff --git a/lib/test/unit/ui/junitxml/xml.erb b/lib/test/unit/ui/junitxml/xml.erb
@@ -16,6 +16,12 @@
 			<skipped message="<%=h test_case.omission.message %>"/>
 %		elsif test_case.pending
 			<skipped message="<%=h test_case.pending.message %>"/>
+%		end
+%		if test_case.stdout.size > 0
+			<system-out><%=h test_case.stdout.string %></system-out>
+%		end
+%		if test_case.stderr.size > 0
+			<system-err><%=h test_case.stderr.string %></system-err>
 %		end
 		</testcase>
 %	end
diff --git a/test/check.rb b/test/check.rb
@@ -11,20 +11,16 @@ def check_testsuite(testsuite, name, tests, errors, failures, skipped)
     assert_compare(0, "<", Float(testsuite.attribute("time").value))
   end
 
-  def check_testcase_success(testcase, class_name, assertions)
-    assert_equal(class_name, testcase.attribute("classname").value)
-    assert_equal(assertions.to_s, testcase.attribute("assertions").value)
-    assert_compare(0, "<", Float(testcase.attribute("time").value))
+  def check_testcase_success(testcase, class_name, assertions, out = nil, err = nil)
+    check_test_case(testcase, class_name, assertions, out, err)
 
     assert_equal(0, testcase.get_elements("failure").size)
     assert_equal(0, testcase.get_elements("error").size)
     assert_equal(0, testcase.get_elements("skipped").size)
   end
 
-  def check_testcase_failure(testcase, class_name, assertions, message = nil)
-    assert_equal(class_name, testcase.attribute("classname").value)
-    assert_equal(assertions.to_s, testcase.attribute("assertions").value)
-    assert_compare(0, "<", Float(testcase.attribute("time").value))
+  def check_testcase_failure(testcase, class_name, assertions, message = nil, out = nil, err = nil)
+    check_test_case(testcase, class_name, assertions, out, err)
 
     failures = testcase.get_elements("failure")
     assert_equal(1, failures.size)
@@ -38,10 +34,8 @@ def check_testcase_failure(testcase, class_name, assertions, message = nil)
     assert_equal(0, testcase.get_elements("skipped").size)
   end
 
-  def check_testcase_error(testcase, class_name, assertions, message = nil)
-    assert_equal(class_name, testcase.attribute("classname").value)
-    assert_equal(assertions.to_s, testcase.attribute("assertions").value)
-    assert_compare(0, "<", Float(testcase.attribute("time").value))
+  def check_testcase_error(testcase, class_name, assertions, message = nil, out = nil, err = nil)
+    check_test_case(testcase, class_name, assertions, out, err)
 
     errors = testcase.get_elements("error")
     assert_equal(1, errors.size)
@@ -56,10 +50,8 @@ def check_testcase_error(testcase, class_name, assertions, message = nil)
     assert_equal(0, testcase.get_elements("skipped").size)
   end
 
-  def check_testcase_skipped(testcase, class_name, assertions, message = nil)
-    assert_equal(class_name, testcase.attribute("classname").value)
-    assert_equal(assertions.to_s, testcase.attribute("assertions").value)
-    assert_compare(0, "<", Float(testcase.attribute("time").value))
+  def check_testcase_skipped(testcase, class_name, assertions, message = nil, out = nil, err = nil)
+    check_test_case(testcase, class_name, assertions, out, err)
 
     skipped = testcase.get_elements("skipped")
     assert_equal(1, skipped.size)
@@ -68,4 +60,26 @@ def check_testcase_skipped(testcase, class_name, assertions, message = nil)
     assert_equal(0, testcase.get_elements("failure").size)
     assert_equal(0, testcase.get_elements("error").size)
   end
+
+  def check_test_case(testcase, class_name, assertions, out = nil, err = nil)
+    assert_equal(class_name, testcase.attribute("classname").value)
+    assert_equal(assertions.to_s, testcase.attribute("assertions").value)
+    assert_compare(0, "<", Float(testcase.attribute("time").value))
+
+    system_outs = testcase.get_elements("system-out")
+    if out
+      assert_equal(1, system_outs.size)
+      assert_match(out, system_outs.first.text)
+    else
+      assert_equal(0, system_outs.size)
+    end
+
+    system_errs = testcase.get_elements("system-err")
+    if err
+      assert_equal(1, system_errs.size)
+      assert_match(err, system_errs.first.text)
+    else
+      assert_equal(0, system_errs.size)
+    end
+  end
 end
diff --git a/test/test_xml_with_output_capture.rb b/test/test_xml_with_output_capture.rb
@@ -0,0 +1,115 @@
+require "stringio"
+require 'rexml/document'
+require "test/unit"
+require "test/unit/ui/junitxml/testrunner"
+require_relative "check"
+
+class TestXmlWithOutput < Test::Unit::TestCase
+  include Check
+
+  setup do
+    test_case = Class.new(Test::Unit::TestCase) do
+      include Test::Unit::Util::Output
+
+      test "success" do
+        assert_equal(1, 1)
+        puts("out 1")
+      end
+
+      def test_failure
+        assert_equal(1, 1)
+        warn("warn 1")
+        assert_equal(1, 2)
+      end
+
+      def test_error
+        warn("warn 2")
+        puts("out 2")
+        assert_equal(1, 1)
+        assert_equal(1, 1)
+        assert_equal(1, 1)
+        raise "hello"
+      end
+
+      def test_omission
+        puts("out 3")
+        omit("omission 1")
+      end
+
+      def test_pending
+        warn("warn 3")
+        pend("pending 1")
+      end
+
+      def test_with_capture_output
+        out, err = capture_output do
+          puts("out 4")
+          warn("warn 4")
+        end
+        assert_equal("out 4\n", out)
+        assert_equal("warn 4\n", err)
+      end
+    end
+
+    output = StringIO.new
+    runner = Test::Unit::UI::JUnitXml::TestRunner.new(
+      test_case.suite, :output => output)
+    runner.start
+
+    output.rewind
+    @doc = REXML::Document.new(output)
+  end
+
+  test "testsuites" do
+    testsuites_array = @doc.get_elements("/testsuites")
+    assert_equal(1, testsuites_array.size)
+  end
+
+  test "testsuite" do
+    testsuite_array = @doc.get_elements("/testsuites/testsuite")
+    assert_equal(1, testsuite_array.size)
+    check_testsuite(testsuite_array.first, "", 6, 1, 1, 2)
+  end
+
+  test "testcase success" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='success']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_success(testcase_array.first, "", 1, "out 1")
+  end
+
+  test "testcase failure" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='test_failure()']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_failure(testcase_array.first, "", 2, /.+/, nil, "warn 1")
+  end
+
+  test "testcase error" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='test_error()']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_error(testcase_array.first, "", 3, "hello", "out 2", "warn 2")
+  end
+
+  test "testcase omission" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='test_omission()']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_skipped(testcase_array.first, "", 0, "omission 1", "out 3")
+  end
+
+  test "testcase pending" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='test_pending()']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_skipped(testcase_array.first, "", 0, "pending 1", nil, "warn 3")
+  end
+
+  test "testcase test_with_capture_output" do
+    testcase_array = @doc.get_elements(
+      "/testsuites/testsuite/testcase[@name='test_with_capture_output()']")
+    assert_equal(1, testcase_array.size)
+    check_testcase_success(testcase_array.first, "", 2)
+  end
+end
diff --git a/test/test_xml_without_output_capture.rb b/test/test_xml_without_output_capture.rb
