auto_roll.py 8.1 KB
Newer Older
1 2 3 4 5
#!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

6 7 8
# for py2/py3 compatibility
from __future__ import print_function

9 10 11 12 13
import argparse
import os
import sys

from common_includes import *
14 15 16 17 18 19

ROLL_SUMMARY = ("Summary of changes available at:\n"
                "https://chromium.googlesource.com/v8/v8/+log/%s..%s")

ISSUE_MSG = (
"""Please follow these instructions for assigning/CC'ing issues:
20
https://v8.dev/docs/triage-issues
21 22 23

Please close rolling in case of a roll revert:
https://v8-roll.appspot.com/
24 25
This only works with a Google account.

26 27 28 29 30
CQ_INCLUDE_TRYBOTS=luci.chromium.try:linux-blink-rel
CQ_INCLUDE_TRYBOTS=luci.chromium.try:linux_optional_gpu_tests_rel
CQ_INCLUDE_TRYBOTS=luci.chromium.try:mac_optional_gpu_tests_rel
CQ_INCLUDE_TRYBOTS=luci.chromium.try:win_optional_gpu_tests_rel
CQ_INCLUDE_TRYBOTS=luci.chromium.try:android_optional_gpu_tests_rel""")
31 32 33 34 35

class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
36
    self['json_output']['monitoring_state'] = 'preparation'
37 38 39
    # Update v8 remote tracking branches.
    self.GitFetchOrigin()
    self.Git("fetch origin +refs/tags/*:refs/tags/*")
40 41 42 43 44 45


class DetectLastRoll(Step):
  MESSAGE = "Detect commit ID of the last Chromium roll."

  def RunStep(self):
46
    self['json_output']['monitoring_state'] = 'detect_last_roll'
47 48
    self["last_roll"] = self._options.last_roll
    if not self["last_roll"]:
49 50 51 52
      # Get last-rolled v8 revision from Chromium's DEPS file.
      self["last_roll"] = self.Command(
          "gclient", "getdep -r src/v8", cwd=self._options.chromium).strip()

53 54 55 56 57 58 59 60
    self["last_version"] = self.GetVersionTag(self["last_roll"])
    assert self["last_version"], "The last rolled v8 revision is not tagged."


class DetectRevisionToRoll(Step):
  MESSAGE = "Detect commit ID of the V8 revision to roll."

  def RunStep(self):
61
    self['json_output']['monitoring_state'] = 'detect_revision'
62 63 64 65 66 67
    self["roll"] = self._options.revision
    if self["roll"]:
      # If the revision was passed on the cmd line, continue script execution
      # in the next step.
      return False

68 69 70 71 72
    # The revision that should be rolled. Check for the latest of the most
    # recent releases based on commit timestamp.
    revisions = self.GetRecentReleases(
        max_age=self._options.max_age * DAY_IN_SECONDS)
    assert revisions, "Didn't find any recent release."
73

74 75 76 77 78 79
    # There must be some progress between the last roll and the new candidate
    # revision (i.e. we don't go backwards). The revisions are ordered newest
    # to oldest. It is possible that the newest timestamp has no progress
    # compared to the last roll, i.e. if the newest release is a cherry-pick
    # on a release branch. Then we look further.
    for revision in revisions:
80 81 82
      version = self.GetVersionTag(revision)
      assert version, "Internal error. All recent releases should have a tag"

83
      if SortingKey(self["last_version"]) < SortingKey(version):
84 85 86
        self["roll"] = revision
        break
    else:
87
      print("There is no newer v8 revision than the one in Chromium (%s)."
88
            % self["last_roll"])
89
      self['json_output']['monitoring_state'] = 'up_to_date'
90 91 92
      return True


93 94 95 96
class PrepareRollCandidate(Step):
  MESSAGE = "Robustness checks of the roll candidate."

  def RunStep(self):
97
    self['json_output']['monitoring_state'] = 'prepare_candidate'
98 99 100 101 102 103 104 105 106 107 108 109 110 111
    self["roll_title"] = self.GitLog(n=1, format="%s",
                                     git_hash=self["roll"])

    # Make sure the last roll and the roll candidate are releases.
    version = self.GetVersionTag(self["roll"])
    assert version, "The revision to roll is not tagged."
    version = self.GetVersionTag(self["last_roll"])
    assert version, "The revision used as last roll is not tagged."


class SwitchChromium(Step):
  MESSAGE = "Switch to Chromium checkout."

  def RunStep(self):
112
    self['json_output']['monitoring_state'] = 'switch_chromium'
