# -*- coding: utf-8 -*- # Copyright (c) 2012, Dag Wieers # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' name: mail type: notification short_description: Sends failure events via email description: - This callback will report failures via email. author: - Dag Wieers (@dagwieers) requirements: - whitelisting in configuration options: mta: description: - Mail Transfer Agent, server that accepts SMTP. type: str env: - name: SMTPHOST ini: - section: callback_mail key: smtphost default: localhost mtaport: description: - Mail Transfer Agent Port. - Port at which server SMTP. type: int ini: - section: callback_mail key: smtpport default: 25 to: description: - Mail recipient. type: list elements: str ini: - section: callback_mail key: to default: [root] sender: description: - Mail sender. - Note that this will be required from community.general 6.0.0 on. type: str ini: - section: callback_mail key: sender cc: description: - CC'd recipients. type: list elements: str ini: - section: callback_mail key: cc bcc: description: - BCC'd recipients. type: list elements: str ini: - section: callback_mail key: bcc ''' import json import os import re import email.utils import smtplib from ansible.module_utils.common.text.converters import to_bytes from ansible.parsing.ajson import AnsibleJSONEncoder from ansible.plugins.callback import CallbackBase class CallbackModule(CallbackBase): ''' This Ansible callback plugin mails errors to interested parties. ''' CALLBACK_VERSION = 2.0 CALLBACK_TYPE = 'notification' CALLBACK_NAME = 'community.general.mail' CALLBACK_NEEDS_WHITELIST = True def __init__(self, display=None): super(CallbackModule, self).__init__(display=display) self.sender = None self.to = 'root' self.smtphost = os.getenv('SMTPHOST', 'localhost') self.smtpport = 25 self.cc = None self.bcc = None def set_options(self, task_keys=None, var_options=None, direct=None): super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct) self.sender = self.get_option('sender') if self.sender is None: self._display.deprecated( 'The sender for the mail callback has not been specified. This will be an error in the future', version='6.0.0', collection_name='community.general') self.to = self.get_option('to') self.smtphost = self.get_option('mta') self.smtpport = self.get_option('mtaport') self.cc = self.get_option('cc') self.bcc = self.get_option('bcc') def mail(self, subject='Ansible error mail', body=None): if body is None: body = subject smtp = smtplib.SMTP(self.smtphost, port=self.smtpport) sender_address = email.utils.parseaddr(self.sender) if self.to: to_addresses = email.utils.getaddresses(self.to) if self.cc: cc_addresses = email.utils.getaddresses(self.cc) if self.bcc: bcc_addresses = email.utils.getaddresses(self.bcc) content = 'Date: %s\n' % email.utils.formatdate() content += 'From: %s\n' % email.utils.formataddr(sender_address) if self.to: content += 'To: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in to_addresses]) if self.cc: content += 'Cc: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in cc_addresses]) content += 'Message-ID: %s\n' % email.utils.make_msgid() content += 'Subject: %s\n\n' % subject.strip() content += body addresses = to_addresses if self.cc: addresses += cc_addresses if self.bcc: addresses += bcc_addresses if not addresses: self._display.warning('No receiver has been specified for the mail callback plugin.') smtp.sendmail(self.sender, [address for name, address in addresses], to_bytes(content)) smtp.quit() def subject_msg(self, multiline, failtype, linenr): return '%s: %s' % (failtype, multiline.strip('\r\n').splitlines()[linenr]) def indent(self, multiline, indent=8): return re.sub('^', ' ' * indent, multiline, flags=re.MULTILINE) def body_blob(self, multiline, texttype): ''' Turn some text output in a well-indented block for sending in a mail body ''' intro = 'with the following %s:\n\n' % texttype blob = '' for line in multiline.strip('\r\n').splitlines(): blob += '%s\n' % line return intro + self.indent(blob) + '\n' def mail_result(self, result, failtype): host = result._host.get_name() if not self.sender: self.sender = '"Ansible: %s" ' % host # Add subject if self.itembody: subject = self.itemsubject elif result._result.get('failed_when_result') is True: subject = "Failed due to 'failed_when' condition" elif result._result.get('msg'): subject = self.subject_msg(result._result['msg'], failtype, 0) elif result._result.get('stderr'): subject = self.subject_msg(result._result['stderr'], failtype, -1) elif result._result.get('stdout'): subject = self.subject_msg(result._result['stdout'], failtype, -1) elif result._result.get('exception'): # Unrelated exceptions are added to output :-/ subject = self.subject_msg(result._result['exception'], failtype, -1) else: subject = '%s: %s' % (failtype, result._task.name or result._task.action) # Make playbook name visible (e.g. in Outlook/Gmail condensed view) body = 'Playbook: %s\n' % os.path.basename(self.playbook._file_name) if result._task.name: body += 'Task: %s\n' % result._task.name body += 'Module: %s\n' % result._task.action body += 'Host: %s\n' % host body += '\n' # Add task information (as much as possible) body += 'The following task failed:\n\n' if 'invocation' in result._result: body += self.indent('%s: %s\n' % (result._task.action, json.dumps(result._result['invocation']['module_args'], indent=4))) elif result._task.name: body += self.indent('%s (%s)\n' % (result._task.name, result._task.action)) else: body += self.indent('%s\n' % result._task.action) body += '\n' # Add item / message if self.itembody: body += self.itembody elif result._result.get('failed_when_result') is True: body += "due to the following condition:\n\n" + self.indent('failed_when:\n- ' + '\n- '.join(result._task.failed_when)) + '\n\n' elif result._result.get('msg'): body += self.body_blob(result._result['msg'], 'message') # Add stdout / stderr / exception / warnings / deprecations if result._result.get('stdout'): body += self.body_blob(result._result['stdout'], 'standard output') if result._result.get('stderr'): body += self.body_blob(result._result['stderr'], 'error output') if result._result.get('exception'): # Unrelated exceptions are added to output :-/ body += self.body_blob(result._result['exception'], 'exception') if result._result.get('warnings'): for i in range(len(result._result.get('warnings'))): body += self.body_blob(result._result['warnings'][i], 'exception %d' % (i + 1)) if result._result.get('deprecations'): for i in range(len(result._result.get('deprecations'))): body += self.body_blob(result._result['deprecations'][i], 'exception %d' % (i + 1)) body += 'and a complete dump of the error:\n\n' body += self.indent('%s: %s' % (failtype, json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4))) self.mail(subject=subject, body=body) def v2_playbook_on_start(self, playbook): self.playbook = playbook self.itembody = '' def v2_runner_on_failed(self, result, ignore_errors=False): if ignore_errors: return self.mail_result(result, 'Failed') def v2_runner_on_unreachable(self, result): self.mail_result(result, 'Unreachable') def v2_runner_on_async_failed(self, result): self.mail_result(result, 'Async failure') def v2_runner_item_on_failed(self, result): # Pass item information to task failure self.itemsubject = result._result['msg'] self.itembody += self.body_blob(json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4), "failed item dump '%(item)s'" % result._result)