taskgraph.transforms package

Submodules

taskgraph.transforms.balrog module

Transform the beetmover task into an actual task description.

taskgraph.transforms.balrog.make_task_description(config, jobs)
taskgraph.transforms.balrog.validate(config, jobs)

taskgraph.transforms.base module

class taskgraph.transforms.base.TransformConfig(kind, path, config, params, kind_dependencies_tasks=None, graph_config=None)

Bases: object

A container for configuration affecting transforms. The config argument to transforms is an instance of this class, possibly with additional kind-specific attributes beyond those set here.

class taskgraph.transforms.base.TransformSequence(transforms=None)

Bases: object

Container for a sequence of transforms. Each transform is represented as a callable taking (config, items) and returning a generator which will yield transformed items. The resulting sequence has the same interface.

This is convenient to use in a file full of transforms, as it provides a decorator, @transforms.add, that will add the decorated function to the sequence.

add(func)

taskgraph.transforms.beetmover module

Transform the beetmover task into an actual task description.

taskgraph.transforms.beetmover.generate_upstream_artifacts(signing_task_ref, build_task_ref, platform, locale=None)
taskgraph.transforms.beetmover.make_task_description(config, jobs)
taskgraph.transforms.beetmover.make_task_worker(config, jobs)
taskgraph.transforms.beetmover.validate(config, jobs)

taskgraph.transforms.beetmover_cdns module

Transform the beetmover-cdns task into a task description.

taskgraph.transforms.beetmover_cdns.make_beetmover_cdns_description(config, jobs)
taskgraph.transforms.beetmover_cdns.make_beetmover_cdns_worker(config, jobs)
taskgraph.transforms.beetmover_cdns.validate(config, jobs)

taskgraph.transforms.beetmover_checksums module

Transform the checksums signing task into an actual task description.

taskgraph.transforms.beetmover_checksums.generate_upstream_artifacts(refs, platform, locale=None)
taskgraph.transforms.beetmover_checksums.make_beetmover_checksums_description(config, jobs)
taskgraph.transforms.beetmover_checksums.make_beetmover_checksums_worker(config, jobs)
taskgraph.transforms.beetmover_checksums.validate(config, jobs)

taskgraph.transforms.beetmover_l10n module

Transform the signing task into an actual task description.

taskgraph.transforms.beetmover_l10n.make_beetmover_description(config, jobs)

taskgraph.transforms.beetmover_repackage module

Transform the beetmover task into an actual task description.

taskgraph.transforms.beetmover_repackage.generate_partials_upstream_artifacts(artifacts, platform, locale=None)
taskgraph.transforms.beetmover_repackage.generate_upstream_artifacts(build_task_ref, build_signing_task_ref, repackage_task_ref, repackage_signing_task_ref, platform, locale=None)
taskgraph.transforms.beetmover_repackage.is_valid_beetmover_job(job)
taskgraph.transforms.beetmover_repackage.make_partials_artifacts(config, jobs)
taskgraph.transforms.beetmover_repackage.make_task_description(config, jobs)
taskgraph.transforms.beetmover_repackage.make_task_worker(config, jobs)
taskgraph.transforms.beetmover_repackage.validate(config, jobs)

taskgraph.transforms.beetmover_repackage_l10n module

Transform the signing task into an actual task description.

taskgraph.transforms.beetmover_repackage_l10n.make_beetmover_description(config, jobs)

taskgraph.transforms.beetmover_source module

Transform the beetmover-source task to also append build as dependency

taskgraph.transforms.beetmover_source.tweak_beetmover_source_dependencies_and_upstream_artifacts(config, jobs)

taskgraph.transforms.bouncer_check module

taskgraph.transforms.bouncer_check.add_command(config, jobs)
taskgraph.transforms.bouncer_check.add_previous_versions(config, jobs)
taskgraph.transforms.bouncer_check.command_to_string(config, jobs)

Convert command to string to make it work properly with run-task

taskgraph.transforms.bouncer_check.handle_keyed_by(config, jobs)

Resolve fields that can be keyed by project, etc.

taskgraph.transforms.build module

Apply some defaults and minor modifications to the jobs defined in the build kind.

taskgraph.transforms.build.set_defaults(config, jobs)

Set defaults, including those that differ per worker implementation

taskgraph.transforms.build.set_env(config, jobs)

Set extra environment variables from try command line.

taskgraph.transforms.build_attrs module

taskgraph.transforms.build_attrs.set_build_attributes(config, jobs)

