~sseman/juju-ci-tools/model-change-watcher-py3-2

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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
from collections import namedtuple
from datetime import (
    datetime,
    timedelta,
)
from mock import (
    Mock,
    patch,
)

import pytz

from tests import TestCase
from winazurearm import (
    ARMClient,
    DEFAULT_RESOURCE_PREFIX,
    delete_instance,
    delete_resources,
    find_vm_instance,
    list_resources,
    main,
    OLD_MACHINE_AGE,
    ResourceGroupDetails,
)


AZURE_ENVIRON = {
    'AZURE_SUBSCRIPTION_ID': 'subscription_id',
    'AZURE_CLIENT_ID': 'client_id',
    'AZURE_SECRET': 'secret',
    'AZURE_TENANT': 'tenant',
}

# The azure unit test use namedtuples like these to avoid tight
# coupling between services. When Azure ARM is stable, we might want
# to use the real objects.
ResourceGroup = namedtuple('ResourceGroup', ['name'])
StorageAccount = namedtuple('StorageAccount', ['name', 'creation_time'])
VirtualMachine = namedtuple('VirtualMachine', ['name', 'vm_id'])
Network = namedtuple('Network', ['name'])
Address = namedtuple('Address', ['name', 'ip_address'])


class FakePoller:

    def __init__(self, result_data=None):
        self.is_done = False
        self.result_data = result_data

    def done(self):
        return self.is_done

    def result(self):
        if self.is_done:
            raise Exception('It is an error to call result after done.')
        self.is_done = True
        return self.result_data


def fake_init_services(client):
    """Repurpose the lazy init to install mocks."""
    # client.resource.resource_groups.list()
    client.resource = Mock(resource_groups=Mock(
        list=Mock(return_value=[]),
        delete=Mock(return_value=None)))
    # client.storage.storage_accounts.list_by_resource_group()
    client.storage = Mock(
        storage_accounts=Mock(list_by_resource_group=Mock(return_value=[])))
    # client.compute.virtual_machines.list()
    client.compute = Mock(virtual_machines=Mock(
        list=Mock(return_value=[]),
        delete=Mock(return_value=None)))
    # client.network.public_ip_addresses.list()
    # client.network.virtual_networks.list()
    client.network = Mock(
        public_ip_addresses=Mock(list=Mock(return_value=[])),
        virtual_networks=Mock(list=Mock(return_value=[])))


@patch('winazurearm.ARMClient.init_services',
       autospec=True, side_effect=fake_init_services)
