recipe_engine/internal/autoroll_impl/roll_candidate.py

# Copyright 2017 The LUCI Authors. All rights reserved.
# Use of this source code is governed under the Apache License, Version 2.0
# that can be found in the LICENSE file.

import copy


# TODO(iannucci): This value is split with the autoroller recipe which lives in
# the infra.git repo. It's pretty dumb to have this duplication.
#
# Additionally, this detection is a bit cheezy. Some alternatives:
#   * Identify the recipe autoroller account(s). This is nice because the
#     accounts are verified (unlike the commit message), but it's awkward
#     because there's no consistent set of accounts that we can encode here, so
#     we'd have to plumb it through as an option. Worth consideration.
#   * Add an `Autoroller: recipes` footer or something to the commit message and
#     have gerrit verify this. This would be more difficult (because we'd have
#     to program gerrit to have an ACL for this footer, a function it doesn't
#     currently have), but it would be more general.
_AUTOROLLER_PREFIX = 'Roll recipe dependencies'


class RollCandidate:
  """RollCandidate holds a single, consistent recipes_cfg_pb2.RepoSpec
  representing a potential autoroll candidate.
  """

  def __init__(self, repo_spec):
    """
    Args:
      repo_spec (recipes_cfg_pb2.RepoSpec) - Read-only RepoSpec message, will be
        copied internally.
    """
    self.repo_spec = copy.deepcopy(repo_spec)

  def changelist(self, repos):
    """Returns changelist for this RollCandidate.

    This will return all CommitMetadata in every repo that was rolled by this
    RollCandidate.

    This excludes commits which were created by the autoroller.

    Args:
      repos dict(repo_name, CommitList) - The repo CommitList mapping obtained
        by calling candidate_algorithm.get_roll_candidates().

    Returns dict(repo_name, [CommitMetadata])
    """
    ret = {}
    for pid, dep in self.repo_spec.deps.items():
      rolled = [
        # The [1:] is to skip the very first commit, which is the commit value
        # that the autoroller started with.
        meta for meta in repos[pid].changelist(dep.revision)[1:]
        if not (
            meta.message_lines and
            meta.message_lines[0].startswith(_AUTOROLLER_PREFIX)
        )
      ]
      if rolled:
        ret[pid] = rolled
    return ret