Home | History | Annotate | Download | only in checkers
      1 # Copyright (C) 2010 Google Inc. All rights reserved.
      2 #
      3 # Redistribution and use in source and binary forms, with or without
      4 # modification, are permitted provided that the following conditions are
      5 # met:
      6 #
      7 #     * Redistributions of source code must retain the above copyright
      8 # notice, this list of conditions and the following disclaimer.
      9 #     * Redistributions in binary form must reproduce the above
     10 # copyright notice, this list of conditions and the following disclaimer
     11 # in the documentation and/or other materials provided with the
     12 # distribution.
     13 #     * Neither the name of Google Inc. nor the names of its
     14 # contributors may be used to endorse or promote products derived from
     15 # this software without specific prior written permission.
     16 #
     17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28 
     29 """Checks WebKit style for test_expectations files."""
     30 
     31 import logging
     32 import optparse
     33 import os
     34 import re
     35 import sys
     36 
     37 from common import TabChecker
     38 from webkitpy.common.host import Host
     39 from webkitpy.layout_tests.models.test_expectations import TestExpectationParser
     40 
     41 
     42 _log = logging.getLogger(__name__)
     43 
     44 
     45 class TestExpectationsChecker(object):
     46     """Processes TestExpectations lines for validating the syntax."""
     47 
     48     categories = set(['test/expectations'])
     49 
     50     def __init__(self, file_path, handle_style_error, host=None):
     51         self._file_path = file_path
     52         self._handle_style_error = handle_style_error
     53         self._tab_checker = TabChecker(file_path, handle_style_error)
     54 
     55         # FIXME: host should be a required parameter, not an optional one.
     56         host = host or Host()
     57         host.initialize_scm()
     58 
     59         self._port_obj = host.port_factory.get()
     60 
     61         # Suppress error messages of test_expectations module since they will be reported later.
     62         log = logging.getLogger("webkitpy.layout_tests.layout_package.test_expectations")
     63         log.setLevel(logging.CRITICAL)
     64 
     65     def _handle_error_message(self, lineno, message, confidence):
     66         pass
     67 
     68     def check_test_expectations(self, expectations_str, tests=None):
     69         parser = TestExpectationParser(self._port_obj, tests, is_lint_mode=True)
     70         expectations = parser.parse('expectations', expectations_str)
     71 
     72         level = 5
     73         for expectation_line in expectations:
     74             for warning in expectation_line.warnings:
     75                 self._handle_style_error(expectation_line.line_numbers, 'test/expectations', level, warning)
     76 
     77     def check_tabs(self, lines):
     78         self._tab_checker.check(lines)
     79 
     80     def check(self, lines):
     81         expectations = '\n'.join(lines)
     82         if self._port_obj:
     83             self.check_test_expectations(expectations_str=expectations, tests=None)
     84 
     85         # Warn tabs in lines as well
     86         self.check_tabs(lines)
     87