class WinAzureARMTestCase(TestCase):

    test_environ = AZURE_ENVIRON

    def test_main_list_resources(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.list_resources', autospec=True) as lr_mock:
            code = main(['winazurearm.py', 'list-resources', 'juju-deploy*'])
        self.assertEqual(0, code)
        self.assertEqual(1, is_mock.call_count)
        lr_mock.assert_called_once_with(
            client, glob='juju-deploy*', print_out=True, recursive=False)

    def test_main_delete_resources(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.delete_resources', autospec=True) as dr_mock:
            code = main(['winazurearm.py', 'delete-resources', 'juju-deploy*'])
        self.assertEqual(0, code)
        self.assertEqual(1, is_mock.call_count)
        dr_mock.assert_called_once_with(
            client, glob='juju-deploy*', old_age=OLD_MACHINE_AGE)

    def test_main_delete_resources_old_age(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.delete_resources', autospec=True) as dr_mock:
            code = main(['winazurearm.py', 'delete-resources',
                         '-o', '2', 'juju-deploy*'])
        self.assertEqual(0, code)
        self.assertEqual(1, is_mock.call_count)
        dr_mock.assert_called_once_with(
            client, glob='juju-deploy*', old_age=2)

    def test_main_delete_instance_instance_id(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.delete_instance', autospec=True) as di_mock:
            code = main(['winazurearm.py', 'delete-instance', 'instance-id'])
        self.assertEqual(0, code)
        self.assertEqual(1, is_mock.call_count)
        di_mock.assert_called_once_with(
            client, 'instance-id', resource_group=None)

    def test_main_delete_instance_not_found(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.delete_instance', autospec=True,
                   side_effect=ValueError) as di_mock:
            code = main(['winazurearm.py', 'delete-instance', 'instance-id'])
        self.assertEqual(1, code)
        self.assertEqual(1, is_mock.call_count)
        di_mock.assert_called_once_with(
            client, 'instance-id', resource_group=None)

    def test_main_delete_instance_name_group(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        with patch('winazurearm.delete_instance', autospec=True) as di_mock:
            code = main(['winazurearm.py', 'delete-instance', 'name', 'group'])
        self.assertEqual(0, code)
        self.assertEqual(1, is_mock.call_count)
        di_mock.assert_called_once_with(client, 'name', resource_group='group')

    def test_list_resources(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        groups = [ResourceGroup('juju-foo-0'), ResourceGroup('juju-bar-1')]
        client.resource.resource_groups.list.return_value = groups
        result = list_resources(client, 'juju-bar*')
        rgd = ResourceGroupDetails(client, groups[-1])
        self.assertEqual([rgd], result)
        client.resource.resource_groups.list.assert_called_once_with()

    def test_list_resources_ignore_default(self, is_mock):
        # Default resources are created by Azure. They should only be
        # seen via the UI. A glob for everything will still ignore defaults.
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        groups = [ResourceGroup('{}-network'.format(DEFAULT_RESOURCE_PREFIX))]
        client.resource.resource_groups.list.return_value = groups
        result = list_resources(client, '*')
        self.assertEqual([], result)

    def test_list_resources_recursive(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        # For the call to find many groups.
        a_group = ResourceGroup('juju-bar-1')
        b_group = ResourceGroup('juju-foo-0')
        client.resource.resource_groups.list.return_value = [a_group, b_group]
        # For the call to load a ResourceGroupDetails instance.
        storage_account = StorageAccount('abcd-12', datetime.now(tz=pytz.UTC))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        virtual_machine = VirtualMachine('admin-machine-0', 'bcde-1234')
        client.compute.virtual_machines.list.return_value = [virtual_machine]
        address = Address('machine-0-public-ip', '1.2.3.4')
        client.network.public_ip_addresses.list.return_value = [address]
        network = Network('juju-bar-network-1')
        client.network.virtual_networks.list.return_value = [network]
        # The addition of recursive=True will get the details of the
        # subordinate resources and set is_loaded to True.
        result = list_resources(client, 'juju-bar*', recursive=True)
        rgd = ResourceGroupDetails(
            client, a_group, storage_accounts=[storage_account],
            vms=[virtual_machine], addresses=[address], networks=[network])
        rgd.is_loaded = True
        self.assertEqual([rgd], result)

    def test_delete_resources_found_old(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_groups's storage_account is 4 hours old.
        storage_account = StorageAccount('abcd-12', now - timedelta(hours=4))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        poller = FakePoller()
        client.resource.resource_groups.delete.return_value = poller
        # Delete resource groups that are 2 hours old.
        count = delete_resources(client, 'juju-bar*', old_age=2, now=now)
        self.assertEqual(1, count)
        client.resource.resource_groups.delete.assert_called_once_with(
            'juju-bar-1')
        self.assertIs(True, poller.is_done)

    def test_delete_resources_not_found_old(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_groups's storage_account is 2 hours old.
        storage_account = StorageAccount('abcd-12', now - timedelta(hours=2))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        # Delete resource groups that are 8 hours old.
        count = delete_resources(client, 'juju-bar*', old_age=8, now=now)
        self.assertEqual(0, count)
        self.assertEqual(0, client.resource.resource_groups.delete.call_count)

    def test_delete_resources_read_only(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient(
            'subscription_id', 'client_id', 'secret', 'tenant', read_only=True)
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_groups's storage_account is 4 hours old.
        storage_account = StorageAccount('abcd-12', now - timedelta(hours=4))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        count = delete_resources(client, 'juju-bar*', old_age=2, now=now)
        self.assertEqual(0, count)
        self.assertEqual(0, client.resource.resource_groups.delete.call_count)

    def test_delete_resources_poller_already_done(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_groups's storage_account is 4 hours old.
        storage_account = StorageAccount('abcd-12', now - timedelta(hours=4))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        poller = FakePoller()
        poller.is_done = True
        client.resource.resource_groups.delete.return_value = poller
        count = delete_resources(client, 'juju-bar*', old_age=2, now=now)
        self.assertEqual(1, count)
        self.assertEqual(1, client.resource.resource_groups.delete.call_count)

    def test_delete_resources_poller_is_none(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_groups's storage_account is 4 hours old.
        storage_account = StorageAccount('abcd-12', now - timedelta(hours=4))
        client.storage.storage_accounts.list_by_resource_group.return_value = [
            storage_account]
        count = delete_resources(client, 'juju-bar*', old_age=2, now=now)
        self.assertEqual(1, count)
        self.assertEqual(1, client.resource.resource_groups.delete.call_count)

    def test_delete_resources_old_age_0(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        a_group = ResourceGroup('juju-bar-1')
        b_group = ResourceGroup('juju-foo-0')
        client.resource.resource_groups.list.return_value = [a_group, b_group]
        poller = FakePoller()
        client.resource.resource_groups.delete.return_value = poller
        # Delete resource groups that are 0 hours old.
        # All matched resource_groups are deleted
        count = delete_resources(client, 'juju-bar*', old_age=0, now=now)
        self.assertEqual(1, count)
        self.assertEqual(1, client.resource.resource_groups.delete.call_count)
        self.assertIs(True, poller.is_done)

    # https://bugs.launchpad.net/juju-ci-tools/+bug/1613767
    def xxx_test_delete_resources_only_network(self, is_mock):
        now = datetime.now(tz=pytz.utc)
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        group = ResourceGroup('juju-bar-1')
        client.resource.resource_groups.list.return_value = [group]
        # The resource_group has a network, but nothing else
        network = Network('juju-bar-network-1')
        client.network.virtual_networks.list.return_value = [network]
        poller = FakePoller()
        client.resource.resource_groups.delete.return_value = poller
        count = delete_resources(client, 'juju-bar*', old_age=2, now=now)
        self.assertEqual(1, count)
        self.assertEqual(1, client.resource.resource_groups.delete.call_count)

    def test_find_vm_instance(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        rgd1 = ResourceGroupDetails(
            client, ResourceGroup('one'),
            vms=[VirtualMachine('name-0', 'id-a'),
                 VirtualMachine('name-1', 'id-b')])
        rgd2 = ResourceGroupDetails(
            client, ResourceGroup('two'),
            vms=[VirtualMachine('name-0', 'id-y'),
                 VirtualMachine('name-1', 'id-z')])
        resources = [rgd1, rgd2]
        self.assertEqual(
            (None, None), find_vm_instance(resources, 'id-q', None))
        self.assertEqual(
            (rgd2, rgd2.vms[0]), find_vm_instance(resources, 'id-y', None))
        self.assertEqual(
            (rgd2, rgd2.vms[0]), find_vm_instance(resources, 'name-0', 'two'))
        self.assertEqual(
            (None, None), find_vm_instance(resources, 'name-0', 'three'))
        self.assertEqual(
            (None, None), find_vm_instance(resources, 'name-9', 'two'))

    def test_delete_instance_with_name_and_resource_group(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        poller = FakePoller()
        client.compute.virtual_machines.delete.return_value = poller
        vm1 = VirtualMachine('name-0', 'id-a')
        rgd1 = ResourceGroupDetails(client, ResourceGroup('one'), vms=[vm1])
        with patch('winazurearm.list_resources', autospec=True,
                   return_value=[rgd1]) as lr_mock:
            # Passing just a name and group will take the group glob path.
            delete_instance(client, 'name-0', 'one')
        lr_mock.assert_called_once_with(client, glob='one', recursive=True)
        client.compute.virtual_machines.delete.assert_called_once_with(
            'one', 'name-0')
        self.assertIs(True, poller.is_done)

    def test_delete_instance_with_id(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        poller = FakePoller()
        client.compute.virtual_machines.delete.return_value = poller
        vm1 = VirtualMachine('name-0', 'id-a')
        rgd1 = ResourceGroupDetails(client, ResourceGroup('one'), vms=[vm1])
        vm2 = VirtualMachine('name-0', 'id-b')
        rgd2 = ResourceGroupDetails(client, ResourceGroup('two'), vms=[vm2])
        with patch('winazurearm.list_resources', autospec=True,
                   return_value=[rgd1, rgd2]) as lr_mock:
            # Passing just an id will take the * glob path.
            delete_instance(client, 'id-a')
        lr_mock.assert_called_once_with(client, glob='*', recursive=True)
        client.compute.virtual_machines.delete.assert_called_once_with(
            'one', 'name-0')
        self.assertIs(True, poller.is_done)

    def test_delete_instance_without_match(self, is_mock):
        client = ARMClient('subscription_id', 'client_id', 'secret', 'tenant')
        client.init_services()
        vm1 = VirtualMachine('name-0', 'id-a')
        rgd1 = ResourceGroupDetails(client, ResourceGroup('one'), vms=[vm1])
        with patch('winazurearm.list_resources', autospec=True,
                   return_value=[rgd1]):
            # Passing an non-existent id bypasses the call to delete.
            with self.assertRaises(ValueError):
                delete_instance(client, 'id-z')
        self.assertEqual(0, client.compute.virtual_machines.delete.call_count)