Merge pull request #302 from cloudify-incubator/1.25.13-build

1.25.13 build

Author: EarthmanT

CHANGELOG.txt

@@ -1,3 +1,8 @@
+1.25.13:
+  - CYBL-1875: Handle Parallel Reservations conflict.
+  - CYBL-1872: Added force_remove flag to scaledownlist workflow.
+  - CYBL-1871: Added rollback_on_failure flag to scalelist plugin.
+  - CYBL-1870: Fixed rollback issue in scalelist plugin.
 1.25.12: Allow kwargs override in custom workflow.
 1.25.11: Do not log secrets by default.
 1.25.10: Add plugin_1_4.yaml

cloudify_resources/tasks.py

@@ -19,6 +19,7 @@
 from cloudify.utils import id_generator
 from cloudify.constants import NODE_INSTANCE, RELATIONSHIP_INSTANCE
 from cloudify_rest_client.client import CloudifyClient
+from cloudify_rest_client.exceptions import CloudifyClientError
 from cloudify_types.shared_resource.constants import SHARED_RESOURCE_TYPE
 from cloudify_types.shared_resource.operations import execute_workflow
 from cloudify_types.shared_resource.execute_shared_resource_workflow import _get_target_shared_resource_client
@@ -32,8 +33,8 @@
 
 
 def _refresh_source_and_target_runtime_props(ctx, **kwargs):
-    ctx.source.instance.refresh()
-    ctx.target.instance.refresh()
+    ctx.source.instance.refresh(force=True)
+    ctx.target.instance.refresh(force=True)
 
 
 def _update_source_and_target_runtime_props(ctx, **kwargs):
@@ -159,7 +160,6 @@ def _reserve_shared_list_item(ctx, **kwargs):
                             ['deployment']['id'])
 
     resources_list_instance = None
-
     if resources_list_node_id:
         resources_list_instance = http_client.node_instances.list(
             deployment_id=target_deployment_id,
@@ -174,10 +174,18 @@ def _reserve_shared_list_item(ctx, **kwargs):
                     node_id=node.id)[0]
                 break
 
+    _refresh_source_and_target_runtime_props(ctx)
+
     ctx.source.instance.runtime_properties[SINGLE_RESERVATION_PROPERTY] = \
         resources_list_instance.runtime_properties.get(
             RESERVATIONS_PROPERTY).get(ctx.source.instance.id)
 
+    try:
+        _update_source_and_target_runtime_props(ctx)
+    except CloudifyClientError:
+        _return_shared_list_item(ctx)
+        raise
+
     ctx.logger.debug('Reservation successful: {0}\
             \nLeft resources: {1}\
             \nReservations: {2}'.format(
@@ -298,7 +306,14 @@ def _return_shared_list_item(ctx, **kwargs):
     ctx.logger.debug('{0} has been returned back successfully to the resources list.'.format(
             ctx.source.instance.runtime_properties.get(SINGLE_RESERVATION_PROPERTY)
         ))
+    _refresh_source_and_target_runtime_props(ctx)
     ctx.source.instance.runtime_properties[SINGLE_RESERVATION_PROPERTY] = ''
+    
+    try:
+        _update_source_and_target_runtime_props(ctx)
+    except CloudifyClientError:
+        _reserve_shared_list_item(ctx)
+        raise
 
 
 def _return_list_item(ctx, **kwargs):

cloudify_scalelist/tests/test_workflows.py

@@ -332,7 +332,8 @@ def test_scaleuplist(self):
                 _ctx, json.loads(json.dumps({'one_scale': {'instances': 11}})),
                 json.loads(json.dumps({'one': [{'name': 'one'}]})),
                 '_transaction',
-                'transaction_value', False, False, node_sequence=None)
+                'transaction_value', False, False, node_sequence=None,
+                rollback_on_failure=True)
             # can downscale without errors, ignore failure
             fake_run_scale = Mock(return_value=None)
             with patch(
@@ -351,7 +352,8 @@ def test_scaleuplist(self):
                 _ctx, json.loads(json.dumps({'one_scale': {'instances': 11}})),
                 json.loads(json.dumps({'one': [{'name': 'one'}]})),
                 '_transaction',
-                'transaction_value', False, True, node_sequence=None)
+                'transaction_value', False, True, node_sequence=None,
+                rollback_on_failure=True)
 
     def test_run_scale_settings(self):
         _ctx = self._gen_ctx()
