Group SCM-specific functions in classes to simplify generalization of the interface.

tests/gclient_scm_test.py

 #!/usr/bin/python
 #
 # Copyright 2008-2009 Google Inc.  All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #      http://www.apache.org/licenses/LICENSE-2.0
 #
@@ skipping 15 matching lines @@
 from super_mox import mox, SuperMoxBaseTestBase
 
 
 class BaseTestCase(GCBaseTestCase):
   def setUp(self):
     GCBaseTestCase.setUp(self)
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'FileRead')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'FileWrite')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'SubprocessCall')
     self.mox.StubOutWithMock(gclient_scm.gclient_utils, 'RemoveDirectory')
-    self._CaptureSVNInfo = gclient_scm.CaptureSVNInfo
-    self.mox.StubOutWithMock(gclient_scm, 'CaptureSVN')
-    self.mox.StubOutWithMock(gclient_scm, 'CaptureSVNInfo')
-    self.mox.StubOutWithMock(gclient_scm, 'CaptureSVNStatus')
-    self.mox.StubOutWithMock(gclient_scm, 'RunSVN')
-    self.mox.StubOutWithMock(gclient_scm, 'RunSVNAndGetFileList')
+    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, 'Run')
+    self.mox.StubOutWithMock(gclient_scm.scm.SVN, 'RunAndGetFileList')
     self._scm_wrapper = gclient_scm.CreateSCM
 
 
 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.nohooks = False
 
   def Options(self, *args, **kwargs):
     return self.OptionsObject(self, *args, **kwargs)
 
   def setUp(self):
     BaseTestCase.setUp(self)
     self.root_dir = self.Dir()
     self.args = self.Args()
     self.url = self.Url()
     self.relpath = 'asf'
 
   def testDir(self):
     members = [
-      'FullUrlForRelativeUrl', 'RunCommand', 'cleanup', 'diff', 'export',
-      'pack', 'relpath', 'revert', 'revinfo', 'runhooks', 'scm_name', 'status',
-      'update', 'url',
+        'COMMAND', 'Capture', 'CaptureHeadRevision', 'CaptureInfo',
+        'CaptureStatus', 'DiffItem', 'FullUrlForRelativeUrl', 'GetFileProperty',
+        'IsMoved', 'Run', 'RunAndFilterOutput', 'RunAndGetFileList',
+        'RunCommand', 'cleanup', 'diff', 'export', 'pack', 'relpath', 'revert',
+        'revinfo', 'runhooks', 'scm_name', 'status', 'update', 'url',
     ]
 
     # If you add a member, be sure to add the relevant test!
     self.compareMembers(self._scm_wrapper(), members)
 
   def testUnsupportedSCM(self):
     args = [self.url, self.root_dir, self.relpath]
     kwargs = {'scm_name' : 'foo'}
     exception_msg = 'Unsupported scm %(scm_name)s' % kwargs
     self.assertRaisesError(exception_msg, self._scm_wrapper, *args, **kwargs)
@@ skipping 26 matching lines @@
     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)
     # It'll to a checkout instead.
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path, '.git')
                                ).AndReturn(False)
     print("\n_____ %s is missing, synching instead" % self.relpath)
     # Checkout.
     gclient_scm.os.path.exists(base_path).AndReturn(False)
     files_list = self.mox.CreateMockAnything()
-    gclient_scm.RunSVNAndGetFileList(options, ['checkout', self.url, base_path],
-                                     self.root_dir, files_list)
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['checkout', self.url, base_path],
+                                          self.root_dir, files_list)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.revert(options, self.args, files_list)
 
   def testRevertNone(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)
-    gclient_scm.CaptureSVNStatus(base_path).AndReturn([])
-    gclient_scm.RunSVNAndGetFileList(options, ['update', '--revision', 'BASE'],
-                                     base_path, mox.IgnoreArg())
+    gclient_scm.scm.SVN.CaptureStatus(base_path).AndReturn([])
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['update', '--revision', 'BASE'],
+                                          base_path, mox.IgnoreArg())
 
     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)
 
   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')
     file_path2 = gclient_scm.os.path.join(base_path, 'b')
-    gclient_scm.CaptureSVNStatus(base_path).AndReturn(items)
+    gclient_scm.scm.SVN.CaptureStatus(base_path).AndReturn(items)
     gclient_scm.os.path.exists(file_path1).AndReturn(True)
     gclient_scm.os.path.isfile(file_path1).AndReturn(True)
     gclient_scm.os.remove(file_path1)
     gclient_scm.os.path.exists(file_path2).AndReturn(True)
     gclient_scm.os.path.isfile(file_path2).AndReturn(True)
     gclient_scm.os.remove(file_path2)
