Add automated sys.stdout check.

tests/gclient_scm_test.py

 #!/usr/bin/python
 # Copyright (c) 2010 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Unit tests for gclient_scm.py."""
 
 # Import before super_mox to keep valid references.
 from os import rename
 from shutil import rmtree
 import StringIO
 from subprocess import Popen, PIPE, STDOUT
 import tempfile
 import unittest
 import __builtin__
 
 # Fixes include path.
-from super_mox import mox, TestCaseUtils, SuperMoxTestBase
+from super_mox import mox, StdoutCheck, TestCaseUtils, SuperMoxTestBase
 
 import gclient_scm
 
 
 class GCBaseTestCase(object):
   def assertRaisesError(self, msg, fn, *args, **kwargs):
     """Like unittest's assertRaises() but checks for Gclient.Error."""
     try:
       fn(*args, **kwargs)
     except gclient_scm.gclient_utils.Error, e:
       self.assertEquals(e.args[0], msg)
     else:
       self.fail('%s not raised' % msg)
 
-  def setUp(self):
-    self.stdout = StringIO.StringIO()
-
-  def tearDown(self):
-    try:
-      self.stdout.getvalue()
-      self.fail()
-    except AttributeError:
-      pass
-
-  def checkstdout(self, expected):
-    value = self.stdout.getvalue()
-    self.stdout.close()
-    self.assertEquals(expected, value)
-
 
 class BaseTestCase(GCBaseTestCase, SuperMoxTestBase):
   def setUp(self):
-    GCBaseTestCase.setUp(self)
     SuperMoxTestBase.setUp(self)
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'CheckCall')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'CheckCallAndFilter')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils,
         'CheckCallAndFilterAndHeader')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'FileRead')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'FileWrite')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'Popen')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'RemoveDirectory')
     self._CaptureSVNInfo = gclient_scm.scm.SVN.CaptureInfo
     self.mox.StubOutWithMock(gclient_scm.scm.SVN, 'Capture')
     self.mox.StubOutWithMock(gclient_scm.scm.SVN, 'CaptureInfo')
     self.mox.StubOutWithMock(gclient_scm.scm.SVN, 'CaptureStatus')
     self.mox.StubOutWithMock(gclient_scm.scm.SVN, 'RunAndGetFileList')
     self._scm_wrapper = gclient_scm.CreateSCM
-    gclient_scm.sys.stdout.flush = lambda: None
     gclient_scm.scm.SVN.current_version = None
 
   def tearDown(self):
-    GCBaseTestCase.tearDown(self)
     SuperMoxTestBase.tearDown(self)
 
 
 class SVNWrapperTestCase(BaseTestCase):
   class OptionsObject(object):
      def __init__(self, test_case, verbose=False, revision=None):
       self.verbose = verbose
       self.revision = revision
       self.manually_grab_svn_rev = True
       self.deps_os = None
       self.force = False
       self.reset = False
       self.nohooks = False
-      self.stdout = test_case.stdout
+      self.stdout = gclient_scm.sys.stdout
 
   def Options(self, *args, **kwargs):
     return self.OptionsObject(self, *args, **kwargs)
 
   def setUp(self):
     BaseTestCase.setUp(self)
     self.url = self.SvnUrl()
 
   def testDir(self):
     members = [
         'FullUrlForRelativeUrl', 'RunCommand',
         'cleanup', 'diff', 'export', 'pack', 'relpath', 'revert',
         'revinfo', 'runhooks', 'status', 'update',
         'updatesingle', 'url',
     ]
 
     # If you add a member, be sure to add the relevant test!
     self.compareMembers(self._scm_wrapper('svn://a'), members)
-    self.checkstdout('')
 
   def testUnsupportedSCM(self):
     args = ['gopher://foo', self.root_dir, self.relpath]
     exception_msg = 'No SCM found for url gopher://foo'
     self.assertRaisesError(exception_msg, self._scm_wrapper, *args)
