From 9936c5f9f62310b312680b5a7ecf0642b70b5bb9 Mon Sep 17 00:00:00 2001 From: James Cammarata Date: Sun, 2 Aug 2015 09:28:52 -0400 Subject: [PATCH] Fixing the pause module for devel --- lib/ansible/plugins/action/pause.py | 92 ++++++++++++++++++----------- 1 file changed, 56 insertions(+), 36 deletions(-) diff --git a/lib/ansible/plugins/action/pause.py b/lib/ansible/plugins/action/pause.py index c5a97d53666..f622d55eeff 100644 --- a/lib/ansible/plugins/action/pause.py +++ b/lib/ansible/plugins/action/pause.py @@ -18,14 +18,21 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type import datetime +import signal import sys +import termios import time - -from termios import tcflush, TCIFLUSH +import tty from ansible.errors import * from ansible.plugins.action import ActionBase +class AnsibleTimeoutExceeded(Exception): + pass + +def timeout_handler(signum, frame): + raise AnsibleTimeoutExceeded + class ActionModule(ActionBase): ''' pauses execution for a length or time, or until input is received ''' @@ -48,13 +55,9 @@ class ActionModule(ActionBase): delta = None, ) - # FIXME: not sure if we can get this info directly like this anymore? - #hosts = ', '.join(self.runner.host_set) - # Is 'args' empty, then this is the default prompted pause if self._task.args is None or len(self._task.args.keys()) == 0: pause_type = 'prompt' - #prompt = "[%s]\nPress enter to continue:\n" % hosts prompt = "[%s]\nPress enter to continue:\n" % self._task.get_name().strip() # Are 'minutes' or 'seconds' keys that exist in 'args'? @@ -76,51 +79,68 @@ class ActionModule(ActionBase): # Is 'prompt' a key in 'args'? elif 'prompt' in self._task.args: pause_type = 'prompt' - #prompt = "[%s]\n%s:\n" % (hosts, self._task.args['prompt']) prompt = "[%s]\n%s:\n" % (self._task.get_name().strip(), self._task.args['prompt']) - # I have no idea what you're trying to do. But it's so wrong. else: + # I have no idea what you're trying to do. But it's so wrong. return dict(failed=True, msg="invalid pause type given. must be one of: %s" % ", ".join(self.PAUSE_TYPES)) - #vv("created 'pause' ActionModule: pause_type=%s, duration_unit=%s, calculated_seconds=%s, prompt=%s" % \ - # (self.pause_type, self.duration_unit, self.seconds, self.prompt)) - ######################################################################## # Begin the hard work! start = time.time() result['start'] = str(datetime.datetime.now()) - - # FIXME: this is all very broken right now, as prompting from the worker side - # is not really going to be supported, and actions marked as BYPASS_HOST_LOOP - # probably should not be run through the executor engine at all. Also, ctrl+c - # is now captured on the parent thread, so it can't be caught here via the - # KeyboardInterrupt exception. - try: - if not pause_type == 'prompt': - print("(^C-c = continue early, ^C-a = abort)") - #print("[%s]\nPausing for %s seconds" % (hosts, seconds)) - print("[%s]\nPausing for %s seconds" % (self._task.get_name().strip(), seconds)) - time.sleep(seconds) + if seconds is not None: + # setup the alarm handler + signal.signal(signal.SIGALRM, timeout_handler) + signal.alarm(seconds) + # show the prompt + print("Pausing for %d seconds" % seconds) + print("(ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)\r"), else: - # Clear out any unflushed buffered input which would - # otherwise be consumed by raw_input() prematurely. - #tcflush(sys.stdin, TCIFLUSH) - result['user_input'] = raw_input(prompt.encode(sys.stdout.encoding)) - except KeyboardInterrupt: + print("(press enter to continue, ctrl+C to abort)") + + # save the attributes on the existing (duped) stdin so + # that we can restore them later after we set raw mode + fd = self._connection._new_stdin.fileno() + old_settings = termios.tcgetattr(fd) + tty.setraw(fd) + + # flush the buffer to make sure no previous key presses + # are read in below + termios.tcflush(self._connection._new_stdin, termios.TCIFLUSH) + + # read key presses and act accordingly while True: - print('\nAction? (a)bort/(c)ontinue: ') - c = getch() - if c == 'c': - # continue playbook evaluation - break - elif c == 'a': - # abort further playbook evaluation - raise ae('user requested abort!') + key_pressed = self._connection._new_stdin.read(1) + if pause_type in ('minutes', 'seconds'): + if key_pressed == '\x03': + key_pressed = self._connection._new_stdin.read(1) + if key_pressed == 'a': + raise KeyboardInterrupt + elif key_pressed == 'c': + break + else: + if key_pressed == '\x03': + raise KeyboardInterrupt + elif key_pressed == '\r': + break + except KeyboardInterrupt: + # cancel the previously set alarm signal + if seconds is not None: + signal.alarm(0) + raise AnsibleError('user requested abort!') + except AnsibleTimeoutExceeded: + # this is the exception we expect when the alarm signal + # fires, so we simply ignore it to move into the cleanup + pass finally: + # cleanup and save some information + # restore the old settings for the duped stdin fd + termios.tcsetattr(fd, termios.TCSADRAIN, old_settings) + duration = time.time() - start result['stop'] = str(datetime.datetime.now()) result['delta'] = int(duration)