summaryrefslogtreecommitdiffstats
path: root/taskcluster/gecko_taskgraph/loader/transform.py
blob: 1e513bcb73bcb8feddd34f7ee140d00a83fa4e25 (plain)
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
# 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 logging

from taskgraph.util.yaml import load_yaml

from ..util.templates import merge

logger = logging.getLogger(__name__)


def loader(kind, path, config, params, loaded_tasks):
    """
    Get the input elements that will be transformed into tasks in a generic
    way.  The elements themselves are free-form, and become the input to the
    first transform.

    By default, this reads jobs from the `jobs` key, or from yaml files
    named by `jobs-from`.  The entities are read from mappings, and the
    keys to those mappings are added in the `name` key of each entity.

    If there is a `job-defaults` config, then every job is merged with it.
    This provides a simple way to set default values for all jobs of a kind.
    The `job-defaults` key can also be specified in a yaml file pointed to by
    `jobs-from`. In this case it will only apply to tasks defined in the same
    file.

    Other kind implementations can use a different loader function to
    produce inputs and hand them to `transform_inputs`.
    """

    def jobs():
        defaults = config.get("job-defaults")
        for name, job in config.get("jobs", {}).items():
            if defaults:
                job = merge(defaults, job)
            job["job-from"] = "kind.yml"
            yield name, job

        for filename in config.get("jobs-from", []):
            tasks = load_yaml(path, filename)

            file_defaults = tasks.pop("job-defaults", None)
            if defaults:
                file_defaults = merge(defaults, file_defaults or {})

            for name, job in tasks.items():
                if file_defaults:
                    job = merge(file_defaults, job)
                job["job-from"] = filename
                yield name, job

    for name, job in jobs():
        job["name"] = name
        logger.debug(f"Generating tasks for {kind} {name}")
        yield job