061baa5ec8a97c2fe475b3a8f531cd0e37217684
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / steps / validatechangelogs.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 logging
30 import sys
31
32 from webkitpy.tool.steps.abstractstep import AbstractStep
33 from webkitpy.tool.steps.options import Options
34 from webkitpy.common.checkout.diff_parser import DiffParser
35
36 _log = logging.getLogger(__name__)
37
38
39 # This is closely related to the ValidateReviewer step and the CommitterValidator class.
40 # We may want to unify more of this code in one place.
41 class ValidateChangeLogs(AbstractStep):
42     @classmethod
43     def options(cls):
44         return AbstractStep.options() + [
45             Options.non_interactive,
46         ]
47
48     def _check_changelog_diff(self, diff_file):
49         if not self._tool.checkout().is_path_to_changelog(diff_file.filename):
50             return True
51         # Each line is a tuple, the first value is the deleted line number
52         # Date, reviewer, bug title, bug url, and empty lines could all be
53         # identical in the most recent entries.  If the diff starts any
54         # later than that, assume that the entry is wrong.
55         if diff_file.lines[0][0] < 8:
56             return True
57         if self._options.non_interactive:
58             return False
59
60         _log.info("The diff to %s looks wrong. Are you sure your ChangeLog entry is at the top of the file?" % (diff_file.filename))
61         # FIXME: Do we need to make the file path absolute?
62         self._tool.scm().diff_for_file(diff_file.filename)
63         if self._tool.user.confirm("OK to continue?", default='n'):
64             return True
65         return False
66
67     def run(self, state):
68         changed_files = self.cached_lookup(state, "changed_files")
69         for filename in changed_files:
70             if not self._tool.checkout().is_path_to_changelog(filename):
71                 continue
72             # Diff ChangeLogs directly because svn-create-patch will move
73             # ChangeLog entries to the # top automatically, defeating our
74             # validation here.
75             # FIXME: Should we diff all the ChangeLogs at once?
76             diff = self._tool.scm().diff_for_file(filename)
77             parsed_diff = DiffParser(diff.splitlines())
78             for filename, diff_file in parsed_diff.files.items():
79                 if not self._check_changelog_diff(diff_file):
80                     _log.error("ChangeLog entry in %s is not at the top of the file." % diff_file.filename)
81                     sys.exit(1)