-    self.checkstdout('')
 
   def testSVNFullUrlForRelativeUrl(self):
     self.url = 'svn://a/b/c/d'
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     self.assertEqual(scm.FullUrlForRelativeUrl('/crap'), 'svn://a/b/crap')
-    self.checkstdout('')
 
   def testGITFullUrlForRelativeUrl(self):
     self.url = 'git://a/b/c/d'
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     self.assertEqual(scm.FullUrlForRelativeUrl('/crap'), 'git://a/b/c/crap')
-    self.checkstdout('')
 
   def testRunCommandException(self):
     options = self.Options(verbose=False)
     file_path = gclient_scm.os.path.join(self.root_dir, self.relpath, '.git')
     gclient_scm.os.path.exists(file_path).AndReturn(False)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     exception = "Unsupported argument(s): %s" % ','.join(self.args)
     self.assertRaisesError(exception, scm.RunCommand,
                            'update', options, self.args)
-    self.checkstdout('')
 
   def testRunCommandUnknown(self):
     # TODO(maruel): if ever used.
-    self.checkstdout('')
+    pass
 
   def testRevertMissing(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     gclient_scm.os.path.isdir(base_path).AndReturn(False)
     gclient_scm.scm.SVN.Capture(['--version']
         ).AndReturn('svn, version 1.5.1 (r32289)')
     # It'll to a checkout instead.
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path, '.git')
                                ).AndReturn(False)
@@ skipping 23 matching lines @@
                                           ['update', '--revision', 'BASE'],
                                           cwd=base_path,
                                           file_list=mox.IgnoreArg(),
                                           stdout=options.stdout)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     file_list = []
     scm.revert(options, self.args, file_list)
-    self.checkstdout('')
 
   def testRevert2Files(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     gclient_scm.os.path.isdir(base_path).AndReturn(True)
     items = [
       ('M      ', 'a'),
       ('A      ', 'b'),
     ]
     file_path1 = gclient_scm.os.path.join(base_path, 'a')
@@ skipping 55 matching lines @@
     gclient_scm.scm.SVN.RunAndGetFileList(options.verbose,
                                           ['status'] + self.args,
                                           cwd=base_path, file_list=[],
                                           stdout=options.stdout).AndReturn(None)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     file_list = []
     self.assertEqual(scm.status(options, self.args, file_list), None)
-    self.checkstdout('')
 
   # TODO(maruel):  TEST REVISIONS!!!
   # TODO(maruel):  TEST RELOCATE!!!
   def testUpdateCheckout(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     file_info = gclient_scm.gclient_utils.PrintableObject()
     file_info.root = 'blah'
     file_info.url = self.url
     file_info.uuid = 'ABC'
     file_info.revision = 42
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path, '.git')
                                ).AndReturn(False)
     # Checkout.
     gclient_scm.os.path.exists(base_path).AndReturn(False)
     files_list = self.mox.CreateMockAnything()
     gclient_scm.scm.SVN.Capture(['--version']
         ).AndReturn('svn, version 1.5.1 (r32289)')
     gclient_scm.scm.SVN.RunAndGetFileList(options.verbose,
                                           ['checkout', self.url, base_path,
                                            '--force'],
                                           cwd=self.root_dir,
                                           file_list=files_list,
                                           stdout=options.stdout)
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.update(options, (), files_list)
-    self.checkstdout('')
 
   def testUpdateUpdate(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     options.force = True
     options.nohooks = False
     file_info = {
       'Repository Root': 'blah',
       'URL': self.url,
       'UUID': 'ABC',
@@ skipping 21 matching lines @@
     files_list = []
     gclient_scm.scm.SVN.RunAndGetFileList(
         options.verbose,
         ['update', base_path] + additional_args,
         cwd=self.root_dir, file_list=files_list, stdout=options.stdout)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.update(options, (), files_list)
-    self.checkstdout('')
 
   def testUpdateSingleCheckout(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     file_info = {
       'URL': self.url,
       'Revision': 42,
     }
 
     # Checks to make sure that we support svn co --depth.
@@ skipping 17 matching lines @@
     gclient_scm.scm.SVN.RunAndGetFileList(options.verbose, ['update', 'DEPS'],
         cwd=base_path, file_list=files_list, stdout=options.stdout)
 
     # Now we fall back on scm.update().
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path, '.git')
         ).AndReturn(False)
     gclient_scm.os.path.exists(base_path).AndReturn(True)
     gclient_scm.scm.SVN.CaptureInfo(
         gclient_scm.os.path.join(base_path, ".")).AndReturn(file_info)
     gclient_scm.scm.SVN.CaptureInfo(file_info['URL']).AndReturn(file_info)
-    options.stdout.write("\n_____ %s at 42" % self.relpath)
-    options.stdout.write('\n')
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.updatesingle(options, ['DEPS'], files_list)
-    self.checkstdout(
-        2 * ('\n_____ %s at 42\n' % self.relpath))
+    self.checkstdout('\n_____ %s at 42\n' % self.relpath)
 
   def testUpdateSingleCheckoutSVN14(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     file_info = {
       'URL': self.url,
       'Revision': 42,
     }
 
     # Checks to make sure that we support svn co --depth.
     gclient_scm.scm.SVN.current_version = None
     gclient_scm.scm.SVN.Capture(['--version']
         ).AndReturn('svn, version 1.4.4 (r25188)')
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path)
         ).AndReturn(True)
 
     # When checking out a single file with svn 1.4, we use svn export
     files_list = self.mox.CreateMockAnything()
     gclient_scm.gclient_utils.CheckCallAndFilterAndHeader(
         ['svn', 'export', gclient_scm.os.path.join(self.url, 'DEPS'),
             gclient_scm.os.path.join(base_path, 'DEPS')],
         always=True, cwd=self.root_dir, stdout=options.stdout)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.updatesingle(options, ['DEPS'], files_list)
