Merge pull request #927 from StackStorm/fix_sensor_registration

Fix sensor registration and webhook trigger registration

Author: Kami

CHANGELOG.rst

@@ -21,6 +21,8 @@ Docs: http://docks.stackstorm.com/latest
   actions were executed through SSH, now they are executed directly without the overhead of SSH.
 * Fix local runner so it correctly executes a command under the provider system user if ``user``
   parameter is provided. (bug-fix)
+* Fix a bug with a Trigger database object in some cases being created twice when registering a
+  rule. (bug-fix)
 
 v0.6.0 - December 8, 2014
 -------------------------

contrib/examples/actions/mistral-basic.yaml

@@ -1,5 +1,6 @@
 name: 'examples.mistral-basic'
 version: '2.0'
+description: 'Basic mistral workflow example'
 workflows:
     demo:
         type: direct

contrib/packs/actions/install.meta.yaml

@@ -5,7 +5,7 @@
                 Will download pack, load the actions, sensors and rules from the pack.
                 Note that install require reboot of some st2 services."
   enabled: true
-  entry_point: "install.yaml"
+  entry_point: "workflows/install.yaml"
   parameters:
     packs:
       type: "array"

contrib/packs/actions/uninstall.meta.yaml

@@ -5,11 +5,10 @@
                 Removes pack and content from st2. Note that uninstall
                 require reboot of some st2 services."
   enabled: true
-  entry_point: "uninstall.yaml"
+  entry_point: "workflows/uninstall.yaml"
   parameters:
     packs:
       type: "array"
       items:
         type: "string"
       required: true
-

contrib/packs/actions/install.yaml renamed to contrib/packs/actions/workflows/install.yaml

