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
|
# 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 json
import os
import sys
from mach.util import get_state_dir
from mozbuild.base import MozbuildObject
from mozversioncontrol import MissingVCSExtension, get_repository_object
from .lando import push_to_lando_try
GIT_CINNABAR_NOT_FOUND = """
Could not detect `git-cinnabar`.
The `mach try` command requires git-cinnabar to be installed when
pushing from git. Please install it by running:
$ ./mach vcs-setup
""".lstrip()
HG_PUSH_TO_TRY_NOT_FOUND = """
Could not detect `push-to-try`.
The `mach try` command requires the push-to-try extension enabled
when pushing from hg. Please install it by running:
$ ./mach vcs-setup
""".lstrip()
VCS_NOT_FOUND = """
Could not detect version control. Only `hg` or `git` are supported.
""".strip()
UNCOMMITTED_CHANGES = """
ERROR please commit changes before continuing
""".strip()
MAX_HISTORY = 10
MACH_TRY_PUSH_TO_VCS = os.getenv("MACH_TRY_PUSH_TO_VCS") == "1"
TREEHERDER_LANDO_TRY_RUN_URL = (
"https://treeherder.mozilla.org/jobs?repo=try&landoCommitID={job_id}"
)
here = os.path.abspath(os.path.dirname(__file__))
build = MozbuildObject.from_environment(cwd=here)
vcs = get_repository_object(build.topsrcdir)
history_path = os.path.join(
get_state_dir(specific_to_topsrcdir=True), "history", "try_task_configs.json"
)
def write_task_config_history(msg, try_task_config):
if not os.path.isfile(history_path):
if not os.path.isdir(os.path.dirname(history_path)):
os.makedirs(os.path.dirname(history_path))
history = []
else:
with open(history_path) as fh:
history = fh.read().strip().splitlines()
history.insert(0, json.dumps([msg, try_task_config]))
history = history[:MAX_HISTORY]
with open(history_path, "w") as fh:
fh.write("\n".join(history))
def check_working_directory(push=True):
if not push:
return
if not vcs.working_directory_clean():
print(UNCOMMITTED_CHANGES)
sys.exit(1)
def generate_try_task_config(method, labels, params=None, routes=None):
params = params or {}
# The user has explicitly requested a set of jobs, so run them all
# regardless of optimization (unless the selector explicitly sets this to
# True). Their dependencies can be optimized though.
params.setdefault("optimize_target_tasks", False)
# Remove selected labels from 'existing_tasks' parameter if present
if "existing_tasks" in params:
params["existing_tasks"] = {
label: tid
for label, tid in params["existing_tasks"].items()
if label not in labels
}
try_config = params.setdefault("try_task_config", {})
try_config.setdefault("env", {})["TRY_SELECTOR"] = method
try_config["tasks"] = sorted(labels)
if routes:
try_config["routes"] = routes
try_task_config = {"version": 2, "parameters": params}
return try_task_config
def task_labels_from_try_config(try_task_config):
if try_task_config["version"] == 2:
parameters = try_task_config.get("parameters", {})
if "try_task_config" in parameters:
return parameters["try_task_config"].get("tasks")
else:
return None
elif try_task_config["version"] == 1:
return try_task_config.get("tasks", list())
else:
return None
# improves on `" ".join(sys.argv[:])` by requoting argv items containing spaces or single quotes
def get_sys_argv(injected_argv=None):
argv_to_use = injected_argv or sys.argv[:]
formatted_argv = []
for item in argv_to_use:
if " " in item or "'" in item:
formatted_item = f'"{item}"'
else:
formatted_item = item
formatted_argv.append(formatted_item)
return " ".join(formatted_argv)
def push_to_try(
method,
msg,
try_task_config=None,
stage_changes=False,
dry_run=False,
closed_tree=False,
files_to_change=None,
allow_log_capture=False,
push_to_vcs=False,
):
push = not stage_changes and not dry_run
push_to_vcs |= MACH_TRY_PUSH_TO_VCS
check_working_directory(push)
# Format the commit message
closed_tree_string = " ON A CLOSED TREE" if closed_tree else ""
the_cmdline = get_sys_argv()
full_commandline_entry = f"mach try command: `{the_cmdline}`"
commit_message = f"{msg}{closed_tree_string}\n\n{full_commandline_entry}\n\nPushed via `mach try {method}`"
changed_files = {}
if try_task_config:
changed_files["try_task_config.json"] = (
json.dumps(
try_task_config, indent=4, separators=(",", ": "), sort_keys=True
)
+ "\n"
)
if push and method not in ("again", "auto", "empty"):
write_task_config_history(msg, try_task_config)
if (push or stage_changes) and files_to_change:
changed_files.update(files_to_change.items())
if not push:
print("Commit message:")
print(commit_message)
config = changed_files.pop("try_task_config.json", None)
if config:
print("Calculated try_task_config.json:")
print(config)
if stage_changes:
vcs.stage_changes(changed_files)
return
try:
if push_to_vcs:
vcs.push_to_try(
commit_message,
changed_files=changed_files,
allow_log_capture=allow_log_capture,
)
else:
job_id = push_to_lando_try(vcs, commit_message, changed_files)
if job_id:
print(
f"Follow the progress of your build on Treeherder: "
f"{TREEHERDER_LANDO_TRY_RUN_URL.format(job_id=job_id)}"
)
return job_id
except MissingVCSExtension as e:
if e.ext == "push-to-try":
print(HG_PUSH_TO_TRY_NOT_FOUND)
elif e.ext == "cinnabar":
print(GIT_CINNABAR_NOT_FOUND)
else:
raise
sys.exit(1)
finally:
if "try_task_config.json" in changed_files and os.path.isfile(
"try_task_config.json"
):
os.remove("try_task_config.json")
|