Correctly capturing return codes from executed programs (#2)

* Extending ability to capture errors

* Pass the env and set Shell to False

* Explicilty set env

* Correcting name of function

* Correctly capturing and reporting return code

* Removing unnecessary logging

* Bumping Version

* Noting return codes in the README.md

* Updating description.

README.md

@@ -43,6 +43,8 @@ Optional: Use existing env variables if they exist rather than incoming SSM Para
 ## exec switch
 Calls a sub-process to execute the given program. Chamber expects that the given program call is available in the PATH or is a fully qualified location to the executable.
 
+Note: Chamber will capture the return result from the program which is executed and will return the result of the execution back to the shell.
+
 # Credits
 
 The following people / projects are credited for pychamber project.

pychamber/chamber.py

@@ -1,6 +1,6 @@
 import os
-import subprocess
 
+from pychamber.utils.execution_utils import run_command
 from pychamber.utils.ssm_parameter_store import SSMParameterStore
 from pychamber.utils.manage_args import (
     parse_exec,
@@ -47,7 +47,8 @@ def main():
                 my_env[param] = store[ssm_param]
 
     my_command = args.exec
-    subprocess.run(my_command, env = my_env)
+    result = run_command(my_command, env = my_env)
+    return result
 
 # run the main function only if this module is executed as the
 # main script. (if you import this as a module then nothing is executed)

pychamber/utils/execution_utils.py

@@ -0,0 +1,13 @@
+"""Utilities for pychamber."""
+
+import logging
+import subprocess
+
+def run_command(command, env):
+    """ Runs requested process with arguments.
+        Return: returncode of executed program.
+    """
+    logging.debug("Command: {}".format(command))
+    result = subprocess.run(command, env=env, shell=False, capture_output=False)
+
+    return result.returncode

pychamber/utils/manage_args.py

@@ -1,4 +1,4 @@
-# manage_args.py
+"""Process cli arguments via argparse with extensions."""
 
 import argparse
 from enum import Enum

pychamber/utils/ssm_parameter_store.py

@@ -1,3 +1,5 @@
+"""Interact with AWS Parameter Store for secrets via boto3."""
+
 # Copyright (c) 2018 Bao Nguyen <[email protected]>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pychamber"
-version = "0.1.1"
+version = "0.1.3"
 description = ""
 authors = ["Steve Clarke <[email protected]>"]
 readme = "README.md"