Add checks for READMEs for each virtual test suite.

Tools/Scripts/webkitpy/layout_tests/lint_test_expectations.py

 # Copyright (C) 2012 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
@@ skipping 28 matching lines @@
 # This mirrors what the shell normally does.
 INTERRUPTED_EXIT_STATUS = signal.SIGINT + 128
 
 # This is a randomly chosen exit code that can be tested against to
 # indicate that an unexpected exception occurred.
 EXCEPTIONAL_EXIT_STATUS = 254
 
 _log = logging.getLogger(__name__)
 
 
-def lint(host, options, logging_stream):
+def lint(host, options):
+    # FIXME: Remove this when we remove the --chromium flag (crbug.com/245504).
+    if options.platform == 'chromium':
+        options.platform = None
+
+    ports_to_lint = [host.port_factory.get(name) for name in host.port_factory.all_port_names(options.platform)]
+    files_linted = set()
+    lint_failed = False
+
+    for port_to_lint in ports_to_lint:
+        expectations_dict = port_to_lint.expectations_dict()
+
+        for expectations_file in expectations_dict.keys():
+            if expectations_file in files_linted:
+                continue
+
+            try:
+                test_expectations.TestExpectations(port_to_lint,
+                    expectations_dict={expectations_file: expectations_dict[expectations_file]},
+                    is_lint_mode=True)
+            except test_expectations.ParseError as e:
+                lint_failed = True
+                _log.error('')
+                for warning in e.warnings:
+                    _log.error(warning)
+                _log.error('')
+            files_linted.add(expectations_file)
+    return lint_failed
+
+
+def check_virtual_test_suites(host, options):
+    port = host.port_factory.get(options=options)
+    fs = host.filesystem
+    layout_tests_dir = port.layout_tests_dir()
+    virtual_suites = port.virtual_test_suites()
+
+    check_failed = False
+    for suite in virtual_suites:
+        comps = [layout_tests_dir] + suite.name.split('/') + ['README.txt']
+        path_to_readme = fs.join(*comps)
+        if not fs.exists(path_to_readme):
+            _log.error('LayoutTests/%s/README.txt is missing (each virtual suite must have one).' % suite.name)
+            check_failed = True
+    if check_failed:
+        _log.error('')
+    return check_failed
+
+
+def set_up_logging(logging_stream):
     logger = logging.getLogger()
     logger.setLevel(logging.INFO)
     handler = logging.StreamHandler(logging_stream)
     logger.addHandler(handler)
+    return (logger, handler)
 
+
+def tear_down_logging(logger, handler):
+    logger.removeHandler(handler)
+
+
+def run_checks(host, options, logging_stream):
+    logger, handler = set_up_logging(logging_stream)
     try:
-        # FIXME: Remove this when we remove the --chromium flag (crbug.com/245504).
-        if options.platform == 'chromium':
-            options.platform = None
-
-        ports_to_lint = [host.port_factory.get(name) for name in host.port_factory.all_port_names(options.platform)]
-        files_linted = set()
-        lint_failed = False
-
-        for port_to_lint in ports_to_lint:
-            expectations_dict = port_to_lint.expectations_dict()
-
-            for expectations_file in expectations_dict.keys():
-                if expectations_file in files_linted:
-                    continue
-
-                try:
-                    test_expectations.TestExpectations(port_to_lint,
-                        expectations_dict={expectations_file: expectations_dict[expectations_file]},
-                        is_lint_mode=True)
-                except test_expectations.ParseError as e:
-                    lint_failed = True
-                    _log.error('')
-                    for warning in e.warnings:
-                        _log.error(warning)
-                    _log.error('')
-                files_linted.add(expectations_file)
-
-        if lint_failed:
+        lint_failed = lint(host, options)
+        check_failed = check_virtual_test_suites(host, options)
+        if lint_failed or check_failed:
             _log.error('Lint failed.')
-            return -1
-
-        _log.info('Lint succeeded.')
-        return 0
+            return 1
+        else:
+            _log.info('Lint succeeded.')
+            return 0
     finally:
         logger.removeHandler(handler)
 
 
 def main(argv, _, stderr):
     parser = optparse.OptionParser(option_list=platform_options(use_globs=True))
     options, _ = parser.parse_args(argv)
 
     if options.platform and 'test' in options.platform:
         # It's a bit lame to import mocks into real code, but this allows the user
         # to run tests against the test platform interactively, which is useful for
         # debugging test failures.
         from webkitpy.common.host_mock import MockHost
         host = MockHost()
     else:
         host = Host()
 
     try:
-        exit_status = lint(host, options, stderr)
+        exit_status = run_checks(host, options, stderr)
     except KeyboardInterrupt:
         exit_status = INTERRUPTED_EXIT_STATUS
     except Exception as e:
         print >> stderr, '\n%s raised: %s' % (e.__class__.__name__, str(e))
         traceback.print_exc(file=stderr)
         exit_status = EXCEPTIONAL_EXIT_STATUS
 
     return exit_status