Make custom filters available in Mistral; Disable Decryption-by-default in st2kv function

circle.yml

@@ -7,3 +7,4 @@ dependencies:
 test:
   override:
     - tox -e pep8
+    - tox -e py27

requirements.txt

@@ -3,3 +3,4 @@
 # process, which may cause wedges in the gate later.
 
 retrying<1.4,>=1.3
+semver==2.7.2

setup.cfg

@@ -10,7 +10,26 @@ mistral.actions =
     st2.action = st2mistral.actions.stackstorm:St2Action
 
 mistral.expression.functions =
+    json_escape = st2mistral.functions.json_escape:json_escape
+    regex_match = st2mistral.functions.regex:regex_match
+    regex_replace = st2mistral.functions.regex:regex_replace
+    regex_search = st2mistral.functions.regex:regex_search
+    regex_substring = st2mistral.functions.regex:regex_substring
     st2kv = st2mistral.functions.stackstorm:st2kv_
+    to_complex = st2mistral.functions.data:to_complex
+    to_human_time_from_seconds = st2mistral.functions.time:to_human_time_from_seconds
+    to_json_string = st2mistral.functions.data:to_json_string
+    to_yaml_string = st2mistral.functions.data:to_yaml_string
+    use_none = st2mistral.functions.use_none:use_none
+    version_compare = st2mistral.functions.version:version_compare
+    version_bump_major = st2mistral.functions.version:version_bump_major
+    version_bump_minor = st2mistral.functions.version:version_bump_minor
+    version_bump_patch = st2mistral.functions.version:version_bump_patch
+    version_equal = st2mistral.functions.version:version_equal
+    version_less_than = st2mistral.functions.version:version_less_than
+    version_match = st2mistral.functions.version:version_match
+    version_more_than = st2mistral.functions.version:version_more_than
+    version_strip_patch = st2mistral.functions.version:version_strip_patch
 
 mistral.auth =
     st2 = st2mistral.auth.server:St2AuthHandler

st2mistral/functions/data.py

@@ -0,0 +1,38 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+import yaml
+
+__all__ = [
+    'to_complex',
+    'to_json_string',
+    'to_yaml_string'
+]
+
+
+def to_complex(context, value):
+    return json.dumps(value)
+
+
+def to_json_string(context, value, indent=4, sort_keys=False,
+                   separators=(',', ':')):
+    return json.dumps(value, indent=indent, separators=separators,
+                      sort_keys=sort_keys)
+
+
+def to_yaml_string(context, value, indent=4, allow_unicode=True):
+    return yaml.safe_dump(value, indent=indent, allow_unicode=allow_unicode,
+                          default_flow_style=False)

st2mistral/functions/json_escape.py

@@ -0,0 +1,36 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+
+__all__ = [
+    'json_escape'
+]
+
+
+def json_escape(context, value):
+    """Adds escape sequences to problematic characters in the string
+
+    This function simply passes the value to json.dumps
+    as a convenient way of escaping characters in it
+
+    However, before returning, we want to strip the double
+    quotes at the ends of the string, since we're not looking
+    for a valid JSON value at the end, just conveniently using
+    this function to do the escaping. The value could be any
+    arbitrary value
+    """
+
+    return json.dumps(value).strip('"')

st2mistral/functions/regex.py

@@ -0,0 +1,58 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+import six
+
+__all__ = [
+    'regex_match',
+    'regex_replace',
+    'regex_search'
+]
+
+
+def _get_regex_flags(ignorecase=False):
+    return re.I if ignorecase else 0
+
+
+def regex_match(context, value, pattern=u'', ignorecase=False):
+    if not isinstance(value, six.string_types):
+        value = str(value)
+    flags = _get_regex_flags(ignorecase)
+    return bool(re.match(pattern, value, flags))
+
+
+def regex_replace(context, value=u'', pattern=u'', replacement=u'',
+                  ignorecase=False):
+    if not isinstance(value, six.string_types):
+        value = str(value)
+    flags = _get_regex_flags(ignorecase)
+    regex = re.compile(pattern, flags)
+    return regex.sub(replacement, value)
+
+
+def regex_search(context, value, pattern=u'', ignorecase=False):
+    if not isinstance(value, six.string_types):
+        value = str(value)
+    flags = _get_regex_flags(ignorecase)
+    return bool(re.search(pattern, value, flags))
+
+
+def regex_substring(context, value, pattern=u'', result_index=0,
+                    ignorecase=False):
+    if not isinstance(value, six.string_types):
+        value = str(value)
+    flags = _get_regex_flags(ignorecase)
+    return re.findall(pattern, value, flags)[result_index]

st2mistral/functions/stackstorm.py

@@ -24,11 +24,19 @@
 from mistral import exceptions as exc
 from st2mistral.utils import http
 