-    self.checkstdout('')
 
   def testUpdateSingleCheckoutSVNUpgrade(self):
     options = self.Options(verbose=True)
     base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     file_info = {
       'URL': self.url,
       'Revision': 42,
     }
 
     # Checks to make sure that we support svn co --depth.
@@ skipping 75 matching lines @@
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     file_list = []
     scm.update(options, self.args, file_list)
     self.checkstdout(
         ('________ found .git directory; skipping %s\n' % self.relpath))
 
 
-class GitWrapperTestCase(GCBaseTestCase, TestCaseUtils, unittest.TestCase):
+class GitWrapperTestCase(GCBaseTestCase, StdoutCheck, TestCaseUtils,
+                         unittest.TestCase):
   """This class doesn't use pymox."""
   class OptionsObject(object):
      def __init__(self, test_case, verbose=False, revision=None):
       self.verbose = verbose
       self.revision = revision
       self.manually_grab_svn_rev = True
       self.deps_os = None
       self.force = False
       self.reset = False
       self.nohooks = False
-      self.stdout = test_case.stdout
+      self.stdout = gclient_scm.sys.stdout
 
   sample_git_import = """blob
 mark :1
 data 6
 Hello
 
 blob
 mark :2
 data 4
 Bye
@@ skipping 52 matching lines @@
         stderr=STDOUT, cwd=path).communicate()
     Popen(['git', 'checkout', '-b', 'new', 'origin/master', '-q'], stdout=PIPE,
         stderr=STDOUT, cwd=path).communicate()
     Popen(['git', 'push', 'origin', 'origin/origin:origin/master', '-q'],
         stdout=PIPE, stderr=STDOUT, cwd=path).communicate()
     Popen(['git', 'config', '--unset', 'remote.origin.fetch'], stdout=PIPE,
         stderr=STDOUT, cwd=path).communicate()
     return True
 
   def setUp(self):
-    GCBaseTestCase.setUp(self)
     TestCaseUtils.setUp(self)
     unittest.TestCase.setUp(self)
     self.url = 'git://foo'
     self.root_dir = tempfile.mkdtemp()
     self.relpath = '.'
     self.base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     self.enabled = self.CreateGitRepo(self.sample_git_import, self.base_path)
+    StdoutCheck.setUp(self)
 
   def tearDown(self):
-    if not self.enabled:
-      self.checkstdout('')
-    GCBaseTestCase.tearDown(self)
+    StdoutCheck.tearDown(self)
     TestCaseUtils.tearDown(self)
     unittest.TestCase.tearDown(self)
     rmtree(self.root_dir)
 
   def testDir(self):
     members = [
         'FullUrlForRelativeUrl', 'RunCommand',
         'cleanup', 'diff', 'export', 'pack', 'relpath', 'revert',
         'revinfo', 'runhooks', 'status', 'update', 'url',
     ]
 
     # If you add a member, be sure to add the relevant test!
     self.compareMembers(gclient_scm.CreateSCM(url=self.url), members)
-    if self.enabled:
-      self.checkstdout('')
 
   def testRevertMissing(self):
     if not self.enabled:
       return
     options = self.Options()
     file_path = gclient_scm.os.path.join(self.base_path, 'a')
     scm = gclient_scm.CreateSCM(url=self.url, root_dir=self.root_dir,
                                 relpath=self.relpath)
     file_list = []
     scm.update(options, None, file_list)
@@ skipping 204 matching lines @@
     exception = ('\n____ . at refs/heads/master\n'
                  '\tYou have unstaged changes.\n'
                  '\tPlease commit, stash, or reset.\n')
     self.assertRaisesError(exception, scm.update, options, (), [])
     # The hash always changes. Use a cheap trick.
     start = ('\n________ running \'git commit -am test\' in \'%s\'\n'
              '[new ') % gclient_scm.os.path.join(self.root_dir, '.')
     end = ('] test\n 1 files changed, 1 insertions(+), '
          '1 deletions(-)\n\n_____ . at refs/heads/master\n'
          'Attempting rebase onto refs/remotes/origin/master...\n')
-    self.assertTrue(self.stdout.getvalue().startswith(start))
-    self.assertTrue(self.stdout.getvalue().endswith(end))
-    self.assertEquals(len(self.stdout.getvalue()), len(start) + len(end) + 7)
-    self.stdout.close()
+    self.assertTrue(gclient_scm.sys.stdout.getvalue().startswith(start))
+    self.assertTrue(gclient_scm.sys.stdout.getvalue().endswith(end))
+    self.assertEquals(len(gclient_scm.sys.stdout.getvalue()),
+                      len(start) + len(end) + 7)
+    gclient_scm.sys.stdout.close()
 
   def testUpdateNotGit(self):
     if not self.enabled:
       return
     options = self.Options()
     scm = gclient_scm.CreateSCM(url=self.url, root_dir=self.root_dir,
                                 relpath=self.relpath)
     git_path = gclient_scm.os.path.join(self.base_path, '.git')
     rename(git_path, git_path + 'foo')
     exception = ('\n____ . at refs/heads/master\n'
                  '\tPath is not a git repo. No .git dir.\n'
                  '\tTo resolve:\n'
                  '\t\trm -rf .\n'
                  '\tAnd run gclient sync again\n')
     self.assertRaisesError(exception, scm.update, options, (), [])
-    self.checkstdout('')
 
   def testRevinfo(self):
     if not self.enabled:
       return
     options = self.Options()
     scm = gclient_scm.CreateSCM(url=self.url, root_dir=self.root_dir,
                                 relpath=self.relpath)
     rev_info = scm.revinfo(options, (), None)
     self.assertEquals(rev_info, '069c602044c5388d2d15c3f875b057c852003458')
-    self.checkstdout('')
 
 
 if __name__ == '__main__':
   unittest.main()
 
 # vim: ts=2:sw=2:tw=80:et: