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.system.executive import ScriptError
     33 from webkitpy.tool.steps.abstractstep import AbstractStep
     34 from webkitpy.tool.steps.options import Options
     35 from webkitpy.common.system.deprecated_logging import error
     36 
     37 
     38 class PrepareChangeLog(AbstractStep):
     39     @classmethod
     40     def options(cls):
     41         return AbstractStep.options() + [
     42             Options.quiet,
     43             Options.email,
     44             Options.git_commit,
     45         ]
     46 
     47     def _ensure_bug_url(self, state):
     48         if not state.get("bug_id"):
     49             return
     50         bug_id = state.get("bug_id")
     51         changelogs = self.cached_lookup(state, "changelogs")
     52         for changelog_path in changelogs:
     53             changelog = ChangeLog(changelog_path)
     54             if not changelog.latest_entry().bug_id():
     55                 changelog.set_short_description_and_bug_url(
     56                     self.cached_lookup(state, "bug_title"),
     57                     self._tool.bugs.bug_url_for_bug_id(bug_id))
     58 
     59     def run(self, state):
     60         if self.cached_lookup(state, "changelogs"):
     61             self._ensure_bug_url(state)
     62             return
     63         os.chdir(self._tool.scm().checkout_root)
     64         args = self._tool.port().prepare_changelog_command()
     65         if state.get("bug_id"):
     66             args.append("--bug=%s" % state["bug_id"])
     67             args.append("--description=%s" % self._tool.bugs.fetch_bug(state["bug_id"]).title())
     68         if self._options.email:
     69             args.append("--email=%s" % self._options.email)
     70 
     71         if self._tool.scm().supports_local_commits():
     72             args.append("--merge-base=%s" % self._tool.scm().merge_base(self._options.git_commit))
     73 
     74         args.extend(self._changed_files(state))
     75 
     76         try:
     77             self._tool.executive.run_and_throw_if_fail(args, self._options.quiet)
     78         except ScriptError, e:
     79             error("Unable to prepare ChangeLogs.")
     80         self.did_modify_checkout(state)
     81