service_test.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import docker
  4. from .. import mock
  5. from .. import unittest
  6. from compose.config.types import VolumeFromSpec
  7. from compose.config.types import VolumeSpec
  8. from compose.const import LABEL_CONFIG_HASH
  9. from compose.const import LABEL_ONE_OFF
  10. from compose.const import LABEL_PROJECT
  11. from compose.const import LABEL_SERVICE
  12. from compose.container import Container
  13. from compose.service import build_ulimits
  14. from compose.service import build_volume_binding
  15. from compose.service import ContainerNet
  16. from compose.service import get_container_data_volumes
  17. from compose.service import merge_volume_bindings
  18. from compose.service import NeedsBuildError
  19. from compose.service import Net
  20. from compose.service import NoSuchImageError
  21. from compose.service import parse_repository_tag
  22. from compose.service import Service
  23. from compose.service import ServiceNet
  24. from compose.service import VolumeFromSpec
  25. from compose.service import VolumeSpec
  26. from compose.service import warn_on_masked_volume
  27. class ServiceTest(unittest.TestCase):
  28. def setUp(self):
  29. self.mock_client = mock.create_autospec(docker.Client)
  30. def test_containers(self):
  31. service = Service('db', self.mock_client, 'myproject', image='foo')
  32. self.mock_client.containers.return_value = []
  33. self.assertEqual(list(service.containers()), [])
  34. def test_containers_with_containers(self):
  35. self.mock_client.containers.return_value = [
  36. dict(Name=str(i), Image='foo', Id=i) for i in range(3)
  37. ]
  38. service = Service('db', self.mock_client, 'myproject', image='foo')
  39. self.assertEqual([c.id for c in service.containers()], list(range(3)))
  40. expected_labels = [
  41. '{0}=myproject'.format(LABEL_PROJECT),
  42. '{0}=db'.format(LABEL_SERVICE),
  43. '{0}=False'.format(LABEL_ONE_OFF),
  44. ]
  45. self.mock_client.containers.assert_called_once_with(
  46. all=False,
  47. filters={'label': expected_labels})
  48. def test_container_without_name(self):
  49. self.mock_client.containers.return_value = [
  50. {'Image': 'foo', 'Id': '1', 'Name': '1'},
  51. {'Image': 'foo', 'Id': '2', 'Name': None},
  52. {'Image': 'foo', 'Id': '3'},
  53. ]
  54. service = Service('db', self.mock_client, 'myproject', image='foo')
  55. self.assertEqual([c.id for c in service.containers()], ['1'])
  56. self.assertEqual(service._next_container_number(), 2)
  57. self.assertEqual(service.get_container(1).id, '1')
  58. def test_get_volumes_from_container(self):
  59. container_id = 'aabbccddee'
  60. service = Service(
  61. 'test',
  62. image='foo',
  63. volumes_from=[VolumeFromSpec(mock.Mock(id=container_id, spec=Container), 'rw')])
  64. self.assertEqual(service._get_volumes_from(), [container_id + ':rw'])
  65. def test_get_volumes_from_container_read_only(self):
  66. container_id = 'aabbccddee'
  67. service = Service(
  68. 'test',
  69. image='foo',
  70. volumes_from=[VolumeFromSpec(mock.Mock(id=container_id, spec=Container), 'ro')])
  71. self.assertEqual(service._get_volumes_from(), [container_id + ':ro'])
  72. def test_get_volumes_from_service_container_exists(self):
  73. container_ids = ['aabbccddee', '12345']
  74. from_service = mock.create_autospec(Service)
  75. from_service.containers.return_value = [
  76. mock.Mock(id=container_id, spec=Container)
  77. for container_id in container_ids
  78. ]
  79. service = Service('test', volumes_from=[VolumeFromSpec(from_service, 'rw')], image='foo')
  80. self.assertEqual(service._get_volumes_from(), [container_ids[0] + ":rw"])
  81. def test_get_volumes_from_service_container_exists_with_flags(self):
  82. for mode in ['ro', 'rw', 'z', 'rw,z', 'z,rw']:
  83. container_ids = ['aabbccddee:' + mode, '12345:' + mode]
  84. from_service = mock.create_autospec(Service)
  85. from_service.containers.return_value = [
  86. mock.Mock(id=container_id.split(':')[0], spec=Container)
  87. for container_id in container_ids
  88. ]
  89. service = Service('test', volumes_from=[VolumeFromSpec(from_service, mode)], image='foo')
  90. self.assertEqual(service._get_volumes_from(), [container_ids[0]])
  91. def test_get_volumes_from_service_no_container(self):
  92. container_id = 'abababab'
  93. from_service = mock.create_autospec(Service)
  94. from_service.containers.return_value = []
  95. from_service.create_container.return_value = mock.Mock(
  96. id=container_id,
  97. spec=Container)
  98. service = Service('test', image='foo', volumes_from=[VolumeFromSpec(from_service, 'rw')])
  99. self.assertEqual(service._get_volumes_from(), [container_id + ':rw'])
  100. from_service.create_container.assert_called_once_with()
  101. def test_split_domainname_none(self):
  102. service = Service('foo', image='foo', hostname='name', client=self.mock_client)
  103. opts = service._get_container_create_options({'image': 'foo'}, 1)
  104. self.assertEqual(opts['hostname'], 'name', 'hostname')
  105. self.assertFalse('domainname' in opts, 'domainname')
  106. def test_memory_swap_limit(self):
  107. self.mock_client.create_host_config.return_value = {}
  108. service = Service(name='foo', image='foo', hostname='name', client=self.mock_client, mem_limit=1000000000, memswap_limit=2000000000)
  109. service._get_container_create_options({'some': 'overrides'}, 1)
  110. self.assertTrue(self.mock_client.create_host_config.called)
  111. self.assertEqual(
  112. self.mock_client.create_host_config.call_args[1]['mem_limit'],
  113. 1000000000
  114. )
  115. self.assertEqual(
  116. self.mock_client.create_host_config.call_args[1]['memswap_limit'],
  117. 2000000000
  118. )
  119. def test_cgroup_parent(self):
  120. self.mock_client.create_host_config.return_value = {}
  121. service = Service(name='foo', image='foo', hostname='name', client=self.mock_client, cgroup_parent='test')
  122. service._get_container_create_options({'some': 'overrides'}, 1)
  123. self.assertTrue(self.mock_client.create_host_config.called)
  124. self.assertEqual(
  125. self.mock_client.create_host_config.call_args[1]['cgroup_parent'],
  126. 'test'
  127. )
  128. def test_log_opt(self):
  129. self.mock_client.create_host_config.return_value = {}
  130. log_opt = {'syslog-address': 'tcp://192.168.0.42:123'}
  131. service = Service(name='foo', image='foo', hostname='name', client=self.mock_client, log_driver='syslog', log_opt=log_opt)
  132. service._get_container_create_options({'some': 'overrides'}, 1)
  133. self.assertTrue(self.mock_client.create_host_config.called)
  134. self.assertEqual(
  135. self.mock_client.create_host_config.call_args[1]['log_config'],
  136. {'Type': 'syslog', 'Config': {'syslog-address': 'tcp://192.168.0.42:123'}}
  137. )
  138. def test_split_domainname_fqdn(self):
  139. service = Service(
  140. 'foo',
  141. hostname='name.domain.tld',
  142. image='foo',
  143. client=self.mock_client)
  144. opts = service._get_container_create_options({'image': 'foo'}, 1)
  145. self.assertEqual(opts['hostname'], 'name', 'hostname')
  146. self.assertEqual(opts['domainname'], 'domain.tld', 'domainname')
  147. def test_split_domainname_both(self):
  148. service = Service(
  149. 'foo',
  150. hostname='name',
  151. image='foo',
  152. domainname='domain.tld',
  153. client=self.mock_client)
  154. opts = service._get_container_create_options({'image': 'foo'}, 1)
  155. self.assertEqual(opts['hostname'], 'name', 'hostname')
  156. self.assertEqual(opts['domainname'], 'domain.tld', 'domainname')
  157. def test_split_domainname_weird(self):
  158. service = Service(
  159. 'foo',
  160. hostname='name.sub',
  161. domainname='domain.tld',
  162. image='foo',
  163. client=self.mock_client)
  164. opts = service._get_container_create_options({'image': 'foo'}, 1)
  165. self.assertEqual(opts['hostname'], 'name.sub', 'hostname')
  166. self.assertEqual(opts['domainname'], 'domain.tld', 'domainname')
  167. def test_no_default_hostname_when_not_using_networking(self):
  168. service = Service(
  169. 'foo',
  170. image='foo',
  171. use_networking=False,
  172. client=self.mock_client,
  173. )
  174. opts = service._get_container_create_options({'image': 'foo'}, 1)
  175. self.assertIsNone(opts.get('hostname'))
  176. def test_get_container_create_options_with_name_option(self):
  177. service = Service(
  178. 'foo',
  179. image='foo',
  180. client=self.mock_client,
  181. container_name='foo1')
  182. name = 'the_new_name'
  183. opts = service._get_container_create_options(
  184. {'name': name},
  185. 1,
  186. one_off=True)
  187. self.assertEqual(opts['name'], name)
  188. def test_get_container_create_options_does_not_mutate_options(self):
  189. labels = {'thing': 'real'}
  190. environment = {'also': 'real'}
  191. service = Service(
  192. 'foo',
  193. image='foo',
  194. labels=dict(labels),
  195. client=self.mock_client,
  196. environment=dict(environment),
  197. )
  198. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  199. prev_container = mock.Mock(
  200. id='ababab',
  201. image_config={'ContainerConfig': {}})
  202. opts = service._get_container_create_options(
  203. {},
  204. 1,
  205. previous_container=prev_container)
  206. self.assertEqual(service.options['labels'], labels)
  207. self.assertEqual(service.options['environment'], environment)
  208. self.assertEqual(
  209. opts['labels'][LABEL_CONFIG_HASH],
  210. '3c85881a8903b9d73a06c41860c8be08acce1494ab4cf8408375966dccd714de')
  211. self.assertEqual(
  212. opts['environment'],
  213. {
  214. 'affinity:container': '=ababab',
  215. 'also': 'real',
  216. }
  217. )
  218. def test_get_container_not_found(self):
  219. self.mock_client.containers.return_value = []
  220. service = Service('foo', client=self.mock_client, image='foo')
  221. self.assertRaises(ValueError, service.get_container)
  222. @mock.patch('compose.service.Container', autospec=True)
  223. def test_get_container(self, mock_container_class):
  224. container_dict = dict(Name='default_foo_2')
  225. self.mock_client.containers.return_value = [container_dict]
  226. service = Service('foo', image='foo', client=self.mock_client)
  227. container = service.get_container(number=2)
  228. self.assertEqual(container, mock_container_class.from_ps.return_value)
  229. mock_container_class.from_ps.assert_called_once_with(
  230. self.mock_client, container_dict)
  231. @mock.patch('compose.service.log', autospec=True)
  232. def test_pull_image(self, mock_log):
  233. service = Service('foo', client=self.mock_client, image='someimage:sometag')
  234. service.pull()
  235. self.mock_client.pull.assert_called_once_with(
  236. 'someimage',
  237. tag='sometag',
  238. stream=True)
  239. mock_log.info.assert_called_once_with('Pulling foo (someimage:sometag)...')
  240. def test_pull_image_no_tag(self):
  241. service = Service('foo', client=self.mock_client, image='ababab')
  242. service.pull()
  243. self.mock_client.pull.assert_called_once_with(
  244. 'ababab',
  245. tag='latest',
  246. stream=True)
  247. @mock.patch('compose.service.log', autospec=True)
  248. def test_pull_image_digest(self, mock_log):
  249. service = Service('foo', client=self.mock_client, image='someimage@sha256:1234')
  250. service.pull()
  251. self.mock_client.pull.assert_called_once_with(
  252. 'someimage',
  253. tag='sha256:1234',
  254. stream=True)
  255. mock_log.info.assert_called_once_with('Pulling foo (someimage@sha256:1234)...')
  256. @mock.patch('compose.service.Container', autospec=True)
  257. def test_recreate_container(self, _):
  258. mock_container = mock.create_autospec(Container)
  259. service = Service('foo', client=self.mock_client, image='someimage')
  260. service.image = lambda: {'Id': 'abc123'}
  261. new_container = service.recreate_container(mock_container)
  262. mock_container.stop.assert_called_once_with(timeout=10)
  263. mock_container.rename_to_tmp_name.assert_called_once_with()
  264. new_container.start.assert_called_once_with()
  265. mock_container.remove.assert_called_once_with()
  266. @mock.patch('compose.service.Container', autospec=True)
  267. def test_recreate_container_with_timeout(self, _):
  268. mock_container = mock.create_autospec(Container)
  269. self.mock_client.inspect_image.return_value = {'Id': 'abc123'}
  270. service = Service('foo', client=self.mock_client, image='someimage')
  271. service.recreate_container(mock_container, timeout=1)
  272. mock_container.stop.assert_called_once_with(timeout=1)
  273. def test_parse_repository_tag(self):
  274. self.assertEqual(parse_repository_tag("root"), ("root", "", ":"))
  275. self.assertEqual(parse_repository_tag("root:tag"), ("root", "tag", ":"))
  276. self.assertEqual(parse_repository_tag("user/repo"), ("user/repo", "", ":"))
  277. self.assertEqual(parse_repository_tag("user/repo:tag"), ("user/repo", "tag", ":"))
  278. self.assertEqual(parse_repository_tag("url:5000/repo"), ("url:5000/repo", "", ":"))
  279. self.assertEqual(parse_repository_tag("url:5000/repo:tag"), ("url:5000/repo", "tag", ":"))
  280. self.assertEqual(parse_repository_tag("root@sha256:digest"), ("root", "sha256:digest", "@"))
  281. self.assertEqual(parse_repository_tag("user/repo@sha256:digest"), ("user/repo", "sha256:digest", "@"))
  282. self.assertEqual(parse_repository_tag("url:5000/repo@sha256:digest"), ("url:5000/repo", "sha256:digest", "@"))
  283. def test_create_container_with_build(self):
  284. service = Service('foo', client=self.mock_client, build='.')
  285. self.mock_client.inspect_image.side_effect = [
  286. NoSuchImageError,
  287. {'Id': 'abc123'},
  288. ]
  289. self.mock_client.build.return_value = [
  290. '{"stream": "Successfully built abcd"}',
  291. ]
  292. service.create_container(do_build=True)
  293. self.mock_client.build.assert_called_once_with(
  294. tag='default_foo',
  295. dockerfile=None,
  296. stream=True,
  297. path='.',
  298. pull=False,
  299. forcerm=False,
  300. nocache=False,
  301. rm=True,
  302. )
  303. def test_create_container_no_build(self):
  304. service = Service('foo', client=self.mock_client, build='.')
  305. self.mock_client.inspect_image.return_value = {'Id': 'abc123'}
  306. service.create_container(do_build=False)
  307. self.assertFalse(self.mock_client.build.called)
  308. def test_create_container_no_build_but_needs_build(self):
  309. service = Service('foo', client=self.mock_client, build='.')
  310. self.mock_client.inspect_image.side_effect = NoSuchImageError
  311. with self.assertRaises(NeedsBuildError):
  312. service.create_container(do_build=False)
  313. def test_build_does_not_pull(self):
  314. self.mock_client.build.return_value = [
  315. b'{"stream": "Successfully built 12345"}',
  316. ]
  317. service = Service('foo', client=self.mock_client, build='.')
  318. service.build()
  319. self.assertEqual(self.mock_client.build.call_count, 1)
  320. self.assertFalse(self.mock_client.build.call_args[1]['pull'])
  321. def test_config_dict(self):
  322. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  323. service = Service(
  324. 'foo',
  325. image='example.com/foo',
  326. client=self.mock_client,
  327. net=ServiceNet(Service('other')),
  328. links=[(Service('one'), 'one')],
  329. volumes_from=[VolumeFromSpec(Service('two'), 'rw')])
  330. config_dict = service.config_dict()
  331. expected = {
  332. 'image_id': 'abcd',
  333. 'options': {'image': 'example.com/foo'},
  334. 'links': [('one', 'one')],
  335. 'net': 'other',
  336. 'volumes_from': [('two', 'rw')],
  337. }
  338. self.assertEqual(config_dict, expected)
  339. def test_config_dict_with_net_from_container(self):
  340. self.mock_client.inspect_image.return_value = {'Id': 'abcd'}
  341. container = Container(
  342. self.mock_client,
  343. {'Id': 'aaabbb', 'Name': '/foo_1'})
  344. service = Service(
  345. 'foo',
  346. image='example.com/foo',
  347. client=self.mock_client,
  348. net=container)
  349. config_dict = service.config_dict()
  350. expected = {
  351. 'image_id': 'abcd',
  352. 'options': {'image': 'example.com/foo'},
  353. 'links': [],
  354. 'net': 'aaabbb',
  355. 'volumes_from': [],
  356. }
  357. self.assertEqual(config_dict, expected)
  358. def test_specifies_host_port_with_no_ports(self):
  359. service = Service(
  360. 'foo',
  361. image='foo')
  362. self.assertEqual(service.specifies_host_port(), False)
  363. def test_specifies_host_port_with_container_port(self):
  364. service = Service(
  365. 'foo',
  366. image='foo',
  367. ports=["2000"])
  368. self.assertEqual(service.specifies_host_port(), False)
  369. def test_specifies_host_port_with_host_port(self):
  370. service = Service(
  371. 'foo',
  372. image='foo',
  373. ports=["1000:2000"])
  374. self.assertEqual(service.specifies_host_port(), True)
  375. def test_specifies_host_port_with_host_ip_no_port(self):
  376. service = Service(
  377. 'foo',
  378. image='foo',
  379. ports=["127.0.0.1::2000"])
  380. self.assertEqual(service.specifies_host_port(), False)
  381. def test_specifies_host_port_with_host_ip_and_port(self):
  382. service = Service(
  383. 'foo',
  384. image='foo',
  385. ports=["127.0.0.1:1000:2000"])
  386. self.assertEqual(service.specifies_host_port(), True)
  387. def test_specifies_host_port_with_container_port_range(self):
  388. service = Service(
  389. 'foo',
  390. image='foo',
  391. ports=["2000-3000"])
  392. self.assertEqual(service.specifies_host_port(), False)
  393. def test_specifies_host_port_with_host_port_range(self):
  394. service = Service(
  395. 'foo',
  396. image='foo',
  397. ports=["1000-2000:2000-3000"])
  398. self.assertEqual(service.specifies_host_port(), True)
  399. def test_specifies_host_port_with_host_ip_no_port_range(self):
  400. service = Service(
  401. 'foo',
  402. image='foo',
  403. ports=["127.0.0.1::2000-3000"])
  404. self.assertEqual(service.specifies_host_port(), False)
  405. def test_specifies_host_port_with_host_ip_and_port_range(self):
  406. service = Service(
  407. 'foo',
  408. image='foo',
  409. ports=["127.0.0.1:1000-2000:2000-3000"])
  410. self.assertEqual(service.specifies_host_port(), True)
  411. def test_get_links_with_networking(self):
  412. service = Service(
  413. 'foo',
  414. image='foo',
  415. links=[(Service('one'), 'one')],
  416. use_networking=True)
  417. self.assertEqual(service._get_links(link_to_self=True), [])
  418. def sort_by_name(dictionary_list):
  419. return sorted(dictionary_list, key=lambda k: k['name'])
  420. class BuildUlimitsTestCase(unittest.TestCase):
  421. def test_build_ulimits_with_dict(self):
  422. ulimits = build_ulimits(
  423. {
  424. 'nofile': {'soft': 10000, 'hard': 20000},
  425. 'nproc': {'soft': 65535, 'hard': 65535}
  426. }
  427. )
  428. expected = [
  429. {'name': 'nofile', 'soft': 10000, 'hard': 20000},
  430. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  431. ]
  432. assert sort_by_name(ulimits) == sort_by_name(expected)
  433. def test_build_ulimits_with_ints(self):
  434. ulimits = build_ulimits({'nofile': 20000, 'nproc': 65535})
  435. expected = [
  436. {'name': 'nofile', 'soft': 20000, 'hard': 20000},
  437. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  438. ]
  439. assert sort_by_name(ulimits) == sort_by_name(expected)
  440. def test_build_ulimits_with_integers_and_dicts(self):
  441. ulimits = build_ulimits(
  442. {
  443. 'nproc': 65535,
  444. 'nofile': {'soft': 10000, 'hard': 20000}
  445. }
  446. )
  447. expected = [
  448. {'name': 'nofile', 'soft': 10000, 'hard': 20000},
  449. {'name': 'nproc', 'soft': 65535, 'hard': 65535}
  450. ]
  451. assert sort_by_name(ulimits) == sort_by_name(expected)
  452. class NetTestCase(unittest.TestCase):
  453. def test_net(self):
  454. net = Net('host')
  455. self.assertEqual(net.id, 'host')
  456. self.assertEqual(net.mode, 'host')
  457. self.assertEqual(net.service_name, None)
  458. def test_net_container(self):
  459. container_id = 'abcd'
  460. net = ContainerNet(Container(None, {'Id': container_id}))
  461. self.assertEqual(net.id, container_id)
  462. self.assertEqual(net.mode, 'container:' + container_id)
  463. self.assertEqual(net.service_name, None)
  464. def test_net_service(self):
  465. container_id = 'bbbb'
  466. service_name = 'web'
  467. mock_client = mock.create_autospec(docker.Client)
  468. mock_client.containers.return_value = [
  469. {'Id': container_id, 'Name': container_id, 'Image': 'abcd'},
  470. ]
  471. service = Service(name=service_name, client=mock_client)
  472. net = ServiceNet(service)
  473. self.assertEqual(net.id, service_name)
  474. self.assertEqual(net.mode, 'container:' + container_id)
  475. self.assertEqual(net.service_name, service_name)
  476. def test_net_service_no_containers(self):
  477. service_name = 'web'
  478. mock_client = mock.create_autospec(docker.Client)
  479. mock_client.containers.return_value = []
  480. service = Service(name=service_name, client=mock_client)
  481. net = ServiceNet(service)
  482. self.assertEqual(net.id, service_name)
  483. self.assertEqual(net.mode, None)
  484. self.assertEqual(net.service_name, service_name)
  485. class ServiceVolumesTest(unittest.TestCase):
  486. def setUp(self):
  487. self.mock_client = mock.create_autospec(docker.Client)
  488. def test_build_volume_binding(self):
  489. binding = build_volume_binding(VolumeSpec.parse('/outside:/inside'))
  490. assert binding == ('/inside', '/outside:/inside:rw')
  491. def test_get_container_data_volumes(self):
  492. options = [VolumeSpec.parse(v) for v in [
  493. '/host/volume:/host/volume:ro',
  494. '/new/volume',
  495. '/existing/volume',
  496. ]]
  497. self.mock_client.inspect_image.return_value = {
  498. 'ContainerConfig': {
  499. 'Volumes': {
  500. '/mnt/image/data': {},
  501. }
  502. }
  503. }
  504. container = Container(self.mock_client, {
  505. 'Image': 'ababab',
  506. 'Volumes': {
  507. '/host/volume': '/host/volume',
  508. '/existing/volume': '/var/lib/docker/aaaaaaaa',
  509. '/removed/volume': '/var/lib/docker/bbbbbbbb',
  510. '/mnt/image/data': '/var/lib/docker/cccccccc',
  511. },
  512. }, has_been_inspected=True)
  513. expected = [
  514. VolumeSpec.parse('/var/lib/docker/aaaaaaaa:/existing/volume:rw'),
  515. VolumeSpec.parse('/var/lib/docker/cccccccc:/mnt/image/data:rw'),
  516. ]
  517. volumes = get_container_data_volumes(container, options)
  518. assert sorted(volumes) == sorted(expected)
  519. def test_merge_volume_bindings(self):
  520. options = [
  521. VolumeSpec.parse('/host/volume:/host/volume:ro'),
  522. VolumeSpec.parse('/host/rw/volume:/host/rw/volume'),
  523. VolumeSpec.parse('/new/volume'),
  524. VolumeSpec.parse('/existing/volume'),
  525. ]
  526. self.mock_client.inspect_image.return_value = {
  527. 'ContainerConfig': {'Volumes': {}}
  528. }
  529. intermediate_container = Container(self.mock_client, {
  530. 'Image': 'ababab',
  531. 'Volumes': {'/existing/volume': '/var/lib/docker/aaaaaaaa'},
  532. }, has_been_inspected=True)
  533. expected = [
  534. '/host/volume:/host/volume:ro',
  535. '/host/rw/volume:/host/rw/volume:rw',
  536. '/var/lib/docker/aaaaaaaa:/existing/volume:rw',
  537. ]
  538. binds = merge_volume_bindings(options, intermediate_container)
  539. self.assertEqual(set(binds), set(expected))
  540. def test_mount_same_host_path_to_two_volumes(self):
  541. service = Service(
  542. 'web',
  543. image='busybox',
  544. volumes=[
  545. VolumeSpec.parse('/host/path:/data1'),
  546. VolumeSpec.parse('/host/path:/data2'),
  547. ],
  548. client=self.mock_client,
  549. )
  550. self.mock_client.inspect_image.return_value = {
  551. 'Id': 'ababab',
  552. 'ContainerConfig': {
  553. 'Volumes': {}
  554. }
  555. }
  556. service._get_container_create_options(
  557. override_options={},
  558. number=1,
  559. )
  560. self.assertEqual(
  561. set(self.mock_client.create_host_config.call_args[1]['binds']),
  562. set([
  563. '/host/path:/data1:rw',
  564. '/host/path:/data2:rw',
  565. ]),
  566. )
  567. def test_different_host_path_in_container_json(self):
  568. service = Service(
  569. 'web',
  570. image='busybox',
  571. volumes=[VolumeSpec.parse('/host/path:/data')],
  572. client=self.mock_client,
  573. )
  574. self.mock_client.inspect_image.return_value = {
  575. 'Id': 'ababab',
  576. 'ContainerConfig': {
  577. 'Volumes': {
  578. '/data': {},
  579. }
  580. }
  581. }
  582. self.mock_client.inspect_container.return_value = {
  583. 'Id': '123123123',
  584. 'Image': 'ababab',
  585. 'Volumes': {
  586. '/data': '/mnt/sda1/host/path',
  587. },
  588. }
  589. service._get_container_create_options(
  590. override_options={},
  591. number=1,
  592. previous_container=Container(self.mock_client, {'Id': '123123123'}),
  593. )
  594. self.assertEqual(
  595. self.mock_client.create_host_config.call_args[1]['binds'],
  596. ['/mnt/sda1/host/path:/data:rw'],
  597. )
  598. def test_warn_on_masked_volume_no_warning_when_no_container_volumes(self):
  599. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  600. container_volumes = []
  601. service = 'service_name'
  602. with mock.patch('compose.service.log') as mock_log:
  603. warn_on_masked_volume(volumes_option, container_volumes, service)
  604. assert not mock_log.warn.called
  605. def test_warn_on_masked_volume_when_masked(self):
  606. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  607. container_volumes = [
  608. VolumeSpec('/var/lib/docker/path', '/path', 'rw'),
  609. VolumeSpec('/var/lib/docker/path', '/other', 'rw'),
  610. ]
  611. service = 'service_name'
  612. with mock.patch('compose.service.log') as mock_log:
  613. warn_on_masked_volume(volumes_option, container_volumes, service)
  614. mock_log.warn.called_once_with(mock.ANY)
  615. def test_warn_on_masked_no_warning_with_same_path(self):
  616. volumes_option = [VolumeSpec('/home/user', '/path', 'rw')]
  617. container_volumes = [VolumeSpec('/home/user', '/path', 'rw')]
  618. service = 'service_name'
  619. with mock.patch('compose.service.log') as mock_log:
  620. warn_on_masked_volume(volumes_option, container_volumes, service)
  621. assert not mock_log.warn.called
  622. def test_create_with_special_volume_mode(self):
  623. self.mock_client.inspect_image.return_value = {'Id': 'imageid'}
  624. self.mock_client.create_container.return_value = {'Id': 'containerid'}
  625. volume = '/tmp:/foo:z'
  626. Service(
  627. 'web',
  628. client=self.mock_client,
  629. image='busybox',
  630. volumes=[VolumeSpec.parse(volume)],
  631. ).create_container()
  632. assert self.mock_client.create_container.call_count == 1
  633. self.assertEqual(
  634. self.mock_client.create_host_config.call_args[1]['binds'],
  635. [volume])