cli_test.py 62 KB

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