author Alex Chronopoulos <>
Tue, 26 Dec 2017 09:48:25 +0100
changeset 445463 cb9a0bfe28ea476c6299d7684dab4b6f2a0b4e0f
parent 444128 7474dc45cbe36534ad063540b5fe4ae4a17eb59c
child 454002 0c677fb018bee767363215edb0b6d0cb4ffb8111
permissions -rw-r--r--
Bug 1426719 - Pick cubeb e1e8337 to beta. r=jesup a=jcristau

# 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

Templates provide a way of modifying the task definition of selected
tasks. They live under taskcluster/taskgraph/templates.

from __future__ import absolute_import, print_function, unicode_literals

import os
from abc import ABCMeta, abstractmethod
from argparse import Action

from mozbuild.base import BuildEnvironmentNotFoundException, MozbuildObject

here = os.path.abspath(os.path.dirname(__file__))

class Template(object):
    __metaclass__ = ABCMeta

    def add_arguments(self, parser):

    def context(self, **kwargs):

class Artifact(Template):

    def add_arguments(self, parser):
        group = parser.add_mutually_exclusive_group()
        group.add_argument('--artifact', action='store_true',
                           help='Force artifact builds where possible.')
        group.add_argument('--no-artifact', action='store_true',
                           help='Disable artifact builds even if being used locally.')

    def context(self, artifact, no_artifact, **kwargs):
        if artifact:
            return {'enabled': '1'}

        if no_artifact:

        build = MozbuildObject.from_environment(cwd=here)
            if build.substs.get("MOZ_ARTIFACT_BUILDS"):
                print("Artifact builds enabled, pass --no-artifact to disable")
                return {'enabled': '1'}
        except BuildEnvironmentNotFoundException:

class Environment(Template):

    def add_arguments(self, parser):
        parser.add_argument('--env', action='append', default=None,
                            help='Set an environment variable, of the form FOO=BAR. '
                                 'Can be passed in multiple times.')

    def context(self, env, **kwargs):
        if not env:
        return dict(e.split('=', 1) for e in env)

class RangeAction(Action):
    def __init__(self, min, max, *args, **kwargs):
        self.min = min
        self.max = max
        kwargs['metavar'] = '[{}-{}]'.format(self.min, self.max)
        super(RangeAction, self).__init__(*args, **kwargs)

    def __call__(self, parser, namespace, values, option_string=None):
        name = option_string or self.dest
        if values < self.min:
            parser.error('{} can not be less than {}'.format(name, self.min))
        if values > self.max:
            parser.error('{} can not be more than {}'.format(name, self.max))
        setattr(namespace, self.dest, values)

class Rebuild(Template):

    def add_arguments(self, parser):
        parser.add_argument('--rebuild', action=RangeAction, min=2, max=20, default=None, type=int,
                            help='Rebuild all selected tasks the specified number of times.')

    def context(self, rebuild, **kwargs):
        if not rebuild:

        return rebuild

all_templates = {
    'artifact': Artifact,
    'env': Environment,
    'rebuild': Rebuild,