Set the build_platform and build_type attributes based on the job name. Although not all jobs using this transform are actual “builds”, the try option syntax treats them as such, and this arranges the attributes appropriately for that purpose.

taskgraph.transforms.build_attrs.set_schedules_optimization(config, jobs)

Set the skip-unless-affected optimization based on the build platform.

taskgraph.transforms.build_lints module

Apply some defaults and minor modifications to the jobs defined in the build kind.

taskgraph.transforms.build_lints.check_mozharness_perfherder_options(config, jobs)

Verify that multiple jobs don’t use the same perfherder bucket.

Build jobs record perfherder metrics by default. Perfherder metrics go to a bucket derived by the platform by default. The name can further be customized by the presence of “extra options” either defined in mozharness sub-configs or in an environment variable.

This linter tries to verify that no 2 jobs will send Perfherder metrics to the same bucket by looking for jobs not defining extra options when their platform or mozharness config are otherwise similar.

taskgraph.transforms.build_signing module

Transform the signing task into an actual task description.

taskgraph.transforms.build_signing.add_signed_routes(config, jobs)

Add routes corresponding to the routes of the build task this corresponds to, with .signed inserted, for all gecko.v2 routes

taskgraph.transforms.build_signing.define_upstream_artifacts(config, jobs)

taskgraph.transforms.checksums_signing module

Transform the checksums signing task into an actual task description.

taskgraph.transforms.checksums_signing.make_checksums_signing_description(config, jobs)
taskgraph.transforms.checksums_signing.validate(config, jobs)

taskgraph.transforms.coalesce module

This transform enables coalescing for tasks with scm level > 1, by defining values for the coalesce settings of the job.

taskgraph.transforms.coalesce.enable_coalescing(config, jobs)

This transform enables coalescing for tasks with scm level > 1, setting the name to be equal to the the first 20 chars of the sha256 of the task name (label). The hashing is simply used to keep the name short, unique, and alphanumeric, since it is used in AMQP routing keys.

Note, the coalescing keys themselves are not intended to be readable strings or embed information. The tasks they represent contain all relevant metadata.

taskgraph.transforms.diffoscope module

This transform construct tasks to perform diffs between builds, as defined in kind.yml

taskgraph.transforms.diffoscope.fill_template(config, tasks)
taskgraph.transforms.diffoscope.validate(config, tasks)

taskgraph.transforms.docker_image module

taskgraph.transforms.docker_image.fill_template(config, tasks)
taskgraph.transforms.docker_image.order_image_tasks(config, tasks)

Iterate image tasks in an order where parent images come first.

taskgraph.transforms.docker_image.validate(config, tasks)

taskgraph.transforms.final_verify module

Transform the beetmover task into an actual task description.

taskgraph.transforms.final_verify.add_command(config, tasks)

taskgraph.transforms.google_play_strings module

Transform the push-apk kind into an actual task description.

taskgraph.transforms.google_play_strings.set_worker_data(config, jobs)

taskgraph.transforms.l10n module

Do transforms specific to l10n kind

taskgraph.transforms.l10n.all_locales_attribute(config, jobs)
taskgraph.transforms.l10n.chunk_locales(config, jobs)

Utilizes chunking for l10n stuff

taskgraph.transforms.l10n.copy_in_useful_magic(config, jobs)
taskgraph.transforms.l10n.handle_keyed_by(config, jobs)

Resolve fields that can be keyed by platform, etc.

taskgraph.transforms.l10n.make_job_description(config, jobs)
taskgraph.transforms.l10n.mh_config_replace_project(config, jobs)

Replaces {project} in mh config entries with the current project

taskgraph.transforms.l10n.mh_options_replace_project(config, jobs)

Replaces {project} in mh option entries with the current project

taskgraph.transforms.l10n.setup_name(config, jobs)
taskgraph.transforms.l10n.setup_nightly_dependency(config, jobs)

Sets up a task dependency to the signing job this relates to

taskgraph.transforms.l10n.validate_again(config, jobs)
taskgraph.transforms.l10n.validate_early(config, jobs)

taskgraph.transforms.marionette_harness module

Set dynamic task description properties of the marionette-harness task.

taskgraph.transforms.marionette_harness.setup_task(config, tasks)

taskgraph.transforms.name_sanity module

Generate labels for tasks without names, consistently. Uses attributes from ‘dependent-task’.

taskgraph.transforms.name_sanity.make_label(config, jobs)

Generate a sane label for a new task constructed from a dependency Using attributes from the dependent job and the current task kind

taskgraph.transforms.nightly_l10n_signing module

Transform the signing task into an actual task description.

