summaryrefslogtreecommitdiffstats
path: root/dovetail/tests/unit/test_container.py
blob: 7c758a7cd0b4844403a646ba666fe8d4f92e60a2 (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
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
#!/usr/bin/env python
#
# Copyright (c) 2018 mokats@intracom-telecom.com and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##

import unittest
from mock import patch, call, Mock
import docker

from dovetail.container import Container

__author__ = 'Stamatis Katsaounis <mokats@intracom-telecom.com>'


class ContainerTesting(unittest.TestCase):

    def setUp(self):
        self.patcher1 = patch.object(docker, 'from_env')
        testcase = patch.object(Container, 'testcase')
        testcase.testcase = {'validate': {
            'type': 'bottlenecks'}}
        test_name_obj = Mock()
        test_name_obj.return_value = 'name'
        testcase.name = test_name_obj
        val_type_obj = Mock()
        val_type_obj.return_value = 'bottlenecks'
        testcase.validate_type = val_type_obj
        self.client = self.patcher1.start().return_value
        self.container = Container(testcase)
        self.logger = Mock()
        self.container.logger = self.logger

    def tearDown(self):
        self.patcher1.stop()

    @patch('dovetail.container.dt_cfg')
    @patch.object(Container, 'copy_file')
    def test_copy_files_in_container(self, mock_copy, mock_config):
        source_file = 'source'
        destination_file = 'destination_file'
        mock_config.dovetail_config = {
            'bottlenecks': {
                'copy_file_in_container': [{
                    'src_file': source_file,
                    'dest_file': destination_file}]}}

        self.container.copy_files_in_container()

        mock_copy.assert_called_once_with(
            source_file, destination_file)

    @patch('dovetail.container.dt_cfg')
    @patch.object(Container, 'copy_file')
    def test_copy_files_in_container_no_file(self, mock_copy, mock_config):
        mock_config.dovetail_config = {
            'bottlenecks': {
                'copy_file_in_container': []}}

        self.container.copy_files_in_container()

        mock_copy.assert_not_called()

    @patch('dovetail.container.dt_cfg')
    @patch.object(Container, 'copy_file')
    def test_copy_files_in_container_no_key(self, mock_copy, mock_config):
        mock_config.dovetail_config = {
            'bottlenecks': {}}

        self.container.copy_files_in_container()

        mock_copy.assert_not_called()

    def test_copy_file_error(self):
        expected = (1, 'src_path or dest_path is empty')
        result = self.container.copy_file(None, None)

        self.assertEqual(expected, result)

    @patch.object(Container, 'exec_cmd')
    def test_copy_file(self, mock_exec):
        expected = (0, 'success')
        mock_exec.return_value = expected
        result = self.container.copy_file('source', 'dest')

        mock_exec.assert_called_once_with(
            'cp source dest', False)
        self.assertEqual(expected, result)

    def test_exec_cmd_error(self):
        expected = (1, 'sub_cmd is empty')
        result = self.container.exec_cmd('')

        self.assertEqual(expected, result)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    def test_exec_cmd(self, mock_utils, mock_config):
        expected = (0, 'success')
        mock_utils.get_value_from_dict.return_value = 'shell'
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        container_obj = Mock()
        container_obj.exec_run.return_value = expected
        self.container.container = container_obj

        result = self.container.exec_cmd('command')

        self.assertEqual(expected, result)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    @patch('sys.exit')
    def test_exec_cmd_exception(self, mock_exit, mock_utils, mock_config):
        mock_utils.get_value_from_dict.return_value = 'shell'
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        container_obj = Mock()
        response_obj = Mock()
        response_obj.status_code = 1
        container_obj.exec_run.side_effect = \
            docker.errors.APIError('error', response=response_obj)
        self.container.container = container_obj

        expected = (1, 'error')
        result = self.container.exec_cmd('command', exit_on_error=True)

        self.assertEqual(expected, result)
        mock_exit.assert_called_once_with(1)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    def test_exec_cmd_no_shell(self, mock_utils, mock_config):
        expected = (1, 'shell is empty')
        mock_utils.exec_cmd.return_value = expected
        mock_utils.get_value_from_dict.return_value = None
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        result = self.container.exec_cmd('command')

        self.assertEqual(expected, result)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    @patch.object(Container, 'get_container')
    def test_clean(self, mock_check, mock_utils, mock_config):
        container_name = 'container'
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        mock_utils.get_value_from_dict.return_value = [container_name]
        self.container.container = Mock()
        mock_check.return_value = Mock()

        self.container.clean()

        mock_utils.get_value_from_dict.assert_called_once_with(
            'extra_container', 'value')
        mock_check.assert_called_once_with(container_name)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    @patch.object(Container, 'get_container')
    def test_clean_extra_error(self, mock_check, mock_utils, mock_config):
        container_name = 'container'
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        mock_utils.get_value_from_dict.return_value = [container_name]
        container_obj = Mock()
        container_obj.remove.side_effect = docker.errors.APIError('error')
        self.container.container = Mock()
        mock_check.return_value = container_obj

        self.container.clean()

        mock_utils.get_value_from_dict.assert_called_once_with(
            'extra_container', 'value')
        mock_check.assert_called_once_with(container_name)

    @patch('dovetail.container.dt_cfg')
    @patch('dovetail.container.dt_utils')
    def test_clean_no_extra_container(self, mock_utils, mock_config):
        mock_utils.get_value_from_dict.return_value = None
        container_obj = Mock()
        container_obj.remove.side_effect = docker.errors.APIError('error')
        self.container.container = container_obj
        self.container.clean()
        mock_utils.get_value_from_dict.assert_called_once()

    def test_get_container_exist_true(self):
        container_name = 'container'
        expected = Mock()
        self.client.containers.get.return_value = expected

        result = self.container.get_container(container_name)

        self.assertEquals(expected, result)

    def test_get_container_none(self):
        container_name = 'container'
        self.client.containers.get.side_effect = \
            docker.errors.APIError('error')

        result = self.container.get_container(container_name)

        self.assertEquals(None, result)

    def test_pull_image_none(self):
        result = self.container.pull_image(None)
        self.assertEquals(None, result)

    @patch.object(Container, 'pull_image_only')
    @patch.object(Container, 'get_image_id')
    def test_pull_image_no_pull(self, mock_get, mock_pull):
        docker_image = 'image'
        mock_pull.return_value = None

        result = self.container.pull_image(docker_image)

        mock_get.assert_called_once_with(docker_image)
        mock_pull.assert_called_once_with(docker_image)
        self.assertEquals(None, result)

    @patch.object(Container, 'pull_image_only')
    @patch.object(Container, 'get_image_id')
    def test_pull_image_no_new_id(self, mock_get, mock_pull):
        docker_image = 'image'
        mock_get.return_value = None
        mock_pull.return_value = Mock()

        result = self.container.pull_image(docker_image)

        mock_pull.assert_called_once_with(docker_image)
        mock_get.assert_has_calls([
            call(docker_image), call(docker_image)])
        self.logger.error.assert_called_once_with(
            'Failed to get the id of image {}.'.format(docker_image))
        self.assertEquals(None, result)

    @patch.object(Container, 'pull_image_only')
    @patch.object(Container, 'get_image_id')
    def test_pull_image_no_old_id(self, mock_get, mock_pull):
        docker_image = 'image'
        mock_get.side_effect = [None, Mock()]
        mock_pull.return_value = Mock()

        result = self.container.pull_image(docker_image)

        mock_pull.assert_called_once_with(docker_image)
        mock_get.assert_has_calls([
            call(docker_image), call(docker_image)])
        self.assertEquals(docker_image, result)

    @patch.object(Container, 'pull_image_only')
    @patch.object(Container, 'get_image_id')
    def test_pull_image_same_id(self, mock_get, mock_pull):
        docker_image = 'image'
        mock_get.return_value = Mock()
        mock_pull.return_value = Mock()

        result = self.container.pull_image(docker_image)

        mock_pull.assert_called_once_with(docker_image)
        mock_get.assert_has_calls([
            call(docker_image), call(docker_image)])
        self.logger.debug.assert_called_once_with(
            'Image {} has no changes, no need to remove.'.format(docker_image))
        self.assertEquals(docker_image, result)

    @patch.object(Container, 'remove_image')
    @patch.object(Container, 'pull_image_only')
    @patch.object(Container, 'get_image_id')
    def test_pull_image_different_id(self, mock_get, mock_pull, mock_remove):
        docker_image = 'image'
        old_obj = Mock()
        mock_get.side_effect = [old_obj, Mock()]
        mock_pull.return_value = Mock()

        result = self.container.pull_image(docker_image)

        mock_pull.assert_called_once_with(docker_image)
        mock_get.assert_has_calls([
            call(docker_image), call(docker_image)])
        mock_remove.assert_called_once_with(old_obj)
        self.assertEquals(docker_image, result)

    def test_pull_image_only(self):
        docker_image = 'image'

        result = self.container.pull_image_only(docker_image)

        self.logger.debug.assert_called_once_with(
            'Success to pull docker image {}!'.format(docker_image))
        self.assertEquals(True, result)

    def test_pull_image_only_error(self):
        docker_image = 'image'
        self.client.images.pull.side_effect = docker.errors.APIError('error')

        result = self.container.pull_image_only(docker_image)

        self.logger.error.assert_called_once_with(
            'Failed to pull docker image {}!'.format(docker_image))
        self.assertEquals(False, result)

    def test_remove_image(self):
        image_id = 'image_id'
        self.client.containers.list.side_effect = \
            docker.errors.APIError('error')

        result = self.container.remove_image(image_id)

        self.logger.debug.assert_has_calls([
            call('Remove image {}.'.format(image_id)),
            call('Remove image {} successfully.'.format(image_id))])
        self.assertEquals(True, result)

    def test_remove_image_ancestors(self):
        image_id = 'image_id'
        self.client.containers.list.return_value = ['cont_a']

        result = self.container.remove_image(image_id)

        self.logger.debug.assert_called_once_with(
            'Image {} has containers, skip.'.format(image_id))
        self.assertEquals(True, result)

    def test_remove_image_error(self):
        image_id = 'image_id'
        self.client.containers.list.return_value = []
        self.client.images.remove.side_effect = \
            docker.errors.ImageNotFound('error')

        result = self.container.remove_image(image_id)

        self.logger.debug.assert_called_once_with(
            'Remove image {}.'.format(image_id))
        self.logger.error.assert_called_once_with(
            'Failed to remove image {}.'.format(image_id))
        self.assertEquals(False, result)

    def test_get_image_id(self):
        image_name = 'image_id'
        mock_img = Mock()
        mock_img.id = image_name
        self.client.images.get.return_value = mock_img

        result = self.container.get_image_id(image_name)

        self.assertEquals(image_name, result)

    def test_get_image_id_error(self):
        image_name = 'image_id'
        self.client.images.get.side_effect = \
            docker.errors.ImageNotFound('error')

        result = self.container.get_image_id(image_name)

        self.assertEquals(None, result)

    @patch('dovetail.container.dt_utils')
    def test_get_config(self, mock_utils):
        expected = 'value'
        mock_utils.get_value_from_dict.return_value = expected

        result = self.container._get_config('a', 'b', 'c')

        mock_utils.get_value_from_dict.assert_called_once_with('a', 'c')
        self.assertEquals(expected, result)

    @patch('dovetail.container.dt_utils')
    def test_get_config_none(self, mock_utils):
        mock_utils.get_value_from_dict.return_value = None

        result = self.container._get_config('a', 'b', 'c')

        mock_utils.get_value_from_dict.assert_has_calls([
            call('a', 'c'), call('a', 'b')])
        self.logger.error.assert_called_once_with(
            "Couldn't find key {}.".format('a'))
        self.assertEquals(None, result)

    @patch('dovetail.container.dt_cfg')
    @patch.object(Container, '_get_config')
    def test_get_docker_image(self, mock_get_conf, mock_config):
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        mock_get_conf.side_effect = ['name', 'tag']

        expected = 'name:tag'
        result = self.container.get_docker_image()

        mock_get_conf.assert_has_calls([
            call('image_name', 'value', {'type': 'bottlenecks'}),
            call('docker_tag', 'value', {'type': 'bottlenecks'})])
        self.assertEquals(expected, result)

    @patch('dovetail.container.dt_logger')
    def test_create_log(self, mock_logger):
        log_obj = Mock()
        log_obj.getLogger.return_value = self.logger
        mock_logger.Logger.return_value = log_obj

        self.container.create_log()

        self.assertEquals(self.logger, self.container.logger)

    @patch('dovetail.container.dt_utils')
    @patch('dovetail.container.dt_cfg')
    def test_create(self, mock_config, mock_utils):
        docker_image = 'docker_image'
        container_id = 'container_id'
        mock_utils.get_value_from_dict.side_effect = [
            {'key': 'value'}, 'shell', 'envs', ['volume_one', 'volume_two']]
        mock_utils.get_hosts_info.return_value = 'host_info'
        container_obj = Mock()
        container_obj.id = container_id
        self.client.containers.run.return_value = container_obj
        project_config = {}
        mock_config.dovetail_config = {'bottlenecks': project_config}

        expected = container_id
        result = self.container.create(docker_image)

        mock_utils.get_value_from_dict.assert_has_calls([
            call('opts', project_config),
            call('shell', project_config),
            call('envs', project_config),
            call('volumes', project_config)])
        mock_utils.get_hosts_info.assert_called_once_with(self.logger)
        self.assertEquals(expected, result)

    @patch('dovetail.container.dt_utils')
    @patch('dovetail.container.dt_cfg')
    def test_create_no_shell(self, mock_config, mock_utils):
        docker_image = 'docker_image'
        mock_config.dovetail_config = {'bottlenecks': 'value'}
        mock_utils.get_value_from_dict.side_effect = ['opts', None]
        mock_utils.get_hosts_info.return_value = 'host_info'

        result = self.container.create(docker_image)

        mock_utils.get_value_from_dict.assert_has_calls([
            call('opts', 'value'),
            call('shell', 'value')])
        self.assertEquals(None, result)

    @patch('dovetail.container.dt_utils')
    @patch('dovetail.container.dt_cfg')
    def test_create_error(self, mock_config, mock_utils):
        docker_image = 'docker_image'
        mock_utils.get_value_from_dict.side_effect = [
            {'key': 'value'}, 'shell', ['envs'], ['volume_one']]
        mock_utils.get_hosts_info.return_value = 'host_info'
        mock_utils.check_https_enabled.return_value = True
        self.client.containers.run.side_effect = \
            docker.errors.ImageNotFound('error')
        project_config = {}
        mock_config.dovetail_config = {'bottlenecks': project_config}
        result = self.container.create(docker_image)

        mock_utils.get_value_from_dict.assert_has_calls([
            call('opts', project_config),
            call('shell', project_config),
            call('envs', project_config),
            call('volumes', project_config)])
        mock_utils.get_hosts_info.assert_called_once_with(self.logger)
        self.assertEquals(None, result)