Merge pull request #4598 from StackStorm/fix_null_filter_unicode_error

Correctly handle exception instances with non-ascii (unicode) error messages

Author: Kami

CHANGELOG.rst

@@ -52,15 +52,24 @@ Fixed
 * Fix orquesta with items task performance issue. Workflow runtime increase significantly when a
   with items task has many items and result in many retries on write conflicts. A distributed lock
   is acquired before write operations to avoid write conflicts. (bug fix) Stackstorm/orquesta#125
+* Fix a bug with some API endpoints returning 500 internal server error when an exception contained
+  unicode data. (bug fix) #4598
+
+2.10.4 - March 15, 2019
+-----------------------
+
+Fixed
+~~~~~
+
 * Fix inadvertent regression in notifier service which would cause generic action trigger to only
   be dispatched for completed states even if custom states were specified using
   ``action_sensor.emit_when`` config option. (bug fix)
   Reported by Shu Sugimoto (@shusugmt). #4591
 * Make sure we don't log auth token and api key inside st2api log file if those values are provided
   via query parameter and not header (``?x-auth-token=foo``, ``?st2-api-key=bar``). (bug fix) #4592
   #4589
-* Fix rendering of config_context in orquesta task that references action in different pack.
-  (bug fix) #4570
+* Fix rendering of ``{{ config_context. }}`` in orquesta task that references action from a
+  different pack (bug fix) #4570 #4567
 * Add missing default config location (``/etc/st2/st2.conf``) to the following services:
   ``st2actionrunner``, ``st2scheduler``, ``st2workflowengine``. (bug fix) #4596
 * Update statsd metrics driver so any exception thrown by statsd library is treated as non fatal.

contrib/examples/actions/pythonactions/fibonacci.py

@@ -21,4 +21,4 @@ def fib(n):
         print(results)
     except Exception as e:
         traceback.print_exc(file=sys.stderr)
-        sys.exit(str(e))
+        sys.exit(six.text_type(e))

contrib/examples/actions/pythonactions/forloop_parse_github_repos.py

@@ -16,6 +16,6 @@ def run(self, content):
                 repo_url = "https://github.com" + repo_half_url
                 output[repo_name] = repo_url
         except Exception as e:
-            raise Exception("Could not parse data: {}".format(str(e)))
+            raise Exception("Could not parse data: {}".format(six.text_type(e)))
 
         return (True, output)

contrib/examples/actions/pythonactions/forloop_push_github_repos.py

@@ -9,6 +9,6 @@ def run(self, data_to_push):
                 # Push data to a service here
                 print(str(each_item))
         except Exception as e:
-            raise Exception("Process failed: {}".format(str(e)))
+            raise Exception("Process failed: {}".format(six.text_type(e)))
 
         return (True, "Data pushed successfully")

contrib/examples/actions/ubuntu_pkg_info/ubuntu_pkg_info.py

@@ -14,7 +14,7 @@ def main(args):
     try:
         payload = transformer.to_json(command_stdout, command_stderr, command_exitcode)
     except Exception as e:
-        sys.stderr.write('JSON conversion failed. %s' % str(e))
+        sys.stderr.write('JSON conversion failed. %s' % six.text_type(e))
         sys.exit(1)
 
     sys.stdout.write(payload)

contrib/linux/actions/wait_for_ssh.py

@@ -2,6 +2,7 @@
 
 import time
 
+import six
 from oslo_config import cfg
 
 from st2common.runners.base_action import Action
@@ -31,7 +32,7 @@ def run(self, hostname, port, username, password=None, keyfile=None, ssh_timeout
                 return True
             except Exception as e:
                 self.logger.info('Attempt %s failed (%s), sleeping for %s seconds...' %
-                                 (attempt, str(e), sleep_delay))
+                                 (attempt, six.text_type(e), sleep_delay))
                 time.sleep(sleep_delay)
 
         raise Exception('Exceeded max retries (%s)' % (retries))

contrib/packs/actions/pack_mgmt/get_installed.py

@@ -16,6 +16,8 @@
 import os
 import yaml
 
+import six
+
 from git.repo import Repo
 from git.exc import InvalidGitRepositoryError
 
@@ -57,7 +59,8 @@ def run(self, pack):
         try:
             details = self._parse_yaml_file(metadata_file)
         except Exception as e:
-            error = ('Pack "%s" doesn\'t contain a valid pack.yaml file: %s' % (pack, str(e)))
+            error = ('Pack "%s" doesn\'t contain a valid pack.yaml file: %s' % (pack,
+                                                                                six.text_type(e)))
             raise Exception(error)
 
         try:

contrib/runners/action_chain_runner/action_chain_runner/action_chain_runner.py

@@ -14,11 +14,13 @@
 # limitations under the License.
 
 from __future__ import absolute_import
