From ba823255fcde17124b6dcc447bb00bc241346312 Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Thu, 29 Sep 2016 07:32:56 -0700 Subject: Fix conflicts in spec file --- callback_plugins/openshift_quick_installer.py | 115 ++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 callback_plugins/openshift_quick_installer.py (limited to 'callback_plugins') diff --git a/callback_plugins/openshift_quick_installer.py b/callback_plugins/openshift_quick_installer.py new file mode 100644 index 000000000..abb22d2fa --- /dev/null +++ b/callback_plugins/openshift_quick_installer.py @@ -0,0 +1,115 @@ +# 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 . + +""" +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 / (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 + + +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 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())) + + # 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('.') + + 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): + """Printer 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('.') -- cgit v1.2.3 From d53389707f4838249715ccc6e67bdc6c06c4cada Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Fri, 23 Sep 2016 10:56:56 -0700 Subject: Silence/dot-print more actions in the callback --- callback_plugins/openshift_quick_installer.py | 51 ++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 5 deletions(-) (limited to 'callback_plugins') diff --git a/callback_plugins/openshift_quick_installer.py b/callback_plugins/openshift_quick_installer.py index abb22d2fa..9d490f02c 100644 --- a/callback_plugins/openshift_quick_installer.py +++ b/callback_plugins/openshift_quick_installer.py @@ -44,6 +44,7 @@ try: except ImportError: # < ansible 2.1 BASECLASS = DEFAULT_MODULE.CallbackModule +from ansible import constants as C reload(sys) sys.setdefaultencoding('utf-8') @@ -61,6 +62,18 @@ class CallbackModule(DEFAULT_MODULE.CallbackModule): 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()) @@ -79,6 +92,14 @@ in the `play` object. 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: @@ -90,6 +111,28 @@ 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 @@ -107,9 +150,7 @@ character to indicate a task has been started. pass def v2_playbook_on_notify(self, res, handler): - """Printer for handlers - -Rather than print out a header for every handler, we print a dot -character to indicate a handler task has been started. + """What happens when a task result is 'changed' and the task has a +'notify' list attached. """ - sys.stdout.write('.') + pass -- cgit v1.2.3 From 088e4ba10dfec171618890ef022c7e86476823bc Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Fri, 23 Sep 2016 13:01:33 -0700 Subject: Copy and paste more methods --- callback_plugins/openshift_quick_installer.py | 100 ++++++++++++++++++++++++-- 1 file changed, 93 insertions(+), 7 deletions(-) (limited to 'callback_plugins') diff --git a/callback_plugins/openshift_quick_installer.py b/callback_plugins/openshift_quick_installer.py index 9d490f02c..f6cc43cf9 100644 --- a/callback_plugins/openshift_quick_installer.py +++ b/callback_plugins/openshift_quick_installer.py @@ -79,6 +79,10 @@ class CallbackModule(DEFAULT_MODULE.CallbackModule): self.plays_count = len(playbook.get_plays()) self.plays_total_ran = 0 + if self._display.verbosity > 1: + from os.path import basename + self.banner("PLAYBOOK: %s" % basename(playbook._file_name)) + def v2_playbook_on_play_start(self, play): """Each play calls this once before running any tasks @@ -111,6 +115,24 @@ character to indicate a task has been started. """ sys.stdout.write('.') + args = '' + # args can be specified as no_log in several places: in the task or in + # the argument spec. We can check whether the task is no_log but the + # argument spec can't be because that is only run on the target + # machine and we haven't run it thereyet at this time. + # + # So we give people a config option to affect display of the args so + # that they can secure this if they feel that their stdout is insecure + # (shoulder surfing, logging stdout straight to a file, etc). + if not task.no_log and C.DISPLAY_ARGS_TO_STDOUT: + args = ', '.join(('%s=%s' % a for a in task.args.items())) + args = ' %s' % args + self.banner("TASK [%s%s]" % (task.get_name().strip(), args)) + if self._display.verbosity >= 2: + path = task.get_path() + if path: + self._display.display("task path: %s" % path, color=C.COLOR_DEBUG, log_only=True) + # pylint: disable=unused-argument,no-self-use def v2_playbook_on_handler_task_start(self, task): """Print out task header for handlers @@ -120,6 +142,8 @@ character to indicate a handler task has been started. """ sys.stdout.write('.') + self.banner("RUNNING HANDLER [%s]" % task.get_name().strip()) + # pylint: disable=unused-argument,no-self-use def v2_playbook_on_cleanup_task_start(self, task): """Print out a task header for cleanup tasks @@ -129,28 +153,90 @@ character to indicate a handler task has been started. """ sys.stdout.write('.') + self.banner("CLEANUP TASK [%s]" % task.get_name().strip()) + def v2_playbook_on_include(self, included_file): """Print out paths to statically included files""" - pass + msg = 'included: %s for %s' % (included_file._filename, ", ".join([h.name for h in included_file._hosts])) + self._display.display(msg, color=C.COLOR_SKIP, log_only=True) def v2_runner_on_ok(self, result): - """This prints out task results in a fancy format""" - pass + """This prints out task results in a fancy format + +The only thing we change here is adding `log_only=True` to the +.display() call + """ + delegated_vars = result._result.get('_ansible_delegated_vars', None) + self._clean_results(result._result, result._task.action) + if result._task.action in ('include', 'include_role'): + return + elif result._result.get('changed', False): + if delegated_vars: + msg = "changed: [%s -> %s]" % (result._host.get_name(), delegated_vars['ansible_host']) + else: + msg = "changed: [%s]" % result._host.get_name() + color = C.COLOR_CHANGED + else: + if delegated_vars: + msg = "ok: [%s -> %s]" % (result._host.get_name(), delegated_vars['ansible_host']) + else: + msg = "ok: [%s]" % result._host.get_name() + color = C.COLOR_OK + + if result._task.loop and 'results' in result._result: + self._process_items(result) + else: + + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + msg += " => %s" % (self._dump_results(result._result),) + self._display.display(msg, color=color, log_only=True) + + self._handle_warnings(result._result) def v2_runner_item_on_ok(self, result): """Print out task results for you're iterating""" - pass + delegated_vars = result._result.get('_ansible_delegated_vars', None) + if result._task.action in ('include', 'include_role'): + return + elif result._result.get('changed', False): + msg = 'changed' + color = C.COLOR_CHANGED + else: + msg = 'ok' + color = C.COLOR_OK + + if delegated_vars: + msg += ": [%s -> %s]" % (result._host.get_name(), delegated_vars['ansible_host']) + else: + msg += ": [%s]" % result._host.get_name() + + msg += " => (item=%s)" % (self._get_item(result._result),) + + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + msg += " => %s" % self._dump_results(result._result) + self._display.display(msg, color=color, log_only=True) def v2_runner_item_on_skipped(self, result): """Print out task results when an item is skipped""" - pass + if C.DISPLAY_SKIPPED_HOSTS: + msg = "skipping: [%s] => (item=%s) " % (result._host.get_name(), self._get_item(result._result)) + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + msg += " => %s" % self._dump_results(result._result) + self._display.display(msg, color=C.COLOR_SKIP, log_only=True) def v2_runner_on_skipped(self, result): """Print out task results when a task (or something else?) is skipped""" - pass + if C.DISPLAY_SKIPPED_HOSTS: + if result._task.loop and 'results' in result._result: + self._process_items(result) + else: + msg = "skipping: [%s]" % result._host.get_name() + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + msg += " => %s" % self._dump_results(result._result) + self._display.display(msg, color=C.COLOR_SKIP, log_only=True) 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 + self._display.display("skipping: no hosts matched", color=C.COLOR_SKIP, log_only=True) -- cgit v1.2.3 From 76f1cd09097dc28c9efe7e2476534fb8a9cfede5 Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Mon, 26 Sep 2016 12:03:36 -0700 Subject: 'fix' unittests by removing the users ability to specify an ansible config --- callback_plugins/openshift_quick_installer.py | 37 +++++++++++++++++---------- 1 file changed, 23 insertions(+), 14 deletions(-) (limited to 'callback_plugins') diff --git a/callback_plugins/openshift_quick_installer.py b/callback_plugins/openshift_quick_installer.py index f6cc43cf9..7923a9a80 100644 --- a/callback_plugins/openshift_quick_installer.py +++ b/callback_plugins/openshift_quick_installer.py @@ -1,3 +1,5 @@ +# pylint: disable=invalid-name,protected-access,import-error,line-too-long + # 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 @@ -11,8 +13,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -""" -This file is a stdout callback plugin for the OpenShift Quick +"""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. @@ -24,13 +25,21 @@ What's different: * The Tasks and Handlers in each play (and included roles) are printed as a series of .'s following the play progress line. +* Many of these methods include copy and paste code from the upstream + default.py callback. We do that to give us control over the stdout + output while allowing Ansible to handle the file logging + normally. The biggest changes here are that we are manually setting + `log_only` to True in the Display.display method and we redefine the + Display.banner method locally so we can set log_only on that call as + well. + """ from __future__ import (absolute_import, print_function) import imp import os import sys - +from ansible import constants as C ANSIBLE_PATH = imp.find_module('ansible')[1] DEFAULT_PATH = os.path.join(ANSIBLE_PATH, 'plugins/callback/default.py') DEFAULT_MODULE = imp.load_source( @@ -44,7 +53,6 @@ try: except ImportError: # < ansible 2.1 BASECLASS = DEFAULT_MODULE.CallbackModule -from ansible import constants as C reload(sys) sys.setdefaultencoding('utf-8') @@ -63,9 +71,11 @@ class CallbackModule(DEFAULT_MODULE.CallbackModule): plays_total_ran = 0 def banner(self, msg, color=None): - ''' - Prints a header-looking line with stars taking up to 80 columns + '''Prints a header-looking line with stars taking up to 80 columns of width (3 columns, minimum) + + Overrides the upstream banner method so that display is called + with log_only=True ''' msg = msg.strip() star_len = (79 - len(msg)) @@ -88,9 +98,8 @@ class CallbackModule(DEFAULT_MODULE.CallbackModule): 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. - +role. Only the tasks directly assigned to a play are exposed in the +`play` object. """ self.plays_total_ran += 1 print("") @@ -187,14 +196,14 @@ The only thing we change here is adding `log_only=True` to the self._process_items(result) else: - if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result: msg += " => %s" % (self._dump_results(result._result),) self._display.display(msg, color=color, log_only=True) self._handle_warnings(result._result) def v2_runner_item_on_ok(self, result): - """Print out task results for you're iterating""" + """Print out task results for items you're iterating over""" delegated_vars = result._result.get('_ansible_delegated_vars', None) if result._task.action in ('include', 'include_role'): return @@ -212,7 +221,7 @@ The only thing we change here is adding `log_only=True` to the msg += " => (item=%s)" % (self._get_item(result._result),) - if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result: msg += " => %s" % self._dump_results(result._result) self._display.display(msg, color=color, log_only=True) @@ -220,7 +229,7 @@ The only thing we change here is adding `log_only=True` to the """Print out task results when an item is skipped""" if C.DISPLAY_SKIPPED_HOSTS: msg = "skipping: [%s] => (item=%s) " % (result._host.get_name(), self._get_item(result._result)) - if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result: msg += " => %s" % self._dump_results(result._result) self._display.display(msg, color=C.COLOR_SKIP, log_only=True) @@ -231,7 +240,7 @@ The only thing we change here is adding `log_only=True` to the self._process_items(result) else: msg = "skipping: [%s]" % result._host.get_name() - if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and not '_ansible_verbose_override' in result._result: + if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result: msg += " => %s" % self._dump_results(result._result) self._display.display(msg, color=C.COLOR_SKIP, log_only=True) -- cgit v1.2.3 From b03d8cf25077cb824f1afca0ecd7d1b8edcc028d Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Thu, 29 Sep 2016 08:07:39 -0700 Subject: Add messages to let the user know if some plays were skipped, but it's ok. Also, remove the final 'press a key to continue' prompt. --- callback_plugins/openshift_quick_installer.py | 40 +++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'callback_plugins') diff --git a/callback_plugins/openshift_quick_installer.py b/callback_plugins/openshift_quick_installer.py index 7923a9a80..e2f125df9 100644 --- a/callback_plugins/openshift_quick_installer.py +++ b/callback_plugins/openshift_quick_installer.py @@ -40,6 +40,7 @@ import imp import os import sys from ansible import constants as C +from ansible.utils.color import colorize, hostcolor ANSIBLE_PATH = imp.find_module('ansible')[1] DEFAULT_PATH = os.path.join(ANSIBLE_PATH, 'plugins/callback/default.py') DEFAULT_MODULE = imp.load_source( @@ -249,3 +250,42 @@ The only thing we change here is adding `log_only=True` to the 'notify' list attached. """ self._display.display("skipping: no hosts matched", color=C.COLOR_SKIP, log_only=True) + + def v2_playbook_on_stats(self, stats): + """Print the final playbook run stats""" + self._display.display("", screen_only=True) + self.banner("PLAY RECAP") + + hosts = sorted(stats.processed.keys()) + for h in hosts: + t = stats.summarize(h) + + self._display.display( + u"%s : %s %s %s %s" % ( + hostcolor(h, t), + colorize(u'ok', t['ok'], C.COLOR_OK), + colorize(u'changed', t['changed'], C.COLOR_CHANGED), + colorize(u'unreachable', t['unreachable'], C.COLOR_UNREACHABLE), + colorize(u'failed', t['failures'], C.COLOR_ERROR)), + screen_only=True + ) + + self._display.display( + u"%s : %s %s %s %s" % ( + hostcolor(h, t, False), + colorize(u'ok', t['ok'], None), + colorize(u'changed', t['changed'], None), + colorize(u'unreachable', t['unreachable'], None), + colorize(u'failed', t['failures'], None)), + log_only=True + ) + + self._display.display("", screen_only=True) + self._display.display("", screen_only=True) + + # Some plays are conditional and won't run (such as load + # balancers) if they aren't required. Let the user know about + # this to avoid potential confusion. + if self.plays_total_ran != self.plays_count: + print("Installation Complete: Note: Play count is an estimate and some were skipped because your install does not require them") + self._display.display("", screen_only=True) -- cgit v1.2.3