@@ -51,6 +51,7 @@ def __init__(self, name, action_exec_id, command, user, env_vars=None, sudo=Fals
         self.env_vars = env_vars or {}
         self.user = user
         self.sudo = sudo
+        self.timeout = timeout
 
     def get_full_command_string(self):
         if self.sudo:
@@ -250,6 +251,7 @@ def __init__(self, name, action_exec_id, script_local_path_abs, script_local_lib
         self.on_behalf_user = on_behalf_user
         self.remote_script = os.path.join(self.remote_dir, pipes.quote(self.script_name))
         self.hosts = hosts
+        self.parallel = parallel
         self.command = self._format_command()
         LOG.debug('RemoteScriptAction: command to run on remote box: %s', self.command)
 

contrib/packs/actions/uninstall.yaml renamed to contrib/packs/actions/workflows/uninstall.yaml

@@ -18,6 +18,17 @@
 from st2common.models.system.common import ResourceReference
 from st2common.persistence.reactor import (Trigger, TriggerType)
 
+__all__ = [
+    'get_trigger_db',
+    'get_trigger_type_db',
+
+    'create_trigger_db',
+    'create_trigger_type_db',
+
+    'create_or_update_trigger_db',
+    'create_or_update_trigger_type_db'
+]
+
 LOG = logging.getLogger(__name__)
 
 
@@ -92,12 +103,12 @@ def _get_trigger_api_given_rule(rule):
     trigger = rule.trigger
     triggertype_ref = ResourceReference.from_string_reference(trigger.get('type'))
     trigger_dict = {}
-    trigger_name = trigger.get('name', None)
-    if trigger_name:
-        trigger_dict['name'] = trigger_name
+
+    trigger_dict['name'] = triggertype_ref.name
     trigger_dict['pack'] = triggertype_ref.pack
     trigger_dict['type'] = triggertype_ref.ref
     trigger_dict['parameters'] = rule.trigger.get('parameters', {})
+
     trigger_api = TriggerAPI(**trigger_dict)
 
     return trigger_api
@@ -110,11 +121,44 @@ def create_trigger_db(trigger):
     trigger_db = get_trigger_db(trigger_api)
     if not trigger_db:
         trigger_db = TriggerAPI.to_model(trigger_api)
-        LOG.debug('verified trigger and formulated TriggerDB=%s', trigger_db)
+        LOG.debug('Verified trigger and formulated TriggerDB=%s', trigger_db)
         trigger_db = Trigger.add_or_update(trigger_db)
     return trigger_db
 
 
+def create_or_update_trigger_db(trigger):
+    """
+    Create a new TriggerDB model if one doesn't exist yet or update existing
+    one.
+
+    :param trigger: Trigger info.
+    :type trigger: ``dict``
+    """
+    assert isinstance(trigger, dict)
+
+    trigger_api = TriggerAPI(**trigger)
+    trigger_api = TriggerAPI.to_model(trigger_api)
+
+    existing_trigger_db = get_trigger_db(trigger_api)
+
+    if existing_trigger_db:
+        is_update = True
+    else:
+        is_update = False
+
+    if is_update:
+        trigger_api.id = existing_trigger_db.id
+
+    trigger_db = Trigger.add_or_update(trigger_api)
+
+    if is_update:
+        LOG.audit('Trigger updated. Trigger=%s', trigger_db)
+    else:
+        LOG.audit('Trigger created. Trigger=%s', trigger_db)
+
+    return trigger_db
+
+
 def create_trigger_db_from_rule(rule):
     trigger_api = _get_trigger_api_given_rule(rule)
     return create_trigger_db(trigger_api)
@@ -133,8 +177,45 @@ def create_trigger_type_db(trigger_type):
     ref = ResourceReference.to_string_reference(name=trigger_type_api.name,
                                                 pack=trigger_type_api.pack)
     trigger_type_db = get_trigger_type_db(ref)
+
     if not trigger_type_db:
         trigger_type_db = TriggerTypeAPI.to_model(trigger_type_api)
         LOG.debug('verified trigger and formulated TriggerDB=%s', trigger_type_db)
         trigger_type_db = TriggerType.add_or_update(trigger_type_db)
     return trigger_type_db
+
+
+def create_or_update_trigger_type_db(trigger_type):
+    """
+    Create or update a trigger type db object in the db given trigger_type definition as dict.
+
+    :param trigger_type: Trigger type model.
+    :type trigger_type: ``dict``
+
+    :rtype: ``object``
+    """
+    assert isinstance(trigger_type, dict)
+
+    trigger_type_api = TriggerTypeAPI(**trigger_type)
+    trigger_type_api = TriggerTypeAPI.to_model(trigger_type_api)
+
+    ref = ResourceReference.to_string_reference(name=trigger_type_api.name,
+                                                pack=trigger_type_api.pack)
+
+    existing_trigger_type_db = get_trigger_type_db(ref)
+    if existing_trigger_type_db:
+        is_update = True
+    else:
+        is_update = False
+
+    if is_update:
+        trigger_type_api.id = existing_trigger_type_db.id
+
+    trigger_type_db = TriggerType.add_or_update(trigger_type_api)
+
+    if is_update:
+        LOG.audit('TriggerType updated. TriggerType=%s', trigger_type_db)
+    else:
+        LOG.audit('TriggerType created. TriggerType=%s', trigger_type_db)
+
+    return trigger_type_db

st2common/st2common/models/system/action.py

@@ -15,11 +15,57 @@
 
 import unittest2
 
-from st2common.models.system.action import (FabricRemoteAction, FabricRemoteScriptAction)
+from st2common.models.system.action import RemoteAction
+from st2common.models.system.action import RemoteScriptAction
+from st2common.models.system.action import FabricRemoteAction
+from st2common.models.system.action import FabricRemoteScriptAction
 
 
-class FabricRemoteActionsTest(unittest2.TestCase):
+class RemoteActionTestCase(unittest2.TestCase):
+    def test_instantiation(self):
+        action = RemoteAction(name='name', action_exec_id='aeid', command='ls -la',
+                              env_vars={'a': 1}, on_behalf_user='onbehalf', user='user',
+                              hosts=['localhost'], parallel=False, sudo=True, timeout=10)
+        self.assertEqual(action.name, 'name')
+        self.assertEqual(action.action_exec_id, 'aeid')
+        self.assertEqual(action.command, 'ls -la')
+        self.assertEqual(action.env_vars, {'a': 1})
+        self.assertEqual(action.on_behalf_user, 'onbehalf')
+        self.assertEqual(action.user, 'user')
+        self.assertEqual(action.hosts, ['localhost'])
+        self.assertEqual(action.parallel, False)
+        self.assertEqual(action.sudo, True)
+        self.assertEqual(action.timeout, 10)
 
+
+class RemoteScriptActionTestCase(unittest2.TestCase):
+    def test_instantiation(self):
+        action = RemoteScriptAction(name='name', action_exec_id='aeid',
+                                    script_local_path_abs='/tmp/sc/ma_script.sh',
+                                    script_local_libs_path_abs='/tmp/sc/libs', named_args=None,
+                                    positional_args=None, env_vars={'a': 1},
+                                    on_behalf_user='onbehalf', user='user',
+                                    remote_dir='/home/mauser', hosts=['localhost'],
+                                    parallel=False, sudo=True, timeout=10)
+        self.assertEqual(action.name, 'name')
+        self.assertEqual(action.action_exec_id, 'aeid')
+        self.assertEqual(action.script_local_libs_path_abs, '/tmp/sc/libs')
+        self.assertEqual(action.env_vars, {'a': 1})
+        self.assertEqual(action.on_behalf_user, 'onbehalf')
+        self.assertEqual(action.user, 'user')
+        self.assertEqual(action.remote_dir, '/home/mauser')
+        self.assertEqual(action.hosts, ['localhost'])
+        self.assertEqual(action.parallel, False)
+        self.assertEqual(action.sudo, True)
+        self.assertEqual(action.timeout, 10)
+
+        self.assertEqual(action.script_local_dir, '/tmp/sc')
+        self.assertEqual(action.script_name, 'ma_script.sh')
+        self.assertEqual(action.remote_script, '/home/mauser/ma_script.sh')
+        self.assertEqual(action.command, '/home/mauser/ma_script.sh')
+
+
+class FabricRemoteActionTestCase(unittest2.TestCase):
     def test_fabric_remote_action_method(self):
         remote_action = FabricRemoteAction('foo', 'foo-id', 'ls -lrth', on_behalf_user='stan',
                                            parallel=True, sudo=False)

st2common/st2common/services/triggers.py

@@ -63,6 +63,10 @@ def _register_sensor_from_pack(self, pack, sensor):
         trigger_types = metadata.get('trigger_types', [])
         poll_interval = metadata.get('poll_interval', None)
 
+        # Add pack to each trigger type item
+        for trigger_type in trigger_types:
+            trigger_type['pack'] = pack
+
         # Add TrigerType models to the DB
         trigger_type_dbs = container_utils.add_trigger_models(trigger_types=trigger_types)