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
|
# 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/.
"""
Support for running jobs that are invoked via the `run-task` script.
"""
from __future__ import absolute_import, print_function, unicode_literals
from six import text_type
from mozpack import path
from taskgraph.transforms.task import taskref_or_string
from taskgraph.transforms.job import run_job_using
from taskgraph.util.schema import Schema
from taskgraph.transforms.job.common import add_tooltool, support_vcs_checkout
from voluptuous import Any, Optional, Required
run_task_schema = Schema(
{
Required("using"): "run-task",
# if true, add a cache at ~worker/.cache, which is where things like pip
# tend to hide their caches. This cache is never added for level-1 jobs.
# TODO Once bug 1526028 is fixed, this and 'use-caches' should be merged.
Required("cache-dotcache"): bool,
# Whether or not to use caches.
Optional("use-caches"): bool,
# if true (the default), perform a checkout of gecko on the worker
Required("checkout"): bool,
Optional(
"cwd",
description="Path to run command in. If a checkout is present, the path "
"to the checkout will be interpolated with the key `checkout`",
): text_type,
# The sparse checkout profile to use. Value is the filename relative to the
# directory where sparse profiles are defined (build/sparse-profiles/).
Required("sparse-profile"): Any(text_type, None),
# if true, perform a checkout of a comm-central based branch inside the
# gecko checkout
Required("comm-checkout"): bool,
# The command arguments to pass to the `run-task` script, after the
# checkout arguments. If a list, it will be passed directly; otherwise
# it will be included in a single argument to `bash -cx`.
Required("command"): Any([taskref_or_string], taskref_or_string),
# Base work directory used to set up the task.
Optional("workdir"): text_type,
# If not false, tooltool downloads will be enabled via relengAPIProxy
# for either just public files, or all files. Only supported on
# docker-worker.
Required("tooltool-downloads"): Any(
False,
"public",
"internal",
),
# Whether to run as root. (defaults to False)
Optional("run-as-root"): bool,
}
)
def common_setup(config, job, taskdesc, command):
run = job["run"]
if run["checkout"]:
support_vcs_checkout(config, job, taskdesc, sparse=bool(run["sparse-profile"]))
command.append(
"--gecko-checkout={}".format(taskdesc["worker"]["env"]["GECKO_PATH"])
)
if run["sparse-profile"]:
command.append(
"--gecko-sparse-profile=build/sparse-profiles/%s" % run["sparse-profile"]
)
taskdesc["worker"].setdefault("env", {})["MOZ_SCM_LEVEL"] = config.params["level"]
worker_defaults = {
"cache-dotcache": False,
"checkout": True,
"comm-checkout": False,
"sparse-profile": None,
"tooltool-downloads": False,
"run-as-root": False,
}
def script_url(config, script):
return config.params.file_url(
"taskcluster/scripts/{}".format(script),
)
@run_job_using(
"docker-worker", "run-task", schema=run_task_schema, defaults=worker_defaults
)
def docker_worker_run_task(config, job, taskdesc):
run = job["run"]
worker = taskdesc["worker"] = job["worker"]
command = ["/builds/worker/bin/run-task"]
common_setup(config, job, taskdesc, command)
if run["tooltool-downloads"]:
internal = run["tooltool-downloads"] == "internal"
add_tooltool(config, job, taskdesc, internal=internal)
if run.get("cache-dotcache"):
worker["caches"].append(
{
"type": "persistent",
"name": "{project}-dotcache".format(**config.params),
"mount-point": "{workdir}/.cache".format(**run),
"skip-untrusted": True,
}
)
run_command = run["command"]
run_cwd = run.get("cwd")
if run_cwd and run["checkout"]:
run_cwd = path.normpath(
run_cwd.format(checkout=taskdesc["worker"]["env"]["GECKO_PATH"])
)
elif run_cwd and "{checkout}" in run_cwd:
raise Exception(
"Found `{{checkout}}` interpolation in `cwd` for task {name} "
"but the task doesn't have a checkout: {cwd}".format(
cwd=run_cwd, name=job.get("name", job.get("label"))
)
)
# dict is for the case of `{'task-reference': text_type}`.
if isinstance(run_command, (text_type, dict)):
run_command = ["bash", "-cx", run_command]
if run["comm-checkout"]:
command.append(
"--comm-checkout={}/comm".format(taskdesc["worker"]["env"]["GECKO_PATH"])
)
command.append("--fetch-hgfingerprint")
if run["run-as-root"]:
command.extend(("--user", "root", "--group", "root"))
if run_cwd:
command.extend(("--task-cwd", run_cwd))
command.append("--")
command.extend(run_command)
worker["command"] = command
@run_job_using(
"generic-worker", "run-task", schema=run_task_schema, defaults=worker_defaults
)
def generic_worker_run_task(config, job, taskdesc):
run = job["run"]
worker = taskdesc["worker"] = job["worker"]
is_win = worker["os"] == "windows"
is_mac = worker["os"] == "macosx"
is_bitbar = worker["os"] == "linux-bitbar"
if run["tooltool-downloads"]:
internal = run["tooltool-downloads"] == "internal"
add_tooltool(config, job, taskdesc, internal=internal)
if is_win:
command = ["C:/mozilla-build/python3/python3.exe", "run-task"]
elif is_mac:
command = ["/usr/local/bin/python3", "run-task"]
else:
command = ["./run-task"]
common_setup(config, job, taskdesc, command)
worker.setdefault("mounts", [])
if run.get("cache-dotcache"):
worker["mounts"].append(
{
"cache-name": "{project}-dotcache".format(**config.params),
"directory": "{workdir}/.cache".format(**run),
}
)
worker["mounts"].append(
{
"content": {
"url": script_url(config, "run-task"),
},
"file": "./run-task",
}
)
if worker.get("env", {}).get("MOZ_FETCHES"):
worker["mounts"].append(
{
"content": {
"url": script_url(config, "misc/fetch-content"),
},
"file": "./fetch-content",
}
)
run_command = run["command"]
run_cwd = run.get("cwd")
if run_cwd and run["checkout"]:
run_cwd = path.normpath(
run_cwd.format(checkout=taskdesc["worker"]["env"]["GECKO_PATH"])
)
elif run_cwd and "{checkout}" in run_cwd:
raise Exception(
"Found `{{checkout}}` interpolation in `cwd` for task {name} "
"but the task doesn't have a checkout: {cwd}".format(
cwd=run_cwd, name=job.get("name", job.get("label"))
)
)
if isinstance(run_command, text_type):
if is_win:
run_command = '"{}"'.format(run_command)
run_command = ["bash", "-cx", run_command]
if run["comm-checkout"]:
command.append(
"--comm-checkout={}/comm".format(taskdesc["worker"]["env"]["GECKO_PATH"])
)
if run["run-as-root"]:
command.extend(("--user", "root", "--group", "root"))
if run_cwd:
command.extend(("--task-cwd", run_cwd))
command.append("--")
if is_bitbar:
# Use the bitbar wrapper script which sets up the device and adb
# environment variables
command.append("/builds/taskcluster/script.py")
command.extend(run_command)
if is_win:
worker["command"] = [" ".join(command)]
else:
worker["command"] = [
["chmod", "+x", "run-task"],
command,
]
|
