service_test.py 29 KB

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