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 import os
     30 
     31 from webkitpy.common.checkout.changelog import ChangeLog
     32 from webkitpy.common.config import urls
     33 from webkitpy.tool.grammar import join_with_separators
     34 from webkitpy.tool.steps.abstractstep import AbstractStep
     35 
     36 
     37 class PrepareChangeLogForRevert(AbstractStep):
     38     @classmethod
     39     def _message_for_revert(cls, revision_list, reason, bug_url=None):
     40         message = "Unreviewed, rolling out %s.\n" % join_with_separators(['r' + str(revision) for revision in revision_list])
     41         for revision in revision_list:
     42             message += "%s\n" % urls.view_revision_url(revision)
     43         if bug_url:
     44             message += "%s\n" % bug_url
     45         # Add an extra new line after the rollout links, before any reason.
     46         message += "\n"
     47         if reason:
     48             message += "%s\n\n" % reason
     49         return message
     50 
     51     def run(self, state):
     52         # This could move to prepare-ChangeLog by adding a --revert= option.
     53         self._tool.executive.run_and_throw_if_fail(self._tool.port().prepare_changelog_command())
     54         changelog_paths = self._tool.checkout().modified_changelogs(git_commit=None)
     55         bug_url = self._tool.bugs.bug_url_for_bug_id(state["bug_id"]) if state["bug_id"] else None
     56         message = self._message_for_revert(state["revision_list"], state["reason"], bug_url)
     57         for changelog_path in changelog_paths:
     58             # FIXME: Seems we should prepare the message outside of changelogs.py and then just pass in
     59             # text that we want to use to replace the reviewed by line.
     60             ChangeLog(changelog_path).update_with_unreviewed_message(message)
     61