Tools/Scripts/webkitpy/tool/steps/checkstyle.py

   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 import os
  30
  31 from webkitpy.common.system.executive import ScriptError
  32 from webkitpy.tool.steps.abstractstep import AbstractStep
  33 from webkitpy.tool.steps.options import Options
  34 from webkitpy.common.system.deprecated_logging import error
  35
  36 class CheckStyle(AbstractStep):
  37     @classmethod
  38     def options(cls):
  39         return AbstractStep.options() + [
  40             Options.non_interactive,
  41             Options.check_style,
  42             Options.git_commit,
  43         ]
  44
  45     def run(self, state):
  46         if not self._options.check_style:
  47             return
  48         os.chdir(self._tool.scm().checkout_root)
  49
  50         args = []
  51         if self._options.git_commit:
  52             args.append("--git-commit")
  53             args.append(self._options.git_commit)
  54
  55         args.append("--diff-files")
  56         args.extend(self._changed_files(state))
  57
  58         try:
  59             self._tool.executive.run_and_throw_if_fail(self._tool.port().check_webkit_style_command() + args)
  60         except ScriptError, e:
  61             if self._options.non_interactive:
  62                 # We need to re-raise the exception here to have the
  63                 # style-queue do the right thing.
  64                 raise e
  65             if not self._tool.user.confirm("Are you sure you want to continue?"):
  66                 exit(1)