6d35be11ec
This patch is implementing skipping automatically actions based on the result of action pre_condition method. This will allow to manage properly situations as migration actions for vms which does not longer exist. This patch includes: - Adding a new state SKIPPED to the Action objects. - Add a new Exception ActionSkipped. An action which raises it from the pre_condition execution is moved to SKIPPED state. - pre_condition will not be executed for any action in SKIPPED state. - execute will not be executed for any action in SKIPPED or FAILED state. - post_condition will not be executed for any action in SKIPPED state. - moving transition to ONGOING from pre_condition to execute. That means that actions raising ActionSkipped will move from PENDING to SKIPPED while actions raising any other Exception will move from PENDING to FAILED. - Adding information on action failed or skipped state to the `status_message` field. - Adding a new option to the testing action nop to simulate skipping on pre_condition, so that we can easily test it. Implements: blueprint add-skip-actions Assisted-By: Cursor (claude-4-sonnet) Change-Id: I59cb4c7006c7c3bcc5ff2071886d3e2929800f9e Signed-off-by: Alfredo Moralejo <amoralej@redhat.com>
222 lines
9.9 KiB
Python
222 lines
9.9 KiB
Python
# Copyright (c) 2015 b<>com
|
|
#
|
|
# Authors: Jean-Emile DARTOIS <jean-emile.dartois@b-com.com>
|
|
#
|
|
# Licensed 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.
|
|
|
|
from unittest import mock
|
|
|
|
from watcher.applier.action_plan import default
|
|
from watcher.applier import default as ap_applier
|
|
from watcher.common import exception
|
|
from watcher.common import utils
|
|
from watcher import notifications
|
|
from watcher import objects
|
|
from watcher.objects import action_plan as ap_objects
|
|
from watcher.tests.db import base
|
|
from watcher.tests.objects import utils as obj_utils
|
|
|
|
|
|
class TestDefaultActionPlanHandler(base.DbTestCase):
|
|
|
|
class FakeApplierException(Exception):
|
|
pass
|
|
|
|
def setUp(self):
|
|
super(TestDefaultActionPlanHandler, self).setUp()
|
|
|
|
p_action_plan_notifications = mock.patch.object(
|
|
notifications, 'action_plan', autospec=True)
|
|
self.m_action_plan_notifications = p_action_plan_notifications.start()
|
|
self.addCleanup(p_action_plan_notifications.stop)
|
|
|
|
obj_utils.create_test_goal(self.context)
|
|
self.strategy = obj_utils.create_test_strategy(self.context)
|
|
self.audit = obj_utils.create_test_audit(
|
|
self.context, strategy_id=self.strategy.id)
|
|
self.action_plan = obj_utils.create_test_action_plan(
|
|
self.context, audit_id=self.audit.id,
|
|
strategy_id=self.strategy.id)
|
|
self.action = obj_utils.create_test_action(
|
|
self.context, action_plan_id=self.action_plan.id,
|
|
action_type='nop',
|
|
input_parameters={'message': 'hello World'})
|
|
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_launch_action_plan(self, m_get_action_plan):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
|
|
expected_calls = [
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.START),
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.END)]
|
|
|
|
self.assertEqual(ap_objects.State.SUCCEEDED, self.action_plan.state)
|
|
|
|
self.assertEqual(
|
|
expected_calls,
|
|
self.m_action_plan_notifications
|
|
.send_action_notification
|
|
.call_args_list)
|
|
|
|
@mock.patch.object(ap_applier.DefaultApplier, "execute")
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_launch_action_plan_with_error(self, m_get_action_plan, m_execute):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
m_execute.side_effect = self.FakeApplierException
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
|
|
expected_calls = [
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.START),
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
priority=objects.fields.NotificationPriority.ERROR,
|
|
phase=objects.fields.NotificationPhase.ERROR)]
|
|
|
|
self.assertEqual(ap_objects.State.FAILED, self.action_plan.state)
|
|
|
|
self.assertEqual(
|
|
expected_calls,
|
|
self.m_action_plan_notifications
|
|
.send_action_notification
|
|
.call_args_list)
|
|
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_cancel_action_plan(self, m_get_action_plan):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
self.action_plan.state = ap_objects.State.CANCELLED
|
|
self.action_plan.save()
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
action = self.action.get_by_uuid(self.context, self.action.uuid)
|
|
self.assertEqual(ap_objects.State.CANCELLED, self.action_plan.state)
|
|
self.assertEqual(objects.action.State.CANCELLED, action.state)
|
|
|
|
@mock.patch.object(ap_applier.DefaultApplier, "execute")
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_cancel_action_plan_with_exception(self, m_get_action_plan,
|
|
m_execute):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
m_execute.side_effect = exception.ActionPlanCancelled(
|
|
self.action_plan.uuid)
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
self.assertEqual(ap_objects.State.CANCELLED, self.action_plan.state)
|
|
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
@mock.patch.object(objects.Action, "list")
|
|
def test_launch_action_plan_failed_actions(self, m_action_list,
|
|
m_get_action_plan):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
failed_action = self.action
|
|
failed_action.state = objects.action.State.FAILED
|
|
m_action_list.return_value = [failed_action]
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
expected_calls = [
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.START),
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
priority=objects.fields.NotificationPriority.ERROR,
|
|
phase=objects.fields.NotificationPhase.ERROR)]
|
|
|
|
self.assertEqual(ap_objects.State.FAILED, self.action_plan.state)
|
|
self.assertEqual(
|
|
expected_calls,
|
|
self.m_action_plan_notifications
|
|
.send_action_notification
|
|
.call_args_list)
|
|
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_launch_action_plan_skipped_actions(self,
|
|
m_get_action_plan):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
skipped_action = obj_utils.create_test_action(
|
|
self.context, action_plan_id=self.action_plan.id,
|
|
action_type='nop',
|
|
uuid=utils.generate_uuid(),
|
|
input_parameters={'message': 'hello World',
|
|
'skip_pre_condition': True})
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
expected_calls = [
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.START),
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.END)
|
|
]
|
|
|
|
self.assertEqual(
|
|
self.action.get_by_uuid(self.context, skipped_action.uuid).state,
|
|
objects.action.State.SKIPPED)
|
|
self.assertEqual(ap_objects.State.SUCCEEDED, self.action_plan.state)
|
|
self.assertEqual(self.action_plan.status_message,
|
|
"One or more actions were skipped.")
|
|
self.assertEqual(
|
|
expected_calls,
|
|
self.m_action_plan_notifications
|
|
.send_action_notification
|
|
.call_args_list)
|
|
|
|
@mock.patch.object(objects.ActionPlan, "get_by_uuid")
|
|
def test_launch_action_plan_manual_skipped_actions(self,
|
|
m_get_action_plan):
|
|
m_get_action_plan.return_value = self.action_plan
|
|
skipped_action = obj_utils.create_test_action(
|
|
self.context, action_plan_id=self.action_plan.id,
|
|
action_type='nop',
|
|
uuid=utils.generate_uuid(),
|
|
state=objects.action.State.SKIPPED,
|
|
input_parameters={'message': 'hello World'})
|
|
command = default.DefaultActionPlanHandler(
|
|
self.context, mock.MagicMock(), self.action_plan.uuid)
|
|
command.execute()
|
|
expected_calls = [
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.START),
|
|
mock.call(self.context, self.action_plan,
|
|
action=objects.fields.NotificationAction.EXECUTION,
|
|
phase=objects.fields.NotificationPhase.END)
|
|
]
|
|
self.assertEqual(
|
|
self.action.get_by_uuid(self.context, skipped_action.uuid).state,
|
|
objects.action.State.SKIPPED)
|
|
self.assertEqual(ap_objects.State.SUCCEEDED, self.action_plan.state)
|
|
self.assertEqual(self.action_plan.status_message,
|
|
"One or more actions were skipped.")
|
|
self.assertEqual(
|
|
expected_calls,
|
|
self.m_action_plan_notifications
|
|
.send_action_notification
|
|
.call_args_list)
|