+
 import eventlet
 import traceback
 import uuid
 import datetime
 
+import six
 from jsonschema import exceptions as json_schema_exc
 
 from st2common.runners.base import ActionRunner
@@ -259,7 +261,7 @@ def pre_run(self):
                                                expected_type=dict)
         except Exception as e:
             message = ('Failed to parse action chain definition from "%s": %s' %
-                       (chainspec_file, str(e)))
+                       (chainspec_file, six.text_type(e)))
             LOG.exception('Failed to load action chain definition.')
             raise runner_exc.ActionRunnerPreRunError(message)
 
@@ -268,11 +270,11 @@ def pre_run(self):
         except json_schema_exc.ValidationError as e:
             # preserve the whole nasty jsonschema message as that is better to get to the
             # root cause
-            message = str(e)
+            message = six.text_type(e)
             LOG.exception('Failed to instantiate ActionChain.')
             raise runner_exc.ActionRunnerPreRunError(message)
         except Exception as e:
-            message = str(e)
+            message = six.text_type(e)
             LOG.exception('Failed to instantiate ActionChain.')
             raise runner_exc.ActionRunnerPreRunError(message)
 
@@ -288,7 +290,7 @@ def pre_run(self):
         try:
             self.chain_holder.validate()
         except Exception as e:
-            raise runner_exc.ActionRunnerPreRunError(str(e))
+            raise runner_exc.ActionRunnerPreRunError(six.text_type(e))
 
     def run(self, action_parameters):
         # Run the action chain.
@@ -610,7 +612,7 @@ def _run_chain(self, action_parameters, resuming=False):
 
     def _format_error(self, e, msg):
         return {
-            'error': '%s. %s' % (msg, str(e)),
+            'error': '%s. %s' % (msg, six.text_type(e)),
             'traceback': traceback.format_exc(10)
         }
 
@@ -657,7 +659,7 @@ def _render_publish_vars(action_node, action_parameters, execution_result,
             key = getattr(e, 'key', None)
             value = getattr(e, 'value', None)
             msg = ('Failed rendering value for publish parameter "%s" in task "%s" '
-                   '(template string=%s): %s' % (key, action_node.name, value, str(e)))
+                   '(template string=%s): %s' % (key, action_node.name, value, six.text_type(e)))
             raise action_exc.ParameterRenderingFailedException(msg)
 
         return rendered_result
@@ -699,7 +701,7 @@ def _resolve_params(action_node, original_parameters, results, chain_vars, chain
             key = getattr(e, 'key', None)
             value = getattr(e, 'value', None)
             msg = ('Failed rendering value for action parameter "%s" in task "%s" '
-                   '(template string=%s): %s') % (key, action_node.name, value, str(e))
+                   '(template string=%s): %s') % (key, action_node.name, value, six.text_type(e))
             raise action_exc.ParameterRenderingFailedException(msg)
         LOG.debug('Rendered params: %s: Type: %s', rendered_params, type(rendered_params))
         return rendered_params

contrib/runners/action_chain_runner/dist_utils.py

@@ -15,19 +15,28 @@
 # limitations under the License.
 
 from __future__ import absolute_import
+
 import os
 import re
 import sys
 
 from distutils.version import StrictVersion
 
+# NOTE: This script can't rely on any 3rd party dependency so we need to use this code here
+PY3 = sys.version_info[0] == 3
+
+if PY3:
+    text_type = str
+else:
+    text_type = unicode
+
 GET_PIP = 'curl https://bootstrap.pypa.io/get-pip.py | python'
 
 try:
     import pip
     from pip import __version__ as pip_version
 except ImportError as e:
-    print('Failed to import pip: %s' % (str(e)))
+    print('Failed to import pip: %s' % (text_type(e)))
     print('')
     print('Download pip:\n%s' % (GET_PIP))
     sys.exit(1)
@@ -41,7 +50,7 @@
     try:
         from pip._internal.req.req_file import parse_requirements
     except ImportError as e:
-        print('Failed to import parse_requirements from pip: %s' % (str(e)))
+        print('Failed to import parse_requirements from pip: %s' % (text_type(e)))
         print('Using pip: %s' % (str(pip_version)))
         sys.exit(1)
 

contrib/runners/action_chain_runner/tests/unit/test_actionchain.py

@@ -687,7 +687,7 @@ def test_chain_runner_publish_param_rendering_failure(self, request):
             # rendering failure
             expected_error = ('Failed rendering value for publish parameter "p1" in '
                               'task "c2" (template string={{ not_defined }}):')
-            self.assertTrue(expected_error in str(e))
+            self.assertTrue(expected_error in six.text_type(e))
             pass
         else:
             self.fail('Exception was not thrown')