summaryrefslogtreecommitdiffstats
path: root/third_party/python/taskcluster_taskgraph/taskgraph/transforms/release_notifications.py
blob: 0796b028e8c755a4d57f28d56114d4cd31e21dd7 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# 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/.
"""
Add notifications via taskcluster-notify for release tasks
"""
from string import Formatter

from voluptuous import ALLOW_EXTRA, Any, Optional, Required

from taskgraph.transforms.base import TransformSequence
from taskgraph.util.schema import Schema, optionally_keyed_by, resolve_keyed_by

RELEASE_NOTIFICATIONS_SCHEMA = Schema(
    {
        Optional("notifications"): {
            Required("emails"): optionally_keyed_by("project", "level", [str]),
            Required("subject"): str,
            Optional("message"): str,
            Optional("status-types"): [
                Any(
                    "on-completed",
                    "on-defined",
                    "on-exception",
                    "on-failed",
                    "on-pending",
                    "on-resolved",
                    "on-running",
                )
            ],
        },
    },
    extra=ALLOW_EXTRA,
)


transforms = TransformSequence()
transforms.add_validate(RELEASE_NOTIFICATIONS_SCHEMA)


class TitleCaseFormatter(Formatter):
    """Support title formatter for strings"""

    def convert_field(self, value, conversion):
        if conversion == "t":
            return str(value).title()
        super().convert_field(value, conversion)
        return value


titleformatter = TitleCaseFormatter()


@transforms.add
def add_notifications(config, jobs):
    for job in jobs:
        label = "{}-{}".format(config.kind, job["name"])

        notifications = job.pop("notifications", None)
        if notifications:
            resolve_keyed_by(
                notifications,
                "emails",
                label,
                **{
                    "level": config.params["level"],
                    "project": config.params["project"],
                },
            )
            emails = notifications["emails"]
            format_kwargs = dict(
                task=job,
                config=config.__dict__,
            )
            subject = titleformatter.format(notifications["subject"], **format_kwargs)
            message = notifications.get("message", notifications["subject"])
            message = titleformatter.format(message, **format_kwargs)
            emails = [email.format(**format_kwargs) for email in emails]

            # By default, we only send mail on success to avoid messages like 'blah is in the
            # candidates dir' when cancelling graphs, dummy job failure, etc
            status_types = notifications.get("status-types", ["on-completed"])
            for s in status_types:
                job.setdefault("routes", []).extend(
                    [f"notify.email.{email}.{s}" for email in emails]
                )

            # Customize the email subject to include release name and build number
            job.setdefault("extra", {}).update(
                {
                    "notify": {
                        "email": {
                            "subject": subject,
                            "content": message,
                        }
                    }
                }
            )

        yield job