Merge pull request #2802 from StackStorm/1.5.1

Release branch for StackStorm v1.5.1

Author: Kami

CHANGELOG.rst

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+1.5.1 - July 13, 2016
+---------------------
+
+* Fix trigger registration when using st2-register-content script with ``--register-triggers``
+  flag. (bug-fix)
+* Fix an issue with CronTimer sometimes not firing due to TriggerInstance creation failure.
+  (bug-fix)
+  Reported by  Cody A. Ray
+* Add support for default values when a new pack configuration is used. Now if a default value
+  is specified for a required config item in the config schema and a value for that item is not
+  provided in the config, default value from config schema is used. (improvement)
+* Allow user to prevent execution parameter merging when re-running an execution by passing
+  ``?no_merge=true`` query parameter to the execution re-run API endpoint. (improvement)
+
 1.5.0 - June 24, 2016
 ---------------------
 

contrib/examples/triggers/sample-trigger.yaml

@@ -1,5 +1,3 @@
 ---
-payload:
-  result: 10
-  work: done
-type: st2.trigger
+name: sample_trigger
+description: Sample trigger

st2api/st2api/controllers/v1/actionexecutions.py

@@ -37,6 +37,7 @@
 from st2common.models.api.action import LiveActionAPI
 from st2common.models.api.action import LiveActionCreateAPI
 from st2common.models.api.base import jsexpose
+from st2common.models.api.base import cast_argument_value
 from st2common.models.api.execution import ActionExecutionAPI
 from st2common.persistence.liveaction import LiveAction
 from st2common.persistence.execution import ActionExecution
@@ -276,22 +277,25 @@ def validate(self):
             return self
 
     @jsexpose(body_cls=ExecutionSpecificationAPI, status_code=http_client.CREATED)
-    def post(self, spec, execution_id):
+    def post(self, spec_api, execution_id, no_merge=False):
         """
         Re-run the provided action execution optionally specifying override parameters.
 
         Handles requests:
 
             POST /executions/<id>/re_run
         """
+        no_merge = cast_argument_value(value_type=bool, value=no_merge)
         existing_execution = self._get_one(id=execution_id, exclude_fields=self.exclude_fields)
 
-        if spec.tasks and existing_execution.runner['name'] != 'mistral-v2':
+        if spec_api.tasks and existing_execution.runner['name'] != 'mistral-v2':
             raise ValueError('Task option is only supported for Mistral workflows.')
 
         # Merge in any parameters provided by the user
-        new_parameters = copy.deepcopy(getattr(existing_execution, 'parameters', {}))
-        new_parameters.update(spec.parameters)
+        new_parameters = {}
+        if not no_merge:
+            new_parameters.update(getattr(existing_execution, 'parameters', {}))
+        new_parameters.update(spec_api.parameters)
 
         # Create object for the new execution
         action_ref = existing_execution.action['ref']
@@ -303,11 +307,11 @@ def post(self, spec, execution_id):
             }
         }
 
-        if spec.tasks:
-            context['re-run']['tasks'] = spec.tasks
+        if spec_api.tasks:
+            context['re-run']['tasks'] = spec_api.tasks
 
-        if spec.reset:
-            context['re-run']['reset'] = spec.reset
+        if spec_api.reset:
+            context['re-run']['reset'] = spec_api.reset
 
         # Add trace to the new execution
         trace = trace_service.get_trace_db_by_action_execution(
@@ -319,7 +323,7 @@ def post(self, spec, execution_id):
         new_liveaction_api = LiveActionCreateAPI(action=action_ref,
                                                  context=context,
                                                  parameters=new_parameters,
-                                                 user=spec.user)
+                                                 user=spec_api.user)
 
         return self._handle_schedule_execution(liveaction_api=new_liveaction_api)
 

st2api/tests/unit/controllers/v1/test_base.py

@@ -65,3 +65,13 @@ def test_wildcard_origin(self):
         self.assertEqual(response.status_int, 200)
         self.assertEqual(response.headers['Access-Control-Allow-Origin'],
                          '*')
+
+    def test_valid_status_code_is_returned_on_invalid_path(self):
+        # TypeError: get_all() takes exactly 1 argument (2 given)
+        resp = self.app.get('/v1/executions/577f775b0640fd1451f2030b/re_run', expect_errors=True)
+        self.assertEqual(resp.status_int, 404)
+
+        # get_one() takes exactly 2 arguments (4 given)
+        resp = self.app.get('/v1/executions/577f775b0640fd1451f2030b/re_run/a/b',
+                            expect_errors=True)
+        self.assertEqual(resp.status_int, 404)

st2client/requirements.txt

@@ -6,3 +6,4 @@ pytz
 pyyaml<4.0,>=3.11
 requests<3.0,>=2.7.0
 six==1.9.0
+argcomplete==1.4.1

st2client/st2client/__init__.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '1.5.0'
+__version__ = '1.5.1'

st2common/st2common/__init__.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '1.5.0'
+__version__ = '1.5.1'

st2common/st2common/bootstrap/triggersregistrar.py

