# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+import codecs
import logging
-import os
import sys
-from webkitpy.common.system.ospath import relpath as _relpath
+import webkitpy.style.checker as checker
+from webkitpy.style.patchreader import PatchReader
+from webkitpy.style.checker import StyleProcessor
+from webkitpy.style.filereader import TextFileReader
+from webkitpy.common.host import Host
_log = logging.getLogger(__name__)
-def change_directory(checkout_root, paths, mock_os=None):
+def change_directory(filesystem, checkout_root, paths):
"""Change the working directory to the WebKit checkout root, if possible.
If every path in the paths parameter is below the checkout root (or if
checkout root, and for path-specific style checks to work as expected.
Path-specific checks include whether files should be skipped, whether
custom style rules should apply to certain files, etc.
- If the checkout root is None or the empty string, this method returns
- the paths parameter unchanged.
Returns:
paths: A copy of the paths parameter -- possibly converted, as follows.
If this method changed the current working directory to the
checkout root, then the list is the paths parameter converted to
- normalized paths relative to the checkout root. Otherwise, the
- paths are not converted.
+ normalized paths relative to the checkout root.
Args:
paths: A list of paths to the files that should be checked for style.
This argument can be None or the empty list if a git commit
or all changes under the checkout root should be checked.
- checkout_root: The path to the root of the WebKit checkout, or None or
- the empty string if no checkout could be detected.
- mock_os: A replacement module for unit testing. Defaults to os.
+ checkout_root: The path to the root of the WebKit checkout.
"""
- os_module = os if mock_os is None else mock_os
-
if paths is not None:
paths = list(paths)
- if not checkout_root:
- if not paths:
- raise Exception("The paths parameter must be non-empty if "
- "there is no checkout root.")
-
- # FIXME: Consider trying to detect the checkout root for each file
- # being checked rather than only trying to detect the checkout
- # root for the current working directory. This would allow
- # files to be checked correctly even if the script is being
- # run from outside any WebKit checkout.
- #
- # Moreover, try to find the "source root" for each file
- # using path-based heuristics rather than using only the
- # presence of a WebKit checkout. For example, we could
- # examine parent directories until a directory is found
- # containing JavaScriptCore, WebCore, WebKit, Websites,
- # and Tools.
- # Then log an INFO message saying that a source root not
- # in a WebKit checkout was found. This will allow us to check
- # the style of non-scm copies of the source tree (e.g.
- # nightlies).
- _log.warn("WebKit checkout root not found:\n"
- " Path-dependent style checks may not work correctly.\n"
- " See the help documentation for more info.")
-
- return paths
-
if paths:
# Then try converting all of the paths to paths relative to
# the checkout root.
rel_paths = []
for path in paths:
- rel_path = _relpath(path, checkout_root)
+ rel_path = filesystem.relpath(path, checkout_root)
if rel_path is None:
# Then the path is not below the checkout root. Since all
# paths should be interpreted relative to the same root,
paths = rel_paths
_log.debug("Changing to checkout root: " + checkout_root)
- os_module.chdir(checkout_root)
+ filesystem.chdir(checkout_root)
return paths
+
+
+class CheckWebKitStyle(object):
+ def _engage_awesome_stderr_hacks(self):
+ # Change stderr to write with replacement characters so we don't die
+ # if we try to print something containing non-ASCII characters.
+ stderr = codecs.StreamReaderWriter(sys.stderr,
+ codecs.getreader('utf8'),
+ codecs.getwriter('utf8'),
+ 'replace')
+ # Setting an "encoding" attribute on the stream is necessary to
+ # prevent the logging module from raising an error. See
+ # the checker.configure_logging() function for more information.
+ stderr.encoding = "UTF-8"
+
+ # FIXME: Change webkitpy.style so that we do not need to overwrite
+ # the global sys.stderr. This involves updating the code to
+ # accept a stream parameter where necessary, and not calling
+ # sys.stderr explicitly anywhere.
+ sys.stderr = stderr
+ return stderr
+
+ def main(self):
+ args = sys.argv[1:]
+
+ host = Host()
+ host._initialize_scm()
+
+ stderr = self._engage_awesome_stderr_hacks()
+
+ # Checking for the verbose flag before calling check_webkit_style_parser()
+ # lets us enable verbose logging earlier.
+ is_verbose = "-v" in args or "--verbose" in args
+
+ checker.configure_logging(stream=stderr, is_verbose=is_verbose)
+ _log.debug("Verbose logging enabled.")
+
+ parser = checker.check_webkit_style_parser()
+ (paths, options) = parser.parse(args)
+
+ configuration = checker.check_webkit_style_configuration(options)
+
+ paths = change_directory(host.filesystem, checkout_root=host.scm().checkout_root, paths=paths)
+
+ style_processor = StyleProcessor(configuration)
+ file_reader = TextFileReader(host.filesystem, style_processor)
+
+ if paths and not options.diff_files:
+ file_reader.process_paths(paths)
+ else:
+ changed_files = paths if options.diff_files else None
+ patch = host.scm().create_patch(options.git_commit, changed_files=changed_files)
+ patch_checker = PatchReader(file_reader)
+ patch_checker.check(patch)
+
+ error_count = style_processor.error_count
+ file_count = file_reader.file_count
+ delete_only_file_count = file_reader.delete_only_file_count
+
+ _log.info("Total errors found: %d in %d files" % (error_count, file_count))
+ # We fail when style errors are found or there are no checked files.
+ return error_count > 0 or (file_count == 0 and delete_only_file_count == 0)
projects / framework / web / webkit-efl.git / blobdiff