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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# 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 to tasks via Taskcluster's notify service.
See https://docs.taskcluster.net/docs/reference/core/notify/usage for
more information.
"""
from voluptuous import ALLOW_EXTRA, Any, Exclusive, Optional, Required
from taskgraph.transforms.base import TransformSequence
from taskgraph.util.schema import Schema, optionally_keyed_by, resolve_keyed_by
_status_type = Any(
"on-completed",
"on-defined",
"on-exception",
"on-failed",
"on-pending",
"on-resolved",
"on-running",
)
_recipients = [
{
Required("type"): "email",
Required("address"): optionally_keyed_by("project", "level", str),
Optional("status-type"): _status_type,
},
{
Required("type"): "matrix-room",
Required("room-id"): str,
Optional("status-type"): _status_type,
},
{
Required("type"): "pulse",
Required("routing-key"): str,
Optional("status-type"): _status_type,
},
{
Required("type"): "slack-channel",
Required("channel-id"): str,
Optional("status-type"): _status_type,
},
]
_route_keys = {
"email": "address",
"matrix-room": "room-id",
"pulse": "routing-key",
"slack-channel": "channel-id",
}
"""Map each type to its primary key that will be used in the route."""
NOTIFY_SCHEMA = Schema(
{
Exclusive("notify", "config"): {
Required("recipients"): [Any(*_recipients)],
Optional("content"): {
Optional("email"): {
Optional("subject"): str,
Optional("content"): str,
Optional("link"): {
Required("text"): str,
Required("href"): str,
},
},
Optional("matrix"): {
Optional("body"): str,
Optional("formatted-body"): str,
Optional("format"): str,
Optional("msg-type"): str,
},
Optional("slack"): {
Optional("text"): str,
Optional("blocks"): list,
Optional("attachments"): list,
},
},
},
# Continue supporting the legacy schema for backwards compat.
Exclusive("notifications", "config"): {
Required("emails"): optionally_keyed_by("project", "level", [str]),
Required("subject"): str,
Optional("message"): str,
Optional("status-types"): [_status_type],
},
},
extra=ALLOW_EXTRA,
)
"""Notify schema."""
transforms = TransformSequence()
transforms.add_validate(NOTIFY_SCHEMA)
def _convert_legacy(config, legacy, label):
"""Convert the legacy format to the new one."""
notify = {
"recipients": [],
"content": {"email": {"subject": legacy["subject"]}},
}
resolve_keyed_by(
legacy,
"emails",
label,
**{
"level": config.params["level"],
"project": config.params["project"],
},
)
status_types = legacy.get("status-types", ["on-completed"])
for email in legacy["emails"]:
for status_type in status_types:
notify["recipients"].append(
{"type": "email", "address": email, "status-type": status_type}
)
notify["content"]["email"]["content"] = legacy.get("message", legacy["subject"])
return notify
def _convert_content(content):
"""Convert the notify content to Taskcluster's format.
The Taskcluster notification format is described here:
https://docs.taskcluster.net/docs/reference/core/notify/usage
"""
tc = {}
if "email" in content:
tc["email"] = content.pop("email")
for key, obj in content.items():
for name in obj.keys():
tc_name = "".join(part.capitalize() for part in name.split("-"))
tc[f"{key}{tc_name}"] = obj[name]
return tc
@transforms.add
def add_notifications(config, tasks):
for task in tasks:
label = "{}-{}".format(config.kind, task["name"])
if "notifications" in task:
notify = _convert_legacy(config, task.pop("notifications"), label)
else:
notify = task.pop("notify", None)
if not notify:
yield task
continue
format_kwargs = dict(
task=task,
config=config.__dict__,
)
def substitute(ctx):
"""Recursively find all strings in a simple nested dict (no lists),
and format them in-place using `format_kwargs`."""
for key, val in ctx.items():
if isinstance(val, str):
ctx[key] = val.format(**format_kwargs)
elif isinstance(val, dict):
ctx[key] = substitute(val)
return ctx
task.setdefault("routes", [])
for recipient in notify["recipients"]:
type = recipient["type"]
recipient.setdefault("status-type", "on-completed")
substitute(recipient)
if type == "email":
resolve_keyed_by(
recipient,
"address",
label,
**{
"level": config.params["level"],
"project": config.params["project"],
},
)
task["routes"].append(
f"notify.{type}.{recipient[_route_keys[type]]}.{recipient['status-type']}"
)
if "content" in notify:
task.setdefault("extra", {}).update(
{"notify": _convert_content(substitute(notify["content"]))}
)
yield task
|
