Source code
Revision control
Copy as Markdown
Other Tools
# 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
import logging
import os
import re
import sys
import warnings
import attr
from taskgraph.util.treeherder import join_symbol
from taskgraph.util.verify import VerificationSequence
from gecko_taskgraph import GECKO
from gecko_taskgraph.util.attributes import (
ALL_PROJECTS,
RELEASE_PROJECTS,
RUN_ON_PROJECT_ALIASES,
)
logger = logging.getLogger(__name__)
doc_base_path = os.path.join(GECKO, "taskcluster", "docs")
verifications = VerificationSequence()
@attr.s(frozen=True)
class DocPaths:
_paths = attr.ib(factory=list)
def get_files(self, filename):
rv = []
for p in self._paths:
doc_path = os.path.join(p, filename)
if os.path.exists(doc_path):
rv.append(doc_path)
return rv
def add(self, path):
"""
Projects that make use of Firefox's taskgraph can extend it with
their own task kinds by registering additional paths for documentation.
documentation_paths.add() needs to be called by the project's Taskgraph
registration function. See taskgraph.config.
"""
self._paths.append(path)
documentation_paths = DocPaths()
documentation_paths.add(doc_base_path)
def verify_docs(filename, identifiers, appearing_as):
"""
Look for identifiers of the type appearing_as in the files
returned by documentation_paths.get_files(). Firefox will have
a single file in a list, but projects such as Thunderbird can have
documentation in another location and may return multiple files.
"""
# We ignore identifiers starting with '_' for the sake of tests.
# Strings starting with "_" are ignored for doc verification
# hence they can be used for faking test values
doc_files = documentation_paths.get_files(filename)
doctext = "".join([open(d).read() for d in doc_files])
if appearing_as == "inline-literal":
expression_list = [
"``" + identifier + "``"
for identifier in identifiers
if not identifier.startswith("_")
]
elif appearing_as == "heading":
expression_list = [
"\n" + identifier + "\n(?:(?:(?:-+\n)+)|(?:(?:.+\n)+))"
for identifier in identifiers
if not identifier.startswith("_")
]
else:
raise Exception(f"appearing_as = `{appearing_as}` not defined")
for expression, identifier in zip(expression_list, identifiers):
match_group = re.search(expression, doctext)
if not match_group:
raise Exception(
"{}: `{}` missing from doc file: `{}`".format(
appearing_as, identifier, filename
)
)
@verifications.add("initial")
def verify_run_using():
from gecko_taskgraph.transforms.job import registry
verify_docs(
filename="transforms/job.rst",
identifiers=registry.keys(),
appearing_as="inline-literal",
)
@verifications.add("parameters")
def verify_parameters_docs(parameters):
if not parameters.strict:
return
parameters_dict = dict(**parameters)
verify_docs(
filename="parameters.rst",
identifiers=list(parameters_dict),
appearing_as="inline-literal",
)
@verifications.add("kinds")
def verify_kinds_docs(kinds):
verify_docs(filename="kinds.rst", identifiers=kinds.keys(), appearing_as="heading")
@verifications.add("full_task_set")
def verify_attributes(task, taskgraph, scratch_pad, graph_config, parameters):
if task is None:
verify_docs(
filename="attributes.rst",
identifiers=list(scratch_pad["attribute_set"]),
appearing_as="heading",
)
return
scratch_pad.setdefault("attribute_set", set()).update(task.attributes.keys())
@verifications.add("full_task_graph")
def verify_task_graph_symbol(task, taskgraph, scratch_pad, graph_config, parameters):
"""
This function verifies that tuple
(collection.keys(), machine.platform, groupSymbol, symbol) is unique
for a target task graph.
"""
if task is None:
return
task_dict = task.task
if "extra" in task_dict:
extra = task_dict["extra"]
if "treeherder" in extra:
treeherder = extra["treeherder"]
collection_keys = tuple(sorted(treeherder.get("collection", {}).keys()))
if len(collection_keys) != 1:
raise Exception(
"Task {} can't be in multiple treeherder collections "
"(the part of the platform after `/`): {}".format(
task.label, collection_keys
)
)
platform = treeherder.get("machine", {}).get("platform")
group_symbol = treeherder.get("groupSymbol")
symbol = treeherder.get("symbol")
key = (platform, collection_keys[0], group_symbol, symbol)
if key in scratch_pad:
raise Exception(
"Duplicate treeherder platform and symbol in tasks "
"`{}`and `{}`: {} {}".format(
task.label,
scratch_pad[key],
f"{platform}/{collection_keys[0]}",
join_symbol(group_symbol, symbol),
)
)
else:
scratch_pad[key] = task.label
@verifications.add("full_task_graph")
def verify_trust_domain_v2_routes(
task, taskgraph, scratch_pad, graph_config, parameters
):
"""
This function ensures that any two tasks have distinct ``index.{trust-domain}.v2`` routes.
"""
if task is None:
return
route_prefix = "index.{}.v2".format(graph_config["trust-domain"])
task_dict = task.task
routes = task_dict.get("routes", [])
for route in routes:
if route.startswith(route_prefix):
if route in scratch_pad:
raise Exception(
"conflict between {}:{} for route: {}".format(
task.label, scratch_pad[route], route
)
)
else:
scratch_pad[route] = task.label
@verifications.add("full_task_graph")
def verify_routes_notification_filters(
task, taskgraph, scratch_pad, graph_config, parameters
):
"""
This function ensures that only understood filters for notifications are
specified.
"""
if task is None:
return
route_prefix = "notify."
valid_filters = (
"on-any",
"on-completed",
"on-defined",
"on-failed",
"on-exception",
"on-pending",
"on-resolved",
"on-running",
"on-transition",
)
task_dict = task.task
routes = task_dict.get("routes", [])
for route in routes:
if route.startswith(route_prefix):
# Get the filter of the route
route_filter = route.split(".")[-1]
if route_filter not in valid_filters:
raise Exception(
"{} has invalid notification filter ({})".format(
task.label, route_filter
)
)
if route_filter == "on-any":
warnings.warn(
DeprecationWarning(
f"notification filter '{route_filter}' is deprecated. Use "
"'on-transition' or 'on-resolved'."
)
)
@verifications.add("full_task_graph")
def verify_dependency_tiers(task, taskgraph, scratch_pad, graph_config, parameters):
tiers = scratch_pad
if task is not None:
tiers[task.label] = (
task.task.get("extra", {}).get("treeherder", {}).get("tier", sys.maxsize)
)
else:
def printable_tier(tier):
if tier == sys.maxsize:
return "unknown"
return tier
for task in taskgraph.tasks.values():
tier = tiers[task.label]
for d in task.dependencies.values():
if taskgraph[d].task.get("workerType") == "always-optimized":
continue
if "dummy" in taskgraph[d].kind:
continue
if tier < tiers[d]:
raise Exception(
"{} (tier {}) cannot depend on {} (tier {})".format(
task.label,
printable_tier(tier),
d,
printable_tier(tiers[d]),
)
)
@verifications.add("full_task_graph")
def verify_required_signoffs(task, taskgraph, scratch_pad, graph_config, parameters):
"""
Task with required signoffs can't be dependencies of tasks with less
required signoffs.
"""
all_required_signoffs = scratch_pad
if task is not None:
all_required_signoffs[task.label] = set(
task.attributes.get("required_signoffs", [])
)
else:
def printable_signoff(signoffs):
if len(signoffs) == 1:
return "required signoff {}".format(*signoffs)
if signoffs:
return "required signoffs {}".format(", ".join(signoffs))
return "no required signoffs"
for task in taskgraph.tasks.values():
required_signoffs = all_required_signoffs[task.label]
for d in task.dependencies.values():
if required_signoffs < all_required_signoffs[d]:
raise Exception(
"{} ({}) cannot depend on {} ({})".format(
task.label,
printable_signoff(required_signoffs),
d,
printable_signoff(all_required_signoffs[d]),
)
)
@verifications.add("full_task_graph")
def verify_aliases(task, taskgraph, scratch_pad, graph_config, parameters):
"""
This function verifies that aliases are not reused.
"""
if task is None:
return
if task.kind not in ("toolchain", "fetch"):
return
for_kind = scratch_pad.setdefault(task.kind, {})
aliases = for_kind.setdefault("aliases", {})
alias_attribute = f"{task.kind}-alias"
if task.label in aliases:
raise Exception(
"Task `{}` has a {} of `{}`, masking a task of that name.".format(
aliases[task.label],
alias_attribute,
task.label[len(task.kind) + 1 :],
)
)
labels = for_kind.setdefault("labels", set())
labels.add(task.label)
attributes = task.attributes
if alias_attribute in attributes:
keys = attributes[alias_attribute]
if not keys:
keys = []
elif isinstance(keys, str):
keys = [keys]
for key in keys:
full_key = f"{task.kind}-{key}"
if full_key in labels:
raise Exception(
"Task `{}` has a {} of `{}`,"
" masking a task of that name.".format(
task.label,
alias_attribute,
key,
)
)
if full_key in aliases:
raise Exception(
"Duplicate {} in tasks `{}`and `{}`: {}".format(
alias_attribute,
task.label,
aliases[full_key],
key,
)
)
else:
aliases[full_key] = task.label
@verifications.add("optimized_task_graph")
def verify_always_optimized(task, taskgraph, scratch_pad, graph_config, parameters):
"""
This function ensures that always-optimized tasks have been optimized.
"""
if task is None:
return
if task.task.get("workerType") == "always-optimized":
raise Exception(f"Could not optimize the task {task.label!r}")
@verifications.add("full_task_graph", run_on_projects=RELEASE_PROJECTS)
def verify_shippable_no_sccache(task, taskgraph, scratch_pad, graph_config, parameters):
if task and task.attributes.get("shippable"):
if task.task.get("payload", {}).get("env", {}).get("USE_SCCACHE"):
raise Exception(f"Shippable job {task.label} cannot use sccache")
@verifications.add("full_task_graph")
def verify_test_packaging(task, taskgraph, scratch_pad, graph_config, parameters):
if task is None:
# In certain cases there are valid reasons for tests to be missing,
# don't error out when that happens.
missing_tests_allowed = any(
(
# user specified `--target-kind`
bool(parameters.get("target-kinds")),
# manifest scheduling is enabled
parameters["test_manifest_loader"] != "default",
)
)
test_env = parameters["try_task_config"].get("env", {})
if test_env.get("MOZHARNESS_TEST_PATHS", "") or test_env.get(
"MOZHARNESS_TEST_TAG", ""
):
# This is sort of a hack, as we are filtering, we might filter out all test jobs
missing_tests_allowed = True
exceptions = []
for task in taskgraph.tasks.values():
if task.kind == "build" and not task.attributes.get(
"skip-verify-test-packaging"
):
build_env = task.task.get("payload", {}).get("env", {})
package_tests = build_env.get("MOZ_AUTOMATION_PACKAGE_TESTS")
shippable = task.attributes.get("shippable", False)
build_has_tests = scratch_pad.get(task.label)
if package_tests != "1":
# Shippable builds should always package tests.
if shippable:
exceptions.append(
"Build job {} is shippable and does not specify "
"MOZ_AUTOMATION_PACKAGE_TESTS=1 in the "
"environment.".format(task.label)
)
# Build tasks in the scratch pad have tests dependent on
# them, so we need to package tests during build.
if build_has_tests:
exceptions.append(
"Build job {} has tests dependent on it and does not specify "
"MOZ_AUTOMATION_PACKAGE_TESTS=1 in the environment".format(
task.label
)
)
else:
# Build tasks that aren't in the scratch pad have no
# dependent tests, so we shouldn't package tests.
# With the caveat that we expect shippable jobs to always
# produce tests.
if not build_has_tests and not shippable:
# If we have not generated all task kinds, we can't verify that
# there are no dependent tests.
if not missing_tests_allowed:
exceptions.append(
"Build job {} has no tests, but specifies "
"MOZ_AUTOMATION_PACKAGE_TESTS={} in the environment. "
"Unset MOZ_AUTOMATION_PACKAGE_TESTS in the task definition "
"to fix.".format(task.label, package_tests)
)
if exceptions:
raise Exception("\n".join(exceptions))
return
if task.kind == "test":
build_task = taskgraph[task.dependencies["build"]]
scratch_pad[build_task.label] = 1
@verifications.add("full_task_graph")
def verify_run_known_projects(task, taskgraph, scratch_pad, graph_config, parameters):
"""Validates the inputs in run-on-projects.
We should never let 'try' (or 'try-comm-central') be in run-on-projects even though it
is valid because it is not considered for try pushes. While here we also validate for
other unknown projects or typos.
"""
if task and task.attributes.get("run_on_projects"):
projects = set(task.attributes["run_on_projects"])
if {"try", "try-comm-central"} & set(projects):
raise Exception(
"In task {}: using try in run-on-projects is invalid; use try "
"selectors to select this task on try".format(task.label)
)
# try isn't valid, but by the time we get here its not an available project anyway.
valid_projects = ALL_PROJECTS | set(RUN_ON_PROJECT_ALIASES.keys())
invalid_projects = projects - valid_projects
if invalid_projects:
raise Exception(
"Task '{}' has an invalid run-on-projects value: "
"{}".format(task.label, invalid_projects)
)