service_test.py 28 KB

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