service_test.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713
  1. from __future__ import unicode_literals
  2. from __future__ import absolute_import
  3. import os
  4. from os import path
  5. import mock
  6. import tempfile
  7. import shutil
  8. import six
  9. from compose import __version__
  10. from compose.const import (
  11. LABEL_CONTAINER_NUMBER,
  12. LABEL_ONE_OFF,
  13. LABEL_PROJECT,
  14. LABEL_SERVICE,
  15. LABEL_VERSION,
  16. )
  17. from compose.service import (
  18. ConfigError,
  19. Service,
  20. build_extra_hosts,
  21. )
  22. from compose.container import Container
  23. from docker.errors import APIError
  24. from .testcases import DockerClientTestCase
  25. def create_and_start_container(service, **override_options):
  26. container = service.create_container(**override_options)
  27. return service.start_container(container)
  28. class ServiceTest(DockerClientTestCase):
  29. def test_containers(self):
  30. foo = self.create_service('foo')
  31. bar = self.create_service('bar')
  32. create_and_start_container(foo)
  33. self.assertEqual(len(foo.containers()), 1)
  34. self.assertEqual(foo.containers()[0].name, 'composetest_foo_1')
  35. self.assertEqual(len(bar.containers()), 0)
  36. create_and_start_container(bar)
  37. create_and_start_container(bar)
  38. self.assertEqual(len(foo.containers()), 1)
  39. self.assertEqual(len(bar.containers()), 2)
  40. names = [c.name for c in bar.containers()]
  41. self.assertIn('composetest_bar_1', names)
  42. self.assertIn('composetest_bar_2', names)
  43. def test_containers_one_off(self):
  44. db = self.create_service('db')
  45. container = db.create_container(one_off=True)
  46. self.assertEqual(db.containers(stopped=True), [])
  47. self.assertEqual(db.containers(one_off=True, stopped=True), [container])
  48. def test_project_is_added_to_container_name(self):
  49. service = self.create_service('web')
  50. create_and_start_container(service)
  51. self.assertEqual(service.containers()[0].name, 'composetest_web_1')
  52. def test_start_stop(self):
  53. service = self.create_service('scalingtest')
  54. self.assertEqual(len(service.containers(stopped=True)), 0)
  55. service.create_container()
  56. self.assertEqual(len(service.containers()), 0)
  57. self.assertEqual(len(service.containers(stopped=True)), 1)
  58. service.start()
  59. self.assertEqual(len(service.containers()), 1)
  60. self.assertEqual(len(service.containers(stopped=True)), 1)
  61. service.stop(timeout=1)
  62. self.assertEqual(len(service.containers()), 0)
  63. self.assertEqual(len(service.containers(stopped=True)), 1)
  64. service.stop(timeout=1)
  65. self.assertEqual(len(service.containers()), 0)
  66. self.assertEqual(len(service.containers(stopped=True)), 1)
  67. def test_kill_remove(self):
  68. service = self.create_service('scalingtest')
  69. create_and_start_container(service)
  70. self.assertEqual(len(service.containers()), 1)
  71. service.remove_stopped()
  72. self.assertEqual(len(service.containers()), 1)
  73. service.kill()
  74. self.assertEqual(len(service.containers()), 0)
  75. self.assertEqual(len(service.containers(stopped=True)), 1)
  76. service.remove_stopped()
  77. self.assertEqual(len(service.containers(stopped=True)), 0)
  78. def test_create_container_with_one_off(self):
  79. db = self.create_service('db')
  80. container = db.create_container(one_off=True)
  81. self.assertEqual(container.name, 'composetest_db_run_1')
  82. def test_create_container_with_one_off_when_existing_container_is_running(self):
  83. db = self.create_service('db')
  84. db.start()
  85. container = db.create_container(one_off=True)
  86. self.assertEqual(container.name, 'composetest_db_run_1')
  87. def test_create_container_with_unspecified_volume(self):
  88. service = self.create_service('db', volumes=['/var/db'])
  89. container = service.create_container()
  90. service.start_container(container)
  91. self.assertIn('/var/db', container.get('Volumes'))
  92. def test_create_container_with_cpu_shares(self):
  93. service = self.create_service('db', cpu_shares=73)
  94. container = service.create_container()
  95. service.start_container(container)
  96. self.assertEqual(container.inspect()['Config']['CpuShares'], 73)
  97. def test_build_extra_hosts(self):
  98. # string
  99. self.assertRaises(ConfigError, lambda: build_extra_hosts("www.example.com: 192.168.0.17"))
  100. # list of strings
  101. self.assertEqual(build_extra_hosts(
  102. ["www.example.com:192.168.0.17"]),
  103. {'www.example.com': '192.168.0.17'})
  104. self.assertEqual(build_extra_hosts(
  105. ["www.example.com: 192.168.0.17"]),
  106. {'www.example.com': '192.168.0.17'})
  107. self.assertEqual(build_extra_hosts(
  108. ["www.example.com: 192.168.0.17",
  109. "static.example.com:192.168.0.19",
  110. "api.example.com: 192.168.0.18"]),
  111. {'www.example.com': '192.168.0.17',
  112. 'static.example.com': '192.168.0.19',
  113. 'api.example.com': '192.168.0.18'})
  114. # list of dictionaries
  115. self.assertRaises(ConfigError, lambda: build_extra_hosts(
  116. [{'www.example.com': '192.168.0.17'},
  117. {'api.example.com': '192.168.0.18'}]))
  118. # dictionaries
  119. self.assertEqual(build_extra_hosts(
  120. {'www.example.com': '192.168.0.17',
  121. 'api.example.com': '192.168.0.18'}),
  122. {'www.example.com': '192.168.0.17',
  123. 'api.example.com': '192.168.0.18'})
  124. def test_create_container_with_extra_hosts_list(self):
  125. extra_hosts = ['somehost:162.242.195.82', 'otherhost:50.31.209.229']
  126. service = self.create_service('db', extra_hosts=extra_hosts)
  127. container = service.create_container()
  128. service.start_container(container)
  129. self.assertEqual(set(container.get('HostConfig.ExtraHosts')), set(extra_hosts))
  130. def test_create_container_with_extra_hosts_string(self):
  131. extra_hosts = 'somehost:162.242.195.82'
  132. service = self.create_service('db', extra_hosts=extra_hosts)
  133. self.assertRaises(ConfigError, lambda: service.create_container())
  134. def test_create_container_with_extra_hosts_list_of_dicts(self):
  135. extra_hosts = [{'somehost': '162.242.195.82'}, {'otherhost': '50.31.209.229'}]
  136. service = self.create_service('db', extra_hosts=extra_hosts)
  137. self.assertRaises(ConfigError, lambda: service.create_container())
  138. def test_create_container_with_extra_hosts_dicts(self):
  139. extra_hosts = {'somehost': '162.242.195.82', 'otherhost': '50.31.209.229'}
  140. extra_hosts_list = ['somehost:162.242.195.82', 'otherhost:50.31.209.229']
  141. service = self.create_service('db', extra_hosts=extra_hosts)
  142. container = service.create_container()
  143. service.start_container(container)
  144. self.assertEqual(set(container.get('HostConfig.ExtraHosts')), set(extra_hosts_list))
  145. def test_create_container_with_cpu_set(self):
  146. service = self.create_service('db', cpuset='0')
  147. container = service.create_container()
  148. service.start_container(container)
  149. self.assertEqual(container.inspect()['Config']['Cpuset'], '0')
  150. def test_create_container_with_read_only_root_fs(self):
  151. read_only = True
  152. service = self.create_service('db', read_only=read_only)
  153. container = service.create_container()
  154. service.start_container(container)
  155. self.assertEqual(container.get('HostConfig.ReadonlyRootfs'), read_only, container.get('HostConfig'))
  156. def test_create_container_with_security_opt(self):
  157. security_opt = ['label:disable']
  158. service = self.create_service('db', security_opt=security_opt)
  159. container = service.create_container()
  160. service.start_container(container)
  161. self.assertEqual(set(container.get('HostConfig.SecurityOpt')), set(security_opt))
  162. def test_create_container_with_mac_address(self):
  163. service = self.create_service('db', mac_address='02:42:ac:11:65:43')
  164. container = service.create_container()
  165. service.start_container(container)
  166. self.assertEqual(container.inspect()['Config']['MacAddress'], '02:42:ac:11:65:43')
  167. def test_create_container_with_specified_volume(self):
  168. host_path = '/tmp/host-path'
  169. container_path = '/container-path'
  170. service = self.create_service('db', volumes=['%s:%s' % (host_path, container_path)])
  171. container = service.create_container()
  172. service.start_container(container)
  173. volumes = container.inspect()['Volumes']
  174. self.assertIn(container_path, volumes)
  175. # Match the last component ("host-path"), because boot2docker symlinks /tmp
  176. actual_host_path = volumes[container_path]
  177. self.assertTrue(path.basename(actual_host_path) == path.basename(host_path),
  178. msg=("Last component differs: %s, %s" % (actual_host_path, host_path)))
  179. @mock.patch.dict(os.environ)
  180. def test_create_container_with_home_and_env_var_in_volume_path(self):
  181. os.environ['VOLUME_NAME'] = 'my-volume'
  182. os.environ['HOME'] = '/tmp/home-dir'
  183. expected_host_path = os.path.join(os.environ['HOME'], os.environ['VOLUME_NAME'])
  184. host_path = '~/${VOLUME_NAME}'
  185. container_path = '/container-path'
  186. service = self.create_service('db', volumes=['%s:%s' % (host_path, container_path)])
  187. container = service.create_container()
  188. service.start_container(container)
  189. actual_host_path = container.get('Volumes')[container_path]
  190. components = actual_host_path.split('/')
  191. self.assertTrue(components[-2:] == ['home-dir', 'my-volume'],
  192. msg="Last two components differ: %s, %s" % (actual_host_path, expected_host_path))
  193. def test_create_container_with_volumes_from(self):
  194. volume_service = self.create_service('data')
  195. volume_container_1 = volume_service.create_container()
  196. volume_container_2 = Container.create(self.client, image='busybox:latest', command=["top"])
  197. host_service = self.create_service('host', volumes_from=[volume_service, volume_container_2])
  198. host_container = host_service.create_container()
  199. host_service.start_container(host_container)
  200. self.assertIn(volume_container_1.id,
  201. host_container.get('HostConfig.VolumesFrom'))
  202. self.assertIn(volume_container_2.id,
  203. host_container.get('HostConfig.VolumesFrom'))
  204. def test_converge(self):
  205. service = self.create_service(
  206. 'db',
  207. environment={'FOO': '1'},
  208. volumes=['/etc'],
  209. entrypoint=['top'],
  210. command=['-d', '1']
  211. )
  212. old_container = service.create_container()
  213. self.assertEqual(old_container.get('Config.Entrypoint'), ['top'])
  214. self.assertEqual(old_container.get('Config.Cmd'), ['-d', '1'])
  215. self.assertIn('FOO=1', old_container.get('Config.Env'))
  216. self.assertEqual(old_container.name, 'composetest_db_1')
  217. service.start_container(old_container)
  218. old_container.inspect() # reload volume data
  219. volume_path = old_container.get('Volumes')['/etc']
  220. num_containers_before = len(self.client.containers(all=True))
  221. service.options['environment']['FOO'] = '2'
  222. new_container = service.converge()[0]
  223. self.assertEqual(new_container.get('Config.Entrypoint'), ['top'])
  224. self.assertEqual(new_container.get('Config.Cmd'), ['-d', '1'])
  225. self.assertIn('FOO=2', new_container.get('Config.Env'))
  226. self.assertEqual(new_container.name, 'composetest_db_1')
  227. self.assertEqual(new_container.get('Volumes')['/etc'], volume_path)
  228. self.assertIn(
  229. 'affinity:container==%s' % old_container.id,
  230. new_container.get('Config.Env'))
  231. self.assertEqual(len(self.client.containers(all=True)), num_containers_before)
  232. self.assertNotEqual(old_container.id, new_container.id)
  233. self.assertRaises(APIError,
  234. self.client.inspect_container,
  235. old_container.id)
  236. def test_converge_when_containers_are_stopped(self):
  237. service = self.create_service(
  238. 'db',
  239. environment={'FOO': '1'},
  240. volumes=['/var/db'],
  241. entrypoint=['top'],
  242. command=['-d', '1']
  243. )
  244. service.create_container()
  245. self.assertEqual(len(service.containers(stopped=True)), 1)
  246. service.converge()
  247. self.assertEqual(len(service.containers(stopped=True)), 1)
  248. def test_converge_with_image_declared_volume(self):
  249. service = Service(
  250. project='composetest',
  251. name='db',
  252. client=self.client,
  253. build='tests/fixtures/dockerfile-with-volume',
  254. )
  255. old_container = create_and_start_container(service)
  256. self.assertEqual(old_container.get('Volumes').keys(), ['/data'])
  257. volume_path = old_container.get('Volumes')['/data']
  258. new_container = service.converge()[0]
  259. self.assertEqual(new_container.get('Volumes').keys(), ['/data'])
  260. self.assertEqual(new_container.get('Volumes')['/data'], volume_path)
  261. def test_start_container_passes_through_options(self):
  262. db = self.create_service('db')
  263. create_and_start_container(db, environment={'FOO': 'BAR'})
  264. self.assertEqual(db.containers()[0].environment['FOO'], 'BAR')
  265. def test_start_container_inherits_options_from_constructor(self):
  266. db = self.create_service('db', environment={'FOO': 'BAR'})
  267. create_and_start_container(db)
  268. self.assertEqual(db.containers()[0].environment['FOO'], 'BAR')
  269. def test_start_container_creates_links(self):
  270. db = self.create_service('db')
  271. web = self.create_service('web', links=[(db, None)])
  272. create_and_start_container(db)
  273. create_and_start_container(db)
  274. create_and_start_container(web)
  275. self.assertEqual(
  276. set(web.containers()[0].links()),
  277. set([
  278. 'composetest_db_1', 'db_1',
  279. 'composetest_db_2', 'db_2',
  280. 'db'])
  281. )
  282. def test_start_container_creates_links_with_names(self):
  283. db = self.create_service('db')
  284. web = self.create_service('web', links=[(db, 'custom_link_name')])
  285. create_and_start_container(db)
  286. create_and_start_container(db)
  287. create_and_start_container(web)
  288. self.assertEqual(
  289. set(web.containers()[0].links()),
  290. set([
  291. 'composetest_db_1', 'db_1',
  292. 'composetest_db_2', 'db_2',
  293. 'custom_link_name'])
  294. )
  295. def test_start_container_with_external_links(self):
  296. db = self.create_service('db')
  297. web = self.create_service('web', external_links=['composetest_db_1',
  298. 'composetest_db_2',
  299. 'composetest_db_3:db_3'])
  300. for _ in range(3):
  301. create_and_start_container(db)
  302. create_and_start_container(web)
  303. self.assertEqual(
  304. set(web.containers()[0].links()),
  305. set([
  306. 'composetest_db_1',
  307. 'composetest_db_2',
  308. 'db_3']),
  309. )
  310. def test_start_normal_container_does_not_create_links_to_its_own_service(self):
  311. db = self.create_service('db')
  312. create_and_start_container(db)
  313. create_and_start_container(db)
  314. c = create_and_start_container(db)
  315. self.assertEqual(set(c.links()), set([]))
  316. def test_start_one_off_container_creates_links_to_its_own_service(self):
  317. db = self.create_service('db')
  318. create_and_start_container(db)
  319. create_and_start_container(db)
  320. c = create_and_start_container(db, one_off=True)
  321. self.assertEqual(
  322. set(c.links()),
  323. set([
  324. 'composetest_db_1', 'db_1',
  325. 'composetest_db_2', 'db_2',
  326. 'db'])
  327. )
  328. def test_start_container_builds_images(self):
  329. service = Service(
  330. name='test',
  331. client=self.client,
  332. build='tests/fixtures/simple-dockerfile',
  333. project='composetest',
  334. )
  335. container = create_and_start_container(service)
  336. container.wait()
  337. self.assertIn('success', container.logs())
  338. self.assertEqual(len(self.client.images(name='composetest_test')), 1)
  339. def test_start_container_uses_tagged_image_if_it_exists(self):
  340. self.client.build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  341. service = Service(
  342. name='test',
  343. client=self.client,
  344. build='this/does/not/exist/and/will/throw/error',
  345. project='composetest',
  346. )
  347. container = create_and_start_container(service)
  348. container.wait()
  349. self.assertIn('success', container.logs())
  350. def test_start_container_creates_ports(self):
  351. service = self.create_service('web', ports=[8000])
  352. container = create_and_start_container(service).inspect()
  353. self.assertEqual(list(container['NetworkSettings']['Ports'].keys()), ['8000/tcp'])
  354. self.assertNotEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8000')
  355. def test_build(self):
  356. base_dir = tempfile.mkdtemp()
  357. self.addCleanup(shutil.rmtree, base_dir)
  358. with open(os.path.join(base_dir, 'Dockerfile'), 'w') as f:
  359. f.write("FROM busybox\n")
  360. self.create_service('web', build=base_dir).build()
  361. self.assertEqual(len(self.client.images(name='composetest_web')), 1)
  362. def test_build_non_ascii_filename(self):
  363. base_dir = tempfile.mkdtemp()
  364. self.addCleanup(shutil.rmtree, base_dir)
  365. with open(os.path.join(base_dir, 'Dockerfile'), 'w') as f:
  366. f.write("FROM busybox\n")
  367. with open(os.path.join(base_dir, b'foo\xE2bar'), 'w') as f:
  368. f.write("hello world\n")
  369. self.create_service('web', build=six.text_type(base_dir)).build()
  370. self.assertEqual(len(self.client.images(name='composetest_web')), 1)
  371. def test_start_container_stays_unpriviliged(self):
  372. service = self.create_service('web')
  373. container = create_and_start_container(service).inspect()
  374. self.assertEqual(container['HostConfig']['Privileged'], False)
  375. def test_start_container_becomes_priviliged(self):
  376. service = self.create_service('web', privileged=True)
  377. container = create_and_start_container(service).inspect()
  378. self.assertEqual(container['HostConfig']['Privileged'], True)
  379. def test_expose_does_not_publish_ports(self):
  380. service = self.create_service('web', expose=[8000])
  381. container = create_and_start_container(service).inspect()
  382. self.assertEqual(container['NetworkSettings']['Ports'], {'8000/tcp': None})
  383. def test_start_container_creates_port_with_explicit_protocol(self):
  384. service = self.create_service('web', ports=['8000/udp'])
  385. container = create_and_start_container(service).inspect()
  386. self.assertEqual(list(container['NetworkSettings']['Ports'].keys()), ['8000/udp'])
  387. def test_start_container_creates_fixed_external_ports(self):
  388. service = self.create_service('web', ports=['8000:8000'])
  389. container = create_and_start_container(service).inspect()
  390. self.assertIn('8000/tcp', container['NetworkSettings']['Ports'])
  391. self.assertEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8000')
  392. def test_start_container_creates_fixed_external_ports_when_it_is_different_to_internal_port(self):
  393. service = self.create_service('web', ports=['8001:8000'])
  394. container = create_and_start_container(service).inspect()
  395. self.assertIn('8000/tcp', container['NetworkSettings']['Ports'])
  396. self.assertEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8001')
  397. def test_port_with_explicit_interface(self):
  398. service = self.create_service('web', ports=[
  399. '127.0.0.1:8001:8000',
  400. '0.0.0.0:9001:9000/udp',
  401. ])
  402. container = create_and_start_container(service).inspect()
  403. self.assertEqual(container['NetworkSettings']['Ports'], {
  404. '8000/tcp': [
  405. {
  406. 'HostIp': '127.0.0.1',
  407. 'HostPort': '8001',
  408. },
  409. ],
  410. '9000/udp': [
  411. {
  412. 'HostIp': '0.0.0.0',
  413. 'HostPort': '9001',
  414. },
  415. ],
  416. })
  417. def test_start_with_image_id(self):
  418. # Image id for the current busybox:latest
  419. service = self.create_service('foo', image='8c2e06607696')
  420. self.assertTrue(service.start_or_create_containers())
  421. def test_scale(self):
  422. service = self.create_service('web')
  423. service.scale(1)
  424. self.assertEqual(len(service.containers()), 1)
  425. # Ensure containers don't have stdout or stdin connected
  426. container = service.containers()[0]
  427. config = container.inspect()['Config']
  428. self.assertFalse(config['AttachStderr'])
  429. self.assertFalse(config['AttachStdout'])
  430. self.assertFalse(config['AttachStdin'])
  431. service.scale(3)
  432. self.assertEqual(len(service.containers()), 3)
  433. service.scale(1)
  434. self.assertEqual(len(service.containers()), 1)
  435. service.scale(0)
  436. self.assertEqual(len(service.containers()), 0)
  437. def test_scale_sets_ports(self):
  438. service = self.create_service('web', ports=['8000'])
  439. service.scale(2)
  440. containers = service.containers()
  441. self.assertEqual(len(containers), 2)
  442. for container in containers:
  443. self.assertEqual(list(container.inspect()['HostConfig']['PortBindings'].keys()), ['8000/tcp'])
  444. def test_network_mode_none(self):
  445. service = self.create_service('web', net='none')
  446. container = create_and_start_container(service)
  447. self.assertEqual(container.get('HostConfig.NetworkMode'), 'none')
  448. def test_network_mode_bridged(self):
  449. service = self.create_service('web', net='bridge')
  450. container = create_and_start_container(service)
  451. self.assertEqual(container.get('HostConfig.NetworkMode'), 'bridge')
  452. def test_network_mode_host(self):
  453. service = self.create_service('web', net='host')
  454. container = create_and_start_container(service)
  455. self.assertEqual(container.get('HostConfig.NetworkMode'), 'host')
  456. def test_pid_mode_none_defined(self):
  457. service = self.create_service('web', pid=None)
  458. container = create_and_start_container(service)
  459. self.assertEqual(container.get('HostConfig.PidMode'), '')
  460. def test_pid_mode_host(self):
  461. service = self.create_service('web', pid='host')
  462. container = create_and_start_container(service)
  463. self.assertEqual(container.get('HostConfig.PidMode'), 'host')
  464. def test_dns_no_value(self):
  465. service = self.create_service('web')
  466. container = create_and_start_container(service)
  467. self.assertIsNone(container.get('HostConfig.Dns'))
  468. def test_dns_single_value(self):
  469. service = self.create_service('web', dns='8.8.8.8')
  470. container = create_and_start_container(service)
  471. self.assertEqual(container.get('HostConfig.Dns'), ['8.8.8.8'])
  472. def test_dns_list(self):
  473. service = self.create_service('web', dns=['8.8.8.8', '9.9.9.9'])
  474. container = create_and_start_container(service)
  475. self.assertEqual(container.get('HostConfig.Dns'), ['8.8.8.8', '9.9.9.9'])
  476. def test_restart_always_value(self):
  477. service = self.create_service('web', restart='always')
  478. container = create_and_start_container(service)
  479. self.assertEqual(container.get('HostConfig.RestartPolicy.Name'), 'always')
  480. def test_restart_on_failure_value(self):
  481. service = self.create_service('web', restart='on-failure:5')
  482. container = create_and_start_container(service)
  483. self.assertEqual(container.get('HostConfig.RestartPolicy.Name'), 'on-failure')
  484. self.assertEqual(container.get('HostConfig.RestartPolicy.MaximumRetryCount'), 5)
  485. def test_cap_add_list(self):
  486. service = self.create_service('web', cap_add=['SYS_ADMIN', 'NET_ADMIN'])
  487. container = create_and_start_container(service)
  488. self.assertEqual(container.get('HostConfig.CapAdd'), ['SYS_ADMIN', 'NET_ADMIN'])
  489. def test_cap_drop_list(self):
  490. service = self.create_service('web', cap_drop=['SYS_ADMIN', 'NET_ADMIN'])
  491. container = create_and_start_container(service)
  492. self.assertEqual(container.get('HostConfig.CapDrop'), ['SYS_ADMIN', 'NET_ADMIN'])
  493. def test_dns_search_no_value(self):
  494. service = self.create_service('web')
  495. container = create_and_start_container(service)
  496. self.assertIsNone(container.get('HostConfig.DnsSearch'))
  497. def test_dns_search_single_value(self):
  498. service = self.create_service('web', dns_search='example.com')
  499. container = create_and_start_container(service)
  500. self.assertEqual(container.get('HostConfig.DnsSearch'), ['example.com'])
  501. def test_dns_search_list(self):
  502. service = self.create_service('web', dns_search=['dc1.example.com', 'dc2.example.com'])
  503. container = create_and_start_container(service)
  504. self.assertEqual(container.get('HostConfig.DnsSearch'), ['dc1.example.com', 'dc2.example.com'])
  505. def test_working_dir_param(self):
  506. service = self.create_service('container', working_dir='/working/dir/sample')
  507. container = service.create_container()
  508. self.assertEqual(container.get('Config.WorkingDir'), '/working/dir/sample')
  509. def test_split_env(self):
  510. service = self.create_service('web', environment=['NORMAL=F1', 'CONTAINS_EQUALS=F=2', 'TRAILING_EQUALS='])
  511. env = create_and_start_container(service).environment
  512. for k, v in {'NORMAL': 'F1', 'CONTAINS_EQUALS': 'F=2', 'TRAILING_EQUALS': ''}.items():
  513. self.assertEqual(env[k], v)
  514. def test_env_from_file_combined_with_env(self):
  515. service = self.create_service('web', environment=['ONE=1', 'TWO=2', 'THREE=3'], env_file=['tests/fixtures/env/one.env', 'tests/fixtures/env/two.env'])
  516. env = create_and_start_container(service).environment
  517. for k, v in {'ONE': '1', 'TWO': '2', 'THREE': '3', 'FOO': 'baz', 'DOO': 'dah'}.items():
  518. self.assertEqual(env[k], v)
  519. @mock.patch.dict(os.environ)
  520. def test_resolve_env(self):
  521. os.environ['FILE_DEF'] = 'E1'
  522. os.environ['FILE_DEF_EMPTY'] = 'E2'
  523. os.environ['ENV_DEF'] = 'E3'
  524. service = self.create_service('web', environment={'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': None, 'NO_DEF': None})
  525. env = create_and_start_container(service).environment
  526. for k, v in {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': ''}.items():
  527. self.assertEqual(env[k], v)
  528. def test_labels(self):
  529. labels_dict = {
  530. 'com.example.description': "Accounting webapp",
  531. 'com.example.department': "Finance",
  532. 'com.example.label-with-empty-value': "",
  533. }
  534. compose_labels = {
  535. LABEL_CONTAINER_NUMBER: '1',
  536. LABEL_ONE_OFF: 'False',
  537. LABEL_PROJECT: 'composetest',
  538. LABEL_SERVICE: 'web',
  539. LABEL_VERSION: __version__,
  540. }
  541. expected = dict(labels_dict, **compose_labels)
  542. service = self.create_service('web', labels=labels_dict)
  543. labels = create_and_start_container(service).labels.items()
  544. for pair in expected.items():
  545. self.assertIn(pair, labels)
  546. service.kill()
  547. service.remove_stopped()
  548. labels_list = ["%s=%s" % pair for pair in labels_dict.items()]
  549. service = self.create_service('web', labels=labels_list)
  550. labels = create_and_start_container(service).labels.items()
  551. for pair in expected.items():
  552. self.assertIn(pair, labels)
  553. def test_empty_labels(self):
  554. labels_list = ['foo', 'bar']
  555. service = self.create_service('web', labels=labels_list)
  556. labels = create_and_start_container(service).labels.items()
  557. for name in labels_list:
  558. self.assertIn((name, ''), labels)
  559. def test_log_drive_invalid(self):
  560. service = self.create_service('web', log_driver='xxx')
  561. self.assertRaises(ValueError, lambda: create_and_start_container(service))
  562. def test_log_drive_empty_default_jsonfile(self):
  563. service = self.create_service('web')
  564. log_config = create_and_start_container(service).log_config
  565. self.assertEqual('json-file', log_config['Type'])
  566. self.assertFalse(log_config['Config'])
  567. def test_log_drive_none(self):
  568. service = self.create_service('web', log_driver='none')
  569. log_config = create_and_start_container(service).log_config
  570. self.assertEqual('none', log_config['Type'])
  571. self.assertFalse(log_config['Config'])
  572. def test_devices(self):
  573. service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
  574. device_config = create_and_start_container(service).get('HostConfig.Devices')
  575. device_dict = {
  576. 'PathOnHost': '/dev/random',
  577. 'CgroupPermissions': 'rwm',
  578. 'PathInContainer': '/dev/mapped-random'
  579. }
  580. self.assertEqual(1, len(device_config))
  581. self.assertDictEqual(device_dict, device_config[0])