mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-25 13:34:01 -07:00
ef5ac023cfImprove callback docs (#5760)
* Improve callback docs.
* Apply suggestions from code review
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
* Update plugins/callback/logentries.py
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
* More improvements.
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
(cherry picked from commit 9e3a729da9)
Co-authored-by: Felix Fontein <felix@fontein.de>
119 lines
4.1 KiB
Python
119 lines
4.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
|
|
# Copyright (c) 2017 Ansible Project
|
|
# 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
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
author: Unknown (!UNKNOWN)
|
|
name: say
|
|
type: notification
|
|
requirements:
|
|
- whitelisting in configuration
|
|
- the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
|
|
short_description: notify using software speech synthesizer
|
|
description:
|
|
- This plugin will use the C(say) or C(espeak) program to "speak" about play events.
|
|
notes:
|
|
- In Ansible 2.8, this callback has been renamed from C(osx_say) into M(community.general.say).
|
|
'''
|
|
|
|
import platform
|
|
import subprocess
|
|
import os
|
|
|
|
from ansible.module_utils.common.process import get_bin_path
|
|
from ansible.plugins.callback import CallbackBase
|
|
|
|
|
|
class CallbackModule(CallbackBase):
|
|
"""
|
|
makes Ansible much more exciting.
|
|
"""
|
|
CALLBACK_VERSION = 2.0
|
|
CALLBACK_TYPE = 'notification'
|
|
CALLBACK_NAME = 'community.general.say'
|
|
CALLBACK_NEEDS_WHITELIST = True
|
|
|
|
def __init__(self):
|
|
|
|
super(CallbackModule, self).__init__()
|
|
|
|
self.FAILED_VOICE = None
|
|
self.REGULAR_VOICE = None
|
|
self.HAPPY_VOICE = None
|
|
self.LASER_VOICE = None
|
|
|
|
try:
|
|
self.synthesizer = get_bin_path('say')
|
|
if platform.system() != 'Darwin':
|
|
# 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter
|
|
self._display.warning("'say' executable found but system is '%s': ignoring voice parameter" % platform.system())
|
|
else:
|
|
self.FAILED_VOICE = 'Zarvox'
|
|
self.REGULAR_VOICE = 'Trinoids'
|
|
self.HAPPY_VOICE = 'Cellos'
|
|
self.LASER_VOICE = 'Princess'
|
|
except ValueError:
|
|
try:
|
|
self.synthesizer = get_bin_path('espeak')
|
|
self.FAILED_VOICE = 'klatt'
|
|
self.HAPPY_VOICE = 'f5'
|
|
self.LASER_VOICE = 'whisper'
|
|
except ValueError:
|
|
self.synthesizer = None
|
|
|
|
# plugin disable itself if say is not present
|
|
# ansible will not call any callback if disabled is set to True
|
|
if not self.synthesizer:
|
|
self.disabled = True
|
|
self._display.warning("Unable to find either 'say' or 'espeak' executable, plugin %s disabled" % os.path.basename(__file__))
|
|
|
|
def say(self, msg, voice):
|
|
cmd = [self.synthesizer, msg]
|
|
if voice:
|
|
cmd.extend(('-v', voice))
|
|
subprocess.call(cmd)
|
|
|
|
def runner_on_failed(self, host, res, ignore_errors=False):
|
|
self.say("Failure on host %s" % host, self.FAILED_VOICE)
|
|
|
|
def runner_on_ok(self, host, res):
|
|
self.say("pew", self.LASER_VOICE)
|
|
|
|
def runner_on_skipped(self, host, item=None):
|
|
self.say("pew", self.LASER_VOICE)
|
|
|
|
def runner_on_unreachable(self, host, res):
|
|
self.say("Failure on host %s" % host, self.FAILED_VOICE)
|
|
|
|
def runner_on_async_ok(self, host, res, jid):
|
|
self.say("pew", self.LASER_VOICE)
|
|
|
|
def runner_on_async_failed(self, host, res, jid):
|
|
self.say("Failure on host %s" % host, self.FAILED_VOICE)
|
|
|
|
def playbook_on_start(self):
|
|
self.say("Running Playbook", self.REGULAR_VOICE)
|
|
|
|
def playbook_on_notify(self, host, handler):
|
|
self.say("pew", self.LASER_VOICE)
|
|
|
|
def playbook_on_task_start(self, name, is_conditional):
|
|
if not is_conditional:
|
|
self.say("Starting task: %s" % name, self.REGULAR_VOICE)
|
|
else:
|
|
self.say("Notifying task: %s" % name, self.REGULAR_VOICE)
|
|
|
|
def playbook_on_setup(self):
|
|
self.say("Gathering facts", self.REGULAR_VOICE)
|
|
|
|
def playbook_on_play_start(self, name):
|
|
self.say("Starting play: %s" % name, self.HAPPY_VOICE)
|
|
|
|
def playbook_on_stats(self, stats):
|
|
self.say("Play complete", self.HAPPY_VOICE)
|