-    gclient_scm.RunSVNAndGetFileList(options, ['update', '--revision', 'BASE'],
-                                     base_path, mox.IgnoreArg())
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['update', '--revision', 'BASE'],
+                                          base_path, mox.IgnoreArg())
     print(gclient_scm.os.path.join(base_path, 'a'))
     print(gclient_scm.os.path.join(base_path, 'b'))
 
     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)
 
   def testRevertDirectory(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 = [
       ('~      ', 'a'),
     ]
-    gclient_scm.CaptureSVNStatus(base_path).AndReturn(items)
+    gclient_scm.scm.SVN.CaptureStatus(base_path).AndReturn(items)
     file_path = gclient_scm.os.path.join(base_path, 'a')
     print(file_path)
     gclient_scm.os.path.exists(file_path).AndReturn(True)
     gclient_scm.os.path.isfile(file_path).AndReturn(False)
     gclient_scm.os.path.isdir(file_path).AndReturn(True)
     gclient_scm.gclient_utils.RemoveDirectory(file_path)
     file_list1 = []
-    gclient_scm.RunSVNAndGetFileList(options, ['update', '--revision', 'BASE'],
-                                     base_path, mox.IgnoreArg())
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['update', '--revision', 'BASE'],
+                                          base_path, mox.IgnoreArg())
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     file_list2 = []
     scm.revert(options, self.args, file_list2)
 
   def testStatus(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)
-    gclient_scm.RunSVNAndGetFileList(options, ['status'] + self.args,
-                                     base_path, []).AndReturn(None)
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['status'] + self.args,
+                                          base_path, []).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)
 
 
   # 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.RunSVNAndGetFileList(options, ['checkout', self.url,
-                                     base_path], self.root_dir, files_list)
+    gclient_scm.scm.SVN.RunAndGetFileList(options,
+                                          ['checkout', self.url, base_path],
+                                          self.root_dir, files_list)
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.update(options, (), files_list)
 
   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',
       'Revision': 42,
     }
     gclient_scm.os.path.exists(gclient_scm.os.path.join(base_path, '.git')
                                ).AndReturn(False)
     # Checkout or update.
     gclient_scm.os.path.exists(base_path).AndReturn(True)
-    gclient_scm.CaptureSVNInfo(gclient_scm.os.path.join(base_path, "."), '.'
-                               ).AndReturn(file_info)
+    gclient_scm.scm.SVN.CaptureInfo(
+        gclient_scm.os.path.join(base_path, "."), '.'
+        ).AndReturn(file_info)
     # Cheat a bit here.
-    gclient_scm.CaptureSVNInfo(file_info['URL'], '.').AndReturn(file_info)
+    gclient_scm.scm.SVN.CaptureInfo(file_info['URL'], '.').AndReturn(file_info)
     additional_args = []
     if options.manually_grab_svn_rev:
       additional_args = ['--revision', str(file_info['Revision'])]
     files_list = []
-    gclient_scm.RunSVNAndGetFileList(options,
-                                     ['update', base_path] + additional_args,
-                                     self.root_dir, files_list)
+    gclient_scm.scm.SVN.RunAndGetFileList(
+        options,
+        ['update', base_path] + additional_args,
+        self.root_dir, files_list)
 
     self.mox.ReplayAll()
     scm = self._scm_wrapper(url=self.url, root_dir=self.root_dir,
                             relpath=self.relpath)
     scm.update(options, (), files_list)
 
   def testUpdateGit(self):
     options = self.Options(verbose=True)
     file_path = gclient_scm.os.path.join(self.root_dir, self.relpath, '.git')
     gclient_scm.os.path.exists(file_path).AndReturn(True)
@@ skipping 87 matching lines @@
     self.base_path = gclient_scm.os.path.join(self.root_dir, self.relpath)
     self.enabled = self.CreateGitRepo(self.sample_git_import, self.base_path)
     SuperMoxBaseTestBase.setUp(self)
 
   def tearDown(self):
     SuperMoxBaseTestBase.tearDown(self)
     shutil.rmtree(self.root_dir)
 
   def testDir(self):
     members = [
-      'FullUrlForRelativeUrl', 'RunCommand', 'cleanup', 'diff', 'export',
-      'relpath', 'revert', 'revinfo', 'runhooks', 'scm_name', 'status',
-      'update', 'url',
+        'COMMAND', 'Capture', 'CaptureStatus', 'FullUrlForRelativeUrl',
+        'RunCommand', 'cleanup', 'diff', 'export', 'relpath', 'revert',
+        'revinfo', 'runhooks', 'scm_name', 'status', 'update', 'url',
     ]
 
     # If you add a member, be sure to add the relevant test!
     self.compareMembers(gclient_scm.CreateSCM(url=self.url), members)
 
   def testRevertMissing(self):
     if not self.enabled:
       return
     options = self.Options()
     file_path = gclient_scm.os.path.join(self.base_path, 'a')
@@ skipping 130 matching lines @@
                                 relpath=self.relpath)
     rev_info = scm.revinfo(options, (), None)
     self.assertEquals(rev_info, '069c602044c5388d2d15c3f875b057c852003458')
 
 
 if __name__ == '__main__':
   import unittest
   unittest.main()
 
 # vim: ts=2:sw=2:tw=80:et: