def display(ctx, task, reverse=None, show_cache=False):
"""
Display a task and its dependencies visually.
"""
registry = TaskRegistry.get()
gb = graph.GraphBuilder(registry, ctx.obj["manifest"])
dag = gb.build(task, influence=show_cache)
options = JoltOptions()
acache = cache.ArtifactCache.get(options)
if reverse:
def iterator(task):
return list(dag.predecessors(task))
reverse = utils.as_list(reverse)
tasklist = dag.select(lambda graph, node: node.short_qualified_name in
reverse or node.qualified_name in reverse)
else:
def iterator(task):
return task.children
tasklist = dag.requested_goals
if dag.has_tasks():
def _display(task, indent=0, last=None):
header = ""
if indent > 0:
for pipe in last[:-1]:
if pipe:
header += "\u2502 "
else:
header += " "
if last[-1]:
header += "\u251c\u2574"
else:
header += "\u2514\u2574"
if not show_cache:
colorize = str
elif task.is_cacheable() and not acache.is_available(task):
colorize = colors.red
else:
colorize = colors.green
print(header + colorize(task.short_qualified_name))
children = iterator(task)
for i in range(0, len(children)):
_display(children[i],
indent + 1,
last=(last or []) + [i + 1 != len(children)])
for task in tasklist:
_display(task)
else:
log.info("no tasks to display")
def __init__(self, registry, manifest, options=None, progress=False):
self.graph = Graph()
self.nodes = {}
self.registry = registry
self.manifest = manifest
self.progress = progress
self.options = options or JoltOptions()
def __init__(self, options=None):
self._options = options or JoltOptions()
self._factories = [
factory(self._options)
for factory in self.__class__.executor_factories
]
self._local_factory = LocalExecutorFactory(self._options)
self._concurrent_factory = ConcurrentLocalExecutorFactory(
self._options)
self._extensions = [
factory().create()
for factory in self.__class__.extension_factories
]
def freeze(ctx, task, default, output, remove):
"""
Freeze the identity of a task.
<WIP>
"""
manifest = ctx.obj["manifest"]
options = JoltOptions(default=default)
acache = cache.ArtifactCache.get(options)
scheduler.ExecutorRegistry.get(options)
registry = TaskRegistry.get()
for params in default:
registry.set_default_parameters(params)
gb = graph.GraphBuilder(registry, manifest)
dag = gb.build(task)
available_in_cache = [
(t.is_available_locally(acache)
or (t.is_available_remotely(acache) and acache.download_enabled()), t)
for t in dag.tasks if t.is_cacheable()
]
for available, task in available_in_cache:
raise_task_error_if(
not remove and not available, task,
"task artifact is not available in any cache, build it first")
for task in dag.tasks:
if task.is_resource() or not task.is_cacheable():
continue
manifest_task = manifest.find_task(task)
if remove and manifest_task:
manifest.remove_task(manifest_task)
continue
if not remove:
if not manifest_task:
manifest_task = manifest.create_task()
manifest_task.name = task.qualified_name
manifest_task.identity = task.identity
manifest.write(fs.path.join(JoltLoader.get().joltdir, output))
def __init__(self, options=None, max_workers=None):
self.pool = ThreadPoolExecutor(max_workers=max_workers)
self._aborted = False
self._queue = queue.PriorityQueue()
self._options = options or JoltOptions()
def build(ctx, task, network, keep_going, default, local, no_download,
no_upload, download, upload, worker, force, salt, copy, debug,
result, jobs):
"""
Build task artifact.
TASK is the name of the task to execute. It is optionally followed by a colon and
parameter value assignments. Assignments are separated by commas. Example:
taskname:param1=value1,param2=value2
Default parameter values can be overridden for any task in the dependency tree
with --default. DEFAULT is a qualified task name, just like TASK, but parameter
assignments change default values.
By default, a task is executed locally and the resulting artifact is stored
in the local artifact cache. If an artifact is already available in the cache,
no execution takes place. Artifacts are identified with a hash digest,
constructed from hashing task attributes.
When remote cache providers are configured, artifacts may be downloaded from and/or
uploaded to the remote cache as execution progresses. Several options exist to control
the behavior, such as --local which disables all remote caches.
Distributed task execution is enabled by passing the --network option. Tasks are then
distributed to and executed by a pool of workers, if one has been configured.
Rebuilds can be forced with either --force or --salt. --force rebuilds the requested
task, but not its dependencies. --salt affects the entire dependency tree. Both add
an extra attribute to the task hash calculation in order to taint the identity and
induce a cache miss. In both cases, existing intermediate files in build directories
are removed before execution starts.
"""
raise_error_if(network and local,
"The -n and -l flags are mutually exclusive")
raise_error_if(network and debug,
"The -g and -n flags are mutually exclusive")
raise_error_if(
no_download and download,
"The --download and --no-download flags are mutually exclusive")
raise_error_if(
no_upload and upload,
"The --upload and --no-upload flags are mutually exclusive")
duration = utils.duration()
task = list(task)
task = [utils.stable_task_name(t) for t in task]
if network:
_download = config.getboolean("network", "download", True)
_upload = config.getboolean("network", "upload", True)
else:
_download = config.getboolean("jolt", "download", True)
_upload = config.getboolean("jolt", "upload", True)
if local:
_download = False
_upload = False
else:
if no_download:
_download = False
if no_upload:
_upload = False
if download:
_download = True
if upload:
_upload = True
options = JoltOptions(network=network,
local=local,
download=_download,
upload=_upload,
keep_going=keep_going,
default=default,
worker=worker,
debug=debug,
salt=salt,
jobs=jobs)
acache = cache.ArtifactCache.get(options)
executors = scheduler.ExecutorRegistry.get(options)
if worker:
log.set_worker()
log.verbose("Local build as a worker")
strategy = scheduler.WorkerStrategy(executors, acache)
elif network:
log.verbose("Distributed build as a user")
strategy = scheduler.DistributedStrategy(executors, acache)
else:
log.verbose("Local build as a user")
strategy = scheduler.LocalStrategy(executors, acache)
hooks.TaskHookRegistry.get(options)
registry = TaskRegistry.get(options)
for params in default:
registry.set_default_parameters(params)
manifest = ctx.obj["manifest"]
for mb in manifest.builds:
for mt in mb.tasks:
task.append(mt.name)
for mt in mb.defaults:
registry.set_default_parameters(mt.name)
if force:
for goal in task:
registry.get_task(goal, manifest=manifest).taint = uuid.uuid4()
gb = graph.GraphBuilder(registry, manifest, options, progress=True)
dag = gb.build(task)
gp = graph.GraphPruner(strategy)
dag = gp.prune(dag)
goal_tasks = dag.goals
goal_task_duration = 0
queue = scheduler.TaskQueue(strategy)
try:
if not dag.has_tasks():
return
progress = log.progress(
"Progress",
dag.number_of_tasks(filterfn=lambda t: not t.is_resource()),
" tasks",
estimates=False,
debug=debug)
with progress:
while dag.has_tasks():
# Find all tasks ready to be executed
leafs = dag.select(lambda graph, task: task.is_ready())
# Order the tasks by their weights to improve build times
leafs.sort(key=lambda x: x.weight)
while leafs:
task = leafs.pop()
queue.submit(acache, task)
task, error = queue.wait()
if not task:
dag.debug()
break
elif task.is_goal() and task.duration_running:
goal_task_duration += task.duration_running.seconds
if not task.is_resource():
progress.update(1)
if not keep_going and error is not None:
queue.abort()
raise error
if dag.failed:
log.error("List of failed tasks")
for failed in dag.failed:
log.error("- {}", failed.log_name.strip("()"))
raise_error("no more tasks could be executed")
for goal in goal_tasks:
if acache.is_available_locally(goal):
with acache.get_artifact(goal) as artifact:
log.info("Location: {0}", artifact.path)
if copy:
artifact.copy("*",
utils.as_dirpath(
fs.path.join(
workdir,
click.format_filename(copy))),
symlinks=True)
except KeyboardInterrupt:
print()
log.warning("Interrupted by user")
try:
queue.abort()
sys.exit(1)
except KeyboardInterrupt:
print()
log.warning("Interrupted again, exiting")
_exit(1)
finally:
log.info("Total execution time: {0} {1}", str(duration),
str(queue.duration_acc) if network else '')
if result:
with report.update() as manifest:
manifest.duration = str(goal_task_duration)
manifest.write(result)
def compdb(ctx, task, default):
"""
Generate a compilation database for a task.
Aggregates compilation databases found in artifacts of the specified task and
its dependencies. The commands are then post-processed and localized to the
current workspace.
All task artifacts are sandboxed and their directory trees are recreated
using symlinks pointing to the origin of collected files. When opening a
file, an IDE can then follow the symlinks into the workspace instead of
opening files in the artifact cache.
The database must be regenerated if dependencies or the directory tree
of an artifact change.
"""
manifest = ctx.obj["manifest"]
options = JoltOptions(default=default)
acache = cache.ArtifactCache.get(options)
TaskHookRegistry.get(options)
executors = scheduler.ExecutorRegistry.get(options)
registry = TaskRegistry.get()
strategy = scheduler.DownloadStrategy(executors, acache)
queue = scheduler.TaskQueue(strategy)
for params in default:
registry.set_default_parameters(params)
gb = graph.GraphBuilder(registry, manifest, options, progress=True)
dag = gb.build(task)
try:
with log.progress("Progress",
dag.number_of_tasks(),
" tasks",
estimates=False,
debug=False) as p:
while dag.has_tasks():
leafs = dag.select(lambda graph, task: task.is_ready())
# Order the tasks by their weights to improve build times
leafs.sort(key=lambda x: x.weight)
while leafs:
task = leafs.pop()
queue.submit(acache, task)
task, error = queue.wait()
p.update(1)
except KeyboardInterrupt:
print()
log.warning("Interrupted by user")
try:
queue.abort()
sys.exit(1)
except KeyboardInterrupt:
print()
log.warning("Interrupted again, exiting")
os._exit(1)
for goal in dag.goals:
artifact, deps = get_task_artifacts(goal)
db = CompDB("all_compile_commands.json", artifact)
db.read()
db.relocate(goal, sandboxes=True)
outdir = goal.tools.builddir("compdb", incremental=True)
dbpath = fs.path.join(outdir, "all_compile_commands.json")
db.write(dbpath, force=True)
stage_artifacts(deps + [artifact], goal.tools)
log.info("Compilation DB: {}", dbpath)