service_test.py 29 KB

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