service_test.py 29 KB

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