Home | History | Annotate | Download | only in steps 
      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 from webkitpy.tool.steps.abstractstep import AbstractStep
     30 from webkitpy.tool.steps.options import Options
     31 from webkitpy.common.checkout.diff_parser import DiffParser
     32 from webkitpy.common.system.deprecated_logging import error, log
     33 
     34 
     35 # This is closely related to the ValidateReviewer step and the CommitterValidator class.
     36 # We may want to unify more of this code in one place.
     37 class ValidateChangeLogs(AbstractStep):
     38     def _check_changelog_diff(self, diff_file):
     39         if not self._tool.checkout().is_path_to_changelog(diff_file.filename):
     40             return True
     41         # Each line is a tuple, the first value is the deleted line number
     42         # Date, reviewer, bug title, bug url, and empty lines could all be
     43         # identical in the most recent entries.  If the diff starts any
     44         # later than that, assume that the entry is wrong.
     45         if diff_file.lines[0][0] < 8:
     46             return True
     47         if self._options.non_interactive:
     48             return False
     49 
     50         log("The diff to %s looks wrong.  Are you sure your ChangeLog entry is at the top of the file?" % (diff_file.filename))
     51         # FIXME: Do we need to make the file path absolute?
     52         self._tool.scm().diff_for_file(diff_file.filename)
     53         if self._tool.user.confirm("OK to continue?", default='n'):
     54             return True
     55         return False
     56 
     57     def run(self, state):
     58         parsed_diff = DiffParser(self.cached_lookup(state, "diff").splitlines())
     59         for filename, diff_file in parsed_diff.files.items():
     60             if not self._check_changelog_diff(diff_file):
     61                 error("ChangeLog entry in %s is not at the top of the file." % diff_file.filename)
     62