fune/taskcluster/taskgraph/util/cached_tasks.py
Tom Prince dd4df1aec9 Bug 1415619: Add a separate trust-domain to cached tasks. r=dustin,gps
This allows firefox and thunderbird builds to avoid using each others bits.

MozReview-Commit-ID: KYQYDd2tkGj

--HG--
extra : rebase_source : 42f1d13ec609f066cb3bd3050ed894296b72d982
2017-11-09 17:15:29 -07:00

97 lines
4 KiB
Python

# 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/.
from __future__ import absolute_import, print_function, unicode_literals
import hashlib
import time
TARGET_CACHE_INDEX = (
'{trust_domain}.cache.level-{level}.{type}.{name}.hash.{digest}'
)
EXTRA_CACHE_INDEXES = [
'{trust_domain}.cache.level-{level}.{type}.{name}.latest',
'{trust_domain}.cache.level-{level}.{type}.{name}.pushdate.{build_date_long}',
]
def add_optimization(config, taskdesc, cache_type, cache_name, digest=None, digest_data=None):
"""
Allow the results of this task to be cached. This adds index routes to the
task so it can be looked up for future runs, and optimization hints so that
cached artifacts can be found. Exactly one of `digest` and `digest_data`
must be passed.
:param TransformConfig config: The configuration for the kind being transformed.
:param dict taskdesc: The description of the current task.
:param str cache_type: The type of task result being cached.
:param str cache_name: The name of the object being cached.
:param digest: A unique string indentifying this version of the artifacts
being generated. Typically this will be the hash of inputs to the task.
:type digest: bytes or None
:param digest_data: A list of bytes representing the inputs of this task.
They will be concatenated and hashed to create the digest for this
task.
:type digest_data: list of bytes or None
"""
if (digest is None) == (digest_data is None):
raise Exception("Must pass exactly one of `digest` and `digest_data`.")
if digest is None:
digest = hashlib.sha256('\n'.join(digest_data)).hexdigest()
subs = {
'trust_domain': config.graph_config['trust-domain'],
'type': cache_type,
'name': cache_name,
'digest': digest,
}
# We'll try to find a cached version of the toolchain at levels above
# and including the current level, starting at the highest level.
index_routes = []
for level in reversed(range(int(config.params['level']), 4)):
subs['level'] = level
index_routes.append(TARGET_CACHE_INDEX.format(**subs))
taskdesc['optimization'] = {'index-search': index_routes}
# ... and cache at the lowest level.
taskdesc.setdefault('routes', []).append(
'index.{}'.format(TARGET_CACHE_INDEX.format(**subs)))
# ... and add some extra routes for humans
subs['build_date_long'] = time.strftime("%Y.%m.%d.%Y%m%d%H%M%S",
time.gmtime(config.params['build_date']))
taskdesc['routes'].extend([
'index.{}'.format(route.format(**subs))
for route in EXTRA_CACHE_INDEXES
])
def cached_index_path(level, trust_domain, cache_type, cache_name, digest=None, digest_data=None):
"""
Get the index path needed to locate the task that would be created by
:func:`add_optimization`.
:param int level: The SCM level of the task to look for.
:param str trust_domain: The trust domain to look for the task in.
:param str cache_type: The type of task result being cached.
:param str cache_name: The name of the object being cached.
:param digest: A unique string indentifying this version of the artifacts
being generated. Typically this will be the hash of inputs to the task.
:type digest: bytes or None
:param digest_data: A list of bytes representing the inputs of this task.
They will be concatenated and hashed to create the digest for this
task.
:type digest_data: list of bytes or None
:return str: The index path.
"""
if (digest is None) == (digest_data is None):
raise Exception("Must pass exactly one of `digest` and `digest_data`.")
if digest is None:
digest = hashlib.sha256('\n'.join(digest_data)).hexdigest()
return TARGET_CACHE_INDEX.format(
trust_domain=trust_domain, level=level, type=cache_type, name=cache_name, digest=digest)