# 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 oslo_config import cfg
from oslo_messaging.rpc import dispatcher

from heat.common import exception
from heat.common import template_format
from heat.engine import service
from heat.engine import stack
from heat.engine import template as templatem
from heat.objects import stack as stack_object
from heat.tests import common
from heat.tests.engine import tools
from heat.tests import utils


class StackServiceActionsTest(common.HeatTestCase):

    def setUp(self):
        super(StackServiceActionsTest, self).setUp()
        self.ctx = utils.dummy_context()
        self.man = service.EngineService('a-host', 'a-topic')
        self.man.thread_group_mgr = service.ThreadGroupManager()

    def tearDown(self):
        self.man.thread_group_mgr.stopall()
        super(StackServiceActionsTest, self).tearDown()

    @mock.patch.object(stack.Stack, 'load')
    @mock.patch.object(service.ThreadGroupManager, 'start')
    def test_stack_suspend(self, mock_start, mock_load):
        stack_name = 'service_suspend_test_stack'
        t = template_format.parse(tools.wp_template)
        stk = utils.parse_stack(t, stack_name=stack_name)
        s = stack_object.Stack.get_by_id(self.ctx, stk.id)

        mock_load.return_value = stk
        thread = mock.MagicMock()
        mock_link = self.patchobject(thread, 'link')
        mock_start.return_value = thread
        self.patchobject(service, 'NotifyEvent')

        result = self.man.stack_suspend(self.ctx, stk.identifier())
        self.assertIsNone(result)
        mock_load.assert_called_once_with(self.ctx, stack=s)
        mock_link.assert_called_once_with(mock.ANY)
        mock_start.assert_called_once_with(stk.id, stk.suspend,
                                           notify=mock.ANY)

        stk.delete()

    @mock.patch.object(stack.Stack, 'load')
    @mock.patch.object(service.ThreadGroupManager, 'start')
    def test_stack_resume(self, mock_start, mock_load):
        stack_name = 'service_resume_test_stack'
        t = template_format.parse(tools.wp_template)
        stk = utils.parse_stack(t, stack_name=stack_name)

        mock_load.return_value = stk
        thread = mock.MagicMock()
        mock_link = self.patchobject(thread, 'link')
        mock_start.return_value = thread
        self.patchobject(service, 'NotifyEvent')

        result = self.man.stack_resume(self.ctx, stk.identifier())
        self.assertIsNone(result)

        mock_load.assert_called_once_with(self.ctx, stack=mock.ANY)
        mock_link.assert_called_once_with(mock.ANY)
        mock_start.assert_called_once_with(stk.id, stk.resume, notify=mock.ANY)

        stk.delete()

    def test_stack_suspend_nonexist(self):
        stack_name = 'service_suspend_nonexist_test_stack'
        t = template_format.parse(tools.wp_template)
        tmpl = templatem.Template(t)
        stk = stack.Stack(self.ctx, stack_name, tmpl)

        ex = self.assertRaises(dispatcher.ExpectedException,
                               self.man.stack_suspend, self.ctx,
                               stk.identifier())
        self.assertEqual(exception.EntityNotFound, ex.exc_info[0])

    def test_stack_resume_nonexist(self):
        stack_name = 'service_resume_nonexist_test_stack'
        t = template_format.parse(tools.wp_template)
        tmpl = templatem.Template(t)
        stk = stack.Stack(self.ctx, stack_name, tmpl)

        ex = self.assertRaises(dispatcher.ExpectedException,
                               self.man.stack_resume, self.ctx,
                               stk.identifier())
        self.assertEqual(exception.EntityNotFound, ex.exc_info[0])

    def _mock_thread_start(self, stack_id, func, *args, **kwargs):
        func(*args, **kwargs)
        return mock.Mock()

    @mock.patch.object(service.ThreadGroupManager, 'start')
    @mock.patch.object(stack.Stack, 'load')
    def test_stack_check(self, mock_load, mock_start):
        stack_name = 'service_check_test_stack'
        t = template_format.parse(tools.wp_template)
        stk = utils.parse_stack(t, stack_name=stack_name)

        stk.check = mock.Mock()
        self.patchobject(service, 'NotifyEvent')
        mock_load.return_value = stk
        mock_start.side_effect = self._mock_thread_start

        self.man.stack_check(self.ctx, stk.identifier())
        self.assertTrue(stk.check.called)

        stk.delete()

    @mock.patch.object(stack.Stack, 'converge_stack')
    @mock.patch.object(stack.Stack, 'load')
    def test_stack_check_convergence(self, mock_load, mock_converge):
        """Test stack_check uses converge_stack when convergence enabled."""
        cfg.CONF.set_override('convergence_engine', True)
        self.addCleanup(cfg.CONF.clear_override, 'convergence_engine')

        stk = tools.get_stack('service_check_convergence_test_stack',
                              self.ctx, convergence=True)
        stk.store()
        mock_load.return_value = stk

        self.man.stack_check(self.ctx, stk.identifier())

        # Verify thread_group_mgr was set on stack
        self.assertEqual(self.man.thread_group_mgr, stk.thread_group_mgr)
        # Verify converge_stack was called with CHECK action
        mock_converge.assert_called_once_with(template=stk.t, action=stk.CHECK)

        stk.delete()

    @mock.patch.object(stack.Stack, 'converge_stack')
    @mock.patch.object(stack.Stack, 'load')
    def test_stack_suspend_convergence(self, mock_load, mock_converge):
        """Test stack_suspend uses converge_stack when convergence enabled."""
        cfg.CONF.set_override('convergence_engine', True)
        self.addCleanup(cfg.CONF.clear_override, 'convergence_engine')

        stk = tools.get_stack('service_suspend_convergence_test_stack',
                              self.ctx, convergence=True)
        stk.store()
        mock_load.return_value = stk

        self.man.stack_suspend(self.ctx, stk.identifier())

        # Verify thread_group_mgr was set on stack
        self.assertEqual(self.man.thread_group_mgr, stk.thread_group_mgr)
        # Verify converge_stack was called with SUSPEND action
        mock_converge.assert_called_once_with(template=stk.t,
                                              action=stk.SUSPEND)

        stk.delete()

    @mock.patch.object(stack.Stack, 'converge_stack')
    @mock.patch.object(stack.Stack, 'load')
    def test_stack_resume_convergence(self, mock_load, mock_converge):
        """Test stack_resume uses converge_stack when convergence enabled."""
        cfg.CONF.set_override('convergence_engine', True)
        self.addCleanup(cfg.CONF.clear_override, 'convergence_engine')

        stk = tools.get_stack('service_resume_convergence_test_stack',
                              self.ctx, convergence=True)
        stk.store()
        mock_load.return_value = stk

        self.man.stack_resume(self.ctx, stk.identifier())

        # Verify thread_group_mgr was set on stack
        self.assertEqual(self.man.thread_group_mgr, stk.thread_group_mgr)
        # Verify converge_stack was called with RESUME action
        mock_converge.assert_called_once_with(template=stk.t,
                                              action=stk.RESUME)

        stk.delete()


