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
|
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
This file is a stdout callback plugin for the OpenShift Quick
Installer. The purpose of this callback plugin is to reduce the amount
of produced output for customers and enable simpler progress checking.
What's different:
* Playbook progress is expressed as: Play <current_play>/<total_plays> (Play Name)
Ex: Play 3/30 (Initialize Megafrobber)
* The Tasks and Handlers in each play (and included roles) are printed
as a series of .'s following the play progress line.
"""
from __future__ import (absolute_import, print_function)
import imp
import os
import sys
ANSIBLE_PATH = imp.find_module('ansible')[1]
DEFAULT_PATH = os.path.join(ANSIBLE_PATH, 'plugins/callback/default.py')
DEFAULT_MODULE = imp.load_source(
'ansible.plugins.callback.default',
DEFAULT_PATH
)
try:
from ansible.plugins.callback import CallbackBase
BASECLASS = CallbackBase
except ImportError: # < ansible 2.1
BASECLASS = DEFAULT_MODULE.CallbackModule
from ansible import constants as C
reload(sys)
sys.setdefaultencoding('utf-8')
class CallbackModule(DEFAULT_MODULE.CallbackModule):
"""
Ansible callback plugin
"""
CALLBACK_VERSION = 2.2
CALLBACK_TYPE = 'stdout'
CALLBACK_NAME = 'openshift_quick_installer'
CALLBACK_NEEDS_WHITELIST = False
plays_count = 0
plays_total_ran = 0
def banner(self, msg, color=None):
'''
Prints a header-looking line with stars taking up to 80 columns
of width (3 columns, minimum)
'''
msg = msg.strip()
star_len = (79 - len(msg))
if star_len < 0:
star_len = 3
stars = "*" * star_len
self._display.display("\n%s %s" % (msg, stars), color=color, log_only=True)
def v2_playbook_on_start(self, playbook):
"""This is basically the start of it all"""
self.plays_count = len(playbook.get_plays())
self.plays_total_ran = 0
def v2_playbook_on_play_start(self, play):
"""Each play calls this once before running any tasks
We could print the number of tasks here as well by using
`play.get_tasks()` but that is not accurate when a play includes a
role. Only the tasks directly assigned to a play are directly exposed
in the `play` object.
"""
self.plays_total_ran += 1
print("")
print("Play %s/%s (%s)" % (self.plays_total_ran, self.plays_count, play.get_name()))
name = play.get_name().strip()
if not name:
msg = "PLAY"
else:
msg = "PLAY [%s]" % name
self.banner(msg)
# pylint: disable=unused-argument,no-self-use
def v2_playbook_on_task_start(self, task, is_conditional):
"""This prints out the task header. For example:
TASK [openshift_facts : Ensure PyYaml is installed] ***...
Rather than print out all that for every task, we print a dot
character to indicate a task has been started.
"""
sys.stdout.write('.')
# pylint: disable=unused-argument,no-self-use
def v2_playbook_on_handler_task_start(self, task):
"""Print out task header for handlers
Rather than print out a header for every handler, we print a dot
character to indicate a handler task has been started.
"""
sys.stdout.write('.')
# pylint: disable=unused-argument,no-self-use
def v2_playbook_on_cleanup_task_start(self, task):
"""Print out a task header for cleanup tasks
Rather than print out a header for every handler, we print a dot
character to indicate a handler task has been started.
"""
sys.stdout.write('.')
def v2_playbook_on_include(self, included_file):
"""Print out paths to statically included files"""
pass
def v2_runner_on_ok(self, result):
"""This prints out task results in a fancy format"""
pass
def v2_runner_item_on_ok(self, result):
"""Print out task results for you're iterating"""
pass
def v2_runner_item_on_skipped(self, result):
"""Print out task results when an item is skipped"""
pass
def v2_runner_on_skipped(self, result):
"""Print out task results when a task (or something else?) is skipped"""
pass
def v2_playbook_on_notify(self, res, handler):
"""What happens when a task result is 'changed' and the task has a
'notify' list attached.
"""
pass
|
