-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathtest_container.py
More file actions
1861 lines (1466 loc) · 73.7 KB
/
test_container.py
File metadata and controls
1861 lines (1466 loc) · 73.7 KB
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Unit test for Container class
"""
import base64
import json
import threading
import time
from unittest import TestCase
from unittest.mock import MagicMock, Mock, call, patch, ANY
from parameterized import parameterized
import docker
from docker.errors import NotFound, APIError
from requests import RequestException
from samcli.commands.local.lib.debug_context import DebugContext
from samcli.lib.utils.packagetype import IMAGE
from samcli.lib.utils.stream_writer import StreamWriter
from samcli.local.docker.container import (
Container,
ContainerContext,
ContainerResponseException,
ContainerConnectionTimeoutException,
PortAlreadyInUse,
)
class TestContainer_init(TestCase):
def setUp(self):
self.image = IMAGE
self.cmd = "cmd"
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.memory_mb = 123
self.exposed_ports = {123: 123}
self.entrypoint = ["a", "b", "c"]
self.env_vars = {"key": "value"}
self.mock_docker_client = Mock()
def test_init_must_store_all_values(self):
container = Container(
self.image,
self.cmd,
self.working_dir,
self.host_dir,
self.memory_mb,
self.exposed_ports,
self.entrypoint,
self.env_vars,
self.mock_docker_client,
)
self.assertEqual(self.image, container._image)
self.assertEqual(self.cmd, container._cmd)
self.assertEqual(self.working_dir, container._working_dir)
self.assertEqual(self.host_dir, container._host_dir)
self.assertEqual(self.exposed_ports, container._exposed_ports)
self.assertEqual(self.entrypoint, container._entrypoint)
self.assertEqual(self.env_vars, container._env_vars)
self.assertEqual(self.memory_mb, container._memory_limit_mb)
self.assertEqual(None, container._network_id)
self.assertEqual(None, container.id)
self.assertIsNone(container._concurrency_semaphore)
self.assertEqual(self.mock_docker_client, container.docker_client)
class TestContainer_create(TestCase):
def setUp(self):
self.image = IMAGE
self.cmd = "cmd"
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.memory_mb = 123
self.exposed_ports = {123: 123}
self.always_exposed_ports = {Container.RAPID_PORT_CONTAINER: ANY}
self.entrypoint = ["a", "b", "c"]
self.env_vars = {"key": "value"}
self.container_opts = {"container": "opts"}
self.additional_volumes = {"/somepath": {"blah": "blah value"}}
self.container_host = "localhost"
self.container_host_interface = "127.0.0.1"
self.container_context = ContainerContext.BUILD
self.mock_docker_client = Mock()
self.mock_docker_client.containers = Mock()
self.mock_docker_client.containers.create = Mock()
self.mock_docker_client.networks = Mock()
self.mock_docker_client.networks.get = Mock()
@patch("samcli.local.docker.container.Container._create_mapped_symlink_files")
def test_must_create_container_with_required_values(self, mock_resolve_symlinks):
"""
Create a container with only required values. Optional values are not provided
:return:
"""
expected_volumes = {self.host_dir: {"bind": self.working_dir, "mode": "ro,delegated"}}
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
container = Container(
self.image,
self.cmd,
self.working_dir,
self.host_dir,
docker_client=self.mock_docker_client,
exposed_ports=self.exposed_ports,
)
container_id = container.create(ContainerContext.INVOKE)
self.assertEqual(container_id, generated_id)
self.assertEqual(container.id, generated_id)
self.assertIsNotNone(container._concurrency_semaphore)
self.mock_docker_client.containers.create.assert_called_with(
self.image,
command=self.cmd,
working_dir=self.working_dir,
volumes=expected_volumes,
tty=False,
ports={
container_port: ("127.0.0.1", host_port)
for container_port, host_port in {**self.exposed_ports, **self.always_exposed_ports}.items()
},
use_config_proxy=True,
)
self.mock_docker_client.networks.get.assert_not_called()
mock_resolve_symlinks.assert_called_with() # When context is INVOKE
@patch("samcli.local.docker.container.Container._create_mapped_symlink_files")
def test_must_create_container_including_all_optional_values(self, mock_resolve_symlinks):
"""
Create a container with required and optional values.
:return:
"""
expected_volumes = {
self.host_dir: {"bind": self.working_dir, "mode": "ro,delegated"},
"/somepath": {"blah": "blah value"},
}
expected_memory = "{}m".format(self.memory_mb)
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
container = Container(
self.image,
self.cmd,
self.working_dir,
self.host_dir,
memory_limit_mb=self.memory_mb,
exposed_ports=self.exposed_ports,
entrypoint=self.entrypoint,
env_vars=self.env_vars,
docker_client=self.mock_docker_client,
container_opts=self.container_opts,
additional_volumes=self.additional_volumes,
container_host=self.container_host,
container_host_interface=self.container_host_interface,
)
container_id = container.create(ContainerContext.BUILD)
self.assertEqual(container_id, generated_id)
self.assertEqual(container.id, generated_id)
self.assertIsNotNone(container._concurrency_semaphore)
self.mock_docker_client.containers.create.assert_called_with(
self.image,
command=self.cmd,
working_dir=self.working_dir,
volumes=expected_volumes,
tty=False,
use_config_proxy=True,
environment=self.env_vars,
ports={
container_port: (self.container_host_interface, host_port)
for container_port, host_port in {**self.exposed_ports, **self.always_exposed_ports}.items()
},
entrypoint=self.entrypoint,
mem_limit=expected_memory,
container="opts",
)
self.mock_docker_client.networks.get.assert_not_called()
mock_resolve_symlinks.assert_not_called() # When context is BUILD
self.assertIsNotNone(container._concurrency_semaphore)
@patch("samcli.local.docker.utils.os")
@patch("samcli.local.docker.container.Container._create_mapped_symlink_files")
def test_must_create_container_translate_volume_path(self, mock_resolve_symlinks, os_mock):
"""
Create a container with required and optional values, with windows style volume mount.
:return:
"""
os_mock.name = "nt"
host_dir = "C:\\Users\\Username\\AppData\\Local\\Temp\\tmp1337"
additional_volumes = {"C:\\Users\\Username\\AppData\\Local\\Temp\\tmp1338": {"blah": "blah value"}}
translated_volumes = {
"/c/Users/Username/AppData/Local/Temp/tmp1337": {"bind": self.working_dir, "mode": "ro,delegated"}
}
translated_additional_volumes = {"/c/Users/Username/AppData/Local/Temp/tmp1338": {"blah": "blah value"}}
translated_volumes.update(translated_additional_volumes)
expected_memory = "{}m".format(self.memory_mb)
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
container = Container(
self.image,
self.cmd,
self.working_dir,
host_dir,
memory_limit_mb=self.memory_mb,
exposed_ports=self.exposed_ports,
entrypoint=self.entrypoint,
env_vars=self.env_vars,
docker_client=self.mock_docker_client,
container_opts=self.container_opts,
additional_volumes=additional_volumes,
)
container_id = container.create(self.container_context)
self.assertEqual(container_id, generated_id)
self.assertEqual(container.id, generated_id)
self.assertIsNotNone(container._concurrency_semaphore)
self.mock_docker_client.containers.create.assert_called_with(
self.image,
command=self.cmd,
working_dir=self.working_dir,
volumes=translated_volumes,
tty=False,
use_config_proxy=True,
environment=self.env_vars,
ports={
container_port: ("127.0.0.1", host_port)
for container_port, host_port in {**self.exposed_ports, **self.always_exposed_ports}.items()
},
entrypoint=self.entrypoint,
mem_limit=expected_memory,
container="opts",
)
self.mock_docker_client.networks.get.assert_not_called()
@patch("samcli.local.docker.container.Container._create_mapped_symlink_files")
def test_must_connect_to_network_on_create(self, mock_resolve_symlinks):
"""
Create a container with only required values. Optional values are not provided
:return:
"""
expected_volumes = {self.host_dir: {"bind": self.working_dir, "mode": "ro,delegated"}}
network_id = "some id"
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
network_mock = Mock()
self.mock_docker_client.networks.get.return_value = network_mock
network_mock.connect = Mock()
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container.network_id = network_id
container_id = container.create(self.container_context)
self.assertEqual(container_id, generated_id)
self.assertIsNotNone(container._concurrency_semaphore)
self.mock_docker_client.containers.create.assert_called_with(
self.image,
command=self.cmd,
working_dir=self.working_dir,
tty=False,
use_config_proxy=True,
volumes=expected_volumes,
ports=self.always_exposed_ports,
)
self.mock_docker_client.networks.get.assert_called_with(network_id)
network_mock.connect.assert_called_with(container_id)
@patch("samcli.local.docker.container.Container._initialize_concurrency_control")
def test_must_initialize_concurrency_control(self, mock_concurrency_control):
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
# Configure the mock to set _concurrency_semaphore when called
def side_effect(container_obj=None):
# This simulates what the real method would do
self.container._concurrency_semaphore = threading.Semaphore(1)
return self.container._concurrency_semaphore
mock_concurrency_control.side_effect = side_effect
container = Container(
self.image,
self.cmd,
self.working_dir,
self.host_dir,
docker_client=self.mock_docker_client,
exposed_ports=self.exposed_ports,
)
# Store the container for the side_effect to use
self.container = container
container_id = container.create(ContainerContext.INVOKE)
self.assertEqual(container_id, generated_id)
self.assertEqual(container.id, generated_id)
mock_concurrency_control.assert_called_once()
self.assertIsNotNone(container._concurrency_semaphore)
mock_concurrency_control.assert_called_once()
@patch("samcli.local.docker.container.Container._create_mapped_symlink_files")
def test_must_connect_to_host_network_on_create(self, mock_resolve_symlinks):
"""
Create a container with only required values. Optional values are not provided
:return:
"""
expected_volumes = {self.host_dir: {"bind": self.working_dir, "mode": "ro,delegated"}}
network_id = "host"
generated_id = "fooobar"
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = generated_id
network_mock = Mock()
self.mock_docker_client.networks.get.return_value = network_mock
network_mock.connect = Mock()
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container.network_id = network_id
container_id = container.create(self.container_context)
self.assertEqual(container_id, generated_id)
self.assertIsNotNone(container._concurrency_semaphore)
self.mock_docker_client.containers.create.assert_called_with(
self.image,
command=self.cmd,
working_dir=self.working_dir,
ports=self.always_exposed_ports,
tty=False,
use_config_proxy=True,
volumes=expected_volumes,
)
self.mock_docker_client.networks.get.assert_not_called()
def test_must_fail_if_already_created(self):
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container.is_created = Mock()
container.is_created.return_value = True
with self.assertRaises(RuntimeError):
container.create(self.container_context)
self.assertIsNone(container._concurrency_semaphore)
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_must_make_host_tmp_dir_if_mount_with_write_container_build(self, mock_makedirs, mock_exists):
"""Test that create() method creates host tmp directory when mount_with_write is True"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "host_tmp_dir"
# Mock filesystem operations to ensure complete isolation
mock_exists.return_value = False
# Mock the docker client create method to avoid actual container creation
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = "test_id"
container.create(self.container_context)
mock_makedirs.assert_called_once_with(container._host_tmp_dir)
mock_exists.assert_called_once_with(container._host_tmp_dir)
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_no_action_when_mount_with_write_false(self, mock_makedirs, mock_exists):
"""Test that create() method takes no action when mount_with_write is False"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = False
container._host_tmp_dir = "host_tmp_dir"
# Mock the docker client create method to avoid actual container creation
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = "test_id"
container.create(self.container_context)
# Should not check if directory exists or create it
mock_exists.assert_not_called()
mock_makedirs.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_no_action_when_host_tmp_dir_none(self, mock_makedirs, mock_exists):
"""Test that create() method takes no action when host_tmp_dir is None"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = None
# Mock the docker client create method to avoid actual container creation
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = "test_id"
container.create(self.container_context)
# Should not check if directory exists or create it
mock_exists.assert_not_called()
mock_makedirs.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_no_action_when_directory_already_exists(self, mock_makedirs, mock_exists):
"""Test that create() method takes no action when directory already exists"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "host_tmp_dir"
mock_exists.return_value = True # Directory already exists
# Mock the docker client create method to avoid actual container creation
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = "test_id"
container.create(self.container_context)
# Should check if directory exists but not create it
mock_exists.assert_called_once_with(container._host_tmp_dir)
mock_makedirs.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_permission_error_during_directory_creation(self, mock_makedirs, mock_exists):
"""Test that create() method propagates permission errors during directory creation"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "/root/restricted_dir"
# Mock filesystem operations to ensure complete isolation
mock_exists.return_value = False
mock_makedirs.side_effect = PermissionError("Permission denied: '/root/restricted_dir'")
with self.assertRaises(PermissionError) as context:
container.create(self.container_context)
self.assertIn("Permission denied", str(context.exception))
mock_makedirs.assert_called_once_with(container._host_tmp_dir)
mock_exists.assert_called_once_with(container._host_tmp_dir)
# Docker client should not be called since directory creation failed
self.mock_docker_client.containers.create.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_os_error_during_directory_creation(self, mock_makedirs, mock_exists):
"""Test that create() method propagates OS errors during directory creation"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "/invalid/path/with/nonexistent/parent"
# Mock filesystem operations to ensure complete isolation
mock_exists.return_value = False
mock_makedirs.side_effect = OSError("No such file or directory")
with self.assertRaises(OSError) as context:
container.create(self.container_context)
self.assertIn("No such file or directory", str(context.exception))
mock_makedirs.assert_called_once_with(container._host_tmp_dir)
mock_exists.assert_called_once_with(container._host_tmp_dir)
# Docker client should not be called since directory creation failed
self.mock_docker_client.containers.create.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_invalid_path_scenarios(self, mock_makedirs, mock_exists):
"""Test that create() method handles invalid path scenarios appropriately"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "/invalid\x00path" # Path with null character
# Mock filesystem operations to ensure complete isolation
mock_exists.return_value = False
mock_makedirs.side_effect = ValueError("embedded null character")
# The ValueError should be raised before we even try to create the container
with self.assertRaises(ValueError) as context:
container.create(self.container_context)
self.assertIn("embedded null character", str(context.exception))
mock_makedirs.assert_called_once_with(container._host_tmp_dir)
mock_exists.assert_called_once_with(container._host_tmp_dir)
# Docker client should not be called since directory creation failed
self.mock_docker_client.containers.create.assert_not_called()
@patch("samcli.local.docker.container.os.path.exists")
@patch("samcli.local.docker.container.os.makedirs")
def test_create_file_exists_error_handled_gracefully(self, mock_makedirs, mock_exists):
"""Test that create() method handles FileExistsError gracefully (race condition scenario)"""
container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
container._mount_with_write = True
container._host_tmp_dir = "host_tmp_dir"
# Mock filesystem operations to ensure complete isolation
mock_exists.return_value = False
# Simulate race condition where directory is created between exists check and makedirs call
mock_makedirs.side_effect = FileExistsError("Directory already exists")
# Mock the docker client create method to avoid actual container creation
self.mock_docker_client.containers.create.return_value = Mock()
self.mock_docker_client.containers.create.return_value.id = "test_id"
# Should not raise an exception - FileExistsError should be handled gracefully
container_id = container.create(self.container_context)
self.assertEqual(container_id, "test_id")
mock_makedirs.assert_called_once_with(container._host_tmp_dir)
mock_exists.assert_called_once_with(container._host_tmp_dir)
class TestContainer_stop(TestCase):
def setUp(self):
self.image = IMAGE
self.cmd = "cmd"
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.mock_docker_client = Mock()
self.mock_docker_client.containers = Mock()
self.mock_docker_client.containers.get = Mock()
self.container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
self.container.id = "someid"
self.container.is_created = Mock()
def test_stop_with_timeout(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
real_container_mock.remove = Mock()
self.container.stop(timeout=3)
self.mock_docker_client.containers.get.assert_called_with("someid")
real_container_mock.stop.assert_called_with(timeout=3)
# Ensure ID remains set
self.assertIsNotNone(self.container.id)
def test_must_work_when_container_is_not_found(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.side_effect = NotFound("msg")
real_container_mock.remove = Mock()
self.container.stop()
self.mock_docker_client.containers.get.assert_called_with("someid")
real_container_mock.remove.assert_not_called()
# Ensure ID remains set
self.assertIsNotNone(self.container.id)
def test_must_raise_unknown_docker_api_errors(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
real_container_mock.stop = Mock()
real_container_mock.stop.side_effect = APIError("some error")
with self.assertRaises(APIError):
self.container.stop()
# Ensure ID remains set
self.assertIsNotNone(self.container.id)
def test_must_skip_if_container_is_not_created(self):
self.container.is_created.return_value = False
self.container.stop()
self.mock_docker_client.containers.get.assert_not_called()
class TestContainer_delete(TestCase):
def setUp(self):
self.image = IMAGE
self.cmd = "cmd"
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.mock_docker_client = Mock()
self.mock_docker_client.containers = Mock()
self.mock_docker_client.containers.get = Mock()
self.container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
self.container.id = "someid"
self.container.is_created = Mock()
def test_must_delete(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
real_container_mock.remove = Mock()
self.container.delete()
self.mock_docker_client.containers.get.assert_called_with("someid")
real_container_mock.remove.assert_called_with(force=True)
# Must reset ID to None because container is now gone
self.assertIsNone(self.container.id)
def test_must_work_when_container_is_not_found(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.side_effect = NotFound("msg")
real_container_mock.remove = Mock()
self.container.delete()
self.mock_docker_client.containers.get.assert_called_with("someid")
real_container_mock.remove.assert_not_called()
# Must reset ID to None because container is now gone
self.assertIsNone(self.container.id)
def test_must_work_if_container_delete_is_in_progress(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
real_container_mock.remove = Mock()
real_container_mock.remove.side_effect = APIError("removal of container is already in progress")
self.container.delete()
self.mock_docker_client.containers.get.assert_called_with("someid")
real_container_mock.remove.assert_called_with(force=True)
# Must reset ID to None because container is now gone
self.assertIsNone(self.container.id)
def test_must_raise_unknown_docker_api_errors(self):
self.container.is_created.return_value = True
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
real_container_mock.remove = Mock()
real_container_mock.remove.side_effect = APIError("some error")
with self.assertRaises(APIError):
self.container.delete()
# Must *NOT* reset ID because Docker API raised an exception
self.assertIsNotNone(self.container.id)
def test_must_skip_if_container_is_not_created(self):
self.container.is_created.return_value = False
self.container.delete()
self.mock_docker_client.containers.get.assert_not_called()
@patch("samcli.local.docker.container.pathlib.Path.exists")
@patch("samcli.local.docker.container.shutil")
def test_must_remove_host_tmp_dir_after_mount_with_write_container_build(self, mock_shutil, mock_exists):
self.container.is_created.return_value = True
self.container._mount_with_write = True
self.container._host_tmp_dir = "host_tmp_dir"
mock_exists.return_value = True
self.container.delete()
mock_shutil.rmtree.assert_called_with(self.container._host_tmp_dir)
class TestContainer_start(TestCase):
def setUp(self):
self.image = IMAGE
self.cmd = "cmd"
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.mock_docker_client = Mock()
self.mock_docker_client.containers = Mock()
self.mock_docker_client.containers.get = Mock()
self.container = Container(
self.image, self.cmd, self.working_dir, self.host_dir, docker_client=self.mock_docker_client
)
self.container.id = "someid"
self.container.is_created = Mock()
def test_must_start_container(self):
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start = Mock()
self.container.start()
self.mock_docker_client.containers.get.assert_called_with(self.container.id)
container_mock.start.assert_called_with()
def test_must_not_start_if_container_is_not_created(self):
self.container.is_created.return_value = False
with self.assertRaises(RuntimeError):
self.container.start()
def test_docker_raises_port_inuse_error(self):
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start.side_effect = PortAlreadyInUse()
with self.assertRaises(PortAlreadyInUse):
self.container.start()
def test_docker_raises_api_error(self):
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start.side_effect = APIError("Mock Error")
with self.assertRaises(APIError):
self.container.start()
def test_docker_api_error_port_in_use_with_str_explanation(self):
"""Test APIError with 'ports are not available' and str explanation (docker-py >= 7.0)"""
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
# Simulate docker-py >= 7.0 where explanation is already a str
error_msg = "ports are not available: listen tcp 127.0.0.1:5005: bind: address already in use"
api_error = APIError(error_msg, response=None, explanation=error_msg)
container_mock.start.side_effect = api_error
with self.assertRaises(PortAlreadyInUse) as context:
self.container.start()
# Verify the error message was preserved
self.assertIn("ports are not available", str(context.exception))
def test_docker_api_error_port_in_use_with_bytes_explanation(self):
"""Test APIError with 'ports are not available' and bytes explanation (docker-py < 7.0)"""
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
# Simulate docker-py < 7.0 where explanation is bytes
error_msg = b"ports are not available: listen tcp 127.0.0.1:5005: bind: address already in use"
api_error = APIError(error_msg.decode(), response=None, explanation=error_msg)
container_mock.start.side_effect = api_error
with self.assertRaises(PortAlreadyInUse) as context:
self.container.start()
# Verify the error message was preserved
self.assertIn("ports are not available", str(context.exception))
def test_docker_api_error_port_in_use_case_insensitive(self):
"""Test APIError with 'Ports are not available' (uppercase P) is caught"""
self.container.is_created.return_value = True
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
# Simulate Docker returning "Ports" with uppercase P
error_msg = "Ports are not available: listen tcp 127.0.0.1:5005: bind: address already in use"
api_error = APIError(error_msg, response=None, explanation=error_msg)
container_mock.start.side_effect = api_error
with self.assertRaises(PortAlreadyInUse) as context:
self.container.start()
# Verify the error message was preserved
self.assertIn("Ports are not available", str(context.exception))
def test_must_not_support_input_data(self):
self.container.is_created.return_value = True
with self.assertRaises(ValueError):
self.container.start(input_data="some input data")
@patch("samcli.local.docker.container.os.path")
@patch("samcli.local.docker.container.os")
def test_start_no_longer_creates_directories(self, mock_os, mock_path):
"""Test that start() method no longer creates directories"""
self.container.is_created.return_value = True
self.container._mount_with_write = True
self.container._host_tmp_dir = "host_tmp_dir"
mock_path.exists.return_value = False # Directory doesn't exist
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start = Mock()
# Should not raise an exception, just log a warning
self.container.start()
# Should not create the directory
mock_os.makedirs.assert_not_called()
# Should still start the container
container_mock.start.assert_called_with()
@patch("samcli.local.docker.container.os.path")
def test_start_works_when_directory_already_exists(self, mock_path):
"""Test that start() method works correctly when directory already exists"""
self.container.is_created.return_value = True
self.container._mount_with_write = True
self.container._host_tmp_dir = "host_tmp_dir"
mock_path.exists.return_value = True # Directory exists
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start = Mock()
# Should work without any issues
self.container.start()
# Should start the container
container_mock.start.assert_called_with()
@patch("samcli.local.docker.container.os.path")
def test_start_works_when_mount_with_write_false(self, mock_path):
"""Test that start() method works correctly when mount_with_write is False"""
self.container.is_created.return_value = True
self.container._mount_with_write = False
self.container._host_tmp_dir = "host_tmp_dir"
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start = Mock()
# Should work without checking directory existence
self.container.start()
# Should not check if directory exists
mock_path.exists.assert_not_called()
# Should start the container
container_mock.start.assert_called_with()
@patch("samcli.local.docker.container.os.path")
def test_start_works_when_host_tmp_dir_none(self, mock_path):
"""Test that start() method works correctly when host_tmp_dir is None"""
self.container.is_created.return_value = True
self.container._mount_with_write = True
self.container._host_tmp_dir = None
container_mock = Mock()
self.mock_docker_client.containers.get.return_value = container_mock
container_mock.start = Mock()
# Should work without checking directory existence
self.container.start()
# Should not check if directory exists
mock_path.exists.assert_not_called()
# Should start the container
container_mock.start.assert_called_with()
class TestContainer_wait_for_result(TestCase):
def setUp(self):
self.image = IMAGE
self.name = "function_name"
self.event = "{}"
self.cmd = ["cmd"]
self.working_dir = "working_dir"
self.host_dir = "host_dir"
self.container_host = "localhost"
self.mock_docker_client = Mock()
self.mock_docker_client.containers = Mock()
self.mock_docker_client.containers.get = Mock()
self.container = Container(
self.image,
self.cmd,
self.working_dir,
self.host_dir,
docker_client=self.mock_docker_client,
container_host=self.container_host,
)
self.container.id = "someid"
self.container._initialize_concurrency_control()
self.container.is_created = Mock()
self.timeout = 1
self.socket_mock = Mock()
self.socket_mock.connect_ex.return_value = 0
@patch("socket.socket")
@patch("samcli.local.docker.container.requests")
def test_wait_for_result_no_error_image_response(self, mock_requests, patched_socket):
self.container.is_created.return_value = True
rie_response = b"\xff\xab"
resp_headers = {
"Date": "Tue, 02 Jan 2024 21:23:31 GMT",
"Content-Type": "image/jpeg",
"Transfer-Encoding": "chunked",
}
real_container_mock = Mock()
self.mock_docker_client.containers.get.return_value = real_container_mock
output_itr = Mock()
real_container_mock.attach.return_value = output_itr
self.container._write_container_output = Mock()
self.container.start_logs_thread_if_not_alive = Mock()
self.container._create_threading_event = Mock()
mock_event = Mock()
self.container._create_threading_event.return_value = mock_event
self.container._logs_thread_event = mock_event
stdout_mock = Mock()
stdout_mock.write_bytes = Mock()
stderr_mock = Mock()
response = Mock()
response.content = rie_response
response.headers = resp_headers
mock_requests.post.return_value = response
patched_socket.return_value = self.socket_mock
start_timer = Mock()
timer = Mock()
start_timer.return_value = timer
self.container.wait_for_result(
event=self.event, full_path=self.name, stdout=stdout_mock, stderr=stderr_mock, start_timer=start_timer
)
# since we passed in a start_timer function, ensure it's called and
# the timer is cancelled once execution is done
start_timer.assert_called()
timer.cancel.assert_called()
# make sure we wait for the same host+port that we make the post request to
host = self.container._container_host
port = self.container.rapid_port_host
self.socket_mock.connect_ex.assert_called_with((host, port))
mock_requests.post.assert_called_with(
self.container.URL.format(host=host, port=port, function_name="function"),
data=b"{}",
headers={"Content-Type": "application/json"},
timeout=(self.container.RAPID_CONNECTION_TIMEOUT, None),
)
stdout_mock.write_bytes.assert_called_with(rie_response)
# Verify start_logs_thread_if_not_alive is called with stderr mock only
self.container.start_logs_thread_if_not_alive.assert_called_once_with(stderr_mock)