service_test.py 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import docker
  4. import pytest
  5. from docker.constants import DEFAULT_DOCKER_API_VERSION
  6. from docker.errors import APIError
  7. from docker.errors import ImageNotFound
  8. from docker.errors import NotFound
  9. from .. import mock
  10. from .. import unittest
  11. from compose.config.errors import DependencyError
  12. from compose.config.types import MountSpec
  13. from compose.config.types import ServicePort
  14. from compose.config.types import ServiceSecret
  15. from compose.config.types import VolumeFromSpec
  16. from compose.config.types import VolumeSpec
  17. from compose.const import API_VERSIONS
  18. from compose.const import LABEL_CONFIG_HASH
  19. from compose.const import LABEL_ONE_OFF
  20. from compose.const import LABEL_PROJECT
  21. from compose.const import LABEL_SERVICE
  22. from compose.const import SECRETS_PATH
  23. from compose.const import WINDOWS_LONGPATH_PREFIX
  24. from compose.container import Container
  25. from compose.errors import OperationFailedError
  26. from compose.parallel import ParallelStreamWriter
  27. from compose.project import OneOffFilter
  28. from compose.service import build_ulimits
  29. from compose.service import build_volume_binding
  30. from compose.service import BuildAction
  31. from compose.service import ContainerNetworkMode
  32. from compose.service import format_environment
  33. from compose.service import formatted_ports
  34. from compose.service import get_container_data_volumes
  35. from compose.service import ImageType
  36. from compose.service import merge_volume_bindings
  37. from compose.service import NeedsBuildError
  38. from compose.service import NetworkMode
  39. from compose.service import NoSuchImageError
  40. from compose.service import parse_repository_tag
  41. from compose.service import rewrite_build_path
  42. from compose.service import Service
  43. from compose.service import ServiceNetworkMode
  44. from compose.service import warn_on_masked_volume
  45. class ServiceTest(unittest.TestCase):
  46. def setUp(self):
  47. self.mock_client = mock.create_autospec(docker.APIClient)
  48. self.mock_client.api_version = DEFAULT_DOCKER_API_VERSION
  49. self.mock_client._general_configs = {}
  50. def test_containers(self):
  51. service = Service('db', self.mock_client, 'myproject', image='foo')
  52. self.mock_client.containers.return_value = []
  53. assert list(service.containers()) == []
  54. def test_containers_with_containers(self):
  55. self.mock_client.containers.return_value = [
  56. dict(Name=str(i), Image='foo', Id=i) for i in range(3)
  57. ]
  58. service = Service('db', self.mock_client, 'myproject', image='foo')
  59. assert [c.id for c in service.containers()] == list(range(3))
  60. expected_labels = [
  61. '{0}=myproject'.format(LABEL_PROJECT),
  62. '{0}=db'.format(LABEL_SERVICE),
  63. '{0}=False'.format(LABEL_ONE_OFF),
  64. ]
  65. self.mock_client.containers.assert_called_once_with(
  66. all=False,
  67. filters={'label': expected_labels})
  68. def test_container_without_name(self):
  69. self.mock_client.containers.return_value = [
  70. {'Image': 'foo', 'Id': '1', 'Name': '1'},
  71. {'Image': 'foo', 'Id': '2', 'Name': None},
  72. {'Image': 'foo', 'Id': '3'},
  73. ]
  74. service = Service('db', self.mock_client, 'myproject', image='foo')
  75. assert [c.id for c in service.containers()] == ['1']
  76. assert service._next_container_number() == 2
  77. assert service.get_container(1).id == '1'
  78. def test_get_volumes_from_container(self):
  79. container_id = 'aabbccddee'
  80. service = Service(
  81. 'test',
  82. image='foo',
  83. volumes_from=[
  84. VolumeFromSpec(
  85. mock.Mock(id=container_id, spec=Container),
  86. 'rw',
  87. 'container')])
  88. assert service._get_volumes_from() == [container_id + ':rw']
  89. def test_get_volumes_from_container_read_only(self):
  90. container_id = 'aabbccddee'
  91. service = Service(
  92. 'test',
  93. image='foo',
  94. volumes_from=[
  95. VolumeFromSpec(
  96. mock.Mock(id=container_id, spec=Container),
  97. 'ro',
  98. 'container')])
  99. assert service._get_volumes_from() == [container_id + ':ro']
  100. def test_get_volumes_from_service_container_exists(self):
  101. container_ids = ['aabbccddee', '12345']
  102. from_service = mock.create_autospec(Service)
  103. from_service.containers.return_value = [
  104. mock.Mock(id=container_id, spec=Container)
  105. for container_id in container_ids
  106. ]
  107. service = Service(
  108. 'test',
  109. volumes_from=[VolumeFromSpec(from_service, 'rw', 'service')],
  110. image='foo')
  111. assert service._get_volumes_from() == [container_ids[0] + ":rw"]
  112. def test_get_volumes_from_service_container_exists_with_flags(self):
  113. for mode in ['ro', 'rw', 'z', 'rw,z', 'z,rw']:
  114. container_ids = ['aabbccddee:' + mode, '12345:' + mode]
  115. from_service = mock.create_autospec(Service)
  116. from_service.containers.return_value = [
  117. mock.Mock(id=container_id.split(':')[0], spec=Container)
  118. for container_id in container_ids
  119. ]
  120. service = Service(
  121. 'test',
  122. volumes_from=[VolumeFromSpec(from_service, mode, 'service')],
  123. image='foo')
  124. assert service._get_volumes_from() == [container_ids[0]]
  125. def test_get_volumes_from_service_no_container(self):
  126. container_id = 'abababab'
  127. from_service = mock.create_autospec(Service)
  128. from_service.containers.return_value = []
  129. from_service.create_container.return_value = mock.Mock(
  130. id=container_id,
  131. spec=Container)
  132. service = Service(
  133. 'test',
  134. image='foo',
  135. volumes_from=[VolumeFromSpec(from_service, 'rw', 'service')])
  136. assert service._get_volumes_from() == [container_id + ':rw']
  137. from_service.create_container.assert_called_once_with()
  138. def test_memory_swap_limit(self):
  139. self.mock_client.create_host_config.return_value = {}
  140. service = Service(
  141. name='foo',
  142. image='foo',
  143. hostname='name',
  144. client=self.mock_client,
  145. mem_limit=1000000000,
  146. memswap_limit=2000000000)
  147. service._get_container_create_options({'some': 'overrides'}, 1)
  148. assert self.mock_client.create_host_config.called
  149. assert self.mock_client.create_host_config.call_args[1]['mem_limit'] == 1000000000
  150. assert self.mock_client.create_host_config.call_args[1]['memswap_limit'] == 2000000000
  151. def test_self_reference_external_link(self):
  152. service = Service(
  153. name='foo',
  154. external_links=['default_foo_1']
  155. )
  156. with pytest.raises(DependencyError):
  157. service.get_container_name('foo', 1)
  158. def test_mem_reservation(self):
  159. self.mock_client.create_host_config.return_value = {}
  160. service = Service(
  161. name='foo',
  162. image='foo',
  163. hostname='name',
  164. client=self.mock_client,
  165. mem_reservation='512m'
  166. )
  167. service._get_container_create_options({'some': 'overrides'}, 1)
  168. assert self.mock_client.create_host_config.called is True
  169. assert self.mock_client.create_host_config.call_args[1]['mem_reservation'] == '512m'
  170. def test_cgroup_parent(self):
  171. self.mock_client.create_host_config.return_value = {}
  172. service = Service(
  173. name='foo',
  174. image='foo',
  175. hostname='name',
  176. client=self.mock_client,
  177. cgroup_parent='test')
  178. service._get_container_create_options({'some': 'overrides'}, 1)
  179. assert self.mock_client.create_host_config.called
  180. assert self.mock_client.create_host_config.call_args[1]['cgroup_parent'] == 'test'
  181. def test_log_opt(self):
  182. self.mock_client.create_host_config.return_value = {}
  183. log_opt = {'syslog-address': 'tcp://192.168.0.42:123'}
  184. logging = {'driver': 'syslog', 'options': log_opt}
  185. service = Service(
  186. name='foo',
  187. image='foo',
  188. hostname='name',
  189. client=self.mock_client,
  190. log_driver='syslog',
  191. logging=logging)
  192. service._get_container_create_options({'some': 'overrides'}, 1)
  193. assert self.mock_client.create_host_config.called
  194. assert self.mock_client.create_host_config.call_args[1]['log_config'] == {
  195. 'Type': 'syslog', 'Config': {'syslog-address': 'tcp://192.168.0.42:123'}
  196. }
  197. def test_stop_grace_period(self):
  198. self.mock_client.api_version = '1.25'
  199. self.mock_client.create_host_config.return_value = {}
  200. service = Service(
  201. 'foo',
  202. image='foo',
  203. client=self.mock_client,
  204. stop_grace_period="1m35s")
  205. opts = service._get_container_create_options({'image': 'foo'}, 1)
  206. assert opts['stop_timeout'] == 95
  207. def test_split_domainname_none(self):
  208. service = Service(
  209. 'foo',
  210. image='foo',
  211. hostname='name.domain.tld',
  212. client=self.mock_client)
  213. opts = service._get_container_create_options({'image': 'foo'}, 1)
  214. assert opts['hostname'] == 'name.domain.tld', 'hostname'
  215. assert not ('domainname' in opts), 'domainname'
  216. def test_split_domainname_fqdn(self):
  217. self.mock_client.api_version = '1.22'
  218. service = Service(
  219. 'foo',
  220. hostname='name.domain.tld',
  221. image='foo',
  222. client=self.mock_client)
  223. opts = service._get_container_create_options({'image': 'foo'}, 1)
  224. assert opts['hostname'] == 'name', 'hostname'
  225. assert opts['domainname'] == 'domain.tld', 'domainname'
  226. def test_split_domainname_both(self):
  227. self.mock_client.api_version = '1.22'
  228. service = Service(
  229. 'foo',
  230. hostname='name',
  231. image='foo',
  232. domainname='domain.tld',
  233. client=self.mock_client)
  234. opts = service._get_container_create_options({'image': 'foo'}, 1)
  235. assert opts['hostname'] == 'name', 'hostname'
  236. assert opts['domainname'] == 'domain.tld', 'domainname'
  237. def test_split_domainname_weird(self):
  238. self.mock_client.api_version = '1.22'
  239. service = Service(
  240. 'foo',
  241. hostname='name.sub',
  242. domainname='domain.tld',
  243. image='foo',
  244. client=self.mock_client)
  245. opts = service._get_container_create_options({'image': 'foo'}, 1)
  246. assert opts['hostname'] == 'name.sub', 'hostname'
  247. assert opts['domainname'] == 'domain.tld', 'domainname'
  248. def test_no_default_hostname_when_not_using_networking(self):
  249. service = Service(
  250. 'foo',
  251. image='foo',
  252. use_networking=False,
  253. client=self.mock_client,
  254. )
  255. opts = service._get_container_create_options({'image': 'foo'}, 1)
  256. assert opts.get('hostname') is None
  257. def test_get_container_create_options_with_name_option(self):
  258. service = Service(
  259. 'foo',
  260. image='foo',
  261. client=self.mock_client,
  262. container_name='foo1')
  263. name = 'the_new_name'
  264. opts = service._get_container_create_options(
  265. {'name': name},
  266. 1,
  267. one_off=OneOffFilter.only)
  268. assert opts['name'] == name
  269. def test_get_container_create_options_does_not_mutate_options(self):
  270. labels = {'thing': 'real'}
  271. environment = {'also': 'real'}
  272. service = Service(
  273. 'foo',
  274. image='foo',
  275. labels=dict(labels),
  276. client=self.mock_client,
  277. environment=dict(environment),
  278. )
  279. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  280. prev_container = mock.Mock(
  281. id='ababab',
  282. image_config={'ContainerConfig': {}}
  283. )
  284. prev_container.full_slug = 'abcdefff1234'
  285. prev_container.get.return_value = None
  286. opts = service._get_container_create_options(
  287. {}, 1, previous_container=prev_container
  288. )
  289. assert service.options['labels'] == labels
  290. assert service.options['environment'] == environment
  291. assert opts['labels'][LABEL_CONFIG_HASH] == \
  292. '2524a06fcb3d781aa2c981fc40bcfa08013bb318e4273bfa388df22023e6f2aa'
  293. assert opts['environment'] == ['also=real']
  294. def test_get_container_create_options_sets_affinity_with_binds(self):
  295. service = Service(
  296. 'foo',
  297. image='foo',
  298. client=self.mock_client,
  299. )
  300. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  301. prev_container = mock.Mock(
  302. id='ababab',
  303. image_config={'ContainerConfig': {'Volumes': ['/data']}})
  304. def container_get(key):
  305. return {
  306. 'Mounts': [
  307. {
  308. 'Destination': '/data',
  309. 'Source': '/some/path',
  310. 'Name': 'abab1234',
  311. },
  312. ]
  313. }.get(key, None)
  314. prev_container.get.side_effect = container_get
  315. prev_container.full_slug = 'abcdefff1234'
  316. opts = service._get_container_create_options(
  317. {},
  318. 1,
  319. previous_container=prev_container
  320. )
  321. assert opts['environment'] == ['affinity:container==ababab']
  322. def test_get_container_create_options_no_affinity_without_binds(self):
  323. service = Service('foo', image='foo', client=self.mock_client)
  324. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  325. prev_container = mock.Mock(
  326. id='ababab',
  327. image_config={'ContainerConfig': {}})
  328. prev_container.get.return_value = None
  329. prev_container.full_slug = 'abcdefff1234'
  330. opts = service._get_container_create_options(
  331. {},
  332. 1,
  333. previous_container=prev_container)
  334. assert opts['environment'] == []
  335. def test_get_container_not_found(self):
  336. self.mock_client.containers.return_value = []
  337. service = Service('foo', client=self.mock_client, image='foo')
  338. with pytest.raises(ValueError):
  339. service.get_container()
  340. @mock.patch('compose.service.Container', autospec=True)
  341. def test_get_container(self, mock_container_class):
  342. container_dict = dict(Name='default_foo_2_bdfa3ed91e2c')
  343. self.mock_client.containers.return_value = [container_dict]
  344. service = Service('foo', image='foo', client=self.mock_client)
  345. container = service.get_container(number=2)
  346. assert container == mock_container_class.from_ps.return_value
  347. mock_container_class.from_ps.assert_called_once_with(
  348. self.mock_client, container_dict)
  349. @mock.patch('compose.service.log', autospec=True)
  350. def test_pull_image(self, mock_log):
  351. service = Service('foo', client=self.mock_client, image='someimage:sometag')
  352. service.pull()
  353. self.mock_client.pull.assert_called_once_with(
  354. 'someimage',
  355. tag='sometag',
  356. stream=True,
  357. platform=None)
  358. mock_log.info.assert_called_once_with('Pulling foo (someimage:sometag)...')
  359. def test_pull_image_no_tag(self):
  360. service = Service('foo', client=self.mock_client, image='ababab')
  361. service.pull()
  362. self.mock_client.pull.assert_called_once_with(
  363. 'ababab',
  364. tag='latest',
  365. stream=True,
  366. platform=None)
  367. @mock.patch('compose.service.log', autospec=True)
  368. def test_pull_image_digest(self, mock_log):
  369. service = Service('foo', client=self.mock_client, image='someimage@sha256:1234')
  370. service.pull()
  371. self.mock_client.pull.assert_called_once_with(
  372. 'someimage',
  373. tag='sha256:1234',
  374. stream=True,
  375. platform=None)
  376. mock_log.info.assert_called_once_with('Pulling foo (someimage@sha256:1234)...')
  377. @mock.patch('compose.service.log', autospec=True)
  378. def test_pull_image_with_platform(self, mock_log):
  379. self.mock_client.api_version = '1.35'
  380. service = Service(
  381. 'foo', client=self.mock_client, image='someimage:sometag', platform='windows/x86_64'
  382. )
  383. service.pull()
  384. assert self.mock_client.pull.call_count == 1
  385. call_args = self.mock_client.pull.call_args
  386. assert call_args[1]['platform'] == 'windows/x86_64'
  387. @mock.patch('compose.service.log', autospec=True)
  388. def test_pull_image_with_platform_unsupported_api(self, mock_log):
  389. self.mock_client.api_version = '1.33'
  390. service = Service(
  391. 'foo', client=self.mock_client, image='someimage:sometag', platform='linux/arm'
  392. )
  393. with pytest.raises(OperationFailedError):
  394. service.pull()
  395. def test_pull_image_with_default_platform(self):
  396. self.mock_client.api_version = '1.35'
  397. service = Service(
  398. 'foo', client=self.mock_client, image='someimage:sometag',
  399. default_platform='linux'
  400. )
  401. assert service.platform == 'linux'
  402. service.pull()
  403. assert self.mock_client.pull.call_count == 1
  404. call_args = self.mock_client.pull.call_args
  405. assert call_args[1]['platform'] == 'linux'
  406. @mock.patch('compose.service.Container', autospec=True)
  407. def test_recreate_container(self, _):
  408. mock_container = mock.create_autospec(Container)
  409. mock_container.full_slug = 'abcdefff1234'
  410. service = Service('foo', client=self.mock_client, image='someimage')
  411. service.image = lambda: {'Id': 'abc123'}
  412. new_container = service.recreate_container(mock_container)
  413. mock_container.stop.assert_called_once_with(timeout=10)
  414. mock_container.rename_to_tmp_name.assert_called_once_with()
  415. new_container.start.assert_called_once_with()
  416. mock_container.remove.assert_called_once_with()
  417. @mock.patch('compose.service.Container', autospec=True)
  418. def test_recreate_container_with_timeout(self, _):
  419. mock_container = mock.create_autospec(Container)
  420. mock_container.full_slug = 'abcdefff1234'
  421. self.mock_client.inspect_image.return_value = {'Id': 'abc123'}
  422. service = Service('foo', client=self.mock_client, image='someimage')
  423. service.recreate_container(mock_container, timeout=1)
  424. mock_container.stop.assert_called_once_with(timeout=1)
  425. def test_parse_repository_tag(self):
  426. assert parse_repository_tag("root") == ("root", "", ":")
  427. assert parse_repository_tag("root:tag") == ("root", "tag", ":")
  428. assert parse_repository_tag("user/repo") == ("user/repo", "", ":")
  429. assert parse_repository_tag("user/repo:tag") == ("user/repo", "tag", ":")
  430. assert parse_repository_tag("url:5000/repo") == ("url:5000/repo", "", ":")
  431. assert parse_repository_tag("url:5000/repo:tag") == ("url:5000/repo", "tag", ":")
  432. assert parse_repository_tag("root@sha256:digest") == ("root", "sha256:digest", "@")
  433. assert parse_repository_tag("user/repo@sha256:digest") == ("user/repo", "sha256:digest", "@")
  434. assert parse_repository_tag("url:5000/repo@sha256:digest") == (
  435. "url:5000/repo", "sha256:digest", "@"
  436. )
  437. def test_create_container(self):
  438. service = Service('foo', client=self.mock_client, build={'context': '.'})
  439. self.mock_client.inspect_image.side_effect = [
  440. NoSuchImageError,
  441. {'Id': 'abc123'},
  442. ]
  443. self.mock_client.build.return_value = [
  444. '{"stream": "Successfully built abcd"}',
  445. ]
  446. with mock.patch('compose.service.log', autospec=True) as mock_log:
  447. service.create_container()
  448. assert mock_log.warn.called
  449. _, args, _ = mock_log.warn.mock_calls[0]
  450. assert 'was built because it did not already exist' in args[0]
  451. assert self.mock_client.build.call_count == 1
  452. self.mock_client.build.call_args[1]['tag'] == 'default_foo'
  453. def test_ensure_image_exists_no_build(self):
  454. service = Service('foo', client=self.mock_client, build={'context': '.'})
  455. self.mock_client.inspect_image.return_value = {'Id': 'abc123'}
  456. service.ensure_image_exists(do_build=BuildAction.skip)
  457. assert not self.mock_client.build.called
  458. def test_ensure_image_exists_no_build_but_needs_build(self):
  459. service = Service('foo', client=self.mock_client, build={'context': '.'})
  460. self.mock_client.inspect_image.side_effect = NoSuchImageError
  461. with pytest.raises(NeedsBuildError):
  462. service.ensure_image_exists(do_build=BuildAction.skip)
  463. def test_ensure_image_exists_force_build(self):
  464. service = Service('foo', client=self.mock_client, build={'context': '.'})
  465. self.mock_client.inspect_image.return_value = {'Id': 'abc123'}
  466. self.mock_client.build.return_value = [
  467. '{"stream": "Successfully built abcd"}',
  468. ]
  469. with mock.patch('compose.service.log', autospec=True) as mock_log:
  470. service.ensure_image_exists(do_build=BuildAction.force)
  471. assert not mock_log.warn.called
  472. assert self.mock_client.build.call_count == 1
  473. self.mock_client.build.call_args[1]['tag'] == 'default_foo'
  474. def test_build_does_not_pull(self):
  475. self.mock_client.build.return_value = [
  476. b'{"stream": "Successfully built 12345"}',
  477. ]
  478. service = Service('foo', client=self.mock_client, build={'context': '.'})
  479. service.build()
  480. assert self.mock_client.build.call_count == 1
  481. assert not self.mock_client.build.call_args[1]['pull']
  482. def test_build_with_platform(self):
  483. self.mock_client.api_version = '1.35'
  484. self.mock_client.build.return_value = [
  485. b'{"stream": "Successfully built 12345"}',
  486. ]
  487. service = Service('foo', client=self.mock_client, build={'context': '.'}, platform='linux')
  488. service.build()
  489. assert self.mock_client.build.call_count == 1
  490. call_args = self.mock_client.build.call_args
  491. assert call_args[1]['platform'] == 'linux'
  492. def test_build_with_default_platform(self):
  493. self.mock_client.api_version = '1.35'
  494. self.mock_client.build.return_value = [
  495. b'{"stream": "Successfully built 12345"}',
  496. ]
  497. service = Service(
  498. 'foo', client=self.mock_client, build={'context': '.'},
  499. default_platform='linux'
  500. )
  501. assert service.platform == 'linux'
  502. service.build()
  503. assert self.mock_client.build.call_count == 1
  504. call_args = self.mock_client.build.call_args
  505. assert call_args[1]['platform'] == 'linux'
  506. def test_service_platform_precedence(self):
  507. self.mock_client.api_version = '1.35'
  508. service = Service(
  509. 'foo', client=self.mock_client, platform='linux/arm',
  510. default_platform='osx'
  511. )
  512. assert service.platform == 'linux/arm'
  513. def test_service_ignore_default_platform_with_unsupported_api(self):
  514. self.mock_client.api_version = '1.32'
  515. self.mock_client.build.return_value = [
  516. b'{"stream": "Successfully built 12345"}',
  517. ]
  518. service = Service(
  519. 'foo', client=self.mock_client, default_platform='windows', build={'context': '.'}
  520. )
  521. assert service.platform is None
  522. service.build()
  523. assert self.mock_client.build.call_count == 1
  524. call_args = self.mock_client.build.call_args
  525. assert call_args[1]['platform'] is None
  526. def test_build_with_override_build_args(self):
  527. self.mock_client.build.return_value = [
  528. b'{"stream": "Successfully built 12345"}',
  529. ]
  530. build_args = {
  531. 'arg1': 'arg1_new_value',
  532. }
  533. service = Service('foo', client=self.mock_client,
  534. build={'context': '.', 'args': {'arg1': 'arg1', 'arg2': 'arg2'}})
  535. service.build(build_args_override=build_args)
  536. called_build_args = self.mock_client.build.call_args[1]['buildargs']
  537. assert called_build_args['arg1'] == build_args['arg1']
  538. assert called_build_args['arg2'] == 'arg2'
  539. def test_build_with_isolation_from_service_config(self):
  540. self.mock_client.build.return_value = [
  541. b'{"stream": "Successfully built 12345"}',
  542. ]
  543. service = Service('foo', client=self.mock_client, build={'context': '.'}, isolation='hyperv')
  544. service.build()
  545. assert self.mock_client.build.call_count == 1
  546. called_build_args = self.mock_client.build.call_args[1]
  547. assert called_build_args['isolation'] == 'hyperv'
  548. def test_build_isolation_from_build_override_service_config(self):
  549. self.mock_client.build.return_value = [
  550. b'{"stream": "Successfully built 12345"}',
  551. ]
  552. service = Service(
  553. 'foo', client=self.mock_client, build={'context': '.', 'isolation': 'default'},
  554. isolation='hyperv'
  555. )
  556. service.build()
  557. assert self.mock_client.build.call_count == 1
  558. called_build_args = self.mock_client.build.call_args[1]
  559. assert called_build_args['isolation'] == 'default'
  560. def test_config_dict(self):
  561. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  562. service = Service(
  563. 'foo',
  564. image='example.com/foo',
  565. client=self.mock_client,
  566. network_mode=ServiceNetworkMode(Service('other')),
  567. networks={'default': None},
  568. links=[(Service('one'), 'one')],
  569. volumes_from=[VolumeFromSpec(Service('two'), 'rw', 'service')])
  570. config_dict = service.config_dict()
  571. expected = {
  572. 'image_id': 'abcd',
  573. 'options': {'image': 'example.com/foo'},
  574. 'links': [('one', 'one')],
  575. 'net': 'other',
  576. 'networks': {'default': None},
  577. 'volumes_from': [('two', 'rw')],
  578. }
  579. assert config_dict == expected
  580. def test_config_dict_with_network_mode_from_container(self):
  581. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  582. container = Container(
  583. self.mock_client,
  584. {'Id': 'aaabbb', 'Name': '/foo_1'})
  585. service = Service(
  586. 'foo',
  587. image='example.com/foo',
  588. client=self.mock_client,
  589. network_mode=ContainerNetworkMode(container))
  590. config_dict = service.config_dict()
  591. expected = {
  592. 'image_id': 'abcd',
  593. 'options': {'image': 'example.com/foo'},
  594. 'links': [],
  595. 'networks': {},
  596. 'net': 'aaabbb',
  597. 'volumes_from': [],
  598. }
  599. assert config_dict == expected
  600. def test_config_hash_matches_label(self):
  601. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  602. service = Service(
  603. 'foo',
  604. image='example.com/foo',
  605. client=self.mock_client,
  606. network_mode=NetworkMode('bridge'),
  607. networks={'bridge': {}, 'net2': {}},
  608. links=[(Service('one', client=self.mock_client), 'one')],
  609. volumes_from=[VolumeFromSpec(Service('two', client=self.mock_client), 'rw', 'service')],
  610. volumes=[VolumeSpec('/ext', '/int', 'ro')],
  611. build={'context': 'some/random/path'},
  612. )
  613. config_hash = service.config_hash
  614. for api_version in set(API_VERSIONS.values()):
  615. self.mock_client.api_version = api_version
  616. assert service._get_container_create_options(
  617. {}, 1
  618. )['labels'][LABEL_CONFIG_HASH] == config_hash
  619. def test_remove_image_none(self):
  620. web = Service('web', image='example', client=self.mock_client)
  621. assert not web.remove_image(ImageType.none)
  622. assert not self.mock_client.remove_image.called
  623. def test_remove_image_local_with_image_name_doesnt_remove(self):
  624. web = Service('web', image='example', client=self.mock_client)
  625. assert not web.remove_image(ImageType.local)
  626. assert not self.mock_client.remove_image.called
  627. def test_remove_image_local_without_image_name_does_remove(self):
  628. web = Service('web', build='.', client=self.mock_client)
  629. assert web.remove_image(ImageType.local)
  630. self.mock_client.remove_image.assert_called_once_with(web.image_name)
  631. def test_remove_image_all_does_remove(self):
  632. web = Service('web', image='example', client=self.mock_client)
  633. assert web.remove_image(ImageType.all)
  634. self.mock_client.remove_image.assert_called_once_with(web.image_name)
  635. def test_remove_image_with_error(self):
  636. self.mock_client.remove_image.side_effect = error = APIError(
  637. message="testing",
  638. response={},
  639. explanation="Boom")
  640. web = Service('web', image='example', client=self.mock_client)
  641. with mock.patch('compose.service.log', autospec=True) as mock_log:
  642. assert not web.remove_image(ImageType.all)
  643. mock_log.error.assert_called_once_with(
  644. "Failed to remove image for service %s: %s", web.name, error)
  645. def test_remove_non_existing_image(self):
  646. self.mock_client.remove_image.side_effect = ImageNotFound('image not found')
  647. web = Service('web', image='example', client=self.mock_client)
  648. with mock.patch('compose.service.log', autospec=True) as mock_log:
  649. assert not web.remove_image(ImageType.all)
  650. mock_log.warning.assert_called_once_with("Image %s not found.", web.image_name)
  651. def test_specifies_host_port_with_no_ports(self):
  652. service = Service(
  653. 'foo',
  654. image='foo')
  655. assert not service.specifies_host_port()
  656. def test_specifies_host_port_with_container_port(self):
  657. service = Service(
  658. 'foo',
  659. image='foo',
  660. ports=["2000"])
  661. assert not service.specifies_host_port()
  662. def test_specifies_host_port_with_host_port(self):
  663. service = Service(
  664. 'foo',
  665. image='foo',
  666. ports=["1000:2000"])
  667. assert service.specifies_host_port()
  668. def test_specifies_host_port_with_host_ip_no_port(self):
  669. service = Service(
  670. 'foo',
  671. image='foo',
  672. ports=["127.0.0.1::2000"])
  673. assert not service.specifies_host_port()
  674. def test_specifies_host_port_with_host_ip_and_port(self):
  675. service = Service(
  676. 'foo',
  677. image='foo',
  678. ports=["127.0.0.1:1000:2000"])
  679. assert service.specifies_host_port()
  680. def test_specifies_host_port_with_container_port_range(self):
  681. service = Service(
  682. 'foo',
  683. image='foo',
  684. ports=["2000-3000"])
  685. assert not service.specifies_host_port()
  686. def test_specifies_host_port_with_host_port_range(self):
  687. service = Service(
  688. 'foo',
  689. image='foo',
  690. ports=["1000-2000:2000-3000"])
  691. assert service.specifies_host_port()
  692. def test_specifies_host_port_with_host_ip_no_port_range(self):
  693. service = Service(
  694. 'foo',
  695. image='foo',
  696. ports=["127.0.0.1::2000-3000"])
  697. assert not service.specifies_host_port()
  698. def test_specifies_host_port_with_host_ip_and_port_range(self):
  699. service = Service(
  700. 'foo',
  701. image='foo',
  702. ports=["127.0.0.1:1000-2000:2000-3000"])
  703. assert service.specifies_host_port()
  704. def test_image_name_from_config(self):
  705. image_name = 'example/web:latest'
  706. service = Service('foo', image=image_name)
  707. assert service.image_name == image_name
  708. def test_image_name_default(self):
  709. service = Service('foo', project='testing')
  710. assert service.image_name == 'testing_foo'
  711. @mock.patch('compose.service.log', autospec=True)
  712. def test_only_log_warning_when_host_ports_clash(self, mock_log):
  713. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  714. ParallelStreamWriter.instance = None
  715. name = 'foo'
  716. service = Service(
  717. name,
  718. client=self.mock_client,
  719. ports=["8080:80"])
  720. service.scale(0)
  721. assert not mock_log.warn.called
  722. service.scale(1)
  723. assert not mock_log.warn.called
  724. service.scale(2)
  725. mock_log.warn.assert_called_once_with(
  726. 'The "{}" service specifies a port on the host. If multiple containers '
  727. 'for this service are created on a single host, the port will clash.'.format(name))
  728. def test_parse_proxy_config(self):
  729. default_proxy_config = {
  730. 'httpProxy': 'http://proxy.mycorp.com:3128',
  731. 'httpsProxy': 'https://user:[email protected]:3129',
  732. 'ftpProxy': 'http://ftpproxy.mycorp.com:21',
  733. 'noProxy': '*.intra.mycorp.com',
  734. }
  735. self.mock_client.base_url = 'http+docker://localunixsocket'
  736. self.mock_client._general_configs = {
  737. 'proxies': {
  738. 'default': default_proxy_config,
  739. }
  740. }
  741. service = Service('foo', client=self.mock_client)
  742. assert service._parse_proxy_config() == {
  743. 'HTTP_PROXY': default_proxy_config['httpProxy'],
  744. 'http_proxy': default_proxy_config['httpProxy'],
  745. 'HTTPS_PROXY': default_proxy_config['httpsProxy'],
  746. 'https_proxy': default_proxy_config['httpsProxy'],
  747. 'FTP_PROXY': default_proxy_config['ftpProxy'],
  748. 'ftp_proxy': default_proxy_config['ftpProxy'],
  749. 'NO_PROXY': default_proxy_config['noProxy'],
  750. 'no_proxy': default_proxy_config['noProxy'],
  751. }
  752. def test_parse_proxy_config_per_host(self):
  753. default_proxy_config = {
  754. 'httpProxy': 'http://proxy.mycorp.com:3128',
  755. 'httpsProxy': 'https://user:[email protected]:3129',
  756. 'ftpProxy': 'http://ftpproxy.mycorp.com:21',
  757. 'noProxy': '*.intra.mycorp.com',
  758. }
  759. host_specific_proxy_config = {
  760. 'httpProxy': 'http://proxy.example.com:3128',
  761. 'httpsProxy': 'https://user:[email protected]:3129',
  762. 'ftpProxy': 'http://ftpproxy.example.com:21',
  763. 'noProxy': '*.intra.example.com'
  764. }
  765. self.mock_client.base_url = 'http+docker://localunixsocket'
  766. self.mock_client._general_configs = {
  767. 'proxies': {
  768. 'default': default_proxy_config,
  769. 'tcp://example.docker.com:2376': host_specific_proxy_config,
  770. }
  771. }
  772. service = Service('foo', client=self.mock_client)
  773. assert service._parse_proxy_config() == {
  774. 'HTTP_PROXY': default_proxy_config['httpProxy'],
  775. 'http_proxy': default_proxy_config['httpProxy'],
  776. 'HTTPS_PROXY': default_proxy_config['httpsProxy'],
  777. 'https_proxy': default_proxy_config['httpsProxy'],
  778. 'FTP_PROXY': default_proxy_config['ftpProxy'],
  779. 'ftp_proxy': default_proxy_config['ftpProxy'],
  780. 'NO_PROXY': default_proxy_config['noProxy'],
  781. 'no_proxy': default_proxy_config['noProxy'],
  782. }
  783. self.mock_client._original_base_url = 'tcp://example.docker.com:2376'
  784. assert service._parse_proxy_config() == {
  785. 'HTTP_PROXY': host_specific_proxy_config['httpProxy'],
  786. 'http_proxy': host_specific_proxy_config['httpProxy'],
  787. 'HTTPS_PROXY': host_specific_proxy_config['httpsProxy'],
  788. 'https_proxy': host_specific_proxy_config['httpsProxy'],
  789. 'FTP_PROXY': host_specific_proxy_config['ftpProxy'],
  790. 'ftp_proxy': host_specific_proxy_config['ftpProxy'],
  791. 'NO_PROXY': host_specific_proxy_config['noProxy'],
  792. 'no_proxy': host_specific_proxy_config['noProxy'],
  793. }
  794. def test_build_service_with_proxy_config(self):
  795. default_proxy_config = {
  796. 'httpProxy': 'http://proxy.mycorp.com:3128',
  797. 'httpsProxy': 'https://user:[email protected]:3129',
  798. }
  799. buildargs = {
  800. 'HTTPS_PROXY': 'https://rdcf.th08.jp:8911',
  801. 'https_proxy': 'https://rdcf.th08.jp:8911',
  802. }
  803. self.mock_client._general_configs = {
  804. 'proxies': {
  805. 'default': default_proxy_config,
  806. }
  807. }
  808. self.mock_client.base_url = 'http+docker://localunixsocket'
  809. self.mock_client.build.return_value = [
  810. b'{"stream": "Successfully built 12345"}',
  811. ]
  812. service = Service('foo', client=self.mock_client, build={'context': '.', 'args': buildargs})
  813. service.build()
  814. assert self.mock_client.build.call_count == 1
  815. assert self.mock_client.build.call_args[1]['buildargs'] == {
  816. 'HTTP_PROXY': default_proxy_config['httpProxy'],
  817. 'http_proxy': default_proxy_config['httpProxy'],
  818. 'HTTPS_PROXY': buildargs['HTTPS_PROXY'],
  819. 'https_proxy': buildargs['HTTPS_PROXY'],
  820. }
  821. def test_get_create_options_with_proxy_config(self):
  822. default_proxy_config = {
  823. 'httpProxy': 'http://proxy.mycorp.com:3128',
  824. 'httpsProxy': 'https://user:[email protected]:3129',
  825. 'ftpProxy': 'http://ftpproxy.mycorp.com:21',
  826. }
  827. self.mock_client._general_configs = {
  828. 'proxies': {
  829. 'default': default_proxy_config,
  830. }
  831. }
  832. self.mock_client.base_url = 'http+docker://localunixsocket'
  833. override_options = {
  834. 'environment': {
  835. 'FTP_PROXY': 'ftp://xdge.exo.au:21',
  836. 'ftp_proxy': 'ftp://xdge.exo.au:21',
  837. }
  838. }
  839. environment = {
  840. 'HTTPS_PROXY': 'https://rdcf.th08.jp:8911',
  841. 'https_proxy': 'https://rdcf.th08.jp:8911',
  842. }
  843. service = Service('foo', client=self.mock_client, environment=environment)
  844. create_opts = service._get_container_create_options(override_options, 1)
  845. assert set(create_opts['environment']) == set(format_environment({
  846. 'HTTP_PROXY': default_proxy_config['httpProxy'],
  847. 'http_proxy': default_proxy_config['httpProxy'],
  848. 'HTTPS_PROXY': environment['HTTPS_PROXY'],
  849. 'https_proxy': environment['HTTPS_PROXY'],
  850. 'FTP_PROXY': override_options['environment']['FTP_PROXY'],
  851. 'ftp_proxy': override_options['environment']['FTP_PROXY'],
  852. }))
  853. def test_create_when_removed_containers_are_listed(self):
  854. # This is aimed at simulating a race between the API call to list the
  855. # containers, and the ones to inspect each of the listed containers.
  856. # It can happen that a container has been removed after we listed it.
  857. # containers() returns a container that is about to be removed
  858. self.mock_client.containers.return_value = [
  859. {'Id': 'rm_cont_id', 'Name': 'rm_cont', 'Image': 'img_id'},
  860. ]
  861. # inspect_container() will raise a NotFound when trying to inspect
  862. # rm_cont_id, which at this point has been removed
  863. def inspect(name):
  864. if name == 'rm_cont_id':
  865. raise NotFound(message='Not Found')
  866. if name == 'new_cont_id':
  867. return {'Id': 'new_cont_id'}
  868. raise NotImplementedError("incomplete mock")
  869. self.mock_client.inspect_container.side_effect = inspect
  870. self.mock_client.inspect_image.return_value = {'Id': 'imageid'}
  871. self.mock_client.create_container.return_value = {'Id': 'new_cont_id'}
  872. # We should nonetheless be able to create a new container
  873. service = Service('foo', client=self.mock_client)
  874. assert service.create_container().id == 'new_cont_id'
  875. def test_build_volume_options_duplicate_binds(self):
  876. self.mock_client.api_version = '1.29' # Trigger 3.2 format workaround
  877. service = Service('foo', client=self.mock_client)
  878. ctnr_opts, override_opts = service._build_container_volume_options(
  879. previous_container=None,
  880. container_options={
  881. 'volumes': [
  882. MountSpec.parse({'source': 'vol', 'target': '/data', 'type': 'volume'}),
  883. VolumeSpec.parse('vol:/data:rw'),
  884. ],
  885. 'environment': {},
  886. },
  887. override_options={},
  888. )
  889. assert 'binds' in override_opts
  890. assert len(override_opts['binds']) == 1
  891. assert override_opts['binds'][0] == 'vol:/data:rw'
  892. def test_volumes_order_is_preserved(self):
  893. service = Service('foo', client=self.mock_client)
  894. volumes = [
  895. VolumeSpec.parse(cfg) for cfg in [
  896. '/v{0}:/v{0}:rw'.format(i) for i in range(6)
  897. ]
  898. ]
  899. ctnr_opts, override_opts = service._build_container_volume_options(
  900. previous_container=None,
  901. container_options={
  902. 'volumes': volumes,
  903. 'environment': {},
  904. },
  905. override_options={},
  906. )
  907. assert override_opts['binds'] == [vol.repr() for vol in volumes]
  908. class TestServiceNetwork(unittest.TestCase):
  909. def setUp(self):
  910. self.mock_client = mock.create_autospec(docker.APIClient)
  911. self.mock_client.api_version = DEFAULT_DOCKER_API_VERSION
  912. self.mock_client._general_configs = {}
  913. def test_connect_container_to_networks_short_aliase_exists(self):
  914. service = Service(
  915. 'db',
  916. self.mock_client,
  917. 'myproject',
  918. image='foo',
  919. networks={'project_default': {}})
  920. container = Container(
  921. None,
  922. {
  923. 'Id': 'abcdef',
  924. 'NetworkSettings': {
  925. 'Networks': {
  926. 'project_default': {
  927. 'Aliases': ['analias', 'abcdef'],
  928. },
  929. },
  930. },
  931. },
  932. True)
  933. service.connect_container_to_networks(container)
  934. assert not self.mock_client.disconnect_container_from_network.call_count
  935. assert not self.mock_client.connect_container_to_network.call_count
  936. def sort_by_name(dictionary_list):
  937. return sorted(dictionary_list, key=lambda k: k['name'])
  938. class BuildUlimitsTestCase(unittest.TestCase):
  939. def test_build_ulimits_with_dict(self):
  940. ulimits = build_ulimits(
  941. {
  942. 'nofile': {'soft': 10000, 'hard': 20000},
  943. 'nproc': {'soft': 65535, 'hard': 65535}
  944. }
  945. )
  946. expected = [
  947. {'name': 'nofile', 'soft': 10000, 'hard': 20000},
  948. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  949. ]
  950. assert sort_by_name(ulimits) == sort_by_name(expected)
  951. def test_build_ulimits_with_ints(self):
  952. ulimits = build_ulimits({'nofile': 20000, 'nproc': 65535})
  953. expected = [
  954. {'name': 'nofile', 'soft': 20000, 'hard': 20000},
  955. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  956. ]
  957. assert sort_by_name(ulimits) == sort_by_name(expected)
  958. def test_build_ulimits_with_integers_and_dicts(self):
  959. ulimits = build_ulimits(
  960. {
  961. 'nproc': 65535,
  962. 'nofile': {'soft': 10000, 'hard': 20000}
  963. }
  964. )
  965. expected = [
  966. {'name': 'nofile', 'soft': 10000, 'hard': 20000},
  967. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  968. ]
  969. assert sort_by_name(ulimits) == sort_by_name(expected)
  970. class NetTestCase(unittest.TestCase):
  971. def setUp(self):
  972. self.mock_client = mock.create_autospec(docker.APIClient)
  973. self.mock_client.api_version = DEFAULT_DOCKER_API_VERSION
  974. self.mock_client._general_configs = {}
  975. def test_network_mode(self):
  976. network_mode = NetworkMode('host')
  977. assert network_mode.id == 'host'
  978. assert network_mode.mode == 'host'
  979. assert network_mode.service_name is None
  980. def test_network_mode_container(self):
  981. container_id = 'abcd'
  982. network_mode = ContainerNetworkMode(Container(None, {'Id': container_id}))
  983. assert network_mode.id == container_id
  984. assert network_mode.mode == 'container:' + container_id
  985. assert network_mode.service_name is None
  986. def test_network_mode_service(self):
  987. container_id = 'bbbb'
  988. service_name = 'web'
  989. self.mock_client.containers.return_value = [
  990. {'Id': container_id, 'Name': container_id, 'Image': 'abcd'},
  991. ]
  992. service = Service(name=service_name, client=self.mock_client)
  993. network_mode = ServiceNetworkMode(service)
  994. assert network_mode.id == service_name
  995. assert network_mode.mode == 'container:' + container_id
  996. assert network_mode.service_name == service_name
  997. def test_network_mode_service_no_containers(self):
  998. service_name = 'web'
  999. self.mock_client.containers.return_value = []
  1000. service = Service(name=service_name, client=self.mock_client)
  1001. network_mode = ServiceNetworkMode(service)
  1002. assert network_mode.id == service_name
  1003. assert network_mode.mode is None
  1004. assert network_mode.service_name == service_name
  1005. class ServicePortsTest(unittest.TestCase):
  1006. def test_formatted_ports(self):
  1007. ports = [
  1008. '3000',
  1009. '0.0.0.0:4025-4030:23000-23005',
  1010. ServicePort(6000, None, None, None, None),
  1011. ServicePort(8080, 8080, None, None, None),
  1012. ServicePort('20000', '20000', 'udp', 'ingress', None),
  1013. ServicePort(30000, '30000', 'tcp', None, '127.0.0.1'),
  1014. ]
  1015. formatted = formatted_ports(ports)
  1016. assert ports[0] in formatted
  1017. assert ports[1] in formatted
  1018. assert '6000/tcp' in formatted
  1019. assert '8080:8080/tcp' in formatted
  1020. assert '20000:20000/udp' in formatted
  1021. assert '127.0.0.1:30000:30000/tcp' in formatted
  1022. def build_mount(destination, source, mode='rw'):
  1023. return {'Source': source, 'Destination': destination, 'Mode': mode}
  1024. class ServiceVolumesTest(unittest.TestCase):
  1025. def setUp(self):
  1026. self.mock_client = mock.create_autospec(docker.APIClient)
  1027. self.mock_client.api_version = DEFAULT_DOCKER_API_VERSION
  1028. self.mock_client._general_configs = {}
  1029. def test_build_volume_binding(self):
  1030. binding = build_volume_binding(VolumeSpec.parse('/outside:/inside', True))
  1031. assert binding == ('/inside', '/outside:/inside:rw')
  1032. def test_get_container_data_volumes(self):
  1033. options = [VolumeSpec.parse(v) for v in [
  1034. '/host/volume:/host/volume:ro',
  1035. '/new/volume',
  1036. '/existing/volume',
  1037. 'named:/named/vol',
  1038. '/dev/tmpfs'
  1039. ]]
  1040. self.mock_client.inspect_image.return_value = {
  1041. 'ContainerConfig': {
  1042. 'Volumes': {
  1043. '/mnt/image/data': {},
  1044. }
  1045. }
  1046. }
  1047. container = Container(self.mock_client, {
  1048. 'Image': 'ababab',
  1049. 'Mounts': [
  1050. {
  1051. 'Source': '/host/volume',
  1052. 'Destination': '/host/volume',
  1053. 'Mode': '',
  1054. 'RW': True,
  1055. 'Name': 'hostvolume',
  1056. }, {
  1057. 'Source': '/var/lib/docker/aaaaaaaa',
  1058. 'Destination': '/existing/volume',
  1059. 'Mode': '',
  1060. 'RW': True,
  1061. 'Name': 'existingvolume',
  1062. }, {
  1063. 'Source': '/var/lib/docker/bbbbbbbb',
  1064. 'Destination': '/removed/volume',
  1065. 'Mode': '',
  1066. 'RW': True,
  1067. 'Name': 'removedvolume',
  1068. }, {
  1069. 'Source': '/var/lib/docker/cccccccc',
  1070. 'Destination': '/mnt/image/data',
  1071. 'Mode': '',
  1072. 'RW': True,
  1073. 'Name': 'imagedata',
  1074. },
  1075. ]
  1076. }, has_been_inspected=True)
  1077. expected = [
  1078. VolumeSpec.parse('existingvolume:/existing/volume:rw'),
  1079. VolumeSpec.parse('imagedata:/mnt/image/data:rw'),
  1080. ]
  1081. volumes, _ = get_container_data_volumes(container, options, ['/dev/tmpfs'], [])
  1082. assert sorted(volumes) == sorted(expected)
  1083. def test_merge_volume_bindings(self):
  1084. options = [
  1085. VolumeSpec.parse(v, True) for v in [
  1086. '/host/volume:/host/volume:ro',
  1087. '/host/rw/volume:/host/rw/volume',
  1088. '/new/volume',
  1089. '/existing/volume',
  1090. '/dev/tmpfs'
  1091. ]
  1092. ]
  1093. self.mock_client.inspect_image.return_value = {
  1094. 'ContainerConfig': {'Volumes': {}}
  1095. }
  1096. previous_container = Container(self.mock_client, {
  1097. 'Id': 'cdefab',
  1098. 'Image': 'ababab',
  1099. 'Mounts': [{
  1100. 'Source': '/var/lib/docker/aaaaaaaa',
  1101. 'Destination': '/existing/volume',
  1102. 'Mode': '',
  1103. 'RW': True,
  1104. 'Name': 'existingvolume',
  1105. }],
  1106. }, has_been_inspected=True)
  1107. expected = [
  1108. '/host/volume:/host/volume:ro',
  1109. '/host/rw/volume:/host/rw/volume:rw',
  1110. 'existingvolume:/existing/volume:rw',
  1111. ]
  1112. binds, affinity = merge_volume_bindings(options, ['/dev/tmpfs'], previous_container, [])
  1113. assert sorted(binds) == sorted(expected)
  1114. assert affinity == {'affinity:container': '=cdefab'}
  1115. def test_mount_same_host_path_to_two_volumes(self):
  1116. service = Service(
  1117. 'web',
  1118. image='busybox',
  1119. volumes=[
  1120. VolumeSpec.parse('/host/path:/data1', True),
  1121. VolumeSpec.parse('/host/path:/data2', True),
  1122. ],
  1123. client=self.mock_client,
  1124. )
  1125. self.mock_client.inspect_image.return_value = {
  1126. 'Id': 'ababab',
  1127. 'ContainerConfig': {
  1128. 'Volumes': {}
  1129. }
  1130. }
  1131. service._get_container_create_options(
  1132. override_options={},
  1133. number=1,
  1134. )
  1135. assert set(self.mock_client.create_host_config.call_args[1]['binds']) == set([
  1136. '/host/path:/data1:rw',
  1137. '/host/path:/data2:rw',
  1138. ])
  1139. def test_get_container_create_options_with_different_host_path_in_container_json(self):
  1140. service = Service(
  1141. 'web',
  1142. image='busybox',
  1143. volumes=[VolumeSpec.parse('/host/path:/data')],
  1144. client=self.mock_client,
  1145. )
  1146. volume_name = 'abcdefff1234'
  1147. self.mock_client.inspect_image.return_value = {
  1148. 'Id': 'ababab',
  1149. 'ContainerConfig': {
  1150. 'Volumes': {
  1151. '/data': {},
  1152. }
  1153. }
  1154. }
  1155. self.mock_client.inspect_container.return_value = {
  1156. 'Id': '123123123',
  1157. 'Image': 'ababab',
  1158. 'Mounts': [
  1159. {
  1160. 'Destination': '/data',
  1161. 'Source': '/mnt/sda1/host/path',
  1162. 'Mode': '',
  1163. 'RW': True,
  1164. 'Driver': 'local',
  1165. 'Name': volume_name,
  1166. },
  1167. ]
  1168. }
  1169. service._get_container_create_options(
  1170. override_options={},
  1171. number=1,
  1172. previous_container=Container(self.mock_client, {'Id': '123123123'}),
  1173. )
  1174. assert (
  1175. self.mock_client.create_host_config.call_args[1]['binds'] ==
  1176. ['{}:/data:rw'.format(volume_name)]
  1177. )
  1178. def test_warn_on_masked_volume_no_warning_when_no_container_volumes(self):
  1179. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  1180. container_volumes = []
  1181. service = 'service_name'
  1182. with mock.patch('compose.service.log', autospec=True) as mock_log:
  1183. warn_on_masked_volume(volumes_option, container_volumes, service)
  1184. assert not mock_log.warn.called
  1185. def test_warn_on_masked_volume_when_masked(self):
  1186. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  1187. container_volumes = [
  1188. VolumeSpec('/var/lib/docker/path', '/path', 'rw'),
  1189. VolumeSpec('/var/lib/docker/path', '/other', 'rw'),
  1190. ]
  1191. service = 'service_name'
  1192. with mock.patch('compose.service.log', autospec=True) as mock_log:
  1193. warn_on_masked_volume(volumes_option, container_volumes, service)
  1194. mock_log.warn.assert_called_once_with(mock.ANY)
  1195. def test_warn_on_masked_no_warning_with_same_path(self):
  1196. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  1197. container_volumes = [VolumeSpec('/home/user', '/path', 'rw')]
  1198. service = 'service_name'
  1199. with mock.patch('compose.service.log', autospec=True) as mock_log:
  1200. warn_on_masked_volume(volumes_option, container_volumes, service)
  1201. assert not mock_log.warn.called
  1202. def test_warn_on_masked_no_warning_with_container_only_option(self):
  1203. volumes_option = [VolumeSpec(None, '/path', 'rw')]
  1204. container_volumes = [
  1205. VolumeSpec('/var/lib/docker/volume/path', '/path', 'rw')
  1206. ]
  1207. service = 'service_name'
  1208. with mock.patch('compose.service.log', autospec=True) as mock_log:
  1209. warn_on_masked_volume(volumes_option, container_volumes, service)
  1210. assert not mock_log.warn.called
  1211. def test_create_with_special_volume_mode(self):
  1212. self.mock_client.inspect_image.return_value = {'Id': 'imageid'}
  1213. self.mock_client.create_container.return_value = {'Id': 'containerid'}
  1214. volume = '/tmp:/foo:z'
  1215. Service(
  1216. 'web',
  1217. client=self.mock_client,
  1218. image='busybox',
  1219. volumes=[VolumeSpec.parse(volume, True)],
  1220. ).create_container()
  1221. assert self.mock_client.create_container.call_count == 1
  1222. assert self.mock_client.create_host_config.call_args[1]['binds'] == [volume]
  1223. class ServiceSecretTest(unittest.TestCase):
  1224. def setUp(self):
  1225. self.mock_client = mock.create_autospec(docker.APIClient)
  1226. self.mock_client.api_version = DEFAULT_DOCKER_API_VERSION
  1227. self.mock_client._general_configs = {}
  1228. def test_get_secret_volumes(self):
  1229. secret1 = {
  1230. 'secret': ServiceSecret.parse({'source': 'secret1', 'target': 'b.txt'}),
  1231. 'file': 'a.txt'
  1232. }
  1233. service = Service(
  1234. 'web',
  1235. client=self.mock_client,
  1236. image='busybox',
  1237. secrets=[secret1]
  1238. )
  1239. volumes = service.get_secret_volumes()
  1240. assert volumes[0].source == secret1['file']
  1241. assert volumes[0].target == '{}/{}'.format(SECRETS_PATH, secret1['secret'].target)
  1242. def test_get_secret_volumes_abspath(self):
  1243. secret1 = {
  1244. 'secret': ServiceSecret.parse({'source': 'secret1', 'target': '/d.txt'}),
  1245. 'file': 'c.txt'
  1246. }
  1247. service = Service(
  1248. 'web',
  1249. client=self.mock_client,
  1250. image='busybox',
  1251. secrets=[secret1]
  1252. )
  1253. volumes = service.get_secret_volumes()
  1254. assert volumes[0].source == secret1['file']
  1255. assert volumes[0].target == secret1['secret'].target
  1256. def test_get_secret_volumes_no_target(self):
  1257. secret1 = {
  1258. 'secret': ServiceSecret.parse({'source': 'secret1'}),
  1259. 'file': 'c.txt'
  1260. }
  1261. service = Service(
  1262. 'web',
  1263. client=self.mock_client,
  1264. image='busybox',
  1265. secrets=[secret1]
  1266. )
  1267. volumes = service.get_secret_volumes()
  1268. assert volumes[0].source == secret1['file']
  1269. assert volumes[0].target == '{}/{}'.format(SECRETS_PATH, secret1['secret'].source)
  1270. class RewriteBuildPathTest(unittest.TestCase):
  1271. @mock.patch('compose.service.IS_WINDOWS_PLATFORM', True)
  1272. def test_rewrite_url_no_prefix(self):
  1273. urls = [
  1274. 'http://test.com',
  1275. 'https://test.com',
  1276. 'git://test.com',
  1277. 'github.com/test/test',
  1278. '[email protected]',
  1279. ]
  1280. for u in urls:
  1281. assert rewrite_build_path(u) == u
  1282. @mock.patch('compose.service.IS_WINDOWS_PLATFORM', True)
  1283. def test_rewrite_windows_path(self):
  1284. assert rewrite_build_path('C:\\context') == WINDOWS_LONGPATH_PREFIX + 'C:\\context'
  1285. assert rewrite_build_path(
  1286. rewrite_build_path('C:\\context')
  1287. ) == rewrite_build_path('C:\\context')
  1288. @mock.patch('compose.service.IS_WINDOWS_PLATFORM', False)
  1289. def test_rewrite_unix_path(self):
  1290. assert rewrite_build_path('/context') == '/context'