113 114 115 116 117 118 119 120 121 122 123 124
    cwd = self._options.chromium
    self.InitialEnvironmentChecks(cwd)
    # Check for a clean workdir.
    if not self.GitIsWorkdirClean(cwd=cwd):  # pragma: no cover
      self.Die("Workspace is not clean. Please commit or undo your changes.")
    # Assert that the DEPS file is there.
    if not os.path.exists(os.path.join(cwd, "DEPS")):  # pragma: no cover
      self.Die("DEPS file not present.")


class UpdateChromiumCheckout(Step):
  MESSAGE = "Update the checkout and create a new branch."
125 126

  def RunStep(self):
127
    self['json_output']['monitoring_state'] = 'update_chromium'
128
    cwd = self._options.chromium
129
    self.GitCheckout("main", cwd=cwd)
130 131 132 133 134 135 136 137 138 139 140 141 142
    self.DeleteBranch("work-branch", cwd=cwd)
    self.GitPull(cwd=cwd)

    # Update v8 remotes.
    self.GitFetchOrigin()

    self.GitCreateBranch("work-branch", cwd=cwd)


class UploadCL(Step):
  MESSAGE = "Create and upload CL."

  def RunStep(self):
143
    self['json_output']['monitoring_state'] = 'upload'
144 145
    cwd = self._options.chromium
    # Patch DEPS file.
146
    if self.Command("gclient", "setdep -r src/v8@%s" %
147 148 149 150 151 152 153 154 155 156
                    self["roll"], cwd=cwd) is None:
      self.Die("Failed to create deps for %s" % self["roll"])

    message = []
    message.append("Update V8 to %s." % self["roll_title"].lower())

    message.append(
        ROLL_SUMMARY % (self["last_roll"][:8], self["roll"][:8]))

    message.append(ISSUE_MSG)
157

158
    message.append("R=%s" % self._options.reviewer)
159 160
    self.GitCommit("\n\n".join(message),  author=self._options.author, cwd=cwd)
    if not self._options.dry_run:
161
      self.GitUpload(force=True,
162
                     bypass_hooks=True,
163
                     cq=self._options.use_commit_queue,
164
                     cq_dry_run=self._options.use_dry_run,
165
                     set_bot_commit=True,
166
                     cwd=cwd)
167
      print("CL uploaded.")
168
    else:
169
      print("Dry run - don't upload.")
170

171
    self.GitCheckout("main", cwd=cwd)
172 173 174 175 176 177
    self.GitDeleteBranch("work-branch", cwd=cwd)

class CleanUp(Step):
  MESSAGE = "Done!"

  def RunStep(self):
178
    self['json_output']['monitoring_state'] = 'success'
179 180 181 182 183 184
    print("Congratulations, you have successfully rolled %s into "
          "Chromium."
          % self["roll"])

    # Clean up all temporary files.
    Command("rm", "-f %s*" % self._config["PERSISTFILE_BASENAME"])
185 186 187 188 189 190 191


class AutoRoll(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("-c", "--chromium", required=True,
                        help=("The path to your Chromium src/ "
                              "directory to automate the V8 roll."))
192 193 194
    parser.add_argument("--last-roll",
                        help="The git commit ID of the last rolled version. "
                             "Auto-detected if not specified.")
195
    parser.add_argument("--max-age", default=7, type=int,
196
                        help="Maximum age in days of the latest release.")
197 198 199 200 201
    parser.add_argument("--revision",
                        help="Revision to roll. Auto-detected if not "
                             "specified."),
    parser.add_argument("--roll", help="Deprecated.",
                        default=True, action="store_true")
202 203 204 205 206 207 208
    group = parser.add_mutually_exclusive_group()
    group.add_argument("--use-commit-queue",
                       help="Trigger the CQ full run on upload.",
                       default=False, action="store_true")
    group.add_argument("--use-dry-run",
                       help="Trigger the CQ dry run on upload.",
                       default=True, action="store_true")
209 210

  def _ProcessOptions(self, options):  # pragma: no cover
211
    if not options.author or not options.reviewer:
212
      print("A reviewer (-r) and an author (-a) are required.")
213
      return False
214 215 216 217

    options.requires_editor = False
    options.force = True
    options.manual = False
218 219
    return True

220 221
  def _Config(self):
    return {
222
      "PERSISTFILE_BASENAME": "/tmp/v8-chromium-roll-tempfile",
223 224
    }

225 226
  def _Steps(self):
    return [
227
      Preparation,
228
      DetectLastRoll,
229 230 231 232 233 234
      DetectRevisionToRoll,
      PrepareRollCandidate,
      SwitchChromium,
      UpdateChromiumCheckout,
      UploadCL,
      CleanUp,
235 236 237 238
    ]


if __name__ == "__main__":  # pragma: no cover
239
  sys.exit(AutoRoll().Run())