Merge pull request #68 from StackStorm-Exchange/user_data_fix

Allow user to pass "user_data" parameter to the ec2_run_instances action

Author: Kami

CHANGES.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.1.0
+
+- Fix ``ec2_run_instances`` action so ``user_data`` parameter passed to this action takes
+  precedence over user data which is specified via ``st2_user_data`` config option.
+
+  This way user can override / provide custom user data on per action invocation basis.
+
+- Add additional log statements under debug log level which log which boto method / function
+  is called and with which arguments when ``debug`` config option is set to ``True``. This helps
+  with debugging / troubleshooting various pack related issues.
+
 ## 1.0.3
 
 - Fixed issue with create_vm and destroy_vm workflows using snake_case for CamelCase params

actions/lib/action.py

@@ -22,11 +22,15 @@ def __init__(self, config):
             'aws_access_key_id': None,
             'aws_secret_access_key': None
         }
+        self.user_data_file = config.get('st2_user_data', None)
+        self.debug = config.get('debug', False)
+
         self.userdata = None
 
-        if config.get('st2_user_data', None):
+        # Read in default user data
+        if self.user_data_file:
             try:
-                with open(config['st2_user_data'], 'r') as fp:
+                with open(self.user_data_file, 'r') as fp:
                     self.userdata = fp.read()
             except IOError as e:
                 self.logger.error(e)
@@ -148,10 +152,20 @@ def do_method(self, module_path, cls, action, **kwargs):
             raise ValueError('Invalid or missing credentials (aws_access_key_id,'
                              'aws_secret_access_key) or region')
 
+        if self.debug:
+            method_fqdn = '%s.%s.%s' % (module_path, cls, action)
+            self.logger.debug('Calling method "%s" with kwargs: %s' % (method_fqdn, str(kwargs)))
+
         resultset = getattr(obj, action)(**kwargs)
         formatted = self.resultsets.formatter(resultset)
         return formatted if isinstance(formatted, list) else [formatted]
 
     def do_function(self, module_path, action, **kwargs):
         module = __import__(module_path)
+
+        if self.debug:
+            function_fqdn = '%s.%s' % (module_path, action)
+            self.logger.debug('Calling function "%s" with kwargs: %s' % (function_fqdn,
+                                                                         str(kwargs)))
+
         return getattr(module, action)(**kwargs)

actions/run.py

@@ -16,8 +16,14 @@ def run(self, **kwargs):
         '''
         aws_action = kwargs.pop('action')
         module_path = kwargs.pop('module_path')
-        if aws_action == 'run_instances':
-            kwargs['user_data'] = self.st2_user_data()
+        if aws_action == 'run_instances' and not kwargs.get('user_data', None):
+            # Include default user_data from config (if set)
+            user_data = self.st2_user_data()
+
+            if user_data:
+                self.logger.info('Passing in default user_data specified as st2_user_data config '
+                                 'option (%s file)' % (self.user_data_file))
+                kwargs['user_data'] = self.st2_user_data()
         if aws_action == 'create_tags':
             # Skip "Tags" parameter and pass "tags" as is unless it is a string.
             if 'Tags' not in kwargs and isinstance(kwargs.get('tags'), str):

aws.yaml.example

@@ -3,6 +3,7 @@ aws_access_key_id: access_key
 aws_secret_access_key: secret_key
 region: us-east-1
 st2_user_data: /opt/stackstorm/packs/aws/actions/scripts/bootstrap_user.sh
+debug: true
 
 service_notifications_sensor:
   host: localhost

config.schema.yaml

@@ -17,6 +17,10 @@
   st2_user_data:
     description: "The file for all invocations of the 'aws.ec2_run_instances' action"
     type: "string"
+  debug:
+    type: "boolean"
+    description: "Set to True to log every boto method / function invocation"
+    default: false
   service_notifications_sensor:
     type: object
     properties:

pack.yaml

@@ -20,6 +20,6 @@ keywords:
   - lambda
   - kinesis
 
-version : 1.0.3
+version : 1.1.0
 author : StackStorm, Inc.
 email : info@stackstorm.com