service_test.py 30 KB

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