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.tool.grammar import pluralize
     33 from webkitpy.tool.steps.abstractstep import AbstractStep
     34 from webkitpy.tool.steps.options import Options
     35 from webkitpy.common.system.deprecated_logging import log, error
     36 
     37 class UpdateChangeLogsWithReviewer(AbstractStep):
     38     @classmethod
     39     def options(cls):
     40         return AbstractStep.options() + [
     41             Options.git_commit,
     42             Options.reviewer,
     43         ]
     44 
     45     def _guess_reviewer_from_bug(self, bug_id):
     46         patches = self._tool.bugs.fetch_bug(bug_id).reviewed_patches()
     47         if len(patches) != 1:
     48             log("%s on bug %s, cannot infer reviewer." % (pluralize("reviewed patch", len(patches)), bug_id))
     49             return None
     50         patch = patches[0]
     51         log("Guessing \"%s\" as reviewer from attachment %s on bug %s." % (patch.reviewer().full_name, patch.id(), bug_id))
     52         return patch.reviewer().full_name
     53 
     54     def run(self, state):
     55         bug_id = state.get("bug_id")
     56         if not bug_id and state.get("patch"):
     57             bug_id = state.get("patch").bug_id()
     58 
     59         reviewer = self._options.reviewer
     60         if not reviewer:
     61             if not bug_id:
     62                 log("No bug id provided and --reviewer= not provided.  Not updating ChangeLogs with reviewer.")
     63                 return
     64             reviewer = self._guess_reviewer_from_bug(bug_id)
     65 
     66         if not reviewer:
     67             log("Failed to guess reviewer from bug %s and --reviewer= not provided.  Not updating ChangeLogs with reviewer." % bug_id)
     68             return
     69 
     70         # cached_lookup("changelogs") is always absolute paths.
     71         for changelog_path in self.cached_lookup(state, "changelogs"):
     72             ChangeLog(changelog_path).set_reviewer(reviewer)
     73 
     74         # Tell the world that we just changed something on disk so that the cached diff is invalidated.
     75         self.did_modify_checkout(state)
     76