service_test.py 29 KB

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