summaryrefslogtreecommitdiff
path: root/heat/tests/test_stack_lock.py
blob: 94bfc94ce5795ef5c0423224c54e17f8abd76ea3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
#
#    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.

import mock
from oslo import messaging

from heat.common import exception
from heat.db import api as db_api
from heat.engine import stack_lock
from heat.tests.common import HeatTestCase
from heat.tests import utils


class StackLockTest(HeatTestCase):
    def setUp(self):
        super(StackLockTest, self).setUp()
        self.context = utils.dummy_context()
        self.stack = self.m.CreateMockAnything()
        self.stack.id = "aae01f2d-52ae-47ac-8a0d-3fde3d220fea"
        self.stack.name = "test_stack"
        self.stack.action = "CREATE"
        self.engine_id = stack_lock.StackLock.generate_engine_id()

    class TestThreadLockException(Exception):
            pass

    def test_successful_acquire_new_lock(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn(None)

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        slock.acquire()
        self.m.VerifyAll()

    def test_failed_acquire_existing_lock_current_engine(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn(self.engine_id)

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.assertRaises(exception.ActionInProgress, slock.acquire)
        self.m.VerifyAll()

    def test_successful_acquire_existing_lock_engine_dead(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        self.m.StubOutWithMock(db_api, "stack_lock_steal")
        db_api.stack_lock_steal(self.stack.id, "fake-engine-id",
                                self.engine_id).AndReturn(None)

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.patchobject(slock, 'engine_alive', return_value=False)
        slock.acquire()
        self.m.VerifyAll()

    def test_failed_acquire_existing_lock_engine_alive(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.patchobject(slock, 'engine_alive', return_value=True)
        self.assertRaises(exception.ActionInProgress, slock.acquire)
        self.m.VerifyAll()

    def test_failed_acquire_existing_lock_engine_dead(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        self.m.StubOutWithMock(db_api, "stack_lock_steal")
        db_api.stack_lock_steal(
            self.stack.id, "fake-engine-id",
            self.engine_id).AndReturn("fake-engine-id2")

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.patchobject(slock, 'engine_alive', return_value=False)
        self.assertRaises(exception.ActionInProgress, slock.acquire)
        self.m.VerifyAll()

    def test_successful_acquire_with_retry(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        self.m.StubOutWithMock(db_api, "stack_lock_steal")
        db_api.stack_lock_steal(
            self.stack.id, "fake-engine-id", self.engine_id).AndReturn(True)

        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        db_api.stack_lock_steal(
            self.stack.id, "fake-engine-id", self.engine_id).AndReturn(None)

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.patchobject(slock, 'engine_alive', return_value=False)
        slock.acquire()
        self.m.VerifyAll()

    def test_failed_acquire_one_retry_only(self):
        self.m.StubOutWithMock(db_api, "stack_lock_create")
        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        self.m.StubOutWithMock(db_api, "stack_lock_steal")
        db_api.stack_lock_steal(
            self.stack.id, "fake-engine-id", self.engine_id).AndReturn(True)

        db_api.stack_lock_create(
            self.stack.id, self.engine_id).AndReturn("fake-engine-id")

        db_api.stack_lock_steal(
            self.stack.id, "fake-engine-id", self.engine_id).AndReturn(True)

        self.m.ReplayAll()

        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        self.patchobject(slock, 'engine_alive', return_value=False)
        self.assertRaises(exception.ActionInProgress, slock.acquire)
        self.m.VerifyAll()

    def test_thread_lock_context_mgr_exception(self):
        db_api.stack_lock_create = mock.Mock(return_value=None)
        db_api.stack_lock_release = mock.Mock(return_value=None)
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)

        def check_thread_lock():
            with slock.thread_lock(self.stack.id):
                self.assertEqual(1, db_api.stack_lock_create.call_count)
                raise self.TestThreadLockException
        self.assertRaises(self.TestThreadLockException, check_thread_lock)
        self.assertEqual(1, db_api.stack_lock_release.call_count)

    def test_thread_lock_context_mgr_no_exception(self):
        db_api.stack_lock_create = mock.Mock(return_value=None)
        db_api.stack_lock_release = mock.Mock(return_value=None)
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        with slock.thread_lock(self.stack.id):
            self.assertEqual(1, db_api.stack_lock_create.call_count)
        assert not db_api.stack_lock_release.called

    def test_try_thread_lock_context_mgr_exception(self):
        db_api.stack_lock_create = mock.Mock(return_value=None)
        db_api.stack_lock_release = mock.Mock(return_value=None)
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)

        def check_thread_lock():
            with slock.try_thread_lock(self.stack.id):
                self.assertEqual(1, db_api.stack_lock_create.call_count)
                raise self.TestThreadLockException
        self.assertRaises(self.TestThreadLockException, check_thread_lock)
        self.assertEqual(1, db_api.stack_lock_release.call_count)

    def test_try_thread_lock_context_mgr_no_exception(self):
        db_api.stack_lock_create = mock.Mock(return_value=None)
        db_api.stack_lock_release = mock.Mock(return_value=None)
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        with slock.try_thread_lock(self.stack.id):
            self.assertEqual(1, db_api.stack_lock_create.call_count)
        assert not db_api.stack_lock_release.called

    def test_try_thread_lock_context_mgr_existing_lock(self):
        db_api.stack_lock_create = mock.Mock(return_value=1234)
        db_api.stack_lock_release = mock.Mock(return_value=None)
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)

        def check_thread_lock():
            with slock.try_thread_lock(self.stack.id):
                self.assertEqual(1, db_api.stack_lock_create.call_count)
                raise self.TestThreadLockException
        self.assertRaises(self.TestThreadLockException, check_thread_lock)
        assert not db_api.stack_lock_release.called

    def test_engine_alive_ok(self):
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        mget_client = self.patchobject(stack_lock.rpc_messaging,
                                       'get_rpc_client')
        mclient = mget_client.return_value
        mclient_ctx = mclient.prepare.return_value
        mclient_ctx.call.return_value = True
        ret = slock.engine_alive(self.context, self.engine_id)
        self.assertTrue(ret)
        mclient.prepare.assert_called_once_with(timeout=2)
        mclient_ctx.call.assert_called_once_with(self.context, 'listening')

    def test_engine_alive_timeout(self):
        slock = stack_lock.StackLock(self.context, self.stack, self.engine_id)
        mget_client = self.patchobject(stack_lock.rpc_messaging,
                                       'get_rpc_client')
        mclient = mget_client.return_value
        mclient_ctx = mclient.prepare.return_value
        mclient_ctx.call.side_effect = messaging.MessagingTimeout('too slow')
        ret = slock.engine_alive(self.context, self.engine_id)
        self.assertIs(False, ret)
        mclient.prepare.assert_called_once_with(timeout=2)
        mclient_ctx.call.assert_called_once_with(self.context, 'listening')