-
 LOG = logging.getLogger(__name__)
 
 
-def st2kv_(context, key):
+def st2kv_(context, key, decrypt=False):
+    """Retrieve value for provided key in StackStorm datastore
+
+    :param key: User to whom key belongs.
+    :type key: ``str``
+    :param decrypt: Request decrypted version of the value (defaults to False)
+    :type decrypt: ``bool``
+
+    :rtype: ``dict``
+    """
 
     # Get StackStorm auth token from the action context.
     token = None
@@ -51,7 +59,7 @@ def st2kv_(context, key):
         key_id = key
 
     endpoint = st2_ctx['api_url'] + '/keys/' + key_id
-    params = {'decrypt': True, 'scope': scope}
+    params = {'decrypt': decrypt, 'scope': scope}
 
     LOG.info(
         'Sending HTTP request for custom YAQL function st2kv '

st2mistral/functions/time.py

@@ -0,0 +1,85 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import datetime
+
+__all__ = [
+    'to_human_time_from_seconds'
+]
+
+
+def to_human_time_from_seconds(context, seconds):
+    """Given a time value in seconds, this returns a fuzzy version like 3m5s.
+
+    :param time_seconds: Time specified in seconds.
+    :type time_seconds: ``int`` or ``long`` or ``float``
+
+    :rtype: ``str``
+    """
+    assert (isinstance(seconds, int) or isinstance(seconds, long) or
+            isinstance(seconds, float))
+
+    return _get_human_time(seconds)
+
+
+def _get_human_time(seconds):
+    """Takes number of seconds as input and returns a string of form '1h3m5s'.
+
+    :param seconds: Number of seconds.
+    :type seconds: ``int`` or ``long`` or ``float``
+
+    :rtype: ``str``
+    """
+
+    if seconds is None:
+        return None
+
+    if seconds == 0:
+        return '0s'
+
+    if seconds < 1:
+        return '%s\u03BCs' % seconds  # Microseconds
+
+    if isinstance(seconds, float):
+        seconds = long(round(seconds))  # Let's lose microseconds.
+
+    timedelta = datetime.timedelta(seconds=seconds)
+    offset_date = datetime.datetime(1, 1, 1) + timedelta
+
+    years = offset_date.year - 1
+    days = offset_date.day - 1
+    hours = offset_date.hour
+    mins = offset_date.minute
+    secs = offset_date.second
+
+    time_parts = [years, days, hours, mins, secs]
+
+    first_non_zero_pos = next((i for i, x in enumerate(time_parts) if x), None)
+
+    if first_non_zero_pos is None:
+        return '0s'
+    else:
+        time_parts = time_parts[first_non_zero_pos:]
+
+    if len(time_parts) == 1:
+        return '%ss' % tuple(time_parts)
+    elif len(time_parts) == 2:
+        return '%sm%ss' % tuple(time_parts)
+    elif len(time_parts) == 3:
+        return '%sh%sm%ss' % tuple(time_parts)
+    elif len(time_parts) == 4:
+        return '%sd%sh%sm%ss' % tuple(time_parts)
+    elif len(time_parts) == 5:
+        return '%sy%sd%sh%sm%ss' % tuple(time_parts)

st2mistral/functions/use_none.py

@@ -0,0 +1,28 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__all__ = [
+    'use_none'
+]
+
+
+# Magic string to which None type is serialized when using use_none function
+NONE_MAGIC_VALUE = '%*****__%NONE%__*****%'
+
+
+def use_none(context, value):
+    if value is None:
+        return NONE_MAGIC_VALUE
+    return value

st2mistral/functions/version.py

@@ -0,0 +1,62 @@
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import semver
+
+__all__ = [
+    'version_compare',
+    'version_more_than',
+    'version_less_than',
+    'version_equal',
+    'version_match',
+    'version_bump_major',
+    'version_bump_minor'
+]
+
+
+def version_compare(context, value, pattern):
+    return semver.compare(value, pattern)
+
+
+def version_more_than(context, value, pattern):
+    return semver.compare(value, pattern) == 1
+
+
+def version_less_than(context, value, pattern):
+    return semver.compare(value, pattern) == -1
+
+
+def version_equal(context, value, pattern):
+    return semver.compare(value, pattern) == 0
+
+
+def version_match(context, value, pattern):
+    return semver.match(value, pattern)
+
+
+def version_bump_major(context, value):
+    return semver.bump_major(value)
+
+
+def version_bump_minor(context, value):
+    return semver.bump_minor(value)
+
+
+def version_bump_patch(context, value):
+    return semver.bump_patch(value)
+
+
+def version_strip_patch(context, value):
+    return "{major}.{minor}".format(**semver.parse(value))