taskgraph.transforms.nightly_l10n_signing.define_upstream_artifacts(config, jobs)
taskgraph.transforms.nightly_l10n_signing.make_signing_description(config, jobs)

taskgraph.transforms.partials module

Transform the partials task into an actual task description.

taskgraph.transforms.partials.make_task_description(config, jobs)

taskgraph.transforms.partials_signing module

Transform the partials task into an actual task description.

taskgraph.transforms.partials_signing.generate_upstream_artifacts(release_history, platform, locale=None)
taskgraph.transforms.partials_signing.make_task_description(config, jobs)

taskgraph.transforms.partner_repack module

Transform the partner repack task into an actual task description.

taskgraph.transforms.partner_repack.resolve_properties(config, tasks)

taskgraph.transforms.push_apk module

Transform the push-apk kind into an actual task description.

taskgraph.transforms.push_apk.generate_upstream_artifacts(dependencies)
taskgraph.transforms.push_apk.make_task_description(config, jobs)

taskgraph.transforms.push_apk_breakpoint module

Transform the push-apk-breakpoint kind into an actual task description.

taskgraph.transforms.push_apk_breakpoint.make_task_description(config, jobs)

taskgraph.transforms.release_balrog_publishing module

Add from parameters.yml into Balrog publishing tasks.

taskgraph.transforms.release_balrog_publishing.add_release_eta(config, jobs)

taskgraph.transforms.release_deps module

Add dependencies to release tasks.

taskgraph.transforms.release_deps.add_dependencies(config, jobs)

taskgraph.transforms.release_mark_as_shipped module

Add from parameters.yml into Balrog publishing tasks.

taskgraph.transforms.release_mark_as_shipped.make_task_description(config, jobs)

taskgraph.transforms.release_notifications module

Add notifications via taskcluster-notify for release tasks

taskgraph.transforms.release_notifications.add_notifications(config, jobs)

taskgraph.transforms.release_snap module

taskgraph.transforms.release_snap.format(config, tasks)

Apply format substitution to worker.env and worker.command.

taskgraph.transforms.release_updates module

Transform the update generation task into an actual task description.

taskgraph.transforms.release_updates.add_command(config, tasks)

taskgraph.transforms.repackage module

Transform the repackage task into an actual task description.

taskgraph.transforms.repackage.copy_in_useful_magic(config, jobs)

Copy attributes from upstream task to be used for keyed configuration.

taskgraph.transforms.repackage.handle_keyed_by(config, jobs)

Resolve fields that can be keyed by platform, etc.

taskgraph.transforms.repackage.make_job_description(config, jobs)
taskgraph.transforms.repackage.make_repackage_description(config, jobs)
taskgraph.transforms.repackage.validate(config, jobs)

taskgraph.transforms.repackage_l10n module

Transform the repackage task into an actual task description.

taskgraph.transforms.repackage_l10n.split_locales(config, jobs)

taskgraph.transforms.repackage_routes module

Add indexes to repackage kinds

taskgraph.transforms.repackage_routes.add_indexes(config, jobs)
taskgraph.transforms.repackage_routes.validate(config, jobs)

taskgraph.transforms.repackage_signing module

Transform the repackage signing task into an actual task description.

taskgraph.transforms.repackage_signing.make_repackage_signing_description(config, jobs)
taskgraph.transforms.repackage_signing.validate(config, jobs)

taskgraph.transforms.reverse_chunk_deps module

Adjust dependencies to not exceed MAX_DEPENDENCIES

taskgraph.transforms.reverse_chunk_deps.add_dependencies(config, jobs)
taskgraph.transforms.reverse_chunk_deps.yield_job(orig_job, deps, count)

taskgraph.transforms.signing module

Transform the signing task into an actual task description.

taskgraph.transforms.signing.make_task_description(config, jobs)
taskgraph.transforms.signing.set_defaults(config, jobs)
taskgraph.transforms.signing.validate(config, jobs)

taskgraph.transforms.source_test module

Source-test jobs can run on multiple platforms. These transforms allow jobs with either platform or a list of platforms, and set the appropriate treeherder configuration and attributes for that platform.

taskgraph.transforms.source_test.add_build_dependency(config, job)

Add build dependency to the job and installer_url to env.

taskgraph.transforms.source_test.expand_platforms(config, jobs)
taskgraph.transforms.source_test.handle_platform(config, jobs)

Handle the ‘platform’ property, setting up treeherder context as well as try-related attributes.

taskgraph.transforms.source_test.set_defaults(config, jobs)
taskgraph.transforms.source_test.set_job_name(config, jobs)
taskgraph.transforms.source_test.validate(config, jobs)

