1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import os
import re
import subprocess
import sys
import tempfile
from six.moves.urllib import parse as urlparse
from wptrunner.update.base import Step, StepRunner, exit_clean, exit_unclean
from wptrunner.update.tree import get_unique_name
from .github import GitHub
from .tree import Commit, GitTree, Patch
def rewrite_patch(patch, strip_dir):
"""Take a Patch and convert to a different repository by stripping a prefix from the
file paths. Also rewrite the message to remove the bug number and reviewer, but add
a bugzilla link in the summary.
:param patch: the Patch to convert
:param strip_dir: the path prefix to remove
"""
if not strip_dir.startswith("/"):
strip_dir = "/%s" % strip_dir
new_diff = []
line_starts = [
("diff ", True),
("+++ ", True),
("--- ", True),
("rename from ", False),
("rename to ", False),
]
for line in patch.diff.split("\n"):
for start, leading_slash in line_starts:
strip = strip_dir if leading_slash else strip_dir[1:]
if line.startswith(start):
new_diff.append(line.replace(strip, "").encode("utf8"))
break
else:
new_diff.append(line)
new_diff = "\n".join(new_diff)
assert new_diff != patch
return Patch(patch.author, patch.email, rewrite_message(patch), new_diff)
def rewrite_message(patch):
if patch.message.bug is not None:
return "\n".join(
[
patch.message.summary,
patch.message.body,
"",
"Upstreamed from https://bugzilla.mozilla.org/show_bug.cgi?id=%s [ci skip]"
% patch.message.bug, # noqa E501
]
)
return "\n".join(
[patch.message.full_summary, "%s\n[ci skip]\n" % patch.message.body]
)
class SyncToUpstream(Step):
"""Sync local changes to upstream"""
def create(self, state):
if not state.kwargs["upstream"]:
return
if not isinstance(state.local_tree, GitTree):
self.logger.error("Cannot sync with upstream from a non-Git checkout.")
return exit_clean
try:
import requests # noqa F401
except ImportError:
self.logger.error(
"Upstream sync requires the requests module to be installed"
)
return exit_clean
if not state.sync_tree:
os.makedirs(state.sync["path"])
state.sync_tree = GitTree(root=state.sync["path"])
kwargs = state.kwargs
with state.push(
["local_tree", "sync_tree", "tests_path", "metadata_path", "sync"]
):
state.token = kwargs["token"]
runner = SyncToUpstreamRunner(self.logger, state)
runner.run()
class GetLastSyncData(Step):
"""Find the gecko commit at which we last performed a sync with upstream and the upstream
commit that was synced."""
provides = ["sync_data_path", "last_sync_commit", "old_upstream_rev"]
def create(self, state):
self.logger.info("Looking for last sync commit")
state.sync_data_path = os.path.join(state.metadata_path, "mozilla-sync")
items = {}
with open(state.sync_data_path) as f:
for line in f.readlines():
key, value = [item.strip() for item in line.split(":", 1)]
items[key] = value
state.last_sync_commit = Commit(
state.local_tree, state.local_tree.rev_from_hg(items["local"])
)
state.old_upstream_rev = items["upstream"]
if not state.local_tree.contains_commit(state.last_sync_commit):
self.logger.error(
"Could not find last sync commit %s" % state.last_sync_commit.sha1
)
return exit_clean
self.logger.info(
"Last sync to web-platform-tests happened in %s"
% state.last_sync_commit.sha1
)
class CheckoutBranch(Step):
"""Create a branch in the sync tree pointing at the last upstream sync commit
and check it out"""
provides = ["branch"]
def create(self, state):
self.logger.info("Updating sync tree from %s" % state.sync["remote_url"])
state.branch = state.sync_tree.unique_branch_name(
"outbound_update_%s" % state.old_upstream_rev
)
state.sync_tree.update(
state.sync["remote_url"], state.sync["branch"], state.branch
)
state.sync_tree.checkout(state.old_upstream_rev, state.branch, force=True)
class GetBaseCommit(Step):
"""Find the latest upstream commit on the branch that we are syncing with"""
provides = ["base_commit"]
def create(self, state):
state.base_commit = state.sync_tree.get_remote_sha1(
state.sync["remote_url"], state.sync["branch"]
)
self.logger.debug("New base commit is %s" % state.base_commit.sha1)
class LoadCommits(Step):
"""Get a list of commits in the gecko tree that need to be upstreamed"""
provides = ["source_commits", "has_backouts"]
def create(self, state):
state.source_commits = state.local_tree.log(
state.last_sync_commit, state.tests_path
)
update_regexp = re.compile(
r"Bug \d+ - Update web-platform-tests to revision [0-9a-f]{40}"
)
state.has_backouts = False
for i, commit in enumerate(state.source_commits[:]):
if update_regexp.match(commit.message.text):
# This is a previous update commit so ignore it
state.source_commits.remove(commit)
continue
elif commit.message.backouts:
# TODO: Add support for collapsing backouts
state.has_backouts = True
elif not commit.message.bug:
self.logger.error(
"Commit %i (%s) doesn't have an associated bug number."
% (i + 1, commit.sha1)
)
return exit_unclean
self.logger.debug("Source commits: %s" % state.source_commits)
class SelectCommits(Step):
"""Provide a UI to select which commits to upstream"""
def create(self, state):
while True:
commits = state.source_commits[:]
for i, commit in enumerate(commits):
print(f"{i}:\t{commit.message.summary}")
remove = input(
"Provide a space-separated list of any commits numbers "
"to remove from the list to upstream:\n"
).strip()
remove_idx = set()
for item in remove.split(" "):
try:
item = int(item)
except ValueError:
continue
if item < 0 or item >= len(commits):
continue
remove_idx.add(item)
keep_commits = [
(i, cmt) for i, cmt in enumerate(commits) if i not in remove_idx
]
# TODO: consider printed removed commits
print("Selected the following commits to keep:")
for i, commit in keep_commits:
print(f"{i}:\t{commit.message.summary}")
confirm = input("Keep the above commits? y/n\n").strip().lower()
if confirm == "y":
state.source_commits = [item[1] for item in keep_commits]
break
class MovePatches(Step):
"""Convert gecko commits into patches against upstream and commit these to the sync tree."""
provides = ["commits_loaded"]
def create(self, state):
if not hasattr(state, "commits_loaded"):
state.commits_loaded = 0
strip_path = os.path.relpath(state.tests_path, state.local_tree.root)
self.logger.debug("Stripping patch %s" % strip_path)
if not hasattr(state, "patch"):
state.patch = None
for commit in state.source_commits[state.commits_loaded :]:
i = state.commits_loaded + 1
self.logger.info("Moving commit %i: %s" % (i, commit.message.full_summary))
stripped_patch = None
if state.patch:
filename, stripped_patch = state.patch
if not os.path.exists(filename):
stripped_patch = None
else:
with open(filename) as f:
stripped_patch.diff = f.read()
state.patch = None
if not stripped_patch:
patch = commit.export_patch(state.tests_path)
stripped_patch = rewrite_patch(patch, strip_path)
if not stripped_patch.diff:
self.logger.info("Skipping empty patch")
state.commits_loaded = i
continue
try:
state.sync_tree.import_patch(stripped_patch)
except Exception:
with tempfile.NamedTemporaryFile(delete=False, suffix=".diff") as f:
f.write(stripped_patch.diff)
print(
f"""Patch failed to apply. Diff saved in {f.name}
Fix this file so it applies and run with --continue"""
)
state.patch = (f.name, stripped_patch)
print(state.patch)
sys.exit(1)
state.commits_loaded = i
input("Check for differences with upstream")
class RebaseCommits(Step):
"""Rebase commits from the current branch on top of the upstream destination branch.
This step is particularly likely to fail if the rebase generates merge conflicts.
In that case the conflicts can be fixed up locally and the sync process restarted
with --continue.
"""
def create(self, state):
self.logger.info("Rebasing local commits")
continue_rebase = False
# Check if there's a rebase in progress
if os.path.exists(
os.path.join(state.sync_tree.root, ".git", "rebase-merge")
) or os.path.exists(os.path.join(state.sync_tree.root, ".git", "rebase-apply")):
continue_rebase = True
try:
state.sync_tree.rebase(state.base_commit, continue_rebase=continue_rebase)
except subprocess.CalledProcessError:
self.logger.info(
"Rebase failed, fix merge and run %s again with --continue"
% sys.argv[0]
)
raise
self.logger.info("Rebase successful")
class CheckRebase(Step):
"""Check if there are any commits remaining after rebase"""
provides = ["rebased_commits"]
def create(self, state):
state.rebased_commits = state.sync_tree.log(state.base_commit)
if not state.rebased_commits:
self.logger.info("Nothing to upstream, exiting")
return exit_clean
class MergeUpstream(Step):
"""Run steps to push local commits as seperate PRs and merge upstream."""
provides = ["merge_index", "gh_repo"]
def create(self, state):
gh = GitHub(state.token)
if "merge_index" not in state:
state.merge_index = 0
org, name = urlparse.urlsplit(state.sync["remote_url"]).path[1:].split("/")
if name.endswith(".git"):
name = name[:-4]
state.gh_repo = gh.repo(org, name)
for commit in state.rebased_commits[state.merge_index :]:
with state.push(["gh_repo", "sync_tree"]):
state.commit = commit
pr_merger = PRMergeRunner(self.logger, state)
rv = pr_merger.run()
if rv is not None:
return rv
state.merge_index += 1
class UpdateLastSyncData(Step):
"""Update the gecko commit at which we last performed a sync with upstream."""
provides = []
def create(self, state):
self.logger.info("Updating last sync commit")
data = {
"local": state.local_tree.rev_to_hg(state.local_tree.rev),
"upstream": state.sync_tree.rev,
}
with open(state.sync_data_path, "w") as f:
for key, value in data.iteritems():
f.write("%s: %s\n" % (key, value))
# This gets added to the patch later on
class MergeLocalBranch(Step):
"""Create a local branch pointing at the commit to upstream"""
provides = ["local_branch"]
def create(self, state):
branch_prefix = "sync_%s" % state.commit.sha1
local_branch = state.sync_tree.unique_branch_name(branch_prefix)
state.sync_tree.create_branch(local_branch, state.commit)
state.local_branch = local_branch
class MergeRemoteBranch(Step):
"""Get an unused remote branch name to use for the PR"""
provides = ["remote_branch"]
def create(self, state):
remote_branch = "sync_%s" % state.commit.sha1
branches = [
ref[len("refs/heads/") :]
for sha1, ref in state.sync_tree.list_remote(state.gh_repo.url)
if ref.startswith("refs/heads")
]
state.remote_branch = get_unique_name(branches, remote_branch)
class PushUpstream(Step):
"""Push local branch to remote"""
def create(self, state):
self.logger.info("Pushing commit upstream")
state.sync_tree.push(state.gh_repo.url, state.local_branch, state.remote_branch)
class CreatePR(Step):
"""Create a PR for the remote branch"""
provides = ["pr"]
def create(self, state):
self.logger.info("Creating a PR")
commit = state.commit
state.pr = state.gh_repo.create_pr(
commit.message.full_summary,
state.remote_branch,
"master",
commit.message.body if commit.message.body else "",
)
class PRAddComment(Step):
"""Add an issue comment indicating that the code has been reviewed already"""
def create(self, state):
state.pr.issue.add_comment("Code reviewed upstream.")
class MergePR(Step):
"""Merge the PR"""
def create(self, state):
self.logger.info("Merging PR")
state.pr.merge()
class PRDeleteBranch(Step):
"""Delete the remote branch"""
def create(self, state):
self.logger.info("Deleting remote branch")
state.sync_tree.push(state.gh_repo.url, "", state.remote_branch)
class SyncToUpstreamRunner(StepRunner):
"""Runner for syncing local changes to upstream"""
steps = [
GetLastSyncData,
CheckoutBranch,
GetBaseCommit,
LoadCommits,
SelectCommits,
MovePatches,
RebaseCommits,
CheckRebase,
MergeUpstream,
UpdateLastSyncData,
]
class PRMergeRunner(StepRunner):
"""(Sub)Runner for creating and merging a PR"""
steps = [
MergeLocalBranch,
MergeRemoteBranch,
PushUpstream,
CreatePR,
PRAddComment,
MergePR,
PRDeleteBranch,
]
|