class StackServiceUpdateActionsNotSupportedTest(common.HeatTestCase):

    scenarios = [
        ('suspend_in_progress', dict(action='SUSPEND', status='IN_PROGRESS')),
        ('suspend_complete', dict(action='SUSPEND', status='COMPLETE')),
        ('suspend_failed', dict(action='SUSPEND', status='FAILED')),
        ('delete_in_progress', dict(action='DELETE', status='IN_PROGRESS')),
        ('delete_complete', dict(action='DELETE', status='COMPLETE')),
        ('delete_failed', dict(action='DELETE', status='FAILED')),
    ]

    def setUp(self):
        super(StackServiceUpdateActionsNotSupportedTest, self).setUp()
        self.ctx = utils.dummy_context()
        self.man = service.EngineService('a-host', 'a-topic')

    @mock.patch.object(stack.Stack, 'load')
    def test_stack_update_actions_not_supported(self, mock_load):
        stack_name = '%s-%s' % (self.action, self.status)
        t = template_format.parse(tools.wp_template)
        old_stack = utils.parse_stack(t, stack_name=stack_name)

        old_stack.action = self.action
        old_stack.status = self.status

        sid = old_stack.store()
        s = stack_object.Stack.get_by_id(self.ctx, sid)

        mock_load.return_value = old_stack

        params = {'foo': 'bar'}
        template = '{ "Resources": {} }'
        ex = self.assertRaises(dispatcher.ExpectedException,
                               self.man.update_stack,
                               self.ctx, old_stack.identifier(), template,
                               params, None, {})
        self.assertEqual(exception.NotSupported, ex.exc_info[0])
        mock_load.assert_called_once_with(self.ctx, stack=s,
                                          check_refresh_cred=True)

        old_stack.delete()