taskgraph.transforms.spidermonkey module

taskgraph.transforms.spidermonkey.handle_keyed_by(config, jobs)

Resolve fields that can be keyed by platform, etc.

taskgraph.transforms.task module

These transformations take a task description and turn it into a TaskCluster task definition (along with attributes, label, etc.). The input to these transformations is generic to any kind of task, but abstracts away some of the complexities of worker implementations, scopes, and treeherder annotations.

taskgraph.transforms.task.add_generic_index_routes(config, task)
taskgraph.transforms.task.add_index_routes(config, tasks)
taskgraph.transforms.task.add_l10n_index_routes(config, task, force_locale=None)
taskgraph.transforms.task.add_nightly_index_routes(config, task)
taskgraph.transforms.task.add_nightly_l10n_index_routes(config, task, force_locale=None)
taskgraph.transforms.task.add_nightly_multi_index_routes(config, task)
taskgraph.transforms.task.add_release_index_routes(config, task)
taskgraph.transforms.task.build_always_optimized_payload(config, task, task_def)
taskgraph.transforms.task.build_balrog_payload(config, task, task_def)
taskgraph.transforms.task.build_beetmover_cdns_payload(config, task, task_def)
taskgraph.transforms.task.build_beetmover_payload(config, task, task_def)
taskgraph.transforms.task.build_binary_transparency_payload(config, task, task_def)
taskgraph.transforms.task.build_buildbot_bridge_payload(config, task, task_def)
taskgraph.transforms.task.build_docker_worker_payload(config, task, task_def)
taskgraph.transforms.task.build_generic_worker_payload(config, task, task_def)
taskgraph.transforms.task.build_invalid_payload(config, task, task_def)
taskgraph.transforms.task.build_macosx_engine_payload(config, task, task_def)
taskgraph.transforms.task.build_push_apk_breakpoint_payload(config, task, task_def)
taskgraph.transforms.task.build_push_apk_payload(config, task, task_def)
taskgraph.transforms.task.build_scriptworker_signing_payload(config, task, task_def)
taskgraph.transforms.task.build_ship_it_payload(config, task, task_def)
taskgraph.transforms.task.build_task(config, tasks)
taskgraph.transforms.task.chain_of_trust(config, tasks)
taskgraph.transforms.task.check_caches_are_volumes(task)

Ensures that all cache paths are defined as volumes.

Caches and volumes are the only filesystem locations whose content isn’t defined by the Docker image itself. Some caches are optional depending on the job environment. We want paths that are potentially caches to have as similar behavior regardless of whether a cache is used. To help enforce this, we require that all paths used as caches to be declared as Docker volumes. This check won’t catch all offenders. But it is better than nothing.

taskgraph.transforms.task.check_run_task_caches(config, tasks)

Audit for caches requiring run-task.

run-task manages caches in certain ways. If a cache managed by run-task is used by a non run-task task, it could cause problems. So we audit for that and make sure certain cache names are exclusive to run-task.

IF YOU ARE TEMPTED TO MAKE EXCLUSIONS TO THIS POLICY, YOU ARE LIKELY CONTRIBUTING TECHNICAL DEBT AND WILL HAVE TO SOLVE MANY OF THE PROBLEMS THAT RUN-TASK ALREADY SOLVES. THINK LONG AND HARD BEFORE DOING THAT.

taskgraph.transforms.task.check_task_dependencies(config, tasks)

Ensures that tasks don’t have more than 100 dependencies.

taskgraph.transforms.task.check_task_identifiers(config, tasks)

Ensures that all tasks have well defined identifiers: ^[a-zA-Z0-9_-]{1,22}$

taskgraph.transforms.task.coalesce_key(config, task)
taskgraph.transforms.task.index_builder(name)
taskgraph.transforms.task.payload_builder(name)
taskgraph.transforms.task.set_defaults(config, tasks)
taskgraph.transforms.task.superseder_url(config, task)
taskgraph.transforms.task.task_name_from_label(config, tasks)
taskgraph.transforms.task.validate(config, tasks)
taskgraph.transforms.task.verify_index(config, index)

taskgraph.transforms.tests module

These transforms construct a task description to run the given test, based on a test description. The implementation here is shared among all test kinds, but contains specific support for how we run tests in Gecko (via mozharness, invoked in particular ways).

This is a good place to translate a test-description option such as single-core: true to the implementation of that option in a task description (worker options, mozharness commandline, environment variables, etc.)