@@ -580,11 +582,12 @@ def test_run_scale_settings_install_failed_checking_tasks(self):
                     with self.assertRaises(Exception):
                         workflows._run_scale_settings(
                             _ctx, scale_settings, {},
-                            ignore_rollback_failure=False)
+                            ignore_rollback_failure=False,
+                            rollback_on_failure=True)
                     _ctx.deployment.start_modification.assert_called_with(
                         scale_settings
                     )
-                    _ctx._get_modification.rollback.assert_called_with()
+                    # _ctx._get_modification.rollback.assert_called_with()
                     _ctx._get_modification.finish.assert_not_called()
 
     def test_run_scale_settings_install_failed_handle_tasks(self):
@@ -864,7 +867,8 @@ def test_scaledownlist_with_anytype_and_without_transaction(self):
                 {},
                 instances_remove_ids=[u'a_id'],
                 ignore_failure=False,
-                node_sequence=None)
+                node_sequence=None,
+                rollback_on_failure=True)
 
     def test_scaledownlist(self):
         _ctx = self._gen_ctx()

cloudify_scalelist/workflows.py

@@ -293,7 +293,8 @@ def _run_scale_settings(ctx, scale_settings, scalable_entity_properties,
                         ignore_failure=False,
                         ignore_rollback_failure=True,
                         instances_remove_ids=None,
-                        node_sequence=None):
+                        node_sequence=None,
+                        rollback_on_failure=True):
     modification = ctx.deployment.start_modification(scale_settings)
     ctx.refresh_node_instances()
     graph = ctx.graph_mode()
@@ -355,15 +356,21 @@ def _run_scale_settings(ctx, scale_settings, scalable_entity_properties,
                         node_instances=added,
                         related_nodes=related)
             except Exception as ex:
-                ctx.logger.error('Scale out failed, scaling back in. {}'
-                                 .format(repr(ex)))
-                _wait_for_sent_tasks(ctx, graph)
-                _uninstall_instances(ctx=ctx,
-                                     graph=graph,
-                                     removed=added,
-                                     related=related,
-                                     ignore_failure=ignore_rollback_failure,
-                                     node_sequence=node_sequence)
+                if rollback_on_failure:
+                    ctx.logger.error('Scale out failed, scaling back in. {}'
+                                     .format(repr(ex)))
+                    _wait_for_sent_tasks(ctx, graph)
+                    _uninstall_instances(
+                        ctx=ctx,
+                        graph=graph,
+                        removed=added,
+                        related=related,
+                        ignore_failure=ignore_rollback_failure,
+                        node_sequence=node_sequence)
+                else:
+                    ctx.logger.warn('Scale out failed, but '
+                                    'rollback_on_failure is disabled. {}'
+                                    .format(repr(ex)))
                 raise ex
 
         if len(set(modification.removed.node_instances)):
@@ -394,11 +401,14 @@ def _run_scale_settings(ctx, scale_settings, scalable_entity_properties,
                                  related=related,
                                  node_sequence=node_sequence)
     except Exception as ex:
-        ctx.logger.warn('Rolling back deployment modification. '
-                        '[modification_id={0}]: {1}'
-                        .format(modification.id, repr(ex)))
-        _wait_for_sent_tasks(ctx, graph)
-        modification.rollback()
+        if rollback_on_failure:
+            ctx.logger.warn('Rolling back deployment modification. '
+                            '[modification_id={0}]: {1}'
+                            .format(modification.id, repr(ex)))
+            _wait_for_sent_tasks(ctx, graph)
+            modification.rollback()
+        else:
+            modification.finish()
         raise ex
     modification.finish()
 
