Merge pull request #27 from berttejeda/develop

Develop

Author: berttejeda

HISTORY.md

@@ -2,6 +2,17 @@
 History
 =======
 
+## Release 2019-09-15 v1.0.2
+
+* Utilize threading to better handle ctrl-c/breaking out of subprocess calls [c248c99](https://github.com/berttejeda/ansible-taskrunner/commit/c248c99e355e058f9e0d775c4ddd5fe45025a9f7)
+* Renamed yamlc module to proc_mgmt [8e72a54](https://github.com/berttejeda/ansible-taskrunner/commit/8e72a54ff9db57109144ab9855ae6eb4361200dd)
+* Fixed bug in logic for preserving variables/cli order for python 2.x [4c16bd3](https://github.com/berttejeda/ansible-taskrunner/commit/4c16bd3a8493b595bb28e915b02cf18b8d8740ba)
+* Improved debugging for subprocess calls [e00dc4b](https://github.com/berttejeda/ansible-taskrunner/commit/e00dc4bd36e9b7baba860f592a8cd2ad46a2bb0e)
+* Preserve order of variables and cli options for python 2.x [22d330c](https://github.com/berttejeda/ansible-taskrunner/commit/22d330ca8e91af3ff0a287d75e58582391376f23)
+* Refactored handling of variables [ddbc787](https://github.com/berttejeda/ansible-taskrunner/commit/ddbc7870827c304f62a7ca8a733fd021745c7a27)
+* Fixed formatting [ab21879](https://github.com/berttejeda/ansible-taskrunner/commit/ab21879959f1ee1895656c2fc0f1672b3c45f328)
+* Added more documentation for variable declarations [2f4efa7](https://github.com/berttejeda/ansible-taskrunner/commit/2f4efa75f433b71e98f4e954456263697b5e1f45)
+
 ## Release 2019-05-08 v1.0.1
 
 * Deleted unused library [255fcf1](https://github.com/berttejeda/ansible-taskrunner/commit/255fcf1999f901ef9d01318c40c916fcd8461f02)

VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

ansible_taskrunner/cli.py

@@ -41,8 +41,8 @@
     from click_extras import ExtendedEpilog
     from click_extras import ExtendedHelp
     from click_extras import ExtendCLI
-    from yamlc import shell_invocation_mappings
-    from yamlc import CLIInvocation
+    from proc_mgmt import shell_invocation_mappings
+    from proc_mgmt import CLIInvocation
     from yamlr import YamlReader
     # TODO
     # Employ language/regional options    
@@ -71,7 +71,7 @@
 
 # Private variables
 __author__ = 'etejeda'
-__version__ = '1.0.1'
+__version__ = '1.0.2'
 __program_name__ = 'tasks'
 __debug = False
 verbose = 0
@@ -109,7 +109,7 @@ def main(args, tasks_file='Taskfile.yaml', param_set=None, path_string='vars'):
     # Instantiate YAML Reader Class
     yamlr = YamlReader()
     # Instantiate the cli invocation class
-    yamlcli = CLIInvocation()
+    sub_process = CLIInvocation()
     # Load Tasks Manifest
     yaml_input_file = tasks_file
     if os.path.exists(yaml_input_file):
@@ -418,7 +418,7 @@ def run(args=None, **kwargs):
             if prefix == 'echo':
                 print(command)
             else:
-                yamlcli.call(command, debug_enabled=__debug)
+                sub_process.call(command, debug_enabled=__debug)
         else:
             # Invoke the cli provider
             provider_cli.invocation(

ansible_taskrunner/lib/proc_mgmt/__init__.py

@@ -0,0 +1,109 @@
+import os
+import subprocess
+from subprocess import Popen, PIPE, STDOUT
+import sys
+import threading
+import time
+
+# Define how we handle different shell invocations
+shell_invocation_mappings = { 
+    'bash': '{src}',
+    'python': 'python -c """{src}"""',
+    'ruby': 'ruby < <(echo -e """{src}""")'
+}
+
+
+class CLIInvocation:
+
+    def __init__(self):
+
+        self.proc = None
+        self.done = False
+        self.invocation = type('obj', (object,), {
+            'stdout': None,
+            'failed': False,
+            'returncode': 0
+        }
+        )        
+
+    @staticmethod
+    def which(program):
+        """
+        Returns the fully-qualified path to the specified binary
+        """
+        def is_exe(filepath):
+            if sys.platform == 'win32':
+                filepath = filepath.replace('\\', '/')
+                for exe in [filepath, filepath + '.exe']:
+                    if all([os.path.isfile(exe), os.access(exe, os.X_OK)]):
+                        return True
+            else:
+                return os.path.isfile(filepath) and os.access(filepath, os.X_OK)
+        fpath, fname = os.path.split(program)
+        if fpath:
+            if is_exe(program):
+                return program
+        else:
+            for path in os.environ["PATH"].split(os.pathsep):
+                path = path.strip('"')
+                exe_file = os.path.join(path, program)
+                if is_exe(exe_file):
+                    return exe_file
+        return None   
+
+    def call(self, cmd, exe='bash', debug_enabled=False):    
+
+        executable = self.which(exe)
+        if debug_enabled:
+            process_invocation = [executable,'-x','-c', cmd]
+        else:
+            process_invocation = [executable, '-c', cmd]        
+
+        def s():
+            try:
+                if sys.version_info[0] >= 3:
+                    with Popen(process_invocation, stdout=PIPE, stderr=STDOUT, bufsize=1, universal_newlines=True) as self.proc:
+                        for line in self.proc.stdout:
+                            sys.stdout.write(line)  # process line here
+                        if self.proc.returncode != 0:
+                            self.invocation.failed = True
+                            self.invocation.returncode = p.returncode
+                            self.invocation.stdout = 'Encountered error code {errcode} in the specified command {args}'.format(
+                                errcode=p.returncode, args=p.args)
+                            return self.invocation
+                else:
+                    # Invoke process
+                    self.proc = Popen(
+                        process_invocation,
+                        stdout=PIPE,
+                        stderr=STDOUT)
+                    # Poll for new output until finished
+                    while True:
+                        nextline = self.proc.stdout.readline()
+                        if nextline == '' and self.proc.poll() is not None:
+                            break
+                        sys.stdout.write(nextline)
+                        sys.stdout.flush()
+                    self.done = True
+            except Exception:
+                self.done = True
+            self.done = True
+
+        try:
+            if sys.version_info[0] >= 3:
+                t = threading.Thread(target=s, daemon=True)
+            else:
+                t = threading.Thread(target=s)
+            t.start()
+        except Exception:
+            pass
+        try:
+            while not self.done:
+                time.sleep(0.1)
+
+        except KeyboardInterrupt:
+            print("KeyboardInterrupt")
+            try:
+                self.proc.terminate()
+            except Exception:
+                pass

ansible_taskrunner/lib/providers/ansible.py

@@ -15,7 +15,8 @@
 try:
     import click
     from formatting import ansi_colors
-    from yamlc import CLIInvocation
+    from proc_mgmt import shell_invocation_mappings
+    from proc_mgmt import CLIInvocation
 except ImportError as e:
     print('Failed to import at least one required module')
     print('Error was %s' % e)
@@ -60,7 +61,7 @@ def invocation(yaml_input_file=None,
                    kwargs={}):
         """Invoke commands according to provider"""
         logger.info('Ansible Command Provider')
-        yamlcli = CLIInvocation()
+        sub_process = CLIInvocation()
         ansible_playbook_command = default_vars.get(
             'ansible_playbook_command', 'ansible-playbook')
         # Embedded inventory logic
@@ -131,7 +132,7 @@ def invocation(yaml_input_file=None,
                 print(inventory_command)
                 print(ansible_command)
         else:
-            yamlcli.call(command, debug_enabled=debug)
+            sub_process.call(command, debug_enabled=debug)
         # Debugging
         if debug:
             ansible_command_file_descriptor, ansible_command_file_path = mkstemp(prefix='ansible-command',

ansible_taskrunner/lib/providers/bash.py

@@ -11,7 +11,8 @@
 # Import third-party and custom modules
 try:
     import click
-    from yamlc import CLIInvocation
+    from proc_mgmt import shell_invocation_mappings
+    from proc_mgmt import CLIInvocation
 except ImportError as e:
     print('Failed to import at least one required module')
     print('Error was %s' % e)
@@ -48,7 +49,7 @@ def invocation(yaml_input_file=None,
                    kwargs={}):
         """Invoke commands according to provider"""
         logger.info('Bash Command Provider')
-        yamlcli = CLIInvocation()
+        sub_process = CLIInvocation()
         command = '''
 {clv}
 {dsv}
@@ -69,4 +70,4 @@ def invocation(yaml_input_file=None,
             logger.info("ECHO MODE ON")
             print(command)
         else:
-            yamlcli.call(command, debug_enabled=debug)
+            sub_process.call(command, debug_enabled=debug)

ansible_taskrunner/lib/providers/vagrant.py

@@ -11,7 +11,8 @@
 # Import third-party and custom modules
 try:
     import click
-    from yamlc import CLIInvocation
+    from proc_mgmt import shell_invocation_mappings
+    from proc_mgmt import CLIInvocation
 except ImportError as e:
     print('Failed to import at least one required module')
     print('Error was %s' % e)
@@ -53,7 +54,7 @@ def invocation(yaml_input_file=None,
                    kwargs={}):
         """Invoke commands according to provider"""
         logger.info('Vagrant Command Provider')
-        yamlcli = CLIInvocation()
+        sub_process = CLIInvocation()
         command = '''{clv}
 {dsv}
 {psv}
@@ -73,4 +74,4 @@ def invocation(yaml_input_file=None,
             logger.info("ECHO MODE ON")
             print(command)
         else:
-            yamlcli.call(command, debug_enabled=debug)
+            sub_process.call(command, debug_enabled=debug)

ansible_taskrunner/lib/yamlc/__init__.py

@@ -16,7 +16,8 @@
         from lib.py3 import click
     else:
         from lib.py2 import click
-    from lib.common.yamlc import CLIInvocation
+    from lib.proc_mgmt import shell_invocation_mappings
+    from lib.proc_mgmt import CLIInvocation    
 except ImportError as e:
     print('Failed to import at least one required module')
     print('Error was %s' % e)
@@ -51,6 +52,7 @@ def invocation(self,
         raw_args='', 
         kwargs={}):
         logger.info('Example Command Provider')
+        sub_process = CLIInvocation()
         command = '''{dsv}
 {dlv}
 {clv}
@@ -68,4 +70,4 @@ def invocation(self,
             logger.info("ECHO MODE ON")
             print(command)
         else:
-            CLIInvocation().call(command)
+            sub_process.call(command)