Changeset 90480 in webkit

Timestamp:

Jul 6, 2011 12:10:25 PM (13 years ago)

Author:

dbates@webkit.org

Message:

2011-07-06 Daniel Bates <​dbates@webkit.org>

Make SCM unit tests faster
​https://bugs.webkit.org/show_bug.cgi?id=63883

Speeds up the SCM unit tests by a factor of 4. Currently, we create a
mock SVN repo for each test_ method in SVNTest and GitTest and creating
this repo is expensive.

Instead, it is significantly faster to create the mock SVN repo once
and then perform a filesystem copy of it for each test_ method.

Note, Python 2.7's unittest module implements support for per class and
per module setup and tear down methods which could be used to implement
similar functionality. At the time of writing, test-webkitpy is designed
to support Python 2.5. So, we can't take advantage of these Python 2.7
features :(

Reviewed by Eric Seidel.

• Scripts/webkitpy/common/checkout/scm/scm_unittest.py:

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/common/checkout/scm/scm_unittest.py (modified) (5 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2011-07-06  Daniel Bates  <dbates@webkit.org>
+
+        Make SCM unit tests faster
+        https://bugs.webkit.org/show_bug.cgi?id=63883
+
+        Speeds up the SCM unit tests by a factor of 4. Currently, we create a
+        mock SVN repo for each test_ method in SVNTest and GitTest and creating
+        this repo is expensive.
+
+        Instead, it is significantly faster to create the mock SVN repo once
+        and then perform a filesystem copy of it for each test_ method.
+
+        Note, Python 2.7's unittest module implements support for per class and
+        per module setup and tear down methods which could be used to implement
+        similar functionality. At the time of writing, test-webkitpy is designed
+        to support Python 2.5. So, we can't take advantage of these Python 2.7
+        features :(
+
+        Reviewed by Eric Seidel.
+
+        * Scripts/webkitpy/common/checkout/scm/scm_unittest.py:
+
 2011-07-06  Adam Barth  <abarth@webkit.org>
 

trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm_unittest.py

@@ -31 +31 @@
 from __future__ import with_statement
 
+import atexit
 import base64
 import codecs
@@ -58 +59 @@
 from .svn import SVN
 
+# We cache the mock SVN repo so that we don't create it again for each call to an SVNTest or GitTest test_ method.
+# We store it in a global variable so that we can delete this cached repo on exit(3).
+# FIXME: Remove this once we migrate to Python 2.7. Unittest in Python 2.7 supports module-specific setup and teardown functions.
+cached_svn_repo_path = None
+
+
+def remove_dir(path):
+    # Change directory to / to ensure that we aren't in the directory we want to delete.
+    os.chdir('/')
+    shutil.rmtree(path)
+
+
+# FIXME: Remove this once we migrate to Python 2.7. Unittest in Python 2.7 supports module-specific setup and teardown functions.
+@atexit.register
+def delete_cached_mock_repo_at_exit():
+    if cached_svn_repo_path:
+        remove_dir(cached_svn_repo_path)
 
 # Eventually we will want to write tests which work for both scms. (like update_webkit, changed_files, etc.)
@@ -112 +130 @@
 
     @classmethod
-    def _setup_test_commits(cls, test_object):
+    def _setup_test_commits(cls, svn_repo_url):
+
+        svn_checkout_path = tempfile.mkdtemp(suffix="svn_test_checkout")
+        run_command(['svn', 'checkout', '--quiet', svn_repo_url, svn_checkout_path])
+
         # Add some test commits
-        os.chdir(test_object.svn_checkout_path)
+        os.chdir(svn_checkout_path)
 
         write_into_file_at_path("test_file", "test1")
@@ -146 +168 @@
         # svn does not seem to update after commit as I would expect.
         run_command(['svn', 'update'])
-
+        remove_dir(svn_checkout_path)
+
+    # This is a hot function since it's invoked by unittest before calling each test_ method in SVNTest and
+    # GitTest. We create a mock SVN repo once and then perform an SVN checkout from a filesystem copy of
+    # it since it's expensive to create the mock repo.
     @classmethod
     def setup(cls, test_object):
+        global cached_svn_repo_path
+        if not cached_svn_repo_path:
+            cached_svn_repo_path = cls._setup_mock_repo()
+
+        test_object.temp_directory = tempfile.mkdtemp(suffix="svn_test")
+        test_object.svn_repo_path = os.path.join(test_object.temp_directory, "repo")
+        test_object.svn_repo_url = "file://%s" % test_object.svn_repo_path
+        test_object.svn_checkout_path = os.path.join(test_object.temp_directory, "checkout")
+        shutil.copytree(cached_svn_repo_path, test_object.svn_repo_path)
+        run_command(['svn', 'checkout', '--quiet', test_object.svn_repo_url + "/trunk", test_object.svn_checkout_path])
+
+    @classmethod
+    def _setup_mock_repo(cls):
         # Create an test SVN repository
-        test_object.svn_repo_path = tempfile.mkdtemp(suffix="svn_test_repo")
-        test_object.svn_repo_url = "file://%s" % test_object.svn_repo_path # Not sure this will work on windows
+        svn_repo_path = tempfile.mkdtemp(suffix="svn_test_repo")
+        svn_repo_url = "file://%s" % svn_repo_path  # Not sure this will work on windows
         # git svn complains if we don't pass --pre-1.5-compatible, not sure why:
         # Expected FS format '2'; found format '3' at /usr/local/libexec/git-core//git-svn line 1477
-        run_command(['svnadmin', 'create', '--pre-1.5-compatible', test_object.svn_repo_path])
+        run_command(['svnadmin', 'create', '--pre-1.5-compatible', svn_repo_path])
 
         # Create a test svn checkout
-        test_object.svn_checkout_path = tempfile.mkdtemp(suffix="svn_test_checkout")
-        run_command(['svn', 'checkout', '--quiet', test_object.svn_repo_url, test_object.svn_checkout_path])
+        svn_checkout_path = tempfile.mkdtemp(suffix="svn_test_checkout")
+        run_command(['svn', 'checkout', '--quiet', svn_repo_url, svn_checkout_path])
 
         # Create and checkout a trunk dir to match the standard svn configuration to match git-svn's expectations
-        os.chdir(test_object.svn_checkout_path)
+        os.chdir(svn_checkout_path)
         os.mkdir('trunk')
         cls._svn_add('trunk')
@@ -168 +207 @@
 
         # Change directory out of the svn checkout so we can delete the checkout directory.
-        # _setup_test_commits will CD back to the svn checkout directory.
-        os.chdir('/')
-        run_command(['rm', '-rf', test_object.svn_checkout_path])
-        run_command(['svn', 'checkout', '--quiet', test_object.svn_repo_url + '/trunk', test_object.svn_checkout_path])
-
-        cls._setup_test_commits(test_object)
+        remove_dir(svn_checkout_path)
+
+        cls._setup_test_commits(svn_repo_url + "/trunk")
+        return svn_repo_path
 
     @classmethod
     def tear_down(cls, test_object):
-        run_command(['rm', '-rf', test_object.svn_repo_path])
-        run_command(['rm', '-rf', test_object.svn_checkout_path])
+        remove_dir(test_object.temp_directory)
 
         # Now that we've deleted the checkout paths, cwddir may be invalid