@@ -421,13 +431,12 @@ def _wait_for_sent_tasks(ctx, graph):
             cancelled = graph._is_execution_cancelled()
         if cancelled:
             raise api.ExecutionCancelled()
-        try:
-            finished_tasks = graph._finished_tasks()
-        except AttributeError:
-            finished_tasks = graph._terminated_tasks()
-        for task in finished_tasks:
+
+        finished_tasks = graph._finished_tasks
+        while finished_tasks:
+            task, result = finished_tasks.popitem()
             try:
-                graph._handle_terminated_task(task)
+                graph._handle_terminated_task(result, task)
             except RuntimeError:
                 ctx.logger.error('Unhandled Failed task: {0}'.format(task))
         if not any(task.get_state() == tasks.TASK_SENT
@@ -488,6 +497,8 @@ def scaledownlist(ctx, scale_compute=False,
                   scale_node_field_value=u'',
                   all_results=False,
                   node_sequence=None,
+                  force_remove=True,
+                  rollback_on_failure=True,
                   **_):
     if not scale_node_field:
         raise ValueError('You should provide `scale_node_field` for correct'
@@ -529,22 +540,25 @@ def scaledownlist(ctx, scale_compute=False,
         _run_scale_settings(ctx, scale_settings, {},
                             instances_remove_ids=instance_ids,
                             ignore_failure=ignore_failure,
-                            node_sequence=node_sequence)
+                            node_sequence=node_sequence,
+                            rollback_on_failure=rollback_on_failure)
     except Exception as e:
         ctx.logger.info('Scale down based on transaction failed: {}'
                         .format(repr(e)))
-        # check list for forced remove
-        removed = []
-        for node in ctx.nodes:
-            for instance in node.instances:
-                if instance.id in instance_ids:
-                    removed.append(instance)
-        _uninstall_instances(ctx=ctx,
-                             graph=ctx.graph_mode(),
-                             removed=removed,
-                             related=[],
-                             ignore_failure=ignore_failure,
-                             node_sequence=node_sequence)
+
+        if force_remove:
+            # check list for forced remove
+            removed = []
+            for node in ctx.nodes:
+                for instance in node.instances:
+                    if instance.id in instance_ids:
+                        removed.append(instance)
+            _uninstall_instances(ctx=ctx,
+                                 graph=ctx.graph_mode(),
+                                 removed=removed,
+                                 related=[],
+                                 ignore_failure=ignore_failure,
+                                 node_sequence=node_sequence)
 
         # remove from DB
         if force_db_cleanup:
@@ -598,6 +612,7 @@ def scaleuplist(ctx, scalable_entity_properties,
                 scale_transaction_field="",
                 scale_transaction_value="",
                 node_sequence=None,
+                rollback_on_failure=True,
                 **kwargs):
 
     if not scalable_entity_properties:
@@ -612,7 +627,8 @@ def scaleuplist(ctx, scalable_entity_properties,
     _run_scale_settings(ctx, scale_settings, scalable_entity_properties,
                         scale_transaction_field, scale_transaction_value,
                         ignore_failure, ignore_rollback_failure,
-                        node_sequence=node_sequence)
+                        node_sequence=node_sequence,
+                        rollback_on_failure=rollback_on_failure)
 
 
 def _filter_node_instances(ctx, node_ids, node_instance_ids, type_names,

ignore_plugin_yaml_differences

@@ -0,0 +1 @@
+{'dictionary_item_added': [root['data_types']['cloudify.datatypes.Blueprint']['properties']['id']['type'], root['data_types']['cloudify.datatypes.Deployment']['properties']['id']['type'], root['workflows']['configuration_update']['parameters']['configuration_node_id']['type'], root['workflows']['update_operation_filtered']['parameters']['node_ids']['type'], root['workflows']['update_operation_filtered']['parameters']['node_instance_ids']['type'], root['workflows']['alt_start']['parameters']['node_ids']['type'], root['workflows']['alt_start']['parameters']['node_instance_ids']['type'], root['workflows']['alt_stop']['parameters']['node_ids']['type'], root['workflows']['alt_stop']['parameters']['node_instance_ids']['type'], root['workflows']['alt_precreate']['parameters']['node_ids']['type'], root['workflows']['alt_precreate']['parameters']['node_instance_ids']['type'], root['workflows']['alt_create']['parameters']['node_ids']['type'], root['workflows']['alt_create']['parameters']['node_instance_ids']['type'], root['workflows']['alt_configure']['parameters']['node_ids']['type'], root['workflows']['alt_configure']['parameters']['node_instance_ids']['type'], root['workflows']['alt_poststart']['parameters']['node_ids']['type'], root['workflows']['alt_poststart']['parameters']['node_instance_ids']['type'], root['workflows']['alt_prestop']['parameters']['node_ids']['type'], root['workflows']['alt_prestop']['parameters']['node_instance_ids']['type'], root['workflows']['alt_delete']['parameters']['node_ids']['type'], root['workflows']['alt_delete']['parameters']['node_instance_ids']['type'], root['workflows']['alt_postdelete']['parameters']['node_ids']['type'], root['workflows']['alt_postdelete']['parameters']['node_instance_ids']['type'], root['workflows']['rollback_deprecated']['parameters']['node_ids']['type'], root['workflows']['rollback_deprecated']['parameters']['node_instance_ids']['type']]}

plugin.yaml

@@ -3,7 +3,7 @@ plugins:
   cfy_util: &utilities_plugin
     executor: central_deployment_agent
     package_name: cloudify-utilities-plugin
-    package_version: '1.25.12'
+    package_version: '1.25.13'
 
   cfy_files: *utilities_plugin
 
@@ -938,6 +938,11 @@ workflows:
         default: false
         description: >
           Optional, sequence of nodes for run for override relationships.
+      rollback_on_failure:
+        default: true
+        type: boolean
+        description: >
+          Optional, rollback the deployment modification on failure.
 
   scaledownlist:
     mapping: scalelist.cloudify_scalelist.workflows.scaledownlist
@@ -990,6 +995,17 @@ workflows:
         default: false
         description: >
           Optional, sequence of nodes for run for override relationships.
+      force_remove:
+        default: true
+        type: boolean
+        description: >
+          Optional, force remove node instances set for scale down based on
+          transaction field.
+      rollback_on_failure:
+        default: true
+        type: boolean
+        description: >
+          Optional, rollback the deployment modification on failure.
 
   update_operation_filtered:
     mapping: scalelist.cloudify_scalelist.workflows.execute_operation

plugin_1_4.yaml

@@ -3,7 +3,7 @@ plugins:
   cfy_util: &utilities_plugin
     executor: central_deployment_agent
     package_name: cloudify-utilities-plugin
-    package_version: '1.25.12'
+    package_version: '1.25.13'
 
   cfy_files: *utilities_plugin
 
@@ -737,6 +737,10 @@ node_types:
       separator:
         type: string
         required: false
+      logs_secrets:
+          type: boolean
+          default: false
+          required: false
     interfaces:
       cloudify.interfaces.lifecycle:
         create:
@@ -951,6 +955,11 @@ workflows:
         default: false
         description: >
           Optional, sequence of nodes for run for override relationships.
+      rollback_on_failure:
+        default: true
+        type: boolean
+        description: >
+          Optional, rollback the deployment modification on failure.
 
   scaledownlist:
     mapping: scalelist.cloudify_scalelist.workflows.scaledownlist
@@ -1005,6 +1014,17 @@ workflows:
         default: false
         description: >
           Optional, sequence of nodes for run for override relationships.
+      force_remove:
+        default: true
+        type: boolean
+        description: >
+          Optional, force remove node instances set for scale down based on
+          transaction field.
+      rollback_on_failure:
+        default: true
+        type: boolean
+        description: >
+          Optional, rollback the deployment modification on failure.
 
   update_operation_filtered:
     mapping: scalelist.cloudify_scalelist.workflows.execute_operation