The test description should be fully formed by the time it reaches these transforms, and these transforms should not embody any specific knowledge about what should run where. this is the wrong place for special-casing platforms, for example - use all_tests.py instead.

taskgraph.transforms.tests.allow_software_gl_layers(config, tests)

Handle the “allow-software-gl-layers” property for platforms where it applies.

taskgraph.transforms.tests.disable_stylo(config, tests)

Disable Stylo for all jobs on -stylo-disabled platforms.

taskgraph.transforms.tests.enable_code_coverage(config, tests)

Enable code coverage for the linux64-ccov/opt & linux64-jsdcov/opt & win64-ccov/debug build-platforms

taskgraph.transforms.tests.enable_webrender(config, tests)

Handle the “webrender” property by passing a flag to mozharness if it is enabled.

taskgraph.transforms.tests.get_firefox_version()
taskgraph.transforms.tests.handle_keyed_by(config, tests)

Resolve fields that can be keyed by platform, etc.

taskgraph.transforms.tests.handle_keyed_by_mozharness(config, tests)

Resolve a mozharness field if it is keyed by something

taskgraph.transforms.tests.handle_run_on_projects(config, tests)

Handle translating built-projects appropriately

taskgraph.transforms.tests.handle_suite_category(config, tests)
taskgraph.transforms.tests.make_job_description(config, tests)

Convert test descriptions to job descriptions (input to taskgraph.transforms.job)

taskgraph.transforms.tests.normpath(path)
taskgraph.transforms.tests.set_defaults(config, tests)
taskgraph.transforms.tests.set_download_symbols(config, tests)

In general, we download symbols immediately for debug builds, but only on demand for everything else. ASAN builds shouldn’t download symbols since they don’t product symbol zips see bug 1283879

taskgraph.transforms.tests.set_expires_after(config, tests)

Try jobs expire after 2 weeks; everything else lasts 1 year. This helps keep storage costs low.

taskgraph.transforms.tests.set_profile(config, tests)

Set profiling mode for tests.

taskgraph.transforms.tests.set_retry_exit_status(config, tests)

Set the retry exit status to TBPL_RETRY, the value returned by mozharness scripts to indicate a transient failure that should be retried.

taskgraph.transforms.tests.set_tag(config, tests)

Set test for a specific tag.

taskgraph.transforms.tests.set_target(config, tests)
taskgraph.transforms.tests.set_test_type(config, tests)
taskgraph.transforms.tests.set_tier(config, tests)

Set the tier based on policy for all test descriptions that do not specify a tier otherwise.

taskgraph.transforms.tests.set_treeherder_machine_platform(config, tests)

Set the appropriate task.extra.treeherder.machine.platform

taskgraph.transforms.tests.set_worker_type(config, tests)

Set the worker type based on the test platform.

taskgraph.transforms.tests.setup_talos(config, tests)

Add options that are specific to talos jobs (identified by suite=talos)

taskgraph.transforms.tests.single_stylo_traversal_tests(config, tests)

Enable single traversal for all tests on the sequential Stylo platform.

taskgraph.transforms.tests.skip_win10_hardware(config, tests)

Windows 10 hardware isn’t ready yet, don’t even bother scheduling unless we’re on try

taskgraph.transforms.tests.split_chunks(config, tests)

Based on the ‘chunks’ key, split tests up into chunks by duplicating them and assigning ‘this-chunk’ appropriately and updating the treeherder symbol.

taskgraph.transforms.tests.split_e10s(config, tests)
taskgraph.transforms.tests.validate(config, tests)

taskgraph.transforms.try_job module

taskgraph.transforms.try_job.set_job_try_name(config, jobs)

For a task which is governed by -j in try syntax, set the job_try_name attribute based on the job name.

taskgraph.transforms.update_verify module

Transform the beetmover task into an actual task description.

taskgraph.transforms.update_verify.add_command(config, tasks)

taskgraph.transforms.upload_generated_sources module

Transform the upload-generated-files task description template,
taskcluster/ci/upload-generated-sources/kind.yml

into an actual task description.

taskgraph.transforms.upload_generated_sources.add_task_info(config, jobs)

taskgraph.transforms.upload_symbols module

Transform the upload-symbols task description template,
taskcluster/ci/upload-symbols/job-template.yml

into an actual task description.

taskgraph.transforms.upload_symbols.fill_template(config, tasks)

taskgraph.transforms.use_toolchains module

taskgraph.transforms.use_toolchains.use_toolchains(config, jobs)

Add dependencies corresponding to toolchains to use, and pass a list of corresponding artifacts to jobs using toolchains.

Module contents