2009-11-25 Eric Seidel <eric@webkit.org>
authoreric@webkit.org <eric@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 25 Nov 2009 15:46:04 +0000 (15:46 +0000)
committereric@webkit.org <eric@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 25 Nov 2009 15:46:04 +0000 (15:46 +0000)
        Reviewed by Adam Barth.

        Abstract out capturing stdout/stderr into a new OutputCapture class for re-use among the various unit tests.
        https://bugs.webkit.org/show_bug.cgi?id=31870

        * Scripts/modules/commands/queries_unittest.py: Use the new class.
        * Scripts/modules/multicommandtool_unittest.py: Ditto.
        * Scripts/modules/outputcapture.py: Added.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@51381 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitTools/ChangeLog
WebKitTools/Scripts/modules/commands/queries_unittest.py
WebKitTools/Scripts/modules/multicommandtool_unittest.py
WebKitTools/Scripts/modules/outputcapture.py [new file with mode: 0644]

index f71d8f72a0bc435fe6ed93a3ee621d9527ac59cb..31c4fbccc4ca217f680692a9da02fff7aa4d2e6f 100644 (file)
@@ -1,3 +1,14 @@
+2009-11-25  Eric Seidel  <eric@webkit.org>
+
+        Reviewed by Adam Barth.
+
+        Abstract out capturing stdout/stderr into a new OutputCapture class for re-use among the various unit tests.
+        https://bugs.webkit.org/show_bug.cgi?id=31870
+
+        * Scripts/modules/commands/queries_unittest.py: Use the new class.
+        * Scripts/modules/multicommandtool_unittest.py: Ditto.
+        * Scripts/modules/outputcapture.py: Added.
+
 2009-11-24  Dmitry Titov  <dimich@chromium.org>
 
         Reviewed by Eric Seidel.
index 6bae72222bc3936ac7df2d682dc9fe561a61b7a1..d081c529b73c38c1cf3225242ced09d03ee41031 100644 (file)
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import unittest
-from StringIO import StringIO
 
 from modules.commands.queries import *
 from modules.mock_bugzillatool import *
+from modules.outputcapture import OutputCapture
 
 class QueryCommandsTest(unittest.TestCase):
-    def _capture_output_with_name(output_name):
-        self.saved_outputs[output_name] = getattr(sys, output_name)
-        setattr(sys, output_name, StringIO.StringIO())
-
-    def _release_output_with_name(output_name):
-        captured_output = getattr(sys, output_name).getvalue()
-        setattr(sys, output_name, self.saved_outputs[output_name])
-        del self.saved_outputs[output_name]
-        return captured_output
-
-    def _capture_output(self):
-        self._capture_output_with_name("stdout")
-        self._capture_output_with_name("stderr")
-
-    def _restore_output(self):
-        return (self._release_output_with_name("stdout"), self._release_output_with_name("stderr"))
-
     def _assert_execute_outputs(self, command, command_args, expected_stdout, expected_stderr = ""):
-        self._capture_output()
+        capture = OutputCapture()
+        capture.capture_output()
         command.execute(None, command_args, MockBugzillaTool())
-        (stdout_string, stderr_string) = self._restore_output()
+        (stdout_string, stderr_string) = capture.restore_output()
         self.assertEqual(stdout_string, expected_stdout)
         self.assertEqual(expected_stderr, expected_stderr)
 
index dbae909fe3370bd7136b905e6d5260a3134d5c56..a7d59eca18b11efef557b1a721e31f3c88c9fa88 100644 (file)
@@ -29,7 +29,7 @@
 import sys
 import unittest
 from multicommandtool import MultiCommandTool, Command
-from StringIO import StringIO
+from modules.outputcapture import OutputCapture
 
 from optparse import make_option
 
@@ -66,16 +66,6 @@ class TrivialTool(MultiCommandTool):
 
 
 class MultiCommandToolTest(unittest.TestCase):
-    def _capture_stderr(self):
-        self.saved_stderr = sys.stderr
-        sys.stderr = StringIO()
-
-    def _release_stderr(self):
-        string = sys.stderr.getvalue()
-        sys.stderr = self.saved_stderr
-        self.saved_stderr = None
-        return string
-
     def _assert_split(self, args, expected_split):
         self.assertEqual(MultiCommandTool._split_args(args), expected_split)
 
@@ -103,12 +93,14 @@ class MultiCommandToolTest(unittest.TestCase):
         command_with_options = TrivialCommand(options=[make_option("--my_option")])
         tool = TrivialTool(commands=[command_with_options])
 
-        self._capture_stderr()
+        capture = OutputCapture()
+        capture.capture_output()
         exit_code = tool.main(["tool", "help", "trivial"])
-        help_text = self._release_stderr()
-        expected_subcommand_help = "  trivial [options]   help text\nOptions:\n  --my_option=MY_OPTION\n\n"
+        (stdout_string, stderr_string) = capture.restore_output()
+        expected_subcommand_help = "trivial [options]   help text\nOptions:\n  --my_option=MY_OPTION\n\n"
         self.assertEqual(exit_code, 0)
-        self.assertEqual(help_text, expected_subcommand_help)
+        self.assertEqual(stdout_string, "")
+        self.assertEqual(stderr_string, expected_subcommand_help)
 
 
 if __name__ == "__main__":
diff --git a/WebKitTools/Scripts/modules/outputcapture.py b/WebKitTools/Scripts/modules/outputcapture.py
new file mode 100644 (file)
index 0000000..f02fc5d
--- /dev/null
@@ -0,0 +1,53 @@
+# Copyright (c) 2009, Google Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Class for unittest support.  Used for capturing stderr/stdout.
+
+import sys
+from StringIO import StringIO
+
+class OutputCapture(object):
+    def __init__(self):
+        self.saved_outputs = dict()
+
+    def _capture_output_with_name(self, output_name):
+        self.saved_outputs[output_name] = getattr(sys, output_name)
+        setattr(sys, output_name, StringIO())
+
+    def _restore_output_with_name(self, output_name):
+        captured_output = getattr(sys, output_name).getvalue()
+        setattr(sys, output_name, self.saved_outputs[output_name])
+        del self.saved_outputs[output_name]
+        return captured_output
+
+    def capture_output(self):
+        self._capture_output_with_name("stdout")
+        self._capture_output_with_name("stderr")
+
+    def restore_output(self):
+        return (self._restore_output_with_name("stdout"), self._restore_output_with_name("stderr"))