Files
zuul/zuul/driver/smtp/smtpreporter.py
Clark Boylan a219eed5e8 Include ref info in smtp reporter subjects
With the move towards reporting zuul's build dashboard pages we lose
info like the ref/branch that a job ran against when reporting with smtp
(because that info is no longer in the log url). Add the ref info to the
subject lines by default to help make that a little better for our
users.

Change-Id: I9671deb6e1de91832f3830587f90edfe46f06f33
2019-08-19 12:32:40 -07:00

59 lines
1.9 KiB
Python

# Copyright 2013 Rackspace Australia
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import logging
import voluptuous as v
from zuul.lib.logutil import get_annotated_logger
from zuul.reporter import BaseReporter
class SMTPReporter(BaseReporter):
"""Sends off reports to emails via SMTP."""
name = 'smtp'
log = logging.getLogger("zuul.SMTPReporter")
def report(self, item):
"""Send the compiled report message via smtp."""
log = get_annotated_logger(self.log, item.event)
message = self._formatItemReport(item)
log.debug("Report change %s, params %s, message: %s",
item.change, self.config, message)
from_email = self.config['from'] \
if 'from' in self.config else None
to_email = self.config['to'] \
if 'to' in self.config else None
if 'subject' in self.config:
subject = self.config['subject'].format(
change=item.change)
else:
subject = "Report for change {change} against {ref}".format(
change=item.change, ref=item.change.ref)
self.connection.sendMail(subject, message, from_email, to_email,
zuul_event_id=item.event)
def getSchema():
smtp_reporter = v.Schema({
'to': str,
'from': str,
'subject': str,
})
return smtp_reporter