Changeset 112150 in webkit

Timestamp:

Mar 26, 2012 2:58:15 PM (12 years ago)

Author:

dpranke@chromium.org

Message:

add a Tree abstraction to test-webkitpy to better encapsulate things
​https://bugs.webkit.org/show_bug.cgi?id=82158

Reviewed by Adam Barth.

There are no functional changes in this patch, but adding a
basic abstraction for the trees we are looking in for python
tests will allow me to add some features later on more easily
(like ignoring certain directories like webkitpy/thirdparty),
and it makes things slightly less hard-coded.

• Scripts/test-webkitpy:
• Scripts/webkitpy/test/main.py:

(Tester.init):
(Tester):
(Tester.add_tree):
(Tester._parse_args):
(Tester._configure):
(Tester.run):
(Tester._find_modules):
(Tester._run_tests):
(Tester._is_module):
(Tester._log_exception):
(TestDirectoryTree):
(TestDirectoryTree.init):
(TestDirectoryTree.find_modules):
(TestDirectoryTree.clean):

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/test-webkitpy (modified) (2 diffs)
• Scripts/webkitpy/test/main.py (modified) (8 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2012-03-26  Dirk Pranke  <dpranke@chromium.org>
+
+        add a Tree abstraction to test-webkitpy to better encapsulate things
+        https://bugs.webkit.org/show_bug.cgi?id=82158
+
+        Reviewed by Adam Barth.
+
+        There are no functional changes in this patch, but adding a
+        basic abstraction for the trees we are looking in for python
+        tests will allow me to add some features later on more easily
+        (like ignoring certain directories like webkitpy/thirdparty),
+        and it makes things slightly less hard-coded.
+
+        * Scripts/test-webkitpy:
+        * Scripts/webkitpy/test/main.py:
+        (Tester.__init__):
+        (Tester):
+        (Tester.add_tree):
+        (Tester._parse_args):
+        (Tester._configure):
+        (Tester.run):
+        (Tester._find_modules):
+        (Tester._run_tests):
+        (Tester._is_module):
+        (Tester._log_exception):
+        (TestDirectoryTree):
+        (TestDirectoryTree.__init__):
+        (TestDirectoryTree.find_modules):
+        (TestDirectoryTree.clean):
+
 2012-03-26  Ojan Vafai  <ojan@chromium.org>
 

trunk/Tools/Scripts/test-webkitpy

@@ -45 +45 @@
     webkit_root = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
-    # FIXME: We should probably test each package separately to avoid naming conflicts.
-    dirs = [
-        os.path.join(webkit_root, 'Tools', 'Scripts'),
-        os.path.join(webkit_root, 'Source', 'WebKit2', 'Scripts'),
-    ]
+    tester = main.Tester()
+    tester.add_tree(os.path.join(webkit_root, 'Tools', 'Scripts'), 'webkitpy')
+    tester.add_tree(os.path.join(webkit_root, 'Source', 'WebKit2', 'Scripts'), 'webkit2')
 
     # FIXME: Do we need to be able to test QueueStatusServer on Windows as well?
@@ -60 +58 @@
         use_library('django', '1.2')
         dev_appserver.fix_sys_path()
-        dirs.append(os.path.join(webkit_root, 'Tools', 'QueueStatusServer'))
+        tester.add_tree(os.path.join(webkit_root, 'Tools', 'QueueStatusServer'))
     else:
         _log.info('Skipping QueueStatusServer tests; the Google AppEngine Python SDK is not installed.')
 
-    main.Tester.clean_packages(dirs)
-
-    tester = main.Tester()
-    options, args = tester.parse_args(sys.argv)
-    tester.configure(options)
-
-    # Make sure PYTHONPATH is set up correctly so that all of the imports will work.
-    sys.path = [d for d in dirs if d not in sys.path] + sys.path
-
-    sys.exit(not tester.run(dirs, args))
+    sys.exit(not tester.run())

trunk/Tools/Scripts/webkitpy/test/main.py

@@ -37 +37 @@
 
 class Tester(object):
-    @staticmethod
-    def clean_packages(dirs):
-        """Delete all .pyc files under dirs that have no .py file."""
-        for dir_to_clean in dirs:
-            _log.debug("Cleaning orphaned *.pyc files from: %s" % dir_to_clean)
-            for dir_path, dir_names, file_names in os.walk(dir_to_clean):
-                for file_name in file_names:
-                    if file_name.endswith(".pyc") and file_name[:-1] not in file_names:
-                        file_path = os.path.join(dir_path, file_name)
-                        _log.info("Deleting orphan *.pyc file: %s" % file_path)
-                        os.remove(file_path)
-
     def __init__(self):
         self._verbosity = 1
-
-    def parse_args(self, argv):
+        self._trees = []
+
+    def add_tree(self, top_directory, starting_subdirectory=None):
+        self._trees.append(TestDirectoryTree(top_directory, starting_subdirectory))
+
+    def _parse_args(self):
         parser = optparse.OptionParser(usage='usage: %prog [options] [args...]')
         parser.add_option('-a', '--all', action='store_true', default=False,
@@ -72 +64 @@
                          'If no args are given, all the tests will be run.')
 
-        self.progName = os.path.basename(argv[0])
-        return parser.parse_args(argv[1:])
-
-    def configure(self, options):
+        return parser.parse_args()
+
+    def _configure(self, options):
         self._options = options
 
@@ -142 +133 @@
         handler.addFilter(testing_filter)
 
-    def run(self, dirs, args):
-        args = args or self._find_modules(dirs)
-        return self._run_tests(dirs, args)
-
-    def _find_modules(self, dirs):
+    def run(self):
+        options, args = self._parse_args()
+        self._configure(options)
+
+        for tree in self._trees:
+            tree.clean()
+
+        args = args or self._find_modules()
+        return self._run_tests(args)
+
+    def _find_modules(self):
+        suffixes = ['_unittest.py']
+        if not self._options.skip_integrationtests:
+            suffixes.append('_integrationtest.py')
+
         modules = []
-        for dir_to_search in dirs:
-            modules.extend(self._find_modules_under(dir_to_search, '_unittest.py'))
-            if not self._options.skip_integrationtests:
-                modules.extend(self._find_modules_under(dir_to_search, '_integrationtest.py'))
+        for tree in self._trees:
+            modules.extend(tree.find_modules(suffixes))
         modules.sort()
 
@@ -182 +181 @@
         _log.info('')
 
-    def _find_modules_under(self, dir_to_search, suffix):
-
-        def to_package(dir_path):
-            return dir_path.replace(dir_to_search + os.sep, '').replace(os.sep, '.')
-
-        def to_module(filename, package):
-            return package + '.' + filename.replace('.py', '')
-
-        modules = []
-        for dir_path, _, filenames in os.walk(dir_to_search):
-            package = to_package(dir_path)
-            modules.extend(to_module(f, package) for f in filenames if f.endswith(suffix))
-        return modules
-
-    def _run_tests(self, dirs, args):
+    def _run_tests(self, args):
         if self._options.coverage:
             try:
@@ -206 +191 @@
             cov.start()
 
+        # Make sure PYTHONPATH is set up properly.
+        sys.path = [tree.top_directory for tree in self._trees if tree.top_directory not in sys.path] + sys.path
+
         _log.debug("Loading the tests...")
 
@@ -211 +199 @@
         suites = []
         for name in args:
-            if self._is_module(dirs, name):
+            if self._is_module(name):
                 # import modules explicitly before loading their tests because
                 # loadTestsFromName() produces lousy error messages for bad modules.
@@ -237 +225 @@
         return result.wasSuccessful()
 
-    def _is_module(self, dirs, name):
+    def _is_module(self, name):
         relpath = name.replace('.', os.sep) + '.py'
-        return any(os.path.exists(os.path.join(d, relpath)) for d in dirs)
+        return any(os.path.exists(os.path.join(tree.top_directory, relpath)) for tree in self._trees)
 
     def _log_exception(self):
@@ -246 +234 @@
         for l in s.buflist:
             _log.error('  ' + l.rstrip())
+
+
+class TestDirectoryTree(object):
+    def __init__(self, top_directory, starting_subdirectory):
+        self.top_directory = os.path.realpath(top_directory)
+        self.search_directory = self.top_directory
+        self.top_package = ''
+        if starting_subdirectory:
+            self.top_package = starting_subdirectory.replace(os.sep, '.') + '.'
+            self.search_directory = os.path.join(self.top_directory, starting_subdirectory)
+
+    def find_modules(self, suffixes):
+        modules = []
+        for dir_path, _, filenames in os.walk(self.search_directory):
+            dir_path = os.path.join(dir_path, '')
+            package = dir_path.replace(self.top_directory + os.sep, '').replace(os.sep, '.')
+            for f in filenames:
+                if any(f.endswith(suffix) for suffix in suffixes):
+                    modules.append(package + f.replace('.py', ''))
+        return modules
+
+    def clean(self):
+        """Delete all .pyc files in the tree that have no matching .py file."""
+        _log.debug("Cleaning orphaned *.pyc files from: %s" % self.search_directory)
+        for dir_path, dir_names, file_names in os.walk(self.search_directory):
+            for file_name in file_names:
+                if file_name.endswith(".pyc") and file_name[:-1] not in file_names:
+                    file_path = os.path.join(dir_path, file_name)
+                    _log.info("Deleting orphan *.pyc file: %s" % file_path)
+                    os.remove(file_path)