cli_test.py 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import datetime
  4. import json
  5. import os
  6. import shlex
  7. import signal
  8. import subprocess
  9. import time
  10. from collections import Counter
  11. from collections import namedtuple
  12. from operator import attrgetter
  13. import yaml
  14. from docker import errors
  15. from .. import mock
  16. from compose.cli.command import get_project
  17. from compose.container import Container
  18. from compose.project import OneOffFilter
  19. from tests.integration.testcases import DockerClientTestCase
  20. from tests.integration.testcases import get_links
  21. from tests.integration.testcases import pull_busybox
  22. from tests.integration.testcases import v2_only
  23. ProcessResult = namedtuple('ProcessResult', 'stdout stderr')
  24. BUILD_CACHE_TEXT = 'Using cache'
  25. BUILD_PULL_TEXT = 'Status: Image is up to date for busybox:latest'
  26. def start_process(base_dir, options):
  27. proc = subprocess.Popen(
  28. ['docker-compose'] + options,
  29. stdout=subprocess.PIPE,
  30. stderr=subprocess.PIPE,
  31. cwd=base_dir)
  32. print("Running process: %s" % proc.pid)
  33. return proc
  34. def wait_on_process(proc, returncode=0):
  35. stdout, stderr = proc.communicate()
  36. if proc.returncode != returncode:
  37. print("Stderr: {}".format(stderr))
  38. print("Stdout: {}".format(stdout))
  39. assert proc.returncode == returncode
  40. return ProcessResult(stdout.decode('utf-8'), stderr.decode('utf-8'))
  41. def wait_on_condition(condition, delay=0.1, timeout=40):
  42. start_time = time.time()
  43. while not condition():
  44. if time.time() - start_time > timeout:
  45. raise AssertionError("Timeout: %s" % condition)
  46. time.sleep(delay)
  47. def kill_service(service):
  48. for container in service.containers():
  49. container.kill()
  50. class ContainerCountCondition(object):
  51. def __init__(self, project, expected):
  52. self.project = project
  53. self.expected = expected
  54. def __call__(self):
  55. return len(self.project.containers()) == self.expected
  56. def __str__(self):
  57. return "waiting for counter count == %s" % self.expected
  58. class ContainerStateCondition(object):
  59. def __init__(self, client, name, status):
  60. self.client = client
  61. self.name = name
  62. self.status = status
  63. def __call__(self):
  64. try:
  65. container = self.client.inspect_container(self.name)
  66. return container['State']['Status'] == self.status
  67. except errors.APIError:
  68. return False
  69. def __str__(self):
  70. return "waiting for container to be %s" % self.status
  71. class CLITestCase(DockerClientTestCase):
  72. def setUp(self):
  73. super(CLITestCase, self).setUp()
  74. self.base_dir = 'tests/fixtures/simple-composefile'
  75. def tearDown(self):
  76. if self.base_dir:
  77. self.project.kill()
  78. self.project.remove_stopped()
  79. for container in self.project.containers(stopped=True, one_off=OneOffFilter.only):
  80. container.remove(force=True)
  81. networks = self.client.networks()
  82. for n in networks:
  83. if n['Name'].startswith('{}_'.format(self.project.name)):
  84. self.client.remove_network(n['Name'])
  85. super(CLITestCase, self).tearDown()
  86. @property
  87. def project(self):
  88. # Hack: allow project to be overridden
  89. if not hasattr(self, '_project'):
  90. self._project = get_project(self.base_dir)
  91. return self._project
  92. def dispatch(self, options, project_options=None, returncode=0):
  93. project_options = project_options or []
  94. proc = start_process(self.base_dir, project_options + options)
  95. return wait_on_process(proc, returncode=returncode)
  96. def execute(self, container, cmd):
  97. # Remove once Hijack and CloseNotifier sign a peace treaty
  98. self.client.close()
  99. exc = self.client.exec_create(container.id, cmd)
  100. self.client.exec_start(exc)
  101. return self.client.exec_inspect(exc)['ExitCode']
  102. def lookup(self, container, hostname):
  103. return self.execute(container, ["nslookup", hostname]) == 0
  104. def test_help(self):
  105. self.base_dir = 'tests/fixtures/no-composefile'
  106. result = self.dispatch(['help', 'up'], returncode=0)
  107. assert 'Usage: up [options] [SERVICE...]' in result.stdout
  108. # Prevent tearDown from trying to create a project
  109. self.base_dir = None
  110. # TODO: this shouldn't be v2-dependent
  111. @v2_only()
  112. def test_config_list_services(self):
  113. self.base_dir = 'tests/fixtures/v2-full'
  114. result = self.dispatch(['config', '--services'])
  115. assert set(result.stdout.rstrip().split('\n')) == {'web', 'other'}
  116. # TODO: this shouldn't be v2-dependent
  117. @v2_only()
  118. def test_config_quiet_with_error(self):
  119. self.base_dir = None
  120. result = self.dispatch([
  121. '-f', 'tests/fixtures/invalid-composefile/invalid.yml',
  122. 'config', '-q'
  123. ], returncode=1)
  124. assert "'notaservice' must be a mapping" in result.stderr
  125. # TODO: this shouldn't be v2-dependent
  126. @v2_only()
  127. def test_config_quiet(self):
  128. self.base_dir = 'tests/fixtures/v2-full'
  129. assert self.dispatch(['config', '-q']).stdout == ''
  130. # TODO: this shouldn't be v2-dependent
  131. @v2_only()
  132. def test_config_default(self):
  133. self.base_dir = 'tests/fixtures/v2-full'
  134. result = self.dispatch(['config'])
  135. # assert there are no python objects encoded in the output
  136. assert '!!' not in result.stdout
  137. output = yaml.load(result.stdout)
  138. expected = {
  139. 'version': '2.0',
  140. 'volumes': {'data': {'driver': 'local'}},
  141. 'networks': {'front': {}},
  142. 'services': {
  143. 'web': {
  144. 'build': {
  145. 'context': os.path.abspath(self.base_dir),
  146. },
  147. 'networks': {'front': None, 'default': None},
  148. 'volumes_from': ['service:other:rw'],
  149. },
  150. 'other': {
  151. 'image': 'busybox:latest',
  152. 'command': 'top',
  153. 'volumes': ['/data:rw'],
  154. },
  155. },
  156. }
  157. assert output == expected
  158. def test_ps(self):
  159. self.project.get_service('simple').create_container()
  160. result = self.dispatch(['ps'])
  161. assert 'simplecomposefile_simple_1' in result.stdout
  162. def test_ps_default_composefile(self):
  163. self.base_dir = 'tests/fixtures/multiple-composefiles'
  164. self.dispatch(['up', '-d'])
  165. result = self.dispatch(['ps'])
  166. self.assertIn('multiplecomposefiles_simple_1', result.stdout)
  167. self.assertIn('multiplecomposefiles_another_1', result.stdout)
  168. self.assertNotIn('multiplecomposefiles_yetanother_1', result.stdout)
  169. def test_ps_alternate_composefile(self):
  170. config_path = os.path.abspath(
  171. 'tests/fixtures/multiple-composefiles/compose2.yml')
  172. self._project = get_project(self.base_dir, [config_path])
  173. self.base_dir = 'tests/fixtures/multiple-composefiles'
  174. self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
  175. result = self.dispatch(['-f', 'compose2.yml', 'ps'])
  176. self.assertNotIn('multiplecomposefiles_simple_1', result.stdout)
  177. self.assertNotIn('multiplecomposefiles_another_1', result.stdout)
  178. self.assertIn('multiplecomposefiles_yetanother_1', result.stdout)
  179. def test_pull(self):
  180. result = self.dispatch(['pull'])
  181. assert sorted(result.stderr.split('\n'))[1:] == [
  182. 'Pulling another (busybox:latest)...',
  183. 'Pulling simple (busybox:latest)...',
  184. ]
  185. def test_pull_with_digest(self):
  186. result = self.dispatch(['-f', 'digest.yml', 'pull'])
  187. assert 'Pulling simple (busybox:latest)...' in result.stderr
  188. assert ('Pulling digest (busybox@'
  189. 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
  190. '04ee8502d)...') in result.stderr
  191. def test_pull_with_ignore_pull_failures(self):
  192. result = self.dispatch([
  193. '-f', 'ignore-pull-failures.yml',
  194. 'pull', '--ignore-pull-failures'])
  195. assert 'Pulling simple (busybox:latest)...' in result.stderr
  196. assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
  197. assert 'Error: image library/nonexisting-image' in result.stderr
  198. assert 'not found' in result.stderr
  199. def test_build_plain(self):
  200. self.base_dir = 'tests/fixtures/simple-dockerfile'
  201. self.dispatch(['build', 'simple'])
  202. result = self.dispatch(['build', 'simple'])
  203. assert BUILD_CACHE_TEXT in result.stdout
  204. assert BUILD_PULL_TEXT not in result.stdout
  205. def test_build_no_cache(self):
  206. self.base_dir = 'tests/fixtures/simple-dockerfile'
  207. self.dispatch(['build', 'simple'])
  208. result = self.dispatch(['build', '--no-cache', 'simple'])
  209. assert BUILD_CACHE_TEXT not in result.stdout
  210. assert BUILD_PULL_TEXT not in result.stdout
  211. def test_build_pull(self):
  212. # Make sure we have the latest busybox already
  213. pull_busybox(self.client)
  214. self.base_dir = 'tests/fixtures/simple-dockerfile'
  215. self.dispatch(['build', 'simple'], None)
  216. result = self.dispatch(['build', '--pull', 'simple'])
  217. assert BUILD_CACHE_TEXT in result.stdout
  218. assert BUILD_PULL_TEXT in result.stdout
  219. def test_build_no_cache_pull(self):
  220. # Make sure we have the latest busybox already
  221. pull_busybox(self.client)
  222. self.base_dir = 'tests/fixtures/simple-dockerfile'
  223. self.dispatch(['build', 'simple'])
  224. result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
  225. assert BUILD_CACHE_TEXT not in result.stdout
  226. assert BUILD_PULL_TEXT in result.stdout
  227. def test_build_failed(self):
  228. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  229. self.dispatch(['build', 'simple'], returncode=1)
  230. labels = ["com.docker.compose.test_failing_image=true"]
  231. containers = [
  232. Container.from_ps(self.project.client, c)
  233. for c in self.project.client.containers(
  234. all=True,
  235. filters={"label": labels})
  236. ]
  237. assert len(containers) == 1
  238. def test_build_failed_forcerm(self):
  239. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  240. self.dispatch(['build', '--force-rm', 'simple'], returncode=1)
  241. labels = ["com.docker.compose.test_failing_image=true"]
  242. containers = [
  243. Container.from_ps(self.project.client, c)
  244. for c in self.project.client.containers(
  245. all=True,
  246. filters={"label": labels})
  247. ]
  248. assert not containers
  249. def test_create(self):
  250. self.dispatch(['create'])
  251. service = self.project.get_service('simple')
  252. another = self.project.get_service('another')
  253. self.assertEqual(len(service.containers()), 0)
  254. self.assertEqual(len(another.containers()), 0)
  255. self.assertEqual(len(service.containers(stopped=True)), 1)
  256. self.assertEqual(len(another.containers(stopped=True)), 1)
  257. def test_create_with_force_recreate(self):
  258. self.dispatch(['create'], None)
  259. service = self.project.get_service('simple')
  260. self.assertEqual(len(service.containers()), 0)
  261. self.assertEqual(len(service.containers(stopped=True)), 1)
  262. old_ids = [c.id for c in service.containers(stopped=True)]
  263. self.dispatch(['create', '--force-recreate'], None)
  264. self.assertEqual(len(service.containers()), 0)
  265. self.assertEqual(len(service.containers(stopped=True)), 1)
  266. new_ids = [c.id for c in service.containers(stopped=True)]
  267. self.assertNotEqual(old_ids, new_ids)
  268. def test_create_with_no_recreate(self):
  269. self.dispatch(['create'], None)
  270. service = self.project.get_service('simple')
  271. self.assertEqual(len(service.containers()), 0)
  272. self.assertEqual(len(service.containers(stopped=True)), 1)
  273. old_ids = [c.id for c in service.containers(stopped=True)]
  274. self.dispatch(['create', '--no-recreate'], None)
  275. self.assertEqual(len(service.containers()), 0)
  276. self.assertEqual(len(service.containers(stopped=True)), 1)
  277. new_ids = [c.id for c in service.containers(stopped=True)]
  278. self.assertEqual(old_ids, new_ids)
  279. def test_create_with_force_recreate_and_no_recreate(self):
  280. self.dispatch(
  281. ['create', '--force-recreate', '--no-recreate'],
  282. returncode=1)
  283. def test_down_invalid_rmi_flag(self):
  284. result = self.dispatch(['down', '--rmi', 'bogus'], returncode=1)
  285. assert '--rmi flag must be' in result.stderr
  286. @v2_only()
  287. def test_down(self):
  288. self.base_dir = 'tests/fixtures/v2-full'
  289. self.dispatch(['up', '-d'])
  290. wait_on_condition(ContainerCountCondition(self.project, 2))
  291. self.dispatch(['run', 'web', 'true'])
  292. self.dispatch(['run', '-d', 'web', 'tail', '-f', '/dev/null'])
  293. assert len(self.project.containers(one_off=OneOffFilter.only, stopped=True)) == 2
  294. result = self.dispatch(['down', '--rmi=local', '--volumes'])
  295. assert 'Stopping v2full_web_1' in result.stderr
  296. assert 'Stopping v2full_other_1' in result.stderr
  297. assert 'Stopping v2full_web_run_2' in result.stderr
  298. assert 'Removing v2full_web_1' in result.stderr
  299. assert 'Removing v2full_other_1' in result.stderr
  300. assert 'Removing v2full_web_run_1' in result.stderr
  301. assert 'Removing v2full_web_run_2' in result.stderr
  302. assert 'Removing volume v2full_data' in result.stderr
  303. assert 'Removing image v2full_web' in result.stderr
  304. assert 'Removing image busybox' not in result.stderr
  305. assert 'Removing network v2full_default' in result.stderr
  306. assert 'Removing network v2full_front' in result.stderr
  307. def test_up_detached(self):
  308. self.dispatch(['up', '-d'])
  309. service = self.project.get_service('simple')
  310. another = self.project.get_service('another')
  311. self.assertEqual(len(service.containers()), 1)
  312. self.assertEqual(len(another.containers()), 1)
  313. # Ensure containers don't have stdin and stdout connected in -d mode
  314. container, = service.containers()
  315. self.assertFalse(container.get('Config.AttachStderr'))
  316. self.assertFalse(container.get('Config.AttachStdout'))
  317. self.assertFalse(container.get('Config.AttachStdin'))
  318. def test_up_attached(self):
  319. self.base_dir = 'tests/fixtures/echo-services'
  320. result = self.dispatch(['up', '--no-color'])
  321. assert 'simple_1 | simple' in result.stdout
  322. assert 'another_1 | another' in result.stdout
  323. assert 'simple_1 exited with code 0' in result.stdout
  324. assert 'another_1 exited with code 0' in result.stdout
  325. @v2_only()
  326. def test_up(self):
  327. self.base_dir = 'tests/fixtures/v2-simple'
  328. self.dispatch(['up', '-d'], None)
  329. services = self.project.get_services()
  330. network_name = self.project.networks.networks['default'].full_name
  331. networks = self.client.networks(names=[network_name])
  332. self.assertEqual(len(networks), 1)
  333. self.assertEqual(networks[0]['Driver'], 'bridge')
  334. assert 'com.docker.network.bridge.enable_icc' not in networks[0]['Options']
  335. network = self.client.inspect_network(networks[0]['Id'])
  336. for service in services:
  337. containers = service.containers()
  338. self.assertEqual(len(containers), 1)
  339. container = containers[0]
  340. self.assertIn(container.id, network['Containers'])
  341. networks = container.get('NetworkSettings.Networks')
  342. self.assertEqual(list(networks), [network['Name']])
  343. self.assertEqual(
  344. sorted(networks[network['Name']]['Aliases']),
  345. sorted([service.name, container.short_id]))
  346. for service in services:
  347. assert self.lookup(container, service.name)
  348. @v2_only()
  349. def test_up_with_default_network_config(self):
  350. filename = 'default-network-config.yml'
  351. self.base_dir = 'tests/fixtures/networks'
  352. self._project = get_project(self.base_dir, [filename])
  353. self.dispatch(['-f', filename, 'up', '-d'], None)
  354. network_name = self.project.networks.networks['default'].full_name
  355. networks = self.client.networks(names=[network_name])
  356. assert networks[0]['Options']['com.docker.network.bridge.enable_icc'] == 'false'
  357. @v2_only()
  358. def test_up_with_network_aliases(self):
  359. filename = 'network-aliases.yml'
  360. self.base_dir = 'tests/fixtures/networks'
  361. self.dispatch(['-f', filename, 'up', '-d'], None)
  362. back_name = '{}_back'.format(self.project.name)
  363. front_name = '{}_front'.format(self.project.name)
  364. networks = [
  365. n for n in self.client.networks()
  366. if n['Name'].startswith('{}_'.format(self.project.name))
  367. ]
  368. # Two networks were created: back and front
  369. assert sorted(n['Name'] for n in networks) == [back_name, front_name]
  370. web_container = self.project.get_service('web').containers()[0]
  371. back_aliases = web_container.get(
  372. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  373. )
  374. assert 'web' in back_aliases
  375. front_aliases = web_container.get(
  376. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  377. )
  378. assert 'web' in front_aliases
  379. assert 'forward_facing' in front_aliases
  380. assert 'ahead' in front_aliases
  381. @v2_only()
  382. def test_up_with_network_static_addresses(self):
  383. filename = 'network-static-addresses.yml'
  384. ipv4_address = '172.16.100.100'
  385. ipv6_address = 'fe80::1001:100'
  386. self.base_dir = 'tests/fixtures/networks'
  387. self.dispatch(['-f', filename, 'up', '-d'], None)
  388. static_net = '{}_static_test'.format(self.project.name)
  389. networks = [
  390. n for n in self.client.networks()
  391. if n['Name'].startswith('{}_'.format(self.project.name))
  392. ]
  393. # One networks was created: front
  394. assert sorted(n['Name'] for n in networks) == [static_net]
  395. web_container = self.project.get_service('web').containers()[0]
  396. ipam_config = web_container.get(
  397. 'NetworkSettings.Networks.{}.IPAMConfig'.format(static_net)
  398. )
  399. assert ipv4_address in ipam_config.values()
  400. assert ipv6_address in ipam_config.values()
  401. @v2_only()
  402. def test_up_with_networks(self):
  403. self.base_dir = 'tests/fixtures/networks'
  404. self.dispatch(['up', '-d'], None)
  405. back_name = '{}_back'.format(self.project.name)
  406. front_name = '{}_front'.format(self.project.name)
  407. networks = [
  408. n for n in self.client.networks()
  409. if n['Name'].startswith('{}_'.format(self.project.name))
  410. ]
  411. # Two networks were created: back and front
  412. assert sorted(n['Name'] for n in networks) == [back_name, front_name]
  413. back_network = [n for n in networks if n['Name'] == back_name][0]
  414. front_network = [n for n in networks if n['Name'] == front_name][0]
  415. web_container = self.project.get_service('web').containers()[0]
  416. app_container = self.project.get_service('app').containers()[0]
  417. db_container = self.project.get_service('db').containers()[0]
  418. for net_name in [front_name, back_name]:
  419. links = app_container.get('NetworkSettings.Networks.{}.Links'.format(net_name))
  420. assert '{}:database'.format(db_container.name) in links
  421. # db and app joined the back network
  422. assert sorted(back_network['Containers']) == sorted([db_container.id, app_container.id])
  423. # web and app joined the front network
  424. assert sorted(front_network['Containers']) == sorted([web_container.id, app_container.id])
  425. # web can see app but not db
  426. assert self.lookup(web_container, "app")
  427. assert not self.lookup(web_container, "db")
  428. # app can see db
  429. assert self.lookup(app_container, "db")
  430. # app has aliased db to "database"
  431. assert self.lookup(app_container, "database")
  432. @v2_only()
  433. def test_up_missing_network(self):
  434. self.base_dir = 'tests/fixtures/networks'
  435. result = self.dispatch(
  436. ['-f', 'missing-network.yml', 'up', '-d'],
  437. returncode=1)
  438. assert 'Service "web" uses an undefined network "foo"' in result.stderr
  439. @v2_only()
  440. def test_up_with_network_mode(self):
  441. c = self.client.create_container('busybox', 'top', name='composetest_network_mode_container')
  442. self.addCleanup(self.client.remove_container, c, force=True)
  443. self.client.start(c)
  444. container_mode_source = 'container:{}'.format(c['Id'])
  445. filename = 'network-mode.yml'
  446. self.base_dir = 'tests/fixtures/networks'
  447. self._project = get_project(self.base_dir, [filename])
  448. self.dispatch(['-f', filename, 'up', '-d'], None)
  449. networks = [
  450. n for n in self.client.networks()
  451. if n['Name'].startswith('{}_'.format(self.project.name))
  452. ]
  453. assert not networks
  454. for name in ['bridge', 'host', 'none']:
  455. container = self.project.get_service(name).containers()[0]
  456. assert list(container.get('NetworkSettings.Networks')) == [name]
  457. assert container.get('HostConfig.NetworkMode') == name
  458. service_mode_source = 'container:{}'.format(
  459. self.project.get_service('bridge').containers()[0].id)
  460. service_mode_container = self.project.get_service('service').containers()[0]
  461. assert not service_mode_container.get('NetworkSettings.Networks')
  462. assert service_mode_container.get('HostConfig.NetworkMode') == service_mode_source
  463. container_mode_container = self.project.get_service('container').containers()[0]
  464. assert not container_mode_container.get('NetworkSettings.Networks')
  465. assert container_mode_container.get('HostConfig.NetworkMode') == container_mode_source
  466. @v2_only()
  467. def test_up_external_networks(self):
  468. filename = 'external-networks.yml'
  469. self.base_dir = 'tests/fixtures/networks'
  470. self._project = get_project(self.base_dir, [filename])
  471. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  472. assert 'declared as external, but could not be found' in result.stderr
  473. networks = [
  474. n['Name'] for n in self.client.networks()
  475. if n['Name'].startswith('{}_'.format(self.project.name))
  476. ]
  477. assert not networks
  478. network_names = ['{}_{}'.format(self.project.name, n) for n in ['foo', 'bar']]
  479. for name in network_names:
  480. self.client.create_network(name)
  481. self.dispatch(['-f', filename, 'up', '-d'])
  482. container = self.project.containers()[0]
  483. assert sorted(list(container.get('NetworkSettings.Networks'))) == sorted(network_names)
  484. @v2_only()
  485. def test_up_with_external_default_network(self):
  486. filename = 'external-default.yml'
  487. self.base_dir = 'tests/fixtures/networks'
  488. self._project = get_project(self.base_dir, [filename])
  489. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  490. assert 'declared as external, but could not be found' in result.stderr
  491. networks = [
  492. n['Name'] for n in self.client.networks()
  493. if n['Name'].startswith('{}_'.format(self.project.name))
  494. ]
  495. assert not networks
  496. network_name = 'composetest_external_network'
  497. self.client.create_network(network_name)
  498. self.dispatch(['-f', filename, 'up', '-d'])
  499. container = self.project.containers()[0]
  500. assert list(container.get('NetworkSettings.Networks')) == [network_name]
  501. @v2_only()
  502. def test_up_no_services(self):
  503. self.base_dir = 'tests/fixtures/no-services'
  504. self.dispatch(['up', '-d'], None)
  505. network_names = [
  506. n['Name'] for n in self.client.networks()
  507. if n['Name'].startswith('{}_'.format(self.project.name))
  508. ]
  509. assert network_names == []
  510. def test_up_with_links_v1(self):
  511. self.base_dir = 'tests/fixtures/links-composefile'
  512. self.dispatch(['up', '-d', 'web'], None)
  513. # No network was created
  514. network_name = self.project.networks.networks['default'].full_name
  515. networks = self.client.networks(names=[network_name])
  516. assert networks == []
  517. web = self.project.get_service('web')
  518. db = self.project.get_service('db')
  519. console = self.project.get_service('console')
  520. # console was not started
  521. self.assertEqual(len(web.containers()), 1)
  522. self.assertEqual(len(db.containers()), 1)
  523. self.assertEqual(len(console.containers()), 0)
  524. # web has links
  525. web_container = web.containers()[0]
  526. self.assertTrue(web_container.get('HostConfig.Links'))
  527. def test_up_with_net_is_invalid(self):
  528. self.base_dir = 'tests/fixtures/net-container'
  529. result = self.dispatch(
  530. ['-f', 'v2-invalid.yml', 'up', '-d'],
  531. returncode=1)
  532. # TODO: fix validation error messages for v2 files
  533. # assert "Unsupported config option for service 'web': 'net'" in exc.exconly()
  534. assert "Unsupported config option" in result.stderr
  535. def test_up_with_net_v1(self):
  536. self.base_dir = 'tests/fixtures/net-container'
  537. self.dispatch(['up', '-d'], None)
  538. bar = self.project.get_service('bar')
  539. bar_container = bar.containers()[0]
  540. foo = self.project.get_service('foo')
  541. foo_container = foo.containers()[0]
  542. assert foo_container.get('HostConfig.NetworkMode') == \
  543. 'container:{}'.format(bar_container.id)
  544. def test_up_with_no_deps(self):
  545. self.base_dir = 'tests/fixtures/links-composefile'
  546. self.dispatch(['up', '-d', '--no-deps', 'web'], None)
  547. web = self.project.get_service('web')
  548. db = self.project.get_service('db')
  549. console = self.project.get_service('console')
  550. self.assertEqual(len(web.containers()), 1)
  551. self.assertEqual(len(db.containers()), 0)
  552. self.assertEqual(len(console.containers()), 0)
  553. def test_up_with_force_recreate(self):
  554. self.dispatch(['up', '-d'], None)
  555. service = self.project.get_service('simple')
  556. self.assertEqual(len(service.containers()), 1)
  557. old_ids = [c.id for c in service.containers()]
  558. self.dispatch(['up', '-d', '--force-recreate'], None)
  559. self.assertEqual(len(service.containers()), 1)
  560. new_ids = [c.id for c in service.containers()]
  561. self.assertNotEqual(old_ids, new_ids)
  562. def test_up_with_no_recreate(self):
  563. self.dispatch(['up', '-d'], None)
  564. service = self.project.get_service('simple')
  565. self.assertEqual(len(service.containers()), 1)
  566. old_ids = [c.id for c in service.containers()]
  567. self.dispatch(['up', '-d', '--no-recreate'], None)
  568. self.assertEqual(len(service.containers()), 1)
  569. new_ids = [c.id for c in service.containers()]
  570. self.assertEqual(old_ids, new_ids)
  571. def test_up_with_force_recreate_and_no_recreate(self):
  572. self.dispatch(
  573. ['up', '-d', '--force-recreate', '--no-recreate'],
  574. returncode=1)
  575. def test_up_with_timeout(self):
  576. self.dispatch(['up', '-d', '-t', '1'])
  577. service = self.project.get_service('simple')
  578. another = self.project.get_service('another')
  579. self.assertEqual(len(service.containers()), 1)
  580. self.assertEqual(len(another.containers()), 1)
  581. # Ensure containers don't have stdin and stdout connected in -d mode
  582. config = service.containers()[0].inspect()['Config']
  583. self.assertFalse(config['AttachStderr'])
  584. self.assertFalse(config['AttachStdout'])
  585. self.assertFalse(config['AttachStdin'])
  586. def test_up_handles_sigint(self):
  587. proc = start_process(self.base_dir, ['up', '-t', '2'])
  588. wait_on_condition(ContainerCountCondition(self.project, 2))
  589. os.kill(proc.pid, signal.SIGINT)
  590. wait_on_condition(ContainerCountCondition(self.project, 0))
  591. def test_up_handles_sigterm(self):
  592. proc = start_process(self.base_dir, ['up', '-t', '2'])
  593. wait_on_condition(ContainerCountCondition(self.project, 2))
  594. os.kill(proc.pid, signal.SIGTERM)
  595. wait_on_condition(ContainerCountCondition(self.project, 0))
  596. @v2_only()
  597. def test_up_handles_force_shutdown(self):
  598. self.base_dir = 'tests/fixtures/sleeps-composefile'
  599. proc = start_process(self.base_dir, ['up', '-t', '200'])
  600. wait_on_condition(ContainerCountCondition(self.project, 2))
  601. os.kill(proc.pid, signal.SIGTERM)
  602. time.sleep(0.1)
  603. os.kill(proc.pid, signal.SIGTERM)
  604. wait_on_condition(ContainerCountCondition(self.project, 0))
  605. def test_up_handles_abort_on_container_exit(self):
  606. start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  607. wait_on_condition(ContainerCountCondition(self.project, 2))
  608. self.project.stop(['simple'])
  609. wait_on_condition(ContainerCountCondition(self.project, 0))
  610. def test_exec_without_tty(self):
  611. self.base_dir = 'tests/fixtures/links-composefile'
  612. self.dispatch(['up', '-d', 'console'])
  613. self.assertEqual(len(self.project.containers()), 1)
  614. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  615. self.assertEquals(stdout, "/\n")
  616. self.assertEquals(stderr, "")
  617. def test_exec_custom_user(self):
  618. self.base_dir = 'tests/fixtures/links-composefile'
  619. self.dispatch(['up', '-d', 'console'])
  620. self.assertEqual(len(self.project.containers()), 1)
  621. stdout, stderr = self.dispatch(['exec', '-T', '--user=operator', 'console', 'whoami'])
  622. self.assertEquals(stdout, "operator\n")
  623. self.assertEquals(stderr, "")
  624. def test_run_service_without_links(self):
  625. self.base_dir = 'tests/fixtures/links-composefile'
  626. self.dispatch(['run', 'console', '/bin/true'])
  627. self.assertEqual(len(self.project.containers()), 0)
  628. # Ensure stdin/out was open
  629. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  630. config = container.inspect()['Config']
  631. self.assertTrue(config['AttachStderr'])
  632. self.assertTrue(config['AttachStdout'])
  633. self.assertTrue(config['AttachStdin'])
  634. def test_run_service_with_links(self):
  635. self.base_dir = 'tests/fixtures/links-composefile'
  636. self.dispatch(['run', 'web', '/bin/true'], None)
  637. db = self.project.get_service('db')
  638. console = self.project.get_service('console')
  639. self.assertEqual(len(db.containers()), 1)
  640. self.assertEqual(len(console.containers()), 0)
  641. @v2_only()
  642. def test_run_service_with_dependencies(self):
  643. self.base_dir = 'tests/fixtures/v2-dependencies'
  644. self.dispatch(['run', 'web', '/bin/true'], None)
  645. db = self.project.get_service('db')
  646. console = self.project.get_service('console')
  647. self.assertEqual(len(db.containers()), 1)
  648. self.assertEqual(len(console.containers()), 0)
  649. def test_run_with_no_deps(self):
  650. self.base_dir = 'tests/fixtures/links-composefile'
  651. self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
  652. db = self.project.get_service('db')
  653. self.assertEqual(len(db.containers()), 0)
  654. def test_run_does_not_recreate_linked_containers(self):
  655. self.base_dir = 'tests/fixtures/links-composefile'
  656. self.dispatch(['up', '-d', 'db'])
  657. db = self.project.get_service('db')
  658. self.assertEqual(len(db.containers()), 1)
  659. old_ids = [c.id for c in db.containers()]
  660. self.dispatch(['run', 'web', '/bin/true'], None)
  661. self.assertEqual(len(db.containers()), 1)
  662. new_ids = [c.id for c in db.containers()]
  663. self.assertEqual(old_ids, new_ids)
  664. def test_run_without_command(self):
  665. self.base_dir = 'tests/fixtures/commands-composefile'
  666. self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  667. self.dispatch(['run', 'implicit'])
  668. service = self.project.get_service('implicit')
  669. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  670. self.assertEqual(
  671. [c.human_readable_command for c in containers],
  672. [u'/bin/sh -c echo "success"'],
  673. )
  674. self.dispatch(['run', 'explicit'])
  675. service = self.project.get_service('explicit')
  676. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  677. self.assertEqual(
  678. [c.human_readable_command for c in containers],
  679. [u'/bin/true'],
  680. )
  681. def test_run_service_with_entrypoint_overridden(self):
  682. self.base_dir = 'tests/fixtures/dockerfile_with_entrypoint'
  683. name = 'service'
  684. self.dispatch(['run', '--entrypoint', '/bin/echo', name, 'helloworld'])
  685. service = self.project.get_service(name)
  686. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  687. self.assertEqual(
  688. shlex.split(container.human_readable_command),
  689. [u'/bin/echo', u'helloworld'],
  690. )
  691. def test_run_service_with_user_overridden(self):
  692. self.base_dir = 'tests/fixtures/user-composefile'
  693. name = 'service'
  694. user = 'sshd'
  695. self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
  696. service = self.project.get_service(name)
  697. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  698. self.assertEqual(user, container.get('Config.User'))
  699. def test_run_service_with_user_overridden_short_form(self):
  700. self.base_dir = 'tests/fixtures/user-composefile'
  701. name = 'service'
  702. user = 'sshd'
  703. self.dispatch(['run', '-u', user, name], returncode=1)
  704. service = self.project.get_service(name)
  705. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  706. self.assertEqual(user, container.get('Config.User'))
  707. def test_run_service_with_environement_overridden(self):
  708. name = 'service'
  709. self.base_dir = 'tests/fixtures/environment-composefile'
  710. self.dispatch([
  711. 'run', '-e', 'foo=notbar',
  712. '-e', 'allo=moto=bobo',
  713. '-e', 'alpha=beta',
  714. name,
  715. '/bin/true',
  716. ])
  717. service = self.project.get_service(name)
  718. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  719. # env overriden
  720. self.assertEqual('notbar', container.environment['foo'])
  721. # keep environement from yaml
  722. self.assertEqual('world', container.environment['hello'])
  723. # added option from command line
  724. self.assertEqual('beta', container.environment['alpha'])
  725. # make sure a value with a = don't crash out
  726. self.assertEqual('moto=bobo', container.environment['allo'])
  727. def test_run_service_without_map_ports(self):
  728. # create one off container
  729. self.base_dir = 'tests/fixtures/ports-composefile'
  730. self.dispatch(['run', '-d', 'simple'])
  731. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  732. # get port information
  733. port_random = container.get_local_port(3000)
  734. port_assigned = container.get_local_port(3001)
  735. # close all one off containers we just created
  736. container.stop()
  737. # check the ports
  738. self.assertEqual(port_random, None)
  739. self.assertEqual(port_assigned, None)
  740. def test_run_service_with_map_ports(self):
  741. # create one off container
  742. self.base_dir = 'tests/fixtures/ports-composefile'
  743. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  744. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  745. # get port information
  746. port_random = container.get_local_port(3000)
  747. port_assigned = container.get_local_port(3001)
  748. port_range = container.get_local_port(3002), container.get_local_port(3003)
  749. # close all one off containers we just created
  750. container.stop()
  751. # check the ports
  752. self.assertNotEqual(port_random, None)
  753. self.assertIn("0.0.0.0", port_random)
  754. self.assertEqual(port_assigned, "0.0.0.0:49152")
  755. self.assertEqual(port_range[0], "0.0.0.0:49153")
  756. self.assertEqual(port_range[1], "0.0.0.0:49154")
  757. def test_run_service_with_explicitly_maped_ports(self):
  758. # create one off container
  759. self.base_dir = 'tests/fixtures/ports-composefile'
  760. self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
  761. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  762. # get port information
  763. port_short = container.get_local_port(3000)
  764. port_full = container.get_local_port(3001)
  765. # close all one off containers we just created
  766. container.stop()
  767. # check the ports
  768. self.assertEqual(port_short, "0.0.0.0:30000")
  769. self.assertEqual(port_full, "0.0.0.0:30001")
  770. def test_run_service_with_explicitly_maped_ip_ports(self):
  771. # create one off container
  772. self.base_dir = 'tests/fixtures/ports-composefile'
  773. self.dispatch([
  774. 'run', '-d',
  775. '-p', '127.0.0.1:30000:3000',
  776. '--publish', '127.0.0.1:30001:3001',
  777. 'simple'
  778. ])
  779. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  780. # get port information
  781. port_short = container.get_local_port(3000)
  782. port_full = container.get_local_port(3001)
  783. # close all one off containers we just created
  784. container.stop()
  785. # check the ports
  786. self.assertEqual(port_short, "127.0.0.1:30000")
  787. self.assertEqual(port_full, "127.0.0.1:30001")
  788. def test_run_with_expose_ports(self):
  789. # create one off container
  790. self.base_dir = 'tests/fixtures/expose-composefile'
  791. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  792. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  793. ports = container.ports
  794. self.assertEqual(len(ports), 9)
  795. # exposed ports are not mapped to host ports
  796. assert ports['3000/tcp'] is None
  797. assert ports['3001/tcp'] is None
  798. assert ports['3001/udp'] is None
  799. assert ports['3002/tcp'] is None
  800. assert ports['3003/tcp'] is None
  801. assert ports['3004/tcp'] is None
  802. assert ports['3005/tcp'] is None
  803. assert ports['3006/udp'] is None
  804. assert ports['3007/udp'] is None
  805. # close all one off containers we just created
  806. container.stop()
  807. def test_run_with_custom_name(self):
  808. self.base_dir = 'tests/fixtures/environment-composefile'
  809. name = 'the-container-name'
  810. self.dispatch(['run', '--name', name, 'service', '/bin/true'])
  811. service = self.project.get_service('service')
  812. container, = service.containers(stopped=True, one_off=OneOffFilter.only)
  813. self.assertEqual(container.name, name)
  814. def test_run_service_with_workdir_overridden(self):
  815. self.base_dir = 'tests/fixtures/run-workdir'
  816. name = 'service'
  817. workdir = '/var'
  818. self.dispatch(['run', '--workdir={workdir}'.format(workdir=workdir), name])
  819. service = self.project.get_service(name)
  820. container = service.containers(stopped=True, one_off=True)[0]
  821. self.assertEqual(workdir, container.get('Config.WorkingDir'))
  822. def test_run_service_with_workdir_overridden_short_form(self):
  823. self.base_dir = 'tests/fixtures/run-workdir'
  824. name = 'service'
  825. workdir = '/var'
  826. self.dispatch(['run', '-w', workdir, name])
  827. service = self.project.get_service(name)
  828. container = service.containers(stopped=True, one_off=True)[0]
  829. self.assertEqual(workdir, container.get('Config.WorkingDir'))
  830. @v2_only()
  831. def test_run_interactive_connects_to_network(self):
  832. self.base_dir = 'tests/fixtures/networks'
  833. self.dispatch(['up', '-d'])
  834. self.dispatch(['run', 'app', 'nslookup', 'app'])
  835. self.dispatch(['run', 'app', 'nslookup', 'db'])
  836. containers = self.project.get_service('app').containers(
  837. stopped=True, one_off=OneOffFilter.only)
  838. assert len(containers) == 2
  839. for container in containers:
  840. networks = container.get('NetworkSettings.Networks')
  841. assert sorted(list(networks)) == [
  842. '{}_{}'.format(self.project.name, name)
  843. for name in ['back', 'front']
  844. ]
  845. for _, config in networks.items():
  846. assert not config['Aliases']
  847. @v2_only()
  848. def test_run_detached_connects_to_network(self):
  849. self.base_dir = 'tests/fixtures/networks'
  850. self.dispatch(['up', '-d'])
  851. self.dispatch(['run', '-d', 'app', 'top'])
  852. container = self.project.get_service('app').containers(one_off=OneOffFilter.only)[0]
  853. networks = container.get('NetworkSettings.Networks')
  854. assert sorted(list(networks)) == [
  855. '{}_{}'.format(self.project.name, name)
  856. for name in ['back', 'front']
  857. ]
  858. for _, config in networks.items():
  859. assert not config['Aliases']
  860. assert self.lookup(container, 'app')
  861. assert self.lookup(container, 'db')
  862. def test_run_handles_sigint(self):
  863. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  864. wait_on_condition(ContainerStateCondition(
  865. self.project.client,
  866. 'simplecomposefile_simple_run_1',
  867. 'running'))
  868. os.kill(proc.pid, signal.SIGINT)
  869. wait_on_condition(ContainerStateCondition(
  870. self.project.client,
  871. 'simplecomposefile_simple_run_1',
  872. 'exited'))
  873. def test_run_handles_sigterm(self):
  874. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  875. wait_on_condition(ContainerStateCondition(
  876. self.project.client,
  877. 'simplecomposefile_simple_run_1',
  878. 'running'))
  879. os.kill(proc.pid, signal.SIGTERM)
  880. wait_on_condition(ContainerStateCondition(
  881. self.project.client,
  882. 'simplecomposefile_simple_run_1',
  883. 'exited'))
  884. def test_rm(self):
  885. service = self.project.get_service('simple')
  886. service.create_container()
  887. kill_service(service)
  888. self.assertEqual(len(service.containers(stopped=True)), 1)
  889. self.dispatch(['rm', '--force'], None)
  890. self.assertEqual(len(service.containers(stopped=True)), 0)
  891. service = self.project.get_service('simple')
  892. service.create_container()
  893. kill_service(service)
  894. self.assertEqual(len(service.containers(stopped=True)), 1)
  895. self.dispatch(['rm', '-f'], None)
  896. self.assertEqual(len(service.containers(stopped=True)), 0)
  897. def test_rm_all(self):
  898. service = self.project.get_service('simple')
  899. service.create_container(one_off=False)
  900. service.create_container(one_off=True)
  901. kill_service(service)
  902. self.assertEqual(len(service.containers(stopped=True)), 1)
  903. self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 1)
  904. self.dispatch(['rm', '-f'], None)
  905. self.assertEqual(len(service.containers(stopped=True)), 0)
  906. self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 1)
  907. self.dispatch(['rm', '-f', '-a'], None)
  908. self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 0)
  909. service.create_container(one_off=False)
  910. service.create_container(one_off=True)
  911. kill_service(service)
  912. self.assertEqual(len(service.containers(stopped=True)), 1)
  913. self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 1)
  914. self.dispatch(['rm', '-f', '--all'], None)
  915. self.assertEqual(len(service.containers(stopped=True)), 0)
  916. self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 0)
  917. def test_stop(self):
  918. self.dispatch(['up', '-d'], None)
  919. service = self.project.get_service('simple')
  920. self.assertEqual(len(service.containers()), 1)
  921. self.assertTrue(service.containers()[0].is_running)
  922. self.dispatch(['stop', '-t', '1'], None)
  923. self.assertEqual(len(service.containers(stopped=True)), 1)
  924. self.assertFalse(service.containers(stopped=True)[0].is_running)
  925. def test_stop_signal(self):
  926. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  927. self.dispatch(['up', '-d'], None)
  928. service = self.project.get_service('simple')
  929. self.assertEqual(len(service.containers()), 1)
  930. self.assertTrue(service.containers()[0].is_running)
  931. self.dispatch(['stop', '-t', '1'], None)
  932. self.assertEqual(len(service.containers(stopped=True)), 1)
  933. self.assertFalse(service.containers(stopped=True)[0].is_running)
  934. self.assertEqual(service.containers(stopped=True)[0].exit_code, 0)
  935. def test_start_no_containers(self):
  936. result = self.dispatch(['start'], returncode=1)
  937. assert 'No containers to start' in result.stderr
  938. @v2_only()
  939. def test_up_logging(self):
  940. self.base_dir = 'tests/fixtures/logging-composefile'
  941. self.dispatch(['up', '-d'])
  942. simple = self.project.get_service('simple').containers()[0]
  943. log_config = simple.get('HostConfig.LogConfig')
  944. self.assertTrue(log_config)
  945. self.assertEqual(log_config.get('Type'), 'none')
  946. another = self.project.get_service('another').containers()[0]
  947. log_config = another.get('HostConfig.LogConfig')
  948. self.assertTrue(log_config)
  949. self.assertEqual(log_config.get('Type'), 'json-file')
  950. self.assertEqual(log_config.get('Config')['max-size'], '10m')
  951. def test_up_logging_legacy(self):
  952. self.base_dir = 'tests/fixtures/logging-composefile-legacy'
  953. self.dispatch(['up', '-d'])
  954. simple = self.project.get_service('simple').containers()[0]
  955. log_config = simple.get('HostConfig.LogConfig')
  956. self.assertTrue(log_config)
  957. self.assertEqual(log_config.get('Type'), 'none')
  958. another = self.project.get_service('another').containers()[0]
  959. log_config = another.get('HostConfig.LogConfig')
  960. self.assertTrue(log_config)
  961. self.assertEqual(log_config.get('Type'), 'json-file')
  962. self.assertEqual(log_config.get('Config')['max-size'], '10m')
  963. def test_pause_unpause(self):
  964. self.dispatch(['up', '-d'], None)
  965. service = self.project.get_service('simple')
  966. self.assertFalse(service.containers()[0].is_paused)
  967. self.dispatch(['pause'], None)
  968. self.assertTrue(service.containers()[0].is_paused)
  969. self.dispatch(['unpause'], None)
  970. self.assertFalse(service.containers()[0].is_paused)
  971. def test_pause_no_containers(self):
  972. result = self.dispatch(['pause'], returncode=1)
  973. assert 'No containers to pause' in result.stderr
  974. def test_unpause_no_containers(self):
  975. result = self.dispatch(['unpause'], returncode=1)
  976. assert 'No containers to unpause' in result.stderr
  977. def test_logs_invalid_service_name(self):
  978. self.dispatch(['logs', 'madeupname'], returncode=1)
  979. def test_logs_follow(self):
  980. self.base_dir = 'tests/fixtures/echo-services'
  981. self.dispatch(['up', '-d'])
  982. result = self.dispatch(['logs', '-f'])
  983. assert result.stdout.count('\n') == 5
  984. assert 'simple' in result.stdout
  985. assert 'another' in result.stdout
  986. assert 'exited with code 0' in result.stdout
  987. def test_logs_follow_logs_from_new_containers(self):
  988. self.base_dir = 'tests/fixtures/logs-composefile'
  989. self.dispatch(['up', '-d', 'simple'])
  990. proc = start_process(self.base_dir, ['logs', '-f'])
  991. self.dispatch(['up', '-d', 'another'])
  992. wait_on_condition(ContainerStateCondition(
  993. self.project.client,
  994. 'logscomposefile_another_1',
  995. 'exited'))
  996. self.dispatch(['kill', 'simple'])
  997. result = wait_on_process(proc)
  998. assert 'hello' in result.stdout
  999. assert 'test' in result.stdout
  1000. assert 'logscomposefile_another_1 exited with code 0' in result.stdout
  1001. assert 'logscomposefile_simple_1 exited with code 137' in result.stdout
  1002. def test_logs_default(self):
  1003. self.base_dir = 'tests/fixtures/logs-composefile'
  1004. self.dispatch(['up', '-d'])
  1005. result = self.dispatch(['logs'])
  1006. assert 'hello' in result.stdout
  1007. assert 'test' in result.stdout
  1008. assert 'exited with' not in result.stdout
  1009. def test_logs_on_stopped_containers_exits(self):
  1010. self.base_dir = 'tests/fixtures/echo-services'
  1011. self.dispatch(['up'])
  1012. result = self.dispatch(['logs'])
  1013. assert 'simple' in result.stdout
  1014. assert 'another' in result.stdout
  1015. assert 'exited with' not in result.stdout
  1016. def test_logs_timestamps(self):
  1017. self.base_dir = 'tests/fixtures/echo-services'
  1018. self.dispatch(['up', '-d'])
  1019. result = self.dispatch(['logs', '-f', '-t'])
  1020. self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')
  1021. def test_logs_tail(self):
  1022. self.base_dir = 'tests/fixtures/logs-tail-composefile'
  1023. self.dispatch(['up'])
  1024. result = self.dispatch(['logs', '--tail', '2'])
  1025. assert result.stdout.count('\n') == 3
  1026. def test_kill(self):
  1027. self.dispatch(['up', '-d'], None)
  1028. service = self.project.get_service('simple')
  1029. self.assertEqual(len(service.containers()), 1)
  1030. self.assertTrue(service.containers()[0].is_running)
  1031. self.dispatch(['kill'], None)
  1032. self.assertEqual(len(service.containers(stopped=True)), 1)
  1033. self.assertFalse(service.containers(stopped=True)[0].is_running)
  1034. def test_kill_signal_sigstop(self):
  1035. self.dispatch(['up', '-d'], None)
  1036. service = self.project.get_service('simple')
  1037. self.assertEqual(len(service.containers()), 1)
  1038. self.assertTrue(service.containers()[0].is_running)
  1039. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1040. self.assertEqual(len(service.containers()), 1)
  1041. # The container is still running. It has only been paused
  1042. self.assertTrue(service.containers()[0].is_running)
  1043. def test_kill_stopped_service(self):
  1044. self.dispatch(['up', '-d'], None)
  1045. service = self.project.get_service('simple')
  1046. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1047. self.assertTrue(service.containers()[0].is_running)
  1048. self.dispatch(['kill', '-s', 'SIGKILL'], None)
  1049. self.assertEqual(len(service.containers(stopped=True)), 1)
  1050. self.assertFalse(service.containers(stopped=True)[0].is_running)
  1051. def test_restart(self):
  1052. service = self.project.get_service('simple')
  1053. container = service.create_container()
  1054. service.start_container(container)
  1055. started_at = container.dictionary['State']['StartedAt']
  1056. self.dispatch(['restart', '-t', '1'], None)
  1057. container.inspect()
  1058. self.assertNotEqual(
  1059. container.dictionary['State']['FinishedAt'],
  1060. '0001-01-01T00:00:00Z',
  1061. )
  1062. self.assertNotEqual(
  1063. container.dictionary['State']['StartedAt'],
  1064. started_at,
  1065. )
  1066. def test_restart_stopped_container(self):
  1067. service = self.project.get_service('simple')
  1068. container = service.create_container()
  1069. container.start()
  1070. container.kill()
  1071. self.assertEqual(len(service.containers(stopped=True)), 1)
  1072. self.dispatch(['restart', '-t', '1'], None)
  1073. self.assertEqual(len(service.containers(stopped=False)), 1)
  1074. def test_restart_no_containers(self):
  1075. result = self.dispatch(['restart'], returncode=1)
  1076. assert 'No containers to restart' in result.stderr
  1077. def test_scale(self):
  1078. project = self.project
  1079. self.dispatch(['scale', 'simple=1'])
  1080. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1081. self.dispatch(['scale', 'simple=3', 'another=2'])
  1082. self.assertEqual(len(project.get_service('simple').containers()), 3)
  1083. self.assertEqual(len(project.get_service('another').containers()), 2)
  1084. self.dispatch(['scale', 'simple=1', 'another=1'])
  1085. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1086. self.assertEqual(len(project.get_service('another').containers()), 1)
  1087. self.dispatch(['scale', 'simple=1', 'another=1'])
  1088. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1089. self.assertEqual(len(project.get_service('another').containers()), 1)
  1090. self.dispatch(['scale', 'simple=0', 'another=0'])
  1091. self.assertEqual(len(project.get_service('simple').containers()), 0)
  1092. self.assertEqual(len(project.get_service('another').containers()), 0)
  1093. def test_port(self):
  1094. self.base_dir = 'tests/fixtures/ports-composefile'
  1095. self.dispatch(['up', '-d'], None)
  1096. container = self.project.get_service('simple').get_container()
  1097. def get_port(number):
  1098. result = self.dispatch(['port', 'simple', str(number)])
  1099. return result.stdout.rstrip()
  1100. self.assertEqual(get_port(3000), container.get_local_port(3000))
  1101. self.assertEqual(get_port(3001), "0.0.0.0:49152")
  1102. self.assertEqual(get_port(3002), "0.0.0.0:49153")
  1103. def test_port_with_scale(self):
  1104. self.base_dir = 'tests/fixtures/ports-composefile-scale'
  1105. self.dispatch(['scale', 'simple=2'], None)
  1106. containers = sorted(
  1107. self.project.containers(service_names=['simple']),
  1108. key=attrgetter('name'))
  1109. def get_port(number, index=None):
  1110. if index is None:
  1111. result = self.dispatch(['port', 'simple', str(number)])
  1112. else:
  1113. result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
  1114. return result.stdout.rstrip()
  1115. self.assertEqual(get_port(3000), containers[0].get_local_port(3000))
  1116. self.assertEqual(get_port(3000, index=1), containers[0].get_local_port(3000))
  1117. self.assertEqual(get_port(3000, index=2), containers[1].get_local_port(3000))
  1118. self.assertEqual(get_port(3002), "")
  1119. def test_events_json(self):
  1120. events_proc = start_process(self.base_dir, ['events', '--json'])
  1121. self.dispatch(['up', '-d'])
  1122. wait_on_condition(ContainerCountCondition(self.project, 2))
  1123. os.kill(events_proc.pid, signal.SIGINT)
  1124. result = wait_on_process(events_proc, returncode=1)
  1125. lines = [json.loads(line) for line in result.stdout.rstrip().split('\n')]
  1126. assert Counter(e['action'] for e in lines) == {'create': 2, 'start': 2}
  1127. def test_events_human_readable(self):
  1128. events_proc = start_process(self.base_dir, ['events'])
  1129. self.dispatch(['up', '-d', 'simple'])
  1130. wait_on_condition(ContainerCountCondition(self.project, 1))
  1131. os.kill(events_proc.pid, signal.SIGINT)
  1132. result = wait_on_process(events_proc, returncode=1)
  1133. lines = result.stdout.rstrip().split('\n')
  1134. assert len(lines) == 2
  1135. container, = self.project.containers()
  1136. expected_template = (
  1137. ' container {} {} (image=busybox:latest, '
  1138. 'name=simplecomposefile_simple_1)')
  1139. assert expected_template.format('create', container.id) in lines[0]
  1140. assert expected_template.format('start', container.id) in lines[1]
  1141. assert lines[0].startswith(datetime.date.today().isoformat())
  1142. def test_env_file_relative_to_compose_file(self):
  1143. config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
  1144. self.dispatch(['-f', config_path, 'up', '-d'], None)
  1145. self._project = get_project(self.base_dir, [config_path])
  1146. containers = self.project.containers(stopped=True)
  1147. self.assertEqual(len(containers), 1)
  1148. self.assertIn("FOO=1", containers[0].get('Config.Env'))
  1149. @mock.patch.dict(os.environ)
  1150. def test_home_and_env_var_in_volume_path(self):
  1151. os.environ['VOLUME_NAME'] = 'my-volume'
  1152. os.environ['HOME'] = '/tmp/home-dir'
  1153. self.base_dir = 'tests/fixtures/volume-path-interpolation'
  1154. self.dispatch(['up', '-d'], None)
  1155. container = self.project.containers(stopped=True)[0]
  1156. actual_host_path = container.get_mount('/container-path')['Source']
  1157. components = actual_host_path.split('/')
  1158. assert components[-2:] == ['home-dir', 'my-volume']
  1159. def test_up_with_default_override_file(self):
  1160. self.base_dir = 'tests/fixtures/override-files'
  1161. self.dispatch(['up', '-d'], None)
  1162. containers = self.project.containers()
  1163. self.assertEqual(len(containers), 2)
  1164. web, db = containers
  1165. self.assertEqual(web.human_readable_command, 'top')
  1166. self.assertEqual(db.human_readable_command, 'top')
  1167. def test_up_with_multiple_files(self):
  1168. self.base_dir = 'tests/fixtures/override-files'
  1169. config_paths = [
  1170. 'docker-compose.yml',
  1171. 'docker-compose.override.yml',
  1172. 'extra.yml',
  1173. ]
  1174. self._project = get_project(self.base_dir, config_paths)
  1175. self.dispatch(
  1176. [
  1177. '-f', config_paths[0],
  1178. '-f', config_paths[1],
  1179. '-f', config_paths[2],
  1180. 'up', '-d',
  1181. ],
  1182. None)
  1183. containers = self.project.containers()
  1184. self.assertEqual(len(containers), 3)
  1185. web, other, db = containers
  1186. self.assertEqual(web.human_readable_command, 'top')
  1187. self.assertTrue({'db', 'other'} <= set(get_links(web)))
  1188. self.assertEqual(db.human_readable_command, 'top')
  1189. self.assertEqual(other.human_readable_command, 'top')
  1190. def test_up_with_extends(self):
  1191. self.base_dir = 'tests/fixtures/extends'
  1192. self.dispatch(['up', '-d'], None)
  1193. self.assertEqual(
  1194. set([s.name for s in self.project.services]),
  1195. set(['mydb', 'myweb']),
  1196. )
  1197. # Sort by name so we get [db, web]
  1198. containers = sorted(
  1199. self.project.containers(stopped=True),
  1200. key=lambda c: c.name,
  1201. )
  1202. self.assertEqual(len(containers), 2)
  1203. web = containers[1]
  1204. self.assertEqual(
  1205. set(get_links(web)),
  1206. set(['db', 'mydb_1', 'extends_mydb_1']))
  1207. expected_env = set([
  1208. "FOO=1",
  1209. "BAR=2",
  1210. "BAZ=2",
  1211. ])
  1212. self.assertTrue(expected_env <= set(web.get('Config.Env')))