util/gerrit-bot/util.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (c) 2020 The Regents of the University of California
   4 # All Rights Reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders 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
  30 # Utility functions
  31 def parse_commit_subject(subject):
  32     parsed_subject = subject.split(":", maxsplit = 1)
  33
  34     # If the subject does not have a colon, it either does not have tags
  35     # or does not have a message
  36     if len(parsed_subject) <= 1:
  37         return None, None
  38
  39     tags = [ tag.strip() for tag in parsed_subject[0].split(",") ]
  40     message = parsed_subject[1]
  41
  42     return tags, message
  43
  44 # Convert time in seconds to a plausible unit
  45 def convert_time_in_seconds(delta):
  46     time = int(delta)
  47     time_unit = "s"
  48
  49     for curr_unit_limit, next_unit in zip([60, 60, 24], ["m", "h", "d"]):
  50         if time <= curr_unit_limit:
  51             break
  52         time = time // curr_unit_limit + 1
  53         time_unit = next_unit
  54
  55     return f"{time}{time_unit}"
  56
  57 # End of Utility functions
  58
  59 def add_maintainers_to_change(change, maintainers, gerrit_api):
  60     tags, message = parse_commit_subject(change["subject"])
  61     change_id = change["id"]
  62     maintainer_emails = set()
  63     for tag in tags:
  64         try:
  65             for name, email in maintainers[tag].maintainers:
  66                 maintainer_emails.add(email)
  67         except KeyError:
  68             print((f"warning: `change-{change_id}` has an unknown tag: "
  69                    f"`{tag}`"))
  70     for email in maintainer_emails:
  71         gerrit_api.add_reviewer(change_id, email)