@@ -21,8 +21,7 @@
 from st2common.constants.meta import ALLOWED_EXTS
 from st2common.bootstrap.base import ResourceRegistrar
 import st2common.content.utils as content_utils
-from st2common.models.api.trigger import TriggerTypeAPI
-from st2common.persistence.trigger import TriggerType
+from st2common.models.utils import sensor_type_utils
 
 __all__ = [
     'TriggersRegistrar',
@@ -135,22 +134,9 @@ def _register_trigger_from_pack(self, pack, trigger):
             raise Exception('Model is in pack "%s" but field "pack" is different: %s' %
                             (pack, pack_field))
 
-        trigger_api = TriggerTypeAPI(**content)
-        trigger_model = TriggerTypeAPI.to_model(trigger_api)
-
-        trigger_types = TriggerType.query(pack=trigger_model.pack, name=trigger_model.name)
-        if len(trigger_types) >= 1:
-            trigger_type = trigger_types[0]
-            LOG.debug('Found existing trigger id:%s with name:%s. Will update it.',
-                      trigger_type.id, trigger_type.name)
-            trigger_model.id = trigger_type.id
-
-        try:
-            trigger_model = TriggerType.add_or_update(trigger_model)
-        except:
-            LOG.exception('Failed creating trigger model for %s', trigger)
-
-        return trigger_model
+        trigger_types = [content]
+        result = sensor_type_utils.create_trigger_types(trigger_types=trigger_types)
+        return result[0] if result else None
 
 
 def register_triggers(packs_base_paths=None, pack_dir=None, use_pack_cache=True,

st2common/st2common/models/db/__init__.py

@@ -169,6 +169,9 @@ def get_by_name(self, value):
     def get_by_id(self, value):
         return self.get(id=value, raise_exception=True)
 
+    def get_by_uid(self, value):
+        return self.get(uid=value, raise_exception=True)
+
     def get_by_ref(self, value):
         return self.get(ref=value, raise_exception=True)
 

st2common/st2common/models/utils/action_param_utils.py

@@ -40,7 +40,7 @@ def _merge_param_meta_values(action_meta=None, runner_meta=None):
         elif key in runner_meta_keys and key not in action_meta_keys:
             merged_meta[key] = runner_meta[key]
         else:
-            if key in ['immutable', 'required']:
+            if key in ['immutable']:
                 merged_meta[key] = runner_meta.get(key, False) or action_meta.get(key, False)
             else:
                 merged_meta[key] = action_meta.get(key)

st2common/st2common/models/utils/sensor_type_utils.py

@@ -22,7 +22,8 @@
 
 __all__ = [
     'to_sensor_db_model',
-    'get_sensor_entry_point'
+    'get_sensor_entry_point',
+    'create_trigger_types'
 ]
 
 
@@ -53,7 +54,7 @@ def to_sensor_db_model(sensor_api_model=None):
     # Add pack to each trigger type item
     for trigger_type in trigger_types:
         trigger_type['pack'] = pack
-    trigger_type_refs = _create_trigger_types(trigger_types)
+    trigger_type_refs = create_trigger_types(trigger_types)
 
     return _create_sensor_type(pack=pack,
                                name=class_name,
@@ -65,7 +66,7 @@ def to_sensor_db_model(sensor_api_model=None):
                                enabled=enabled)
 
 
-def _create_trigger_types(trigger_types):
+def create_trigger_types(trigger_types):
     if not trigger_types:
         return []
 

st2common/st2common/persistence/base.py

@@ -83,6 +83,10 @@ def get_by_name(cls, value):
     def get_by_id(cls, value):
         return cls._get_impl().get_by_id(value)
 
+    @classmethod
+    def get_by_uid(cls, value):
+        return cls._get_impl().get_by_uid(value)
+
     @classmethod
     def get_by_ref(cls, value):
         return cls._get_impl().get_by_ref(value)

st2common/st2common/services/triggers.py

@@ -28,6 +28,8 @@
     'add_trigger_models',
 
     'get_trigger_db_by_ref',
+    'get_trigger_db_by_id',
+    'get_trigger_db_by_uid',
     'get_trigger_db_given_type_and_params',
     'get_trigger_type_db',
 
@@ -92,6 +94,42 @@ def get_trigger_db_given_type_and_params(type=None, parameters=None):
         return None
 
 
+def get_trigger_db_by_id(id):
+    """
+    Returns the trigger object from db given a trigger id.
+
+    :param ref: Reference to the trigger db object.
+    :type ref: ``str``
+
+    :rtype: ``object``
+    """
+    try:
+        return Trigger.get_by_id(id)
+    except StackStormDBObjectNotFoundError as e:
+        LOG.debug('Database lookup for id="%s" resulted in exception : %s.',
+                  id, e, exc_info=True)
+
+    return None
+
+
+def get_trigger_db_by_uid(uid):
+    """
+    Returns the trigger object from db given a trigger uid.
+
+    :param ref: Reference to the trigger db object.
+    :type ref: ``str``
+
+    :rtype: ``object``
+    """
+    try:
+        return Trigger.get_by_uid(uid)
+    except StackStormDBObjectNotFoundError as e:
+        LOG.debug('Database lookup for uid="%s" resulted in exception : %s.',
+                  uid, e, exc_info=True)
+
+    return None
+
+
 def get_trigger_db_by_ref(ref):
     """
     Returns the trigger object from db given a string ref.
@@ -355,7 +393,8 @@ def _validate_trigger_type(trigger_type):
     required_fields = ['name']
     for field in required_fields:
         if field not in trigger_type:
-            raise TriggerTypeRegistrationException('Invalid trigger type. Missing field %s' % field)
+            raise TriggerTypeRegistrationException('Invalid trigger type. Missing field "%s"' %
+                                                   (field))
 
 
 def _create_trigger(trigger_type):

st2common/st2common/util/api.py

@@ -115,7 +115,7 @@ def get_exception_for_type_error(func, exc):
 
     # Note: Those checks are hacky, but it's better than having no checks and silently
     # accepting invalid requests
-    invalid_num_args_pattern = ('%s\(\) takes %s \d+ arguments \(\d+ given\)' %
+    invalid_num_args_pattern = ('%s\(\) takes %s \d+ arguments? \(\d+ given\)' %
                                 (func_name, '(exactly|at most|at least)'))
     unexpected_keyword_arg_pattern = ('%s\(\) got an unexpected keyword argument \'(.*?)\'' %
                                       (func_name))

st2common/st2common/util/config_loader.py

@@ -103,6 +103,15 @@ def _get_values_for_config(self, config_schema_db, config_db):
                 # Static value, no resolution needed
                 result[config_item_key] = config_item_value
 
+        # If config_schema is available we do a second pass and set default values for required
+        # items which values are not provided / available in the config itself
+        for schema_item_key, schema_item in six.iteritems(schema_values):
+            default_value = schema_item.get('default', None)
+            is_required = schema_item.get('required', False)
+
+            if is_required and default_value and not result.get(schema_item_key, None):
+                result[schema_item_key] = default_value
+
         return result
 
     def _get_datastore_value_for_expression(self, value, config_schema_item=None):

st2common/tests/unit/test_action_param_utils.py

@@ -106,6 +106,18 @@ def test_merge_param_meta_values(self):
         # Immutability is set in action.
         self.assertEqual(merged_meta['immutable'], action_meta['immutable'])
 
+    def test_merge_param_meta_require_override(self):
+        action_meta = {
+            'required': False
+        }
+        runner_meta = {
+            'required': True
+        }
+        merged_meta = action_param_utils._merge_param_meta_values(action_meta=action_meta,
+                                                                  runner_meta=runner_meta)
+
+        self.assertEqual(merged_meta['required'], action_meta['required'])
+
     def test_validate_action_inputs(self):
         requires, unexpected = action_param_utils.validate_action_parameters(
             self.action_dbs['action-1'].ref, {'foo': 'bar'})

st2common/tests/unit/test_config_loader.py

@@ -44,7 +44,6 @@ def test_get_config_all_values_are_loaded_from_local_config(self):
     def test_get_config_some_values_overriden_in_datastore(self):
         # Test a scenario where some values are overriden in datastore via pack
         # flobal config
-
         kvp_db = set_datastore_value_for_config_key(pack_name='dummy_pack_5',
                                                     key_name='api_secret',
                                                     value='some_api_secret',
@@ -71,7 +70,21 @@ def test_get_config_some_values_overriden_in_datastore(self):
             'api_key': 'some_api_key',
             'api_secret': 'some_api_secret',
             'regions': ['us-west-1'],
+            'region': 'default-region-value',
             'private_key_path': 'some_private_key'
         }
 
         self.assertEqual(config, expected_config)
+
+    def test_get_config_default_value_from_config_schema_is_used(self):
+        # No value is provided for "region" in the config, default value from config schema
+        # should be used
+        loader = ContentPackConfigLoader(pack_name='dummy_pack_5')
+        config = loader.get_config()
+        self.assertEqual(config['region'], 'default-region-value')
+
+        # Here a default value is specified in schema but an explicit value is provided in the
+        # config
+        loader = ContentPackConfigLoader(pack_name='dummy_pack_1')
+        config = loader.get_config()
+        self.assertEqual(config['region'], 'us-west-1')

st2common/tests/unit/test_sensor_type_utils.py

@@ -35,7 +35,7 @@ def test_to_sensor_db_model_no_trigger_types(self):
         self.assertEqual(sensor_model.artifact_uri, sensor_meta['artifact_uri'])
         self.assertListEqual(sensor_model.trigger_types, [])
 
-    @mock.patch.object(sensor_type_utils, '_create_trigger_types', mock.MagicMock(
+    @mock.patch.object(sensor_type_utils, 'create_trigger_types', mock.MagicMock(
         return_value=['mock.trigger_ref']))
     def test_to_sensor_db_model_with_trigger_types(self):
         sensor_meta = {