service_test.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705
  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_specified_volume(self):
  158. host_path = '/tmp/host-path'
  159. container_path = '/container-path'
  160. service = self.create_service('db', volumes=['%s:%s' % (host_path, container_path)])
  161. container = service.create_container()
  162. service.start_container(container)
  163. volumes = container.inspect()['Volumes']
  164. self.assertIn(container_path, volumes)
  165. # Match the last component ("host-path"), because boot2docker symlinks /tmp
  166. actual_host_path = volumes[container_path]
  167. self.assertTrue(path.basename(actual_host_path) == path.basename(host_path),
  168. msg=("Last component differs: %s, %s" % (actual_host_path, host_path)))
  169. @mock.patch.dict(os.environ)
  170. def test_create_container_with_home_and_env_var_in_volume_path(self):
  171. os.environ['VOLUME_NAME'] = 'my-volume'
  172. os.environ['HOME'] = '/tmp/home-dir'
  173. expected_host_path = os.path.join(os.environ['HOME'], os.environ['VOLUME_NAME'])
  174. host_path = '~/${VOLUME_NAME}'
  175. container_path = '/container-path'
  176. service = self.create_service('db', volumes=['%s:%s' % (host_path, container_path)])
  177. container = service.create_container()
  178. service.start_container(container)
  179. actual_host_path = container.get('Volumes')[container_path]
  180. components = actual_host_path.split('/')
  181. self.assertTrue(components[-2:] == ['home-dir', 'my-volume'],
  182. msg="Last two components differ: %s, %s" % (actual_host_path, expected_host_path))
  183. def test_create_container_with_volumes_from(self):
  184. volume_service = self.create_service('data')
  185. volume_container_1 = volume_service.create_container()
  186. volume_container_2 = Container.create(self.client, image='busybox:latest', command=["/bin/sleep", "300"])
  187. host_service = self.create_service('host', volumes_from=[volume_service, volume_container_2])
  188. host_container = host_service.create_container()
  189. host_service.start_container(host_container)
  190. self.assertIn(volume_container_1.id,
  191. host_container.get('HostConfig.VolumesFrom'))
  192. self.assertIn(volume_container_2.id,
  193. host_container.get('HostConfig.VolumesFrom'))
  194. def test_converge(self):
  195. service = self.create_service(
  196. 'db',
  197. environment={'FOO': '1'},
  198. volumes=['/etc'],
  199. entrypoint=['sleep'],
  200. command=['300']
  201. )
  202. old_container = service.create_container()
  203. self.assertEqual(old_container.get('Config.Entrypoint'), ['sleep'])
  204. self.assertEqual(old_container.get('Config.Cmd'), ['300'])
  205. self.assertIn('FOO=1', old_container.get('Config.Env'))
  206. self.assertEqual(old_container.name, 'composetest_db_1')
  207. service.start_container(old_container)
  208. old_container.inspect() # reload volume data
  209. volume_path = old_container.get('Volumes')['/etc']
  210. num_containers_before = len(self.client.containers(all=True))
  211. service.options['environment']['FOO'] = '2'
  212. new_container = service.converge()[0]
  213. self.assertEqual(new_container.get('Config.Entrypoint'), ['sleep'])
  214. self.assertEqual(new_container.get('Config.Cmd'), ['300'])
  215. self.assertIn('FOO=2', new_container.get('Config.Env'))
  216. self.assertEqual(new_container.name, 'composetest_db_1')
  217. self.assertEqual(new_container.get('Volumes')['/etc'], volume_path)
  218. self.assertIn(
  219. 'affinity:container==%s' % old_container.id,
  220. new_container.get('Config.Env'))
  221. self.assertEqual(len(self.client.containers(all=True)), num_containers_before)
  222. self.assertNotEqual(old_container.id, new_container.id)
  223. self.assertRaises(APIError,
  224. self.client.inspect_container,
  225. old_container.id)
  226. def test_converge_when_containers_are_stopped(self):
  227. service = self.create_service(
  228. 'db',
  229. environment={'FOO': '1'},
  230. volumes=['/var/db'],
  231. entrypoint=['sleep'],
  232. command=['300']
  233. )
  234. service.create_container()
  235. self.assertEqual(len(service.containers(stopped=True)), 1)
  236. service.converge()
  237. self.assertEqual(len(service.containers(stopped=True)), 1)
  238. def test_converge_with_image_declared_volume(self):
  239. service = Service(
  240. project='composetest',
  241. name='db',
  242. client=self.client,
  243. build='tests/fixtures/dockerfile-with-volume',
  244. )
  245. old_container = create_and_start_container(service)
  246. self.assertEqual(old_container.get('Volumes').keys(), ['/data'])
  247. volume_path = old_container.get('Volumes')['/data']
  248. new_container = service.converge()[0]
  249. self.assertEqual(new_container.get('Volumes').keys(), ['/data'])
  250. self.assertEqual(new_container.get('Volumes')['/data'], volume_path)
  251. def test_start_container_passes_through_options(self):
  252. db = self.create_service('db')
  253. create_and_start_container(db, environment={'FOO': 'BAR'})
  254. self.assertEqual(db.containers()[0].environment['FOO'], 'BAR')
  255. def test_start_container_inherits_options_from_constructor(self):
  256. db = self.create_service('db', environment={'FOO': 'BAR'})
  257. create_and_start_container(db)
  258. self.assertEqual(db.containers()[0].environment['FOO'], 'BAR')
  259. def test_start_container_creates_links(self):
  260. db = self.create_service('db')
  261. web = self.create_service('web', links=[(db, None)])
  262. create_and_start_container(db)
  263. create_and_start_container(db)
  264. create_and_start_container(web)
  265. self.assertEqual(
  266. set(web.containers()[0].links()),
  267. set([
  268. 'composetest_db_1', 'db_1',
  269. 'composetest_db_2', 'db_2',
  270. 'db'])
  271. )
  272. def test_start_container_creates_links_with_names(self):
  273. db = self.create_service('db')
  274. web = self.create_service('web', links=[(db, 'custom_link_name')])
  275. create_and_start_container(db)
  276. create_and_start_container(db)
  277. create_and_start_container(web)
  278. self.assertEqual(
  279. set(web.containers()[0].links()),
  280. set([
  281. 'composetest_db_1', 'db_1',
  282. 'composetest_db_2', 'db_2',
  283. 'custom_link_name'])
  284. )
  285. def test_start_container_with_external_links(self):
  286. db = self.create_service('db')
  287. web = self.create_service('web', external_links=['composetest_db_1',
  288. 'composetest_db_2',
  289. 'composetest_db_3:db_3'])
  290. for _ in range(3):
  291. create_and_start_container(db)
  292. create_and_start_container(web)
  293. self.assertEqual(
  294. set(web.containers()[0].links()),
  295. set([
  296. 'composetest_db_1',
  297. 'composetest_db_2',
  298. 'db_3']),
  299. )
  300. def test_start_normal_container_does_not_create_links_to_its_own_service(self):
  301. db = self.create_service('db')
  302. create_and_start_container(db)
  303. create_and_start_container(db)
  304. c = create_and_start_container(db)
  305. self.assertEqual(set(c.links()), set([]))
  306. def test_start_one_off_container_creates_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, one_off=True)
  311. self.assertEqual(
  312. set(c.links()),
  313. set([
  314. 'composetest_db_1', 'db_1',
  315. 'composetest_db_2', 'db_2',
  316. 'db'])
  317. )
  318. def test_start_container_builds_images(self):
  319. service = Service(
  320. name='test',
  321. client=self.client,
  322. build='tests/fixtures/simple-dockerfile',
  323. project='composetest',
  324. )
  325. container = create_and_start_container(service)
  326. container.wait()
  327. self.assertIn('success', container.logs())
  328. self.assertEqual(len(self.client.images(name='composetest_test')), 1)
  329. def test_start_container_uses_tagged_image_if_it_exists(self):
  330. self.client.build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  331. service = Service(
  332. name='test',
  333. client=self.client,
  334. build='this/does/not/exist/and/will/throw/error',
  335. project='composetest',
  336. )
  337. container = create_and_start_container(service)
  338. container.wait()
  339. self.assertIn('success', container.logs())
  340. def test_start_container_creates_ports(self):
  341. service = self.create_service('web', ports=[8000])
  342. container = create_and_start_container(service).inspect()
  343. self.assertEqual(list(container['NetworkSettings']['Ports'].keys()), ['8000/tcp'])
  344. self.assertNotEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8000')
  345. def test_build(self):
  346. base_dir = tempfile.mkdtemp()
  347. self.addCleanup(shutil.rmtree, base_dir)
  348. with open(os.path.join(base_dir, 'Dockerfile'), 'w') as f:
  349. f.write("FROM busybox\n")
  350. self.create_service('web', build=base_dir).build()
  351. self.assertEqual(len(self.client.images(name='composetest_web')), 1)
  352. def test_build_non_ascii_filename(self):
  353. base_dir = tempfile.mkdtemp()
  354. self.addCleanup(shutil.rmtree, base_dir)
  355. with open(os.path.join(base_dir, 'Dockerfile'), 'w') as f:
  356. f.write("FROM busybox\n")
  357. with open(os.path.join(base_dir, b'foo\xE2bar'), 'w') as f:
  358. f.write("hello world\n")
  359. self.create_service('web', build=six.text_type(base_dir)).build()
  360. self.assertEqual(len(self.client.images(name='composetest_web')), 1)
  361. def test_start_container_stays_unpriviliged(self):
  362. service = self.create_service('web')
  363. container = create_and_start_container(service).inspect()
  364. self.assertEqual(container['HostConfig']['Privileged'], False)
  365. def test_start_container_becomes_priviliged(self):
  366. service = self.create_service('web', privileged=True)
  367. container = create_and_start_container(service).inspect()
  368. self.assertEqual(container['HostConfig']['Privileged'], True)
  369. def test_expose_does_not_publish_ports(self):
  370. service = self.create_service('web', expose=[8000])
  371. container = create_and_start_container(service).inspect()
  372. self.assertEqual(container['NetworkSettings']['Ports'], {'8000/tcp': None})
  373. def test_start_container_creates_port_with_explicit_protocol(self):
  374. service = self.create_service('web', ports=['8000/udp'])
  375. container = create_and_start_container(service).inspect()
  376. self.assertEqual(list(container['NetworkSettings']['Ports'].keys()), ['8000/udp'])
  377. def test_start_container_creates_fixed_external_ports(self):
  378. service = self.create_service('web', ports=['8000:8000'])
  379. container = create_and_start_container(service).inspect()
  380. self.assertIn('8000/tcp', container['NetworkSettings']['Ports'])
  381. self.assertEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8000')
  382. def test_start_container_creates_fixed_external_ports_when_it_is_different_to_internal_port(self):
  383. service = self.create_service('web', ports=['8001:8000'])
  384. container = create_and_start_container(service).inspect()
  385. self.assertIn('8000/tcp', container['NetworkSettings']['Ports'])
  386. self.assertEqual(container['NetworkSettings']['Ports']['8000/tcp'][0]['HostPort'], '8001')
  387. def test_port_with_explicit_interface(self):
  388. service = self.create_service('web', ports=[
  389. '127.0.0.1:8001:8000',
  390. '0.0.0.0:9001:9000/udp',
  391. ])
  392. container = create_and_start_container(service).inspect()
  393. self.assertEqual(container['NetworkSettings']['Ports'], {
  394. '8000/tcp': [
  395. {
  396. 'HostIp': '127.0.0.1',
  397. 'HostPort': '8001',
  398. },
  399. ],
  400. '9000/udp': [
  401. {
  402. 'HostIp': '0.0.0.0',
  403. 'HostPort': '9001',
  404. },
  405. ],
  406. })
  407. def test_start_with_image_id(self):
  408. # Image id for the current busybox:latest
  409. service = self.create_service('foo', image='8c2e06607696')
  410. self.assertTrue(service.start_or_create_containers())
  411. def test_scale(self):
  412. service = self.create_service('web')
  413. service.scale(1)
  414. self.assertEqual(len(service.containers()), 1)
  415. # Ensure containers don't have stdout or stdin connected
  416. container = service.containers()[0]
  417. config = container.inspect()['Config']
  418. self.assertFalse(config['AttachStderr'])
  419. self.assertFalse(config['AttachStdout'])
  420. self.assertFalse(config['AttachStdin'])
  421. service.scale(3)
  422. self.assertEqual(len(service.containers()), 3)
  423. service.scale(1)
  424. self.assertEqual(len(service.containers()), 1)
  425. service.scale(0)
  426. self.assertEqual(len(service.containers()), 0)
  427. def test_scale_on_service_that_cannot_be_scaled(self):
  428. service = self.create_service('web', ports=['8000:8000'])
  429. self.assertRaises(CannotBeScaledError, lambda: service.scale(1))
  430. def test_scale_sets_ports(self):
  431. service = self.create_service('web', ports=['8000'])
  432. service.scale(2)
  433. containers = service.containers()
  434. self.assertEqual(len(containers), 2)
  435. for container in containers:
  436. self.assertEqual(list(container.inspect()['HostConfig']['PortBindings'].keys()), ['8000/tcp'])
  437. def test_network_mode_none(self):
  438. service = self.create_service('web', net='none')
  439. container = create_and_start_container(service)
  440. self.assertEqual(container.get('HostConfig.NetworkMode'), 'none')
  441. def test_network_mode_bridged(self):
  442. service = self.create_service('web', net='bridge')
  443. container = create_and_start_container(service)
  444. self.assertEqual(container.get('HostConfig.NetworkMode'), 'bridge')
  445. def test_network_mode_host(self):
  446. service = self.create_service('web', net='host')
  447. container = create_and_start_container(service)
  448. self.assertEqual(container.get('HostConfig.NetworkMode'), 'host')
  449. def test_pid_mode_none_defined(self):
  450. service = self.create_service('web', pid=None)
  451. container = create_and_start_container(service)
  452. self.assertEqual(container.get('HostConfig.PidMode'), '')
  453. def test_pid_mode_host(self):
  454. service = self.create_service('web', pid='host')
  455. container = create_and_start_container(service)
  456. self.assertEqual(container.get('HostConfig.PidMode'), 'host')
  457. def test_dns_no_value(self):
  458. service = self.create_service('web')
  459. container = create_and_start_container(service)
  460. self.assertIsNone(container.get('HostConfig.Dns'))
  461. def test_dns_single_value(self):
  462. service = self.create_service('web', dns='8.8.8.8')
  463. container = create_and_start_container(service)
  464. self.assertEqual(container.get('HostConfig.Dns'), ['8.8.8.8'])
  465. def test_dns_list(self):
  466. service = self.create_service('web', dns=['8.8.8.8', '9.9.9.9'])
  467. container = create_and_start_container(service)
  468. self.assertEqual(container.get('HostConfig.Dns'), ['8.8.8.8', '9.9.9.9'])
  469. def test_restart_always_value(self):
  470. service = self.create_service('web', restart='always')
  471. container = create_and_start_container(service)
  472. self.assertEqual(container.get('HostConfig.RestartPolicy.Name'), 'always')
  473. def test_restart_on_failure_value(self):
  474. service = self.create_service('web', restart='on-failure:5')
  475. container = create_and_start_container(service)
  476. self.assertEqual(container.get('HostConfig.RestartPolicy.Name'), 'on-failure')
  477. self.assertEqual(container.get('HostConfig.RestartPolicy.MaximumRetryCount'), 5)
  478. def test_cap_add_list(self):
  479. service = self.create_service('web', cap_add=['SYS_ADMIN', 'NET_ADMIN'])
  480. container = create_and_start_container(service)
  481. self.assertEqual(container.get('HostConfig.CapAdd'), ['SYS_ADMIN', 'NET_ADMIN'])
  482. def test_cap_drop_list(self):
  483. service = self.create_service('web', cap_drop=['SYS_ADMIN', 'NET_ADMIN'])
  484. container = create_and_start_container(service)
  485. self.assertEqual(container.get('HostConfig.CapDrop'), ['SYS_ADMIN', 'NET_ADMIN'])
  486. def test_dns_search_no_value(self):
  487. service = self.create_service('web')
  488. container = create_and_start_container(service)
  489. self.assertIsNone(container.get('HostConfig.DnsSearch'))
  490. def test_dns_search_single_value(self):
  491. service = self.create_service('web', dns_search='example.com')
  492. container = create_and_start_container(service)
  493. self.assertEqual(container.get('HostConfig.DnsSearch'), ['example.com'])
  494. def test_dns_search_list(self):
  495. service = self.create_service('web', dns_search=['dc1.example.com', 'dc2.example.com'])
  496. container = create_and_start_container(service)
  497. self.assertEqual(container.get('HostConfig.DnsSearch'), ['dc1.example.com', 'dc2.example.com'])
  498. def test_working_dir_param(self):
  499. service = self.create_service('container', working_dir='/working/dir/sample')
  500. container = service.create_container()
  501. self.assertEqual(container.get('Config.WorkingDir'), '/working/dir/sample')
  502. def test_split_env(self):
  503. service = self.create_service('web', environment=['NORMAL=F1', 'CONTAINS_EQUALS=F=2', 'TRAILING_EQUALS='])
  504. env = create_and_start_container(service).environment
  505. for k, v in {'NORMAL': 'F1', 'CONTAINS_EQUALS': 'F=2', 'TRAILING_EQUALS': ''}.items():
  506. self.assertEqual(env[k], v)
  507. def test_env_from_file_combined_with_env(self):
  508. service = self.create_service('web', environment=['ONE=1', 'TWO=2', 'THREE=3'], env_file=['tests/fixtures/env/one.env', 'tests/fixtures/env/two.env'])
  509. env = create_and_start_container(service).environment
  510. for k, v in {'ONE': '1', 'TWO': '2', 'THREE': '3', 'FOO': 'baz', 'DOO': 'dah'}.items():
  511. self.assertEqual(env[k], v)
  512. @mock.patch.dict(os.environ)
  513. def test_resolve_env(self):
  514. os.environ['FILE_DEF'] = 'E1'
  515. os.environ['FILE_DEF_EMPTY'] = 'E2'
  516. os.environ['ENV_DEF'] = 'E3'
  517. service = self.create_service('web', environment={'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': None, 'NO_DEF': None})
  518. env = create_and_start_container(service).environment
  519. for k, v in {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': ''}.items():
  520. self.assertEqual(env[k], v)
  521. def test_labels(self):
  522. labels_dict = {
  523. 'com.example.description': "Accounting webapp",
  524. 'com.example.department': "Finance",
  525. 'com.example.label-with-empty-value': "",
  526. }
  527. compose_labels = {
  528. LABEL_CONTAINER_NUMBER: '1',
  529. LABEL_ONE_OFF: 'False',
  530. LABEL_PROJECT: 'composetest',
  531. LABEL_SERVICE: 'web',
  532. LABEL_VERSION: __version__,
  533. }
  534. expected = dict(labels_dict, **compose_labels)
  535. service = self.create_service('web', labels=labels_dict)
  536. labels = create_and_start_container(service).labels.items()
  537. for pair in expected.items():
  538. self.assertIn(pair, labels)
  539. service.kill()
  540. service.remove_stopped()
  541. labels_list = ["%s=%s" % pair for pair in labels_dict.items()]
  542. service = self.create_service('web', labels=labels_list)
  543. labels = create_and_start_container(service).labels.items()
  544. for pair in expected.items():
  545. self.assertIn(pair, labels)
  546. def test_empty_labels(self):
  547. labels_list = ['foo', 'bar']
  548. service = self.create_service('web', labels=labels_list)
  549. labels = create_and_start_container(service).labels.items()
  550. for name in labels_list:
  551. self.assertIn((name, ''), labels)
  552. def test_log_drive_invalid(self):
  553. service = self.create_service('web', log_driver='xxx')
  554. self.assertRaises(ValueError, lambda: create_and_start_container(service))
  555. def test_log_drive_empty_default_jsonfile(self):
  556. service = self.create_service('web')
  557. log_config = create_and_start_container(service).log_config
  558. self.assertEqual('json-file', log_config['Type'])
  559. self.assertFalse(log_config['Config'])
  560. def test_log_drive_none(self):
  561. service = self.create_service('web', log_driver='none')
  562. log_config = create_and_start_container(service).log_config
  563. self.assertEqual('none', log_config['Type'])
  564. self.assertFalse(log_config['Config'])
  565. def test_devices(self):
  566. service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
  567. device_config = create_and_start_container(service).get('HostConfig.Devices')
  568. device_dict = {
  569. 'PathOnHost': '/dev/random',
  570. 'CgroupPermissions': 'rwm',
  571. 'PathInContainer': '/dev/mapped-random'
  572. }
  573. self.assertEqual(1, len(device_config))
  574. self.assertDictEqual(device_dict, device_config[0])