cli_test.py 109 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851
  1. # -*- coding: utf-8 -*-
  2. from __future__ import absolute_import
  3. from __future__ import unicode_literals
  4. import datetime
  5. import json
  6. import os.path
  7. import re
  8. import signal
  9. import subprocess
  10. import time
  11. from collections import Counter
  12. from collections import namedtuple
  13. from operator import attrgetter
  14. import pytest
  15. import six
  16. import yaml
  17. from docker import errors
  18. from .. import mock
  19. from ..helpers import create_host_file
  20. from compose.cli.command import get_project
  21. from compose.config.errors import DuplicateOverrideFileFound
  22. from compose.container import Container
  23. from compose.project import OneOffFilter
  24. from compose.utils import nanoseconds_from_time_seconds
  25. from tests.integration.testcases import DockerClientTestCase
  26. from tests.integration.testcases import get_links
  27. from tests.integration.testcases import is_cluster
  28. from tests.integration.testcases import no_cluster
  29. from tests.integration.testcases import pull_busybox
  30. from tests.integration.testcases import SWARM_SKIP_RM_VOLUMES
  31. from tests.integration.testcases import v2_1_only
  32. from tests.integration.testcases import v2_2_only
  33. from tests.integration.testcases import v2_only
  34. from tests.integration.testcases import v3_only
  35. ProcessResult = namedtuple('ProcessResult', 'stdout stderr')
  36. BUILD_CACHE_TEXT = 'Using cache'
  37. BUILD_PULL_TEXT = 'Status: Image is up to date for busybox:latest'
  38. def start_process(base_dir, options):
  39. proc = subprocess.Popen(
  40. ['docker-compose'] + options,
  41. stdout=subprocess.PIPE,
  42. stderr=subprocess.PIPE,
  43. cwd=base_dir)
  44. print("Running process: %s" % proc.pid)
  45. return proc
  46. def wait_on_process(proc, returncode=0):
  47. stdout, stderr = proc.communicate()
  48. if proc.returncode != returncode:
  49. print("Stderr: {}".format(stderr))
  50. print("Stdout: {}".format(stdout))
  51. assert proc.returncode == returncode
  52. return ProcessResult(stdout.decode('utf-8'), stderr.decode('utf-8'))
  53. def wait_on_condition(condition, delay=0.1, timeout=40):
  54. start_time = time.time()
  55. while not condition():
  56. if time.time() - start_time > timeout:
  57. raise AssertionError("Timeout: %s" % condition)
  58. time.sleep(delay)
  59. def kill_service(service):
  60. for container in service.containers():
  61. if container.is_running:
  62. container.kill()
  63. class ContainerCountCondition(object):
  64. def __init__(self, project, expected):
  65. self.project = project
  66. self.expected = expected
  67. def __call__(self):
  68. return len([c for c in self.project.containers() if c.is_running]) == self.expected
  69. def __str__(self):
  70. return "waiting for counter count == %s" % self.expected
  71. class ContainerStateCondition(object):
  72. def __init__(self, client, name, status):
  73. self.client = client
  74. self.name = name
  75. self.status = status
  76. def __call__(self):
  77. try:
  78. if self.name.endswith('*'):
  79. ctnrs = self.client.containers(all=True, filters={'name': self.name[:-1]})
  80. if len(ctnrs) > 0:
  81. container = self.client.inspect_container(ctnrs[0]['Id'])
  82. else:
  83. return False
  84. else:
  85. container = self.client.inspect_container(self.name)
  86. return container['State']['Status'] == self.status
  87. except errors.APIError:
  88. return False
  89. def __str__(self):
  90. return "waiting for container to be %s" % self.status
  91. class CLITestCase(DockerClientTestCase):
  92. def setUp(self):
  93. super(CLITestCase, self).setUp()
  94. self.base_dir = 'tests/fixtures/simple-composefile'
  95. self.override_dir = None
  96. def tearDown(self):
  97. if self.base_dir:
  98. self.project.kill()
  99. self.project.down(None, True)
  100. for container in self.project.containers(stopped=True, one_off=OneOffFilter.only):
  101. container.remove(force=True)
  102. networks = self.client.networks()
  103. for n in networks:
  104. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name)):
  105. self.client.remove_network(n['Name'])
  106. volumes = self.client.volumes().get('Volumes') or []
  107. for v in volumes:
  108. if v['Name'].split('/')[-1].startswith('{}_'.format(self.project.name)):
  109. self.client.remove_volume(v['Name'])
  110. if hasattr(self, '_project'):
  111. del self._project
  112. super(CLITestCase, self).tearDown()
  113. @property
  114. def project(self):
  115. # Hack: allow project to be overridden
  116. if not hasattr(self, '_project'):
  117. self._project = get_project(self.base_dir, override_dir=self.override_dir)
  118. return self._project
  119. def dispatch(self, options, project_options=None, returncode=0):
  120. project_options = project_options or []
  121. proc = start_process(self.base_dir, project_options + options)
  122. return wait_on_process(proc, returncode=returncode)
  123. def execute(self, container, cmd):
  124. # Remove once Hijack and CloseNotifier sign a peace treaty
  125. self.client.close()
  126. exc = self.client.exec_create(container.id, cmd)
  127. self.client.exec_start(exc)
  128. return self.client.exec_inspect(exc)['ExitCode']
  129. def lookup(self, container, hostname):
  130. return self.execute(container, ["nslookup", hostname]) == 0
  131. def test_help(self):
  132. self.base_dir = 'tests/fixtures/no-composefile'
  133. result = self.dispatch(['help', 'up'], returncode=0)
  134. assert 'Usage: up [options] [--scale SERVICE=NUM...] [SERVICE...]' in result.stdout
  135. # Prevent tearDown from trying to create a project
  136. self.base_dir = None
  137. def test_quiet_build(self):
  138. self.base_dir = 'tests/fixtures/build-args'
  139. result = self.dispatch(['build'], None)
  140. quietResult = self.dispatch(['build', '-q'], None)
  141. assert result.stdout != ""
  142. assert quietResult.stdout == ""
  143. def test_help_nonexistent(self):
  144. self.base_dir = 'tests/fixtures/no-composefile'
  145. result = self.dispatch(['help', 'foobar'], returncode=1)
  146. assert 'No such command' in result.stderr
  147. self.base_dir = None
  148. def test_shorthand_host_opt(self):
  149. self.dispatch(
  150. ['-H={0}'.format(os.environ.get('DOCKER_HOST', 'unix://')),
  151. 'up', '-d'],
  152. returncode=0
  153. )
  154. def test_shorthand_host_opt_interactive(self):
  155. self.dispatch(
  156. ['-H={0}'.format(os.environ.get('DOCKER_HOST', 'unix://')),
  157. 'run', 'another', 'ls'],
  158. returncode=0
  159. )
  160. def test_host_not_reachable(self):
  161. result = self.dispatch(['-H=tcp://doesnotexist:8000', 'ps'], returncode=1)
  162. assert "Couldn't connect to Docker daemon" in result.stderr
  163. def test_host_not_reachable_volumes_from_container(self):
  164. self.base_dir = 'tests/fixtures/volumes-from-container'
  165. container = self.client.create_container(
  166. 'busybox', 'true', name='composetest_data_container',
  167. host_config={}
  168. )
  169. self.addCleanup(self.client.remove_container, container)
  170. result = self.dispatch(['-H=tcp://doesnotexist:8000', 'ps'], returncode=1)
  171. assert "Couldn't connect to Docker daemon" in result.stderr
  172. def test_config_list_services(self):
  173. self.base_dir = 'tests/fixtures/v2-full'
  174. result = self.dispatch(['config', '--services'])
  175. assert set(result.stdout.rstrip().split('\n')) == {'web', 'other'}
  176. def test_config_list_volumes(self):
  177. self.base_dir = 'tests/fixtures/v2-full'
  178. result = self.dispatch(['config', '--volumes'])
  179. assert set(result.stdout.rstrip().split('\n')) == {'data'}
  180. def test_config_quiet_with_error(self):
  181. self.base_dir = None
  182. result = self.dispatch([
  183. '-f', 'tests/fixtures/invalid-composefile/invalid.yml',
  184. 'config', '--quiet'
  185. ], returncode=1)
  186. assert "'notaservice' must be a mapping" in result.stderr
  187. def test_config_quiet(self):
  188. self.base_dir = 'tests/fixtures/v2-full'
  189. assert self.dispatch(['config', '--quiet']).stdout == ''
  190. def test_config_with_hash_option(self):
  191. self.base_dir = 'tests/fixtures/v2-full'
  192. result = self.dispatch(['config', '--hash=*'])
  193. for service in self.project.get_services():
  194. assert '{} {}\n'.format(service.name, service.config_hash) in result.stdout
  195. svc = self.project.get_service('other')
  196. result = self.dispatch(['config', '--hash=other'])
  197. assert result.stdout == '{} {}\n'.format(svc.name, svc.config_hash)
  198. def test_config_default(self):
  199. self.base_dir = 'tests/fixtures/v2-full'
  200. result = self.dispatch(['config'])
  201. # assert there are no python objects encoded in the output
  202. assert '!!' not in result.stdout
  203. output = yaml.load(result.stdout)
  204. expected = {
  205. 'version': '2.0',
  206. 'volumes': {'data': {'driver': 'local'}},
  207. 'networks': {'front': {}},
  208. 'services': {
  209. 'web': {
  210. 'build': {
  211. 'context': os.path.abspath(self.base_dir),
  212. },
  213. 'networks': {'front': None, 'default': None},
  214. 'volumes_from': ['service:other:rw'],
  215. },
  216. 'other': {
  217. 'image': 'busybox:latest',
  218. 'command': 'top',
  219. 'volumes': ['/data'],
  220. },
  221. },
  222. }
  223. assert output == expected
  224. def test_config_restart(self):
  225. self.base_dir = 'tests/fixtures/restart'
  226. result = self.dispatch(['config'])
  227. assert yaml.load(result.stdout) == {
  228. 'version': '2.0',
  229. 'services': {
  230. 'never': {
  231. 'image': 'busybox',
  232. 'restart': 'no',
  233. },
  234. 'always': {
  235. 'image': 'busybox',
  236. 'restart': 'always',
  237. },
  238. 'on-failure': {
  239. 'image': 'busybox',
  240. 'restart': 'on-failure',
  241. },
  242. 'on-failure-5': {
  243. 'image': 'busybox',
  244. 'restart': 'on-failure:5',
  245. },
  246. 'restart-null': {
  247. 'image': 'busybox',
  248. 'restart': ''
  249. },
  250. },
  251. }
  252. def test_config_external_network(self):
  253. self.base_dir = 'tests/fixtures/networks'
  254. result = self.dispatch(['-f', 'external-networks.yml', 'config'])
  255. json_result = yaml.load(result.stdout)
  256. assert 'networks' in json_result
  257. assert json_result['networks'] == {
  258. 'networks_foo': {
  259. 'external': True # {'name': 'networks_foo'}
  260. },
  261. 'bar': {
  262. 'external': {'name': 'networks_bar'}
  263. }
  264. }
  265. def test_config_with_dot_env(self):
  266. self.base_dir = 'tests/fixtures/default-env-file'
  267. result = self.dispatch(['config'])
  268. json_result = yaml.load(result.stdout)
  269. assert json_result == {
  270. 'services': {
  271. 'web': {
  272. 'command': 'true',
  273. 'image': 'alpine:latest',
  274. 'ports': ['5643/tcp', '9999/tcp']
  275. }
  276. },
  277. 'version': '2.4'
  278. }
  279. def test_config_with_env_file(self):
  280. self.base_dir = 'tests/fixtures/default-env-file'
  281. result = self.dispatch(['--env-file', '.env2', 'config'])
  282. json_result = yaml.load(result.stdout)
  283. assert json_result == {
  284. 'services': {
  285. 'web': {
  286. 'command': 'false',
  287. 'image': 'alpine:latest',
  288. 'ports': ['5644/tcp', '9998/tcp']
  289. }
  290. },
  291. 'version': '2.4'
  292. }
  293. def test_config_with_dot_env_and_override_dir(self):
  294. self.base_dir = 'tests/fixtures/default-env-file'
  295. result = self.dispatch(['--project-directory', 'alt/', 'config'])
  296. json_result = yaml.load(result.stdout)
  297. assert json_result == {
  298. 'services': {
  299. 'web': {
  300. 'command': 'echo uwu',
  301. 'image': 'alpine:3.4',
  302. 'ports': ['3341/tcp', '4449/tcp']
  303. }
  304. },
  305. 'version': '2.4'
  306. }
  307. def test_config_external_volume_v2(self):
  308. self.base_dir = 'tests/fixtures/volumes'
  309. result = self.dispatch(['-f', 'external-volumes-v2.yml', 'config'])
  310. json_result = yaml.load(result.stdout)
  311. assert 'volumes' in json_result
  312. assert json_result['volumes'] == {
  313. 'foo': {
  314. 'external': True,
  315. },
  316. 'bar': {
  317. 'external': {
  318. 'name': 'some_bar',
  319. },
  320. }
  321. }
  322. def test_config_external_volume_v2_x(self):
  323. self.base_dir = 'tests/fixtures/volumes'
  324. result = self.dispatch(['-f', 'external-volumes-v2-x.yml', 'config'])
  325. json_result = yaml.load(result.stdout)
  326. assert 'volumes' in json_result
  327. assert json_result['volumes'] == {
  328. 'foo': {
  329. 'external': True,
  330. 'name': 'some_foo',
  331. },
  332. 'bar': {
  333. 'external': True,
  334. 'name': 'some_bar',
  335. }
  336. }
  337. def test_config_external_volume_v3_x(self):
  338. self.base_dir = 'tests/fixtures/volumes'
  339. result = self.dispatch(['-f', 'external-volumes-v3-x.yml', 'config'])
  340. json_result = yaml.load(result.stdout)
  341. assert 'volumes' in json_result
  342. assert json_result['volumes'] == {
  343. 'foo': {
  344. 'external': True,
  345. },
  346. 'bar': {
  347. 'external': {
  348. 'name': 'some_bar',
  349. },
  350. }
  351. }
  352. def test_config_external_volume_v3_4(self):
  353. self.base_dir = 'tests/fixtures/volumes'
  354. result = self.dispatch(['-f', 'external-volumes-v3-4.yml', 'config'])
  355. json_result = yaml.load(result.stdout)
  356. assert 'volumes' in json_result
  357. assert json_result['volumes'] == {
  358. 'foo': {
  359. 'external': True,
  360. 'name': 'some_foo',
  361. },
  362. 'bar': {
  363. 'external': True,
  364. 'name': 'some_bar',
  365. }
  366. }
  367. def test_config_external_network_v3_5(self):
  368. self.base_dir = 'tests/fixtures/networks'
  369. result = self.dispatch(['-f', 'external-networks-v3-5.yml', 'config'])
  370. json_result = yaml.load(result.stdout)
  371. assert 'networks' in json_result
  372. assert json_result['networks'] == {
  373. 'foo': {
  374. 'external': True,
  375. 'name': 'some_foo',
  376. },
  377. 'bar': {
  378. 'external': True,
  379. 'name': 'some_bar',
  380. },
  381. }
  382. def test_config_v1(self):
  383. self.base_dir = 'tests/fixtures/v1-config'
  384. result = self.dispatch(['config'])
  385. assert yaml.load(result.stdout) == {
  386. 'version': '2.1',
  387. 'services': {
  388. 'net': {
  389. 'image': 'busybox',
  390. 'network_mode': 'bridge',
  391. },
  392. 'volume': {
  393. 'image': 'busybox',
  394. 'volumes': ['/data'],
  395. 'network_mode': 'bridge',
  396. },
  397. 'app': {
  398. 'image': 'busybox',
  399. 'volumes_from': ['service:volume:rw'],
  400. 'network_mode': 'service:net',
  401. },
  402. },
  403. }
  404. @v3_only()
  405. def test_config_v3(self):
  406. self.base_dir = 'tests/fixtures/v3-full'
  407. result = self.dispatch(['config'])
  408. assert yaml.load(result.stdout) == {
  409. 'version': '3.5',
  410. 'volumes': {
  411. 'foobar': {
  412. 'labels': {
  413. 'com.docker.compose.test': 'true',
  414. },
  415. },
  416. },
  417. 'services': {
  418. 'web': {
  419. 'image': 'busybox',
  420. 'deploy': {
  421. 'mode': 'replicated',
  422. 'replicas': 6,
  423. 'labels': ['FOO=BAR'],
  424. 'update_config': {
  425. 'parallelism': 3,
  426. 'delay': '10s',
  427. 'failure_action': 'continue',
  428. 'monitor': '60s',
  429. 'max_failure_ratio': 0.3,
  430. },
  431. 'resources': {
  432. 'limits': {
  433. 'cpus': '0.05',
  434. 'memory': '50M',
  435. },
  436. 'reservations': {
  437. 'cpus': '0.01',
  438. 'memory': '20M',
  439. },
  440. },
  441. 'restart_policy': {
  442. 'condition': 'on-failure',
  443. 'delay': '5s',
  444. 'max_attempts': 3,
  445. 'window': '120s',
  446. },
  447. 'placement': {
  448. 'constraints': [
  449. 'node.hostname==foo', 'node.role != manager'
  450. ],
  451. 'preferences': [{'spread': 'node.labels.datacenter'}]
  452. },
  453. },
  454. 'healthcheck': {
  455. 'test': 'cat /etc/passwd',
  456. 'interval': '10s',
  457. 'timeout': '1s',
  458. 'retries': 5,
  459. },
  460. 'volumes': [{
  461. 'read_only': True,
  462. 'source': '/host/path',
  463. 'target': '/container/path',
  464. 'type': 'bind'
  465. }, {
  466. 'source': 'foobar', 'target': '/container/volumepath', 'type': 'volume'
  467. }, {
  468. 'target': '/anonymous', 'type': 'volume'
  469. }, {
  470. 'source': 'foobar',
  471. 'target': '/container/volumepath2',
  472. 'type': 'volume',
  473. 'volume': {'nocopy': True}
  474. }],
  475. 'stop_grace_period': '20s',
  476. },
  477. },
  478. }
  479. def test_config_compatibility_mode(self):
  480. self.base_dir = 'tests/fixtures/compatibility-mode'
  481. result = self.dispatch(['--compatibility', 'config'])
  482. assert yaml.load(result.stdout) == {
  483. 'version': '2.3',
  484. 'volumes': {'foo': {'driver': 'default'}},
  485. 'networks': {'bar': {}},
  486. 'services': {
  487. 'foo': {
  488. 'command': '/bin/true',
  489. 'image': 'alpine:3.7',
  490. 'scale': 3,
  491. 'restart': 'always:7',
  492. 'mem_limit': '300M',
  493. 'mem_reservation': '100M',
  494. 'cpus': 0.7,
  495. 'volumes': ['foo:/bar:rw'],
  496. 'networks': {'bar': None},
  497. }
  498. },
  499. }
  500. def test_ps(self):
  501. self.project.get_service('simple').create_container()
  502. result = self.dispatch(['ps'])
  503. assert 'simple-composefile_simple_1' in result.stdout
  504. def test_ps_default_composefile(self):
  505. self.base_dir = 'tests/fixtures/multiple-composefiles'
  506. self.dispatch(['up', '-d'])
  507. result = self.dispatch(['ps'])
  508. assert 'multiple-composefiles_simple_1' in result.stdout
  509. assert 'multiple-composefiles_another_1' in result.stdout
  510. assert 'multiple-composefiles_yetanother_1' not in result.stdout
  511. def test_ps_alternate_composefile(self):
  512. config_path = os.path.abspath(
  513. 'tests/fixtures/multiple-composefiles/compose2.yml')
  514. self._project = get_project(self.base_dir, [config_path])
  515. self.base_dir = 'tests/fixtures/multiple-composefiles'
  516. self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
  517. result = self.dispatch(['-f', 'compose2.yml', 'ps'])
  518. assert 'multiple-composefiles_simple_1' not in result.stdout
  519. assert 'multiple-composefiles_another_1' not in result.stdout
  520. assert 'multiple-composefiles_yetanother_1' in result.stdout
  521. def test_ps_services_filter_option(self):
  522. self.base_dir = 'tests/fixtures/ps-services-filter'
  523. image = self.dispatch(['ps', '--services', '--filter', 'source=image'])
  524. build = self.dispatch(['ps', '--services', '--filter', 'source=build'])
  525. all_services = self.dispatch(['ps', '--services'])
  526. assert 'with_build' in all_services.stdout
  527. assert 'with_image' in all_services.stdout
  528. assert 'with_build' in build.stdout
  529. assert 'with_build' not in image.stdout
  530. assert 'with_image' in image.stdout
  531. assert 'with_image' not in build.stdout
  532. def test_ps_services_filter_status(self):
  533. self.base_dir = 'tests/fixtures/ps-services-filter'
  534. self.dispatch(['up', '-d'])
  535. self.dispatch(['pause', 'with_image'])
  536. paused = self.dispatch(['ps', '--services', '--filter', 'status=paused'])
  537. stopped = self.dispatch(['ps', '--services', '--filter', 'status=stopped'])
  538. running = self.dispatch(['ps', '--services', '--filter', 'status=running'])
  539. assert 'with_build' not in stopped.stdout
  540. assert 'with_image' not in stopped.stdout
  541. assert 'with_build' not in paused.stdout
  542. assert 'with_image' in paused.stdout
  543. assert 'with_build' in running.stdout
  544. assert 'with_image' in running.stdout
  545. def test_ps_all(self):
  546. self.project.get_service('simple').create_container(one_off='blahblah')
  547. result = self.dispatch(['ps'])
  548. assert 'simple-composefile_simple_run_' not in result.stdout
  549. result2 = self.dispatch(['ps', '--all'])
  550. assert 'simple-composefile_simple_run_' in result2.stdout
  551. def test_pull(self):
  552. result = self.dispatch(['pull'])
  553. assert 'Pulling simple' in result.stderr
  554. assert 'Pulling another' in result.stderr
  555. assert 'done' in result.stderr
  556. assert 'failed' not in result.stderr
  557. def test_pull_with_digest(self):
  558. result = self.dispatch(['-f', 'digest.yml', 'pull', '--no-parallel'])
  559. assert 'Pulling simple (busybox:latest)...' in result.stderr
  560. assert ('Pulling digest (busybox@'
  561. 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
  562. '04ee8502d)...') in result.stderr
  563. def test_pull_with_ignore_pull_failures(self):
  564. result = self.dispatch([
  565. '-f', 'ignore-pull-failures.yml',
  566. 'pull', '--ignore-pull-failures', '--no-parallel']
  567. )
  568. assert 'Pulling simple (busybox:latest)...' in result.stderr
  569. assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
  570. assert ('repository nonexisting-image not found' in result.stderr or
  571. 'image library/nonexisting-image:latest not found' in result.stderr or
  572. 'pull access denied for nonexisting-image' in result.stderr)
  573. def test_pull_with_build(self):
  574. result = self.dispatch(['-f', 'pull-with-build.yml', 'pull'])
  575. assert 'Pulling simple' not in result.stderr
  576. assert 'Pulling from_simple' not in result.stderr
  577. assert 'Pulling another ...' in result.stderr
  578. def test_pull_with_quiet(self):
  579. assert self.dispatch(['pull', '--quiet']).stderr == ''
  580. assert self.dispatch(['pull', '--quiet']).stdout == ''
  581. def test_pull_with_parallel_failure(self):
  582. result = self.dispatch([
  583. '-f', 'ignore-pull-failures.yml', 'pull'],
  584. returncode=1
  585. )
  586. assert re.search(re.compile('^Pulling simple', re.MULTILINE), result.stderr)
  587. assert re.search(re.compile('^Pulling another', re.MULTILINE), result.stderr)
  588. assert re.search(
  589. re.compile('^ERROR: for another .*does not exist.*', re.MULTILINE),
  590. result.stderr
  591. )
  592. assert re.search(
  593. re.compile('''^(ERROR: )?(b')?.* nonexisting-image''', re.MULTILINE),
  594. result.stderr
  595. )
  596. def test_pull_with_no_deps(self):
  597. self.base_dir = 'tests/fixtures/links-composefile'
  598. result = self.dispatch(['pull', '--no-parallel', 'web'])
  599. assert sorted(result.stderr.split('\n'))[1:] == [
  600. 'Pulling web (busybox:latest)...',
  601. ]
  602. def test_pull_with_include_deps(self):
  603. self.base_dir = 'tests/fixtures/links-composefile'
  604. result = self.dispatch(['pull', '--no-parallel', '--include-deps', 'web'])
  605. assert sorted(result.stderr.split('\n'))[1:] == [
  606. 'Pulling db (busybox:latest)...',
  607. 'Pulling web (busybox:latest)...',
  608. ]
  609. def test_build_plain(self):
  610. self.base_dir = 'tests/fixtures/simple-dockerfile'
  611. self.dispatch(['build', 'simple'])
  612. result = self.dispatch(['build', 'simple'])
  613. assert BUILD_PULL_TEXT not in result.stdout
  614. def test_build_no_cache(self):
  615. self.base_dir = 'tests/fixtures/simple-dockerfile'
  616. self.dispatch(['build', 'simple'])
  617. result = self.dispatch(['build', '--no-cache', 'simple'])
  618. assert BUILD_CACHE_TEXT not in result.stdout
  619. assert BUILD_PULL_TEXT not in result.stdout
  620. def test_build_pull(self):
  621. # Make sure we have the latest busybox already
  622. pull_busybox(self.client)
  623. self.base_dir = 'tests/fixtures/simple-dockerfile'
  624. self.dispatch(['build', 'simple'], None)
  625. result = self.dispatch(['build', '--pull', 'simple'])
  626. if not is_cluster(self.client):
  627. # If previous build happened on another node, cache won't be available
  628. assert BUILD_CACHE_TEXT in result.stdout
  629. assert BUILD_PULL_TEXT in result.stdout
  630. def test_build_no_cache_pull(self):
  631. # Make sure we have the latest busybox already
  632. pull_busybox(self.client)
  633. self.base_dir = 'tests/fixtures/simple-dockerfile'
  634. self.dispatch(['build', 'simple'])
  635. result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
  636. assert BUILD_CACHE_TEXT not in result.stdout
  637. assert BUILD_PULL_TEXT in result.stdout
  638. def test_build_log_level(self):
  639. self.base_dir = 'tests/fixtures/simple-dockerfile'
  640. result = self.dispatch(['--log-level', 'warning', 'build', 'simple'])
  641. assert result.stderr == ''
  642. result = self.dispatch(['--log-level', 'debug', 'build', 'simple'])
  643. assert 'Building simple' in result.stderr
  644. assert 'Using configuration file' in result.stderr
  645. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  646. result = self.dispatch(['--log-level', 'critical', 'build', 'simple'], returncode=1)
  647. assert result.stderr == ''
  648. result = self.dispatch(['--log-level', 'debug', 'build', 'simple'], returncode=1)
  649. assert 'Building simple' in result.stderr
  650. assert 'non-zero code' in result.stderr
  651. def test_build_failed(self):
  652. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  653. self.dispatch(['build', 'simple'], returncode=1)
  654. labels = ["com.docker.compose.test_failing_image=true"]
  655. containers = [
  656. Container.from_ps(self.project.client, c)
  657. for c in self.project.client.containers(
  658. all=True,
  659. filters={"label": labels})
  660. ]
  661. assert len(containers) == 1
  662. def test_build_failed_forcerm(self):
  663. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  664. self.dispatch(['build', '--force-rm', 'simple'], returncode=1)
  665. labels = ["com.docker.compose.test_failing_image=true"]
  666. containers = [
  667. Container.from_ps(self.project.client, c)
  668. for c in self.project.client.containers(
  669. all=True,
  670. filters={"label": labels})
  671. ]
  672. assert not containers
  673. def test_build_rm(self):
  674. containers = [
  675. Container.from_ps(self.project.client, c)
  676. for c in self.project.client.containers(all=True)
  677. ]
  678. assert not containers
  679. self.base_dir = 'tests/fixtures/simple-dockerfile'
  680. self.dispatch(['build', '--no-rm', 'simple'], returncode=0)
  681. containers = [
  682. Container.from_ps(self.project.client, c)
  683. for c in self.project.client.containers(all=True)
  684. ]
  685. assert containers
  686. for c in self.project.client.containers(all=True):
  687. self.addCleanup(self.project.client.remove_container, c, force=True)
  688. def test_build_shm_size_build_option(self):
  689. pull_busybox(self.client)
  690. self.base_dir = 'tests/fixtures/build-shm-size'
  691. result = self.dispatch(['build', '--no-cache'], None)
  692. assert 'shm_size: 96' in result.stdout
  693. def test_build_memory_build_option(self):
  694. pull_busybox(self.client)
  695. self.base_dir = 'tests/fixtures/build-memory'
  696. result = self.dispatch(['build', '--no-cache', '--memory', '96m', 'service'], None)
  697. assert 'memory: 100663296' in result.stdout # 96 * 1024 * 1024
  698. def test_build_with_buildarg_from_compose_file(self):
  699. pull_busybox(self.client)
  700. self.base_dir = 'tests/fixtures/build-args'
  701. result = self.dispatch(['build'], None)
  702. assert 'Favorite Touhou Character: mariya.kirisame' in result.stdout
  703. def test_build_with_buildarg_cli_override(self):
  704. pull_busybox(self.client)
  705. self.base_dir = 'tests/fixtures/build-args'
  706. result = self.dispatch(['build', '--build-arg', 'favorite_th_character=sakuya.izayoi'], None)
  707. assert 'Favorite Touhou Character: sakuya.izayoi' in result.stdout
  708. @mock.patch.dict(os.environ)
  709. def test_build_with_buildarg_old_api_version(self):
  710. pull_busybox(self.client)
  711. self.base_dir = 'tests/fixtures/build-args'
  712. os.environ['COMPOSE_API_VERSION'] = '1.24'
  713. result = self.dispatch(
  714. ['build', '--build-arg', 'favorite_th_character=reimu.hakurei'], None, returncode=1
  715. )
  716. assert '--build-arg is only supported when services are specified' in result.stderr
  717. result = self.dispatch(
  718. ['build', '--build-arg', 'favorite_th_character=hong.meiling', 'web'], None
  719. )
  720. assert 'Favorite Touhou Character: hong.meiling' in result.stdout
  721. def test_bundle_with_digests(self):
  722. self.base_dir = 'tests/fixtures/bundle-with-digests/'
  723. tmpdir = pytest.ensuretemp('cli_test_bundle')
  724. self.addCleanup(tmpdir.remove)
  725. filename = str(tmpdir.join('example.dab'))
  726. self.dispatch(['bundle', '--output', filename])
  727. with open(filename, 'r') as fh:
  728. bundle = json.load(fh)
  729. assert bundle == {
  730. 'Version': '0.1',
  731. 'Services': {
  732. 'web': {
  733. 'Image': ('dockercloud/hello-world@sha256:fe79a2cfbd17eefc3'
  734. '44fb8419420808df95a1e22d93b7f621a7399fd1e9dca1d'),
  735. 'Networks': ['default'],
  736. },
  737. 'redis': {
  738. 'Image': ('redis@sha256:a84cb8f53a70e19f61ff2e1d5e73fb7ae62d'
  739. '374b2b7392de1e7d77be26ef8f7b'),
  740. 'Networks': ['default'],
  741. }
  742. },
  743. }
  744. def test_build_override_dir(self):
  745. self.base_dir = 'tests/fixtures/build-path-override-dir'
  746. self.override_dir = os.path.abspath('tests/fixtures')
  747. result = self.dispatch([
  748. '--project-directory', self.override_dir,
  749. 'build'])
  750. assert 'Successfully built' in result.stdout
  751. def test_build_override_dir_invalid_path(self):
  752. config_path = os.path.abspath('tests/fixtures/build-path-override-dir/docker-compose.yml')
  753. result = self.dispatch([
  754. '-f', config_path,
  755. 'build'], returncode=1)
  756. assert 'does not exist, is not accessible, or is not a valid URL' in result.stderr
  757. def test_build_parallel(self):
  758. self.base_dir = 'tests/fixtures/build-multiple-composefile'
  759. result = self.dispatch(['build', '--parallel'])
  760. assert 'Successfully tagged build-multiple-composefile_a:latest' in result.stdout
  761. assert 'Successfully tagged build-multiple-composefile_b:latest' in result.stdout
  762. assert 'Successfully built' in result.stdout
  763. def test_create(self):
  764. self.dispatch(['create'])
  765. service = self.project.get_service('simple')
  766. another = self.project.get_service('another')
  767. service_containers = service.containers(stopped=True)
  768. another_containers = another.containers(stopped=True)
  769. assert len(service_containers) == 1
  770. assert len(another_containers) == 1
  771. assert not service_containers[0].is_running
  772. assert not another_containers[0].is_running
  773. def test_create_with_force_recreate(self):
  774. self.dispatch(['create'], None)
  775. service = self.project.get_service('simple')
  776. service_containers = service.containers(stopped=True)
  777. assert len(service_containers) == 1
  778. assert not service_containers[0].is_running
  779. old_ids = [c.id for c in service.containers(stopped=True)]
  780. self.dispatch(['create', '--force-recreate'], None)
  781. service_containers = service.containers(stopped=True)
  782. assert len(service_containers) == 1
  783. assert not service_containers[0].is_running
  784. new_ids = [c.id for c in service_containers]
  785. assert old_ids != new_ids
  786. def test_create_with_no_recreate(self):
  787. self.dispatch(['create'], None)
  788. service = self.project.get_service('simple')
  789. service_containers = service.containers(stopped=True)
  790. assert len(service_containers) == 1
  791. assert not service_containers[0].is_running
  792. old_ids = [c.id for c in service.containers(stopped=True)]
  793. self.dispatch(['create', '--no-recreate'], None)
  794. service_containers = service.containers(stopped=True)
  795. assert len(service_containers) == 1
  796. assert not service_containers[0].is_running
  797. new_ids = [c.id for c in service_containers]
  798. assert old_ids == new_ids
  799. def test_run_one_off_with_volume(self):
  800. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  801. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  802. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  803. self.dispatch([
  804. 'run',
  805. '-v', '{}:/data'.format(volume_path),
  806. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  807. 'simple',
  808. 'test', '-f', '/data/example.txt'
  809. ], returncode=0)
  810. service = self.project.get_service('simple')
  811. container_data = service.containers(one_off=OneOffFilter.only, stopped=True)[0]
  812. mount = container_data.get('Mounts')[0]
  813. assert mount['Source'] == volume_path
  814. assert mount['Destination'] == '/data'
  815. assert mount['Type'] == 'bind'
  816. def test_run_one_off_with_multiple_volumes(self):
  817. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  818. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  819. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  820. self.dispatch([
  821. 'run',
  822. '-v', '{}:/data'.format(volume_path),
  823. '-v', '{}:/data1'.format(volume_path),
  824. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  825. 'simple',
  826. 'test', '-f', '/data/example.txt'
  827. ], returncode=0)
  828. self.dispatch([
  829. 'run',
  830. '-v', '{}:/data'.format(volume_path),
  831. '-v', '{}:/data1'.format(volume_path),
  832. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  833. 'simple',
  834. 'test', '-f' '/data1/example.txt'
  835. ], returncode=0)
  836. def test_run_one_off_with_volume_merge(self):
  837. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  838. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  839. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  840. self.dispatch([
  841. '-f', 'docker-compose.merge.yml',
  842. 'run',
  843. '-v', '{}:/data'.format(volume_path),
  844. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  845. 'simple',
  846. 'test', '-f', '/data/example.txt'
  847. ], returncode=0)
  848. service = self.project.get_service('simple')
  849. container_data = service.containers(one_off=OneOffFilter.only, stopped=True)[0]
  850. mounts = container_data.get('Mounts')
  851. assert len(mounts) == 2
  852. config_mount = [m for m in mounts if m['Destination'] == '/data1'][0]
  853. override_mount = [m for m in mounts if m['Destination'] == '/data'][0]
  854. assert config_mount['Type'] == 'volume'
  855. assert override_mount['Source'] == volume_path
  856. assert override_mount['Type'] == 'bind'
  857. def test_create_with_force_recreate_and_no_recreate(self):
  858. self.dispatch(
  859. ['create', '--force-recreate', '--no-recreate'],
  860. returncode=1)
  861. def test_down_invalid_rmi_flag(self):
  862. result = self.dispatch(['down', '--rmi', 'bogus'], returncode=1)
  863. assert '--rmi flag must be' in result.stderr
  864. @v2_only()
  865. def test_down(self):
  866. self.base_dir = 'tests/fixtures/v2-full'
  867. self.dispatch(['up', '-d'])
  868. wait_on_condition(ContainerCountCondition(self.project, 2))
  869. self.dispatch(['run', 'web', 'true'])
  870. self.dispatch(['run', '-d', 'web', 'tail', '-f', '/dev/null'])
  871. assert len(self.project.containers(one_off=OneOffFilter.only, stopped=True)) == 2
  872. result = self.dispatch(['down', '--rmi=local', '--volumes'])
  873. assert 'Stopping v2-full_web_1' in result.stderr
  874. assert 'Stopping v2-full_other_1' in result.stderr
  875. assert 'Stopping v2-full_web_run_' in result.stderr
  876. assert 'Removing v2-full_web_1' in result.stderr
  877. assert 'Removing v2-full_other_1' in result.stderr
  878. assert 'Removing v2-full_web_run_' in result.stderr
  879. assert 'Removing v2-full_web_run_' in result.stderr
  880. assert 'Removing volume v2-full_data' in result.stderr
  881. assert 'Removing image v2-full_web' in result.stderr
  882. assert 'Removing image busybox' not in result.stderr
  883. assert 'Removing network v2-full_default' in result.stderr
  884. assert 'Removing network v2-full_front' in result.stderr
  885. def test_down_timeout(self):
  886. self.dispatch(['up', '-d'], None)
  887. service = self.project.get_service('simple')
  888. assert len(service.containers()) == 1
  889. assert service.containers()[0].is_running
  890. ""
  891. self.dispatch(['down', '-t', '1'], None)
  892. assert len(service.containers(stopped=True)) == 0
  893. def test_down_signal(self):
  894. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  895. self.dispatch(['up', '-d'], None)
  896. service = self.project.get_service('simple')
  897. assert len(service.containers()) == 1
  898. assert service.containers()[0].is_running
  899. self.dispatch(['down', '-t', '1'], None)
  900. assert len(service.containers(stopped=True)) == 0
  901. def test_up_detached(self):
  902. self.dispatch(['up', '-d'])
  903. service = self.project.get_service('simple')
  904. another = self.project.get_service('another')
  905. assert len(service.containers()) == 1
  906. assert len(another.containers()) == 1
  907. # Ensure containers don't have stdin and stdout connected in -d mode
  908. container, = service.containers()
  909. assert not container.get('Config.AttachStderr')
  910. assert not container.get('Config.AttachStdout')
  911. assert not container.get('Config.AttachStdin')
  912. def test_up_detached_long_form(self):
  913. self.dispatch(['up', '--detach'])
  914. service = self.project.get_service('simple')
  915. another = self.project.get_service('another')
  916. assert len(service.containers()) == 1
  917. assert len(another.containers()) == 1
  918. # Ensure containers don't have stdin and stdout connected in -d mode
  919. container, = service.containers()
  920. assert not container.get('Config.AttachStderr')
  921. assert not container.get('Config.AttachStdout')
  922. assert not container.get('Config.AttachStdin')
  923. def test_up_attached(self):
  924. self.base_dir = 'tests/fixtures/echo-services'
  925. result = self.dispatch(['up', '--no-color'])
  926. simple_name = self.project.get_service('simple').containers(stopped=True)[0].name_without_project
  927. another_name = self.project.get_service('another').containers(
  928. stopped=True
  929. )[0].name_without_project
  930. assert '{} | simple'.format(simple_name) in result.stdout
  931. assert '{} | another'.format(another_name) in result.stdout
  932. assert '{} exited with code 0'.format(simple_name) in result.stdout
  933. assert '{} exited with code 0'.format(another_name) in result.stdout
  934. @v2_only()
  935. def test_up(self):
  936. self.base_dir = 'tests/fixtures/v2-simple'
  937. self.dispatch(['up', '-d'], None)
  938. services = self.project.get_services()
  939. network_name = self.project.networks.networks['default'].full_name
  940. networks = self.client.networks(names=[network_name])
  941. assert len(networks) == 1
  942. assert networks[0]['Driver'] == 'bridge' if not is_cluster(self.client) else 'overlay'
  943. assert 'com.docker.network.bridge.enable_icc' not in networks[0]['Options']
  944. network = self.client.inspect_network(networks[0]['Id'])
  945. for service in services:
  946. containers = service.containers()
  947. assert len(containers) == 1
  948. container = containers[0]
  949. assert container.id in network['Containers']
  950. networks = container.get('NetworkSettings.Networks')
  951. assert list(networks) == [network['Name']]
  952. assert sorted(networks[network['Name']]['Aliases']) == sorted(
  953. [service.name, container.short_id]
  954. )
  955. for service in services:
  956. assert self.lookup(container, service.name)
  957. @v2_only()
  958. def test_up_no_start(self):
  959. self.base_dir = 'tests/fixtures/v2-full'
  960. self.dispatch(['up', '--no-start'], None)
  961. services = self.project.get_services()
  962. default_network = self.project.networks.networks['default'].full_name
  963. front_network = self.project.networks.networks['front'].full_name
  964. networks = self.client.networks(names=[default_network, front_network])
  965. assert len(networks) == 2
  966. for service in services:
  967. containers = service.containers(stopped=True)
  968. assert len(containers) == 1
  969. container = containers[0]
  970. assert not container.is_running
  971. assert container.get('State.Status') == 'created'
  972. volumes = self.project.volumes.volumes
  973. assert 'data' in volumes
  974. volume = volumes['data']
  975. # The code below is a Swarm-compatible equivalent to volume.exists()
  976. remote_volumes = [
  977. v for v in self.client.volumes().get('Volumes', [])
  978. if v['Name'].split('/')[-1] == volume.full_name
  979. ]
  980. assert len(remote_volumes) > 0
  981. @v2_only()
  982. def test_up_no_ansi(self):
  983. self.base_dir = 'tests/fixtures/v2-simple'
  984. result = self.dispatch(['--no-ansi', 'up', '-d'], None)
  985. assert "%c[2K\r" % 27 not in result.stderr
  986. assert "%c[1A" % 27 not in result.stderr
  987. assert "%c[1B" % 27 not in result.stderr
  988. @v2_only()
  989. def test_up_with_default_network_config(self):
  990. filename = 'default-network-config.yml'
  991. self.base_dir = 'tests/fixtures/networks'
  992. self._project = get_project(self.base_dir, [filename])
  993. self.dispatch(['-f', filename, 'up', '-d'], None)
  994. network_name = self.project.networks.networks['default'].full_name
  995. networks = self.client.networks(names=[network_name])
  996. assert networks[0]['Options']['com.docker.network.bridge.enable_icc'] == 'false'
  997. @v2_only()
  998. def test_up_with_network_aliases(self):
  999. filename = 'network-aliases.yml'
  1000. self.base_dir = 'tests/fixtures/networks'
  1001. self.dispatch(['-f', filename, 'up', '-d'], None)
  1002. back_name = '{}_back'.format(self.project.name)
  1003. front_name = '{}_front'.format(self.project.name)
  1004. networks = [
  1005. n for n in self.client.networks()
  1006. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1007. ]
  1008. # Two networks were created: back and front
  1009. assert sorted(n['Name'].split('/')[-1] for n in networks) == [back_name, front_name]
  1010. web_container = self.project.get_service('web').containers()[0]
  1011. back_aliases = web_container.get(
  1012. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  1013. )
  1014. assert 'web' in back_aliases
  1015. front_aliases = web_container.get(
  1016. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  1017. )
  1018. assert 'web' in front_aliases
  1019. assert 'forward_facing' in front_aliases
  1020. assert 'ahead' in front_aliases
  1021. @v2_only()
  1022. def test_up_with_network_internal(self):
  1023. self.require_api_version('1.23')
  1024. filename = 'network-internal.yml'
  1025. self.base_dir = 'tests/fixtures/networks'
  1026. self.dispatch(['-f', filename, 'up', '-d'], None)
  1027. internal_net = '{}_internal'.format(self.project.name)
  1028. networks = [
  1029. n for n in self.client.networks()
  1030. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1031. ]
  1032. # One network was created: internal
  1033. assert sorted(n['Name'].split('/')[-1] for n in networks) == [internal_net]
  1034. assert networks[0]['Internal'] is True
  1035. @v2_only()
  1036. def test_up_with_network_static_addresses(self):
  1037. filename = 'network-static-addresses.yml'
  1038. ipv4_address = '172.16.100.100'
  1039. ipv6_address = 'fe80::1001:100'
  1040. self.base_dir = 'tests/fixtures/networks'
  1041. self.dispatch(['-f', filename, 'up', '-d'], None)
  1042. static_net = '{}_static_test'.format(self.project.name)
  1043. networks = [
  1044. n for n in self.client.networks()
  1045. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1046. ]
  1047. # One networks was created: front
  1048. assert sorted(n['Name'].split('/')[-1] for n in networks) == [static_net]
  1049. web_container = self.project.get_service('web').containers()[0]
  1050. ipam_config = web_container.get(
  1051. 'NetworkSettings.Networks.{}.IPAMConfig'.format(static_net)
  1052. )
  1053. assert ipv4_address in ipam_config.values()
  1054. assert ipv6_address in ipam_config.values()
  1055. @v2_only()
  1056. def test_up_with_networks(self):
  1057. self.base_dir = 'tests/fixtures/networks'
  1058. self.dispatch(['up', '-d'], None)
  1059. back_name = '{}_back'.format(self.project.name)
  1060. front_name = '{}_front'.format(self.project.name)
  1061. networks = [
  1062. n for n in self.client.networks()
  1063. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1064. ]
  1065. # Two networks were created: back and front
  1066. assert sorted(n['Name'].split('/')[-1] for n in networks) == [back_name, front_name]
  1067. # lookup by ID instead of name in case of duplicates
  1068. back_network = self.client.inspect_network(
  1069. [n for n in networks if n['Name'] == back_name][0]['Id']
  1070. )
  1071. front_network = self.client.inspect_network(
  1072. [n for n in networks if n['Name'] == front_name][0]['Id']
  1073. )
  1074. web_container = self.project.get_service('web').containers()[0]
  1075. app_container = self.project.get_service('app').containers()[0]
  1076. db_container = self.project.get_service('db').containers()[0]
  1077. for net_name in [front_name, back_name]:
  1078. links = app_container.get('NetworkSettings.Networks.{}.Links'.format(net_name))
  1079. assert '{}:database'.format(db_container.name) in links
  1080. # db and app joined the back network
  1081. assert sorted(back_network['Containers']) == sorted([db_container.id, app_container.id])
  1082. # web and app joined the front network
  1083. assert sorted(front_network['Containers']) == sorted([web_container.id, app_container.id])
  1084. # web can see app but not db
  1085. assert self.lookup(web_container, "app")
  1086. assert not self.lookup(web_container, "db")
  1087. # app can see db
  1088. assert self.lookup(app_container, "db")
  1089. # app has aliased db to "database"
  1090. assert self.lookup(app_container, "database")
  1091. @v2_only()
  1092. def test_up_missing_network(self):
  1093. self.base_dir = 'tests/fixtures/networks'
  1094. result = self.dispatch(
  1095. ['-f', 'missing-network.yml', 'up', '-d'],
  1096. returncode=1)
  1097. assert 'Service "web" uses an undefined network "foo"' in result.stderr
  1098. @v2_only()
  1099. @no_cluster('container networks not supported in Swarm')
  1100. def test_up_with_network_mode(self):
  1101. c = self.client.create_container(
  1102. 'busybox', 'top', name='composetest_network_mode_container',
  1103. host_config={}
  1104. )
  1105. self.addCleanup(self.client.remove_container, c, force=True)
  1106. self.client.start(c)
  1107. container_mode_source = 'container:{}'.format(c['Id'])
  1108. filename = 'network-mode.yml'
  1109. self.base_dir = 'tests/fixtures/networks'
  1110. self._project = get_project(self.base_dir, [filename])
  1111. self.dispatch(['-f', filename, 'up', '-d'], None)
  1112. networks = [
  1113. n for n in self.client.networks()
  1114. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1115. ]
  1116. assert not networks
  1117. for name in ['bridge', 'host', 'none']:
  1118. container = self.project.get_service(name).containers()[0]
  1119. assert list(container.get('NetworkSettings.Networks')) == [name]
  1120. assert container.get('HostConfig.NetworkMode') == name
  1121. service_mode_source = 'container:{}'.format(
  1122. self.project.get_service('bridge').containers()[0].id)
  1123. service_mode_container = self.project.get_service('service').containers()[0]
  1124. assert not service_mode_container.get('NetworkSettings.Networks')
  1125. assert service_mode_container.get('HostConfig.NetworkMode') == service_mode_source
  1126. container_mode_container = self.project.get_service('container').containers()[0]
  1127. assert not container_mode_container.get('NetworkSettings.Networks')
  1128. assert container_mode_container.get('HostConfig.NetworkMode') == container_mode_source
  1129. @v2_only()
  1130. def test_up_external_networks(self):
  1131. filename = 'external-networks.yml'
  1132. self.base_dir = 'tests/fixtures/networks'
  1133. self._project = get_project(self.base_dir, [filename])
  1134. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  1135. assert 'declared as external, but could not be found' in result.stderr
  1136. networks = [
  1137. n['Name'] for n in self.client.networks()
  1138. if n['Name'].startswith('{}_'.format(self.project.name))
  1139. ]
  1140. assert not networks
  1141. network_names = ['{}_{}'.format(self.project.name, n) for n in ['foo', 'bar']]
  1142. for name in network_names:
  1143. self.client.create_network(name, attachable=True)
  1144. self.dispatch(['-f', filename, 'up', '-d'])
  1145. container = self.project.containers()[0]
  1146. assert sorted(list(container.get('NetworkSettings.Networks'))) == sorted(network_names)
  1147. @v2_only()
  1148. def test_up_with_external_default_network(self):
  1149. filename = 'external-default.yml'
  1150. self.base_dir = 'tests/fixtures/networks'
  1151. self._project = get_project(self.base_dir, [filename])
  1152. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  1153. assert 'declared as external, but could not be found' in result.stderr
  1154. networks = [
  1155. n['Name'] for n in self.client.networks()
  1156. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1157. ]
  1158. assert not networks
  1159. network_name = 'composetest_external_network'
  1160. self.client.create_network(network_name, attachable=True)
  1161. self.dispatch(['-f', filename, 'up', '-d'])
  1162. container = self.project.containers()[0]
  1163. assert list(container.get('NetworkSettings.Networks')) == [network_name]
  1164. @v2_1_only()
  1165. def test_up_with_network_labels(self):
  1166. filename = 'network-label.yml'
  1167. self.base_dir = 'tests/fixtures/networks'
  1168. self._project = get_project(self.base_dir, [filename])
  1169. self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
  1170. network_with_label = '{}_network_with_label'.format(self.project.name)
  1171. networks = [
  1172. n for n in self.client.networks()
  1173. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1174. ]
  1175. assert [n['Name'].split('/')[-1] for n in networks] == [network_with_label]
  1176. assert 'label_key' in networks[0]['Labels']
  1177. assert networks[0]['Labels']['label_key'] == 'label_val'
  1178. @v2_1_only()
  1179. def test_up_with_volume_labels(self):
  1180. filename = 'volume-label.yml'
  1181. self.base_dir = 'tests/fixtures/volumes'
  1182. self._project = get_project(self.base_dir, [filename])
  1183. self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
  1184. volume_with_label = '{}_volume_with_label'.format(self.project.name)
  1185. volumes = [
  1186. v for v in self.client.volumes().get('Volumes', [])
  1187. if v['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1188. ]
  1189. assert set([v['Name'].split('/')[-1] for v in volumes]) == set([volume_with_label])
  1190. assert 'label_key' in volumes[0]['Labels']
  1191. assert volumes[0]['Labels']['label_key'] == 'label_val'
  1192. @v2_only()
  1193. def test_up_no_services(self):
  1194. self.base_dir = 'tests/fixtures/no-services'
  1195. self.dispatch(['up', '-d'], None)
  1196. network_names = [
  1197. n['Name'] for n in self.client.networks()
  1198. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1199. ]
  1200. assert network_names == []
  1201. def test_up_with_links_v1(self):
  1202. self.base_dir = 'tests/fixtures/links-composefile'
  1203. self.dispatch(['up', '-d', 'web'], None)
  1204. # No network was created
  1205. network_name = self.project.networks.networks['default'].full_name
  1206. networks = self.client.networks(names=[network_name])
  1207. assert networks == []
  1208. web = self.project.get_service('web')
  1209. db = self.project.get_service('db')
  1210. console = self.project.get_service('console')
  1211. # console was not started
  1212. assert len(web.containers()) == 1
  1213. assert len(db.containers()) == 1
  1214. assert len(console.containers()) == 0
  1215. # web has links
  1216. web_container = web.containers()[0]
  1217. assert web_container.get('HostConfig.Links')
  1218. def test_up_with_net_is_invalid(self):
  1219. self.base_dir = 'tests/fixtures/net-container'
  1220. result = self.dispatch(
  1221. ['-f', 'v2-invalid.yml', 'up', '-d'],
  1222. returncode=1)
  1223. assert "Unsupported config option for services.bar: 'net'" in result.stderr
  1224. @no_cluster("Legacy networking not supported on Swarm")
  1225. def test_up_with_net_v1(self):
  1226. self.base_dir = 'tests/fixtures/net-container'
  1227. self.dispatch(['up', '-d'], None)
  1228. bar = self.project.get_service('bar')
  1229. bar_container = bar.containers()[0]
  1230. foo = self.project.get_service('foo')
  1231. foo_container = foo.containers()[0]
  1232. assert foo_container.get('HostConfig.NetworkMode') == 'container:{}'.format(
  1233. bar_container.id
  1234. )
  1235. @v3_only()
  1236. def test_up_with_healthcheck(self):
  1237. def wait_on_health_status(container, status):
  1238. def condition():
  1239. container.inspect()
  1240. return container.get('State.Health.Status') == status
  1241. return wait_on_condition(condition, delay=0.5)
  1242. self.base_dir = 'tests/fixtures/healthcheck'
  1243. self.dispatch(['up', '-d'], None)
  1244. passes = self.project.get_service('passes')
  1245. passes_container = passes.containers()[0]
  1246. assert passes_container.get('Config.Healthcheck') == {
  1247. "Test": ["CMD-SHELL", "/bin/true"],
  1248. "Interval": nanoseconds_from_time_seconds(1),
  1249. "Timeout": nanoseconds_from_time_seconds(30 * 60),
  1250. "Retries": 1,
  1251. }
  1252. wait_on_health_status(passes_container, 'healthy')
  1253. fails = self.project.get_service('fails')
  1254. fails_container = fails.containers()[0]
  1255. assert fails_container.get('Config.Healthcheck') == {
  1256. "Test": ["CMD", "/bin/false"],
  1257. "Interval": nanoseconds_from_time_seconds(2.5),
  1258. "Retries": 2,
  1259. }
  1260. wait_on_health_status(fails_container, 'unhealthy')
  1261. disabled = self.project.get_service('disabled')
  1262. disabled_container = disabled.containers()[0]
  1263. assert disabled_container.get('Config.Healthcheck') == {
  1264. "Test": ["NONE"],
  1265. }
  1266. assert 'Health' not in disabled_container.get('State')
  1267. def test_up_with_no_deps(self):
  1268. self.base_dir = 'tests/fixtures/links-composefile'
  1269. self.dispatch(['up', '-d', '--no-deps', 'web'], None)
  1270. web = self.project.get_service('web')
  1271. db = self.project.get_service('db')
  1272. console = self.project.get_service('console')
  1273. assert len(web.containers()) == 1
  1274. assert len(db.containers()) == 0
  1275. assert len(console.containers()) == 0
  1276. def test_up_with_force_recreate(self):
  1277. self.dispatch(['up', '-d'], None)
  1278. service = self.project.get_service('simple')
  1279. assert len(service.containers()) == 1
  1280. old_ids = [c.id for c in service.containers()]
  1281. self.dispatch(['up', '-d', '--force-recreate'], None)
  1282. assert len(service.containers()) == 1
  1283. new_ids = [c.id for c in service.containers()]
  1284. assert old_ids != new_ids
  1285. def test_up_with_no_recreate(self):
  1286. self.dispatch(['up', '-d'], None)
  1287. service = self.project.get_service('simple')
  1288. assert len(service.containers()) == 1
  1289. old_ids = [c.id for c in service.containers()]
  1290. self.dispatch(['up', '-d', '--no-recreate'], None)
  1291. assert len(service.containers()) == 1
  1292. new_ids = [c.id for c in service.containers()]
  1293. assert old_ids == new_ids
  1294. def test_up_with_force_recreate_and_no_recreate(self):
  1295. self.dispatch(
  1296. ['up', '-d', '--force-recreate', '--no-recreate'],
  1297. returncode=1)
  1298. def test_up_with_timeout(self):
  1299. self.dispatch(['up', '-d', '-t', '1'])
  1300. service = self.project.get_service('simple')
  1301. another = self.project.get_service('another')
  1302. assert len(service.containers()) == 1
  1303. assert len(another.containers()) == 1
  1304. @mock.patch.dict(os.environ)
  1305. def test_up_with_ignore_remove_orphans(self):
  1306. os.environ["COMPOSE_IGNORE_ORPHANS"] = "True"
  1307. result = self.dispatch(['up', '-d', '--remove-orphans'], returncode=1)
  1308. assert "COMPOSE_IGNORE_ORPHANS and --remove-orphans cannot be combined." in result.stderr
  1309. def test_up_handles_sigint(self):
  1310. proc = start_process(self.base_dir, ['up', '-t', '2'])
  1311. wait_on_condition(ContainerCountCondition(self.project, 2))
  1312. os.kill(proc.pid, signal.SIGINT)
  1313. wait_on_condition(ContainerCountCondition(self.project, 0))
  1314. def test_up_handles_sigterm(self):
  1315. proc = start_process(self.base_dir, ['up', '-t', '2'])
  1316. wait_on_condition(ContainerCountCondition(self.project, 2))
  1317. os.kill(proc.pid, signal.SIGTERM)
  1318. wait_on_condition(ContainerCountCondition(self.project, 0))
  1319. @v2_only()
  1320. def test_up_handles_force_shutdown(self):
  1321. self.base_dir = 'tests/fixtures/sleeps-composefile'
  1322. proc = start_process(self.base_dir, ['up', '-t', '200'])
  1323. wait_on_condition(ContainerCountCondition(self.project, 2))
  1324. os.kill(proc.pid, signal.SIGTERM)
  1325. time.sleep(0.1)
  1326. os.kill(proc.pid, signal.SIGTERM)
  1327. wait_on_condition(ContainerCountCondition(self.project, 0))
  1328. def test_up_handles_abort_on_container_exit(self):
  1329. self.base_dir = 'tests/fixtures/abort-on-container-exit-0'
  1330. proc = start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  1331. wait_on_condition(ContainerCountCondition(self.project, 0))
  1332. proc.wait()
  1333. assert proc.returncode == 0
  1334. def test_up_handles_abort_on_container_exit_code(self):
  1335. self.base_dir = 'tests/fixtures/abort-on-container-exit-1'
  1336. proc = start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  1337. wait_on_condition(ContainerCountCondition(self.project, 0))
  1338. proc.wait()
  1339. assert proc.returncode == 1
  1340. @v2_only()
  1341. @no_cluster('Container PID mode does not work across clusters')
  1342. def test_up_with_pid_mode(self):
  1343. c = self.client.create_container(
  1344. 'busybox', 'top', name='composetest_pid_mode_container',
  1345. host_config={}
  1346. )
  1347. self.addCleanup(self.client.remove_container, c, force=True)
  1348. self.client.start(c)
  1349. container_mode_source = 'container:{}'.format(c['Id'])
  1350. self.base_dir = 'tests/fixtures/pid-mode'
  1351. self.dispatch(['up', '-d'], None)
  1352. service_mode_source = 'container:{}'.format(
  1353. self.project.get_service('container').containers()[0].id)
  1354. service_mode_container = self.project.get_service('service').containers()[0]
  1355. assert service_mode_container.get('HostConfig.PidMode') == service_mode_source
  1356. container_mode_container = self.project.get_service('container').containers()[0]
  1357. assert container_mode_container.get('HostConfig.PidMode') == container_mode_source
  1358. host_mode_container = self.project.get_service('host').containers()[0]
  1359. assert host_mode_container.get('HostConfig.PidMode') == 'host'
  1360. def test_exec_without_tty(self):
  1361. self.base_dir = 'tests/fixtures/links-composefile'
  1362. self.dispatch(['up', '-d', 'console'])
  1363. assert len(self.project.containers()) == 1
  1364. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  1365. assert stderr == ""
  1366. assert stdout == "/\n"
  1367. def test_exec_detach_long_form(self):
  1368. self.base_dir = 'tests/fixtures/links-composefile'
  1369. self.dispatch(['up', '--detach', 'console'])
  1370. assert len(self.project.containers()) == 1
  1371. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  1372. assert stderr == ""
  1373. assert stdout == "/\n"
  1374. def test_exec_custom_user(self):
  1375. self.base_dir = 'tests/fixtures/links-composefile'
  1376. self.dispatch(['up', '-d', 'console'])
  1377. assert len(self.project.containers()) == 1
  1378. stdout, stderr = self.dispatch(['exec', '-T', '--user=operator', 'console', 'whoami'])
  1379. assert stdout == "operator\n"
  1380. assert stderr == ""
  1381. @v3_only()
  1382. def test_exec_workdir(self):
  1383. self.base_dir = 'tests/fixtures/links-composefile'
  1384. os.environ['COMPOSE_API_VERSION'] = '1.35'
  1385. self.dispatch(['up', '-d', 'console'])
  1386. assert len(self.project.containers()) == 1
  1387. stdout, stderr = self.dispatch(['exec', '-T', '--workdir', '/etc', 'console', 'ls'])
  1388. assert 'passwd' in stdout
  1389. @v2_2_only()
  1390. def test_exec_service_with_environment_overridden(self):
  1391. name = 'service'
  1392. self.base_dir = 'tests/fixtures/environment-exec'
  1393. self.dispatch(['up', '-d'])
  1394. assert len(self.project.containers()) == 1
  1395. stdout, stderr = self.dispatch([
  1396. 'exec',
  1397. '-T',
  1398. '-e', 'foo=notbar',
  1399. '--env', 'alpha=beta',
  1400. name,
  1401. 'env',
  1402. ])
  1403. # env overridden
  1404. assert 'foo=notbar' in stdout
  1405. # keep environment from yaml
  1406. assert 'hello=world' in stdout
  1407. # added option from command line
  1408. assert 'alpha=beta' in stdout
  1409. assert stderr == ''
  1410. def test_run_service_without_links(self):
  1411. self.base_dir = 'tests/fixtures/links-composefile'
  1412. self.dispatch(['run', 'console', '/bin/true'])
  1413. assert len(self.project.containers()) == 0
  1414. # Ensure stdin/out was open
  1415. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1416. config = container.inspect()['Config']
  1417. assert config['AttachStderr']
  1418. assert config['AttachStdout']
  1419. assert config['AttachStdin']
  1420. def test_run_service_with_links(self):
  1421. self.base_dir = 'tests/fixtures/links-composefile'
  1422. self.dispatch(['run', 'web', '/bin/true'], None)
  1423. db = self.project.get_service('db')
  1424. console = self.project.get_service('console')
  1425. assert len(db.containers()) == 1
  1426. assert len(console.containers()) == 0
  1427. @v2_only()
  1428. def test_run_service_with_dependencies(self):
  1429. self.base_dir = 'tests/fixtures/v2-dependencies'
  1430. self.dispatch(['run', 'web', '/bin/true'], None)
  1431. db = self.project.get_service('db')
  1432. console = self.project.get_service('console')
  1433. assert len(db.containers()) == 1
  1434. assert len(console.containers()) == 0
  1435. def test_run_service_with_scaled_dependencies(self):
  1436. self.base_dir = 'tests/fixtures/v2-dependencies'
  1437. self.dispatch(['up', '-d', '--scale', 'db=2', '--scale', 'console=0'])
  1438. db = self.project.get_service('db')
  1439. console = self.project.get_service('console')
  1440. assert len(db.containers()) == 2
  1441. assert len(console.containers()) == 0
  1442. self.dispatch(['run', 'web', '/bin/true'], None)
  1443. assert len(db.containers()) == 2
  1444. assert len(console.containers()) == 0
  1445. def test_run_with_no_deps(self):
  1446. self.base_dir = 'tests/fixtures/links-composefile'
  1447. self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
  1448. db = self.project.get_service('db')
  1449. assert len(db.containers()) == 0
  1450. def test_run_does_not_recreate_linked_containers(self):
  1451. self.base_dir = 'tests/fixtures/links-composefile'
  1452. self.dispatch(['up', '-d', 'db'])
  1453. db = self.project.get_service('db')
  1454. assert len(db.containers()) == 1
  1455. old_ids = [c.id for c in db.containers()]
  1456. self.dispatch(['run', 'web', '/bin/true'], None)
  1457. assert len(db.containers()) == 1
  1458. new_ids = [c.id for c in db.containers()]
  1459. assert old_ids == new_ids
  1460. def test_run_without_command(self):
  1461. self.base_dir = 'tests/fixtures/commands-composefile'
  1462. self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  1463. self.dispatch(['run', 'implicit'])
  1464. service = self.project.get_service('implicit')
  1465. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  1466. assert [c.human_readable_command for c in containers] == [u'/bin/sh -c echo "success"']
  1467. self.dispatch(['run', 'explicit'])
  1468. service = self.project.get_service('explicit')
  1469. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  1470. assert [c.human_readable_command for c in containers] == [u'/bin/true']
  1471. @pytest.mark.skipif(SWARM_SKIP_RM_VOLUMES, reason='Swarm DELETE /containers/<id> bug')
  1472. def test_run_rm(self):
  1473. self.base_dir = 'tests/fixtures/volume'
  1474. proc = start_process(self.base_dir, ['run', '--rm', 'test'])
  1475. service = self.project.get_service('test')
  1476. wait_on_condition(ContainerStateCondition(
  1477. self.project.client,
  1478. 'volume_test_run_*',
  1479. 'running')
  1480. )
  1481. containers = service.containers(one_off=OneOffFilter.only)
  1482. assert len(containers) == 1
  1483. mounts = containers[0].get('Mounts')
  1484. for mount in mounts:
  1485. if mount['Destination'] == '/container-path':
  1486. anonymous_name = mount['Name']
  1487. break
  1488. os.kill(proc.pid, signal.SIGINT)
  1489. wait_on_process(proc, 1)
  1490. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1491. volumes = self.client.volumes()['Volumes']
  1492. assert volumes is not None
  1493. for volume in service.options.get('volumes'):
  1494. if volume.internal == '/container-named-path':
  1495. name = volume.external
  1496. break
  1497. volume_names = [v['Name'].split('/')[-1] for v in volumes]
  1498. assert name in volume_names
  1499. assert anonymous_name not in volume_names
  1500. def test_run_service_with_dockerfile_entrypoint(self):
  1501. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1502. self.dispatch(['run', 'test'])
  1503. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1504. assert container.get('Config.Entrypoint') == ['printf']
  1505. assert container.get('Config.Cmd') == ['default', 'args']
  1506. def test_run_service_with_unset_entrypoint(self):
  1507. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1508. self.dispatch(['run', '--entrypoint=""', 'test', 'true'])
  1509. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1510. assert container.get('Config.Entrypoint') is None
  1511. assert container.get('Config.Cmd') == ['true']
  1512. self.dispatch(['run', '--entrypoint', '""', 'test', 'true'])
  1513. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1514. assert container.get('Config.Entrypoint') is None
  1515. assert container.get('Config.Cmd') == ['true']
  1516. def test_run_service_with_dockerfile_entrypoint_overridden(self):
  1517. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1518. self.dispatch(['run', '--entrypoint', 'echo', 'test'])
  1519. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1520. assert container.get('Config.Entrypoint') == ['echo']
  1521. assert not container.get('Config.Cmd')
  1522. def test_run_service_with_dockerfile_entrypoint_and_command_overridden(self):
  1523. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1524. self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
  1525. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1526. assert container.get('Config.Entrypoint') == ['echo']
  1527. assert container.get('Config.Cmd') == ['foo']
  1528. def test_run_service_with_compose_file_entrypoint(self):
  1529. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1530. self.dispatch(['run', 'test'])
  1531. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1532. assert container.get('Config.Entrypoint') == ['printf']
  1533. assert container.get('Config.Cmd') == ['default', 'args']
  1534. def test_run_service_with_compose_file_entrypoint_overridden(self):
  1535. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1536. self.dispatch(['run', '--entrypoint', 'echo', 'test'])
  1537. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1538. assert container.get('Config.Entrypoint') == ['echo']
  1539. assert not container.get('Config.Cmd')
  1540. def test_run_service_with_compose_file_entrypoint_and_command_overridden(self):
  1541. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1542. self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
  1543. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1544. assert container.get('Config.Entrypoint') == ['echo']
  1545. assert container.get('Config.Cmd') == ['foo']
  1546. def test_run_service_with_compose_file_entrypoint_and_empty_string_command(self):
  1547. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1548. self.dispatch(['run', '--entrypoint', 'echo', 'test', ''])
  1549. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1550. assert container.get('Config.Entrypoint') == ['echo']
  1551. assert container.get('Config.Cmd') == ['']
  1552. def test_run_service_with_user_overridden(self):
  1553. self.base_dir = 'tests/fixtures/user-composefile'
  1554. name = 'service'
  1555. user = 'sshd'
  1556. self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
  1557. service = self.project.get_service(name)
  1558. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1559. assert user == container.get('Config.User')
  1560. def test_run_service_with_user_overridden_short_form(self):
  1561. self.base_dir = 'tests/fixtures/user-composefile'
  1562. name = 'service'
  1563. user = 'sshd'
  1564. self.dispatch(['run', '-u', user, name], returncode=1)
  1565. service = self.project.get_service(name)
  1566. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1567. assert user == container.get('Config.User')
  1568. def test_run_service_with_environment_overridden(self):
  1569. name = 'service'
  1570. self.base_dir = 'tests/fixtures/environment-composefile'
  1571. self.dispatch([
  1572. 'run', '-e', 'foo=notbar',
  1573. '-e', 'allo=moto=bobo',
  1574. '-e', 'alpha=beta',
  1575. name,
  1576. '/bin/true',
  1577. ])
  1578. service = self.project.get_service(name)
  1579. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1580. # env overridden
  1581. assert 'notbar' == container.environment['foo']
  1582. # keep environment from yaml
  1583. assert 'world' == container.environment['hello']
  1584. # added option from command line
  1585. assert 'beta' == container.environment['alpha']
  1586. # make sure a value with a = don't crash out
  1587. assert 'moto=bobo' == container.environment['allo']
  1588. def test_run_service_without_map_ports(self):
  1589. # create one off container
  1590. self.base_dir = 'tests/fixtures/ports-composefile'
  1591. self.dispatch(['run', '-d', 'simple'])
  1592. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1593. # get port information
  1594. port_random = container.get_local_port(3000)
  1595. port_assigned = container.get_local_port(3001)
  1596. # close all one off containers we just created
  1597. container.stop()
  1598. # check the ports
  1599. assert port_random is None
  1600. assert port_assigned is None
  1601. def test_run_service_with_map_ports(self):
  1602. # create one off container
  1603. self.base_dir = 'tests/fixtures/ports-composefile'
  1604. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  1605. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1606. # get port information
  1607. port_random = container.get_local_port(3000)
  1608. port_assigned = container.get_local_port(3001)
  1609. port_range = container.get_local_port(3002), container.get_local_port(3003)
  1610. # close all one off containers we just created
  1611. container.stop()
  1612. # check the ports
  1613. assert port_random is not None
  1614. assert port_assigned.endswith(':49152')
  1615. assert port_range[0].endswith(':49153')
  1616. assert port_range[1].endswith(':49154')
  1617. def test_run_service_with_explicitly_mapped_ports(self):
  1618. # create one off container
  1619. self.base_dir = 'tests/fixtures/ports-composefile'
  1620. self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
  1621. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1622. # get port information
  1623. port_short = container.get_local_port(3000)
  1624. port_full = container.get_local_port(3001)
  1625. # close all one off containers we just created
  1626. container.stop()
  1627. # check the ports
  1628. assert port_short.endswith(':30000')
  1629. assert port_full.endswith(':30001')
  1630. def test_run_service_with_explicitly_mapped_ip_ports(self):
  1631. # create one off container
  1632. self.base_dir = 'tests/fixtures/ports-composefile'
  1633. self.dispatch([
  1634. 'run', '-d',
  1635. '-p', '127.0.0.1:30000:3000',
  1636. '--publish', '127.0.0.1:30001:3001',
  1637. 'simple'
  1638. ])
  1639. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1640. # get port information
  1641. port_short = container.get_local_port(3000)
  1642. port_full = container.get_local_port(3001)
  1643. # close all one off containers we just created
  1644. container.stop()
  1645. # check the ports
  1646. assert port_short == "127.0.0.1:30000"
  1647. assert port_full == "127.0.0.1:30001"
  1648. def test_run_with_expose_ports(self):
  1649. # create one off container
  1650. self.base_dir = 'tests/fixtures/expose-composefile'
  1651. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  1652. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1653. ports = container.ports
  1654. assert len(ports) == 9
  1655. # exposed ports are not mapped to host ports
  1656. assert ports['3000/tcp'] is None
  1657. assert ports['3001/tcp'] is None
  1658. assert ports['3001/udp'] is None
  1659. assert ports['3002/tcp'] is None
  1660. assert ports['3003/tcp'] is None
  1661. assert ports['3004/tcp'] is None
  1662. assert ports['3005/tcp'] is None
  1663. assert ports['3006/udp'] is None
  1664. assert ports['3007/udp'] is None
  1665. # close all one off containers we just created
  1666. container.stop()
  1667. def test_run_with_custom_name(self):
  1668. self.base_dir = 'tests/fixtures/environment-composefile'
  1669. name = 'the-container-name'
  1670. self.dispatch(['run', '--name', name, 'service', '/bin/true'])
  1671. service = self.project.get_service('service')
  1672. container, = service.containers(stopped=True, one_off=OneOffFilter.only)
  1673. assert container.name == name
  1674. def test_run_service_with_workdir_overridden(self):
  1675. self.base_dir = 'tests/fixtures/run-workdir'
  1676. name = 'service'
  1677. workdir = '/var'
  1678. self.dispatch(['run', '--workdir={workdir}'.format(workdir=workdir), name])
  1679. service = self.project.get_service(name)
  1680. container = service.containers(stopped=True, one_off=True)[0]
  1681. assert workdir == container.get('Config.WorkingDir')
  1682. def test_run_service_with_workdir_overridden_short_form(self):
  1683. self.base_dir = 'tests/fixtures/run-workdir'
  1684. name = 'service'
  1685. workdir = '/var'
  1686. self.dispatch(['run', '-w', workdir, name])
  1687. service = self.project.get_service(name)
  1688. container = service.containers(stopped=True, one_off=True)[0]
  1689. assert workdir == container.get('Config.WorkingDir')
  1690. @v2_only()
  1691. def test_run_service_with_use_aliases(self):
  1692. filename = 'network-aliases.yml'
  1693. self.base_dir = 'tests/fixtures/networks'
  1694. self.dispatch(['-f', filename, 'run', '-d', '--use-aliases', 'web', 'top'])
  1695. back_name = '{}_back'.format(self.project.name)
  1696. front_name = '{}_front'.format(self.project.name)
  1697. web_container = self.project.get_service('web').containers(one_off=OneOffFilter.only)[0]
  1698. back_aliases = web_container.get(
  1699. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  1700. )
  1701. assert 'web' in back_aliases
  1702. front_aliases = web_container.get(
  1703. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  1704. )
  1705. assert 'web' in front_aliases
  1706. assert 'forward_facing' in front_aliases
  1707. assert 'ahead' in front_aliases
  1708. @v2_only()
  1709. def test_run_interactive_connects_to_network(self):
  1710. self.base_dir = 'tests/fixtures/networks'
  1711. self.dispatch(['up', '-d'])
  1712. self.dispatch(['run', 'app', 'nslookup', 'app'])
  1713. self.dispatch(['run', 'app', 'nslookup', 'db'])
  1714. containers = self.project.get_service('app').containers(
  1715. stopped=True, one_off=OneOffFilter.only)
  1716. assert len(containers) == 2
  1717. for container in containers:
  1718. networks = container.get('NetworkSettings.Networks')
  1719. assert sorted(list(networks)) == [
  1720. '{}_{}'.format(self.project.name, name)
  1721. for name in ['back', 'front']
  1722. ]
  1723. for _, config in networks.items():
  1724. # TODO: once we drop support for API <1.24, this can be changed to:
  1725. # assert config['Aliases'] == [container.short_id]
  1726. aliases = set(config['Aliases'] or []) - set([container.short_id])
  1727. assert not aliases
  1728. @v2_only()
  1729. def test_run_detached_connects_to_network(self):
  1730. self.base_dir = 'tests/fixtures/networks'
  1731. self.dispatch(['up', '-d'])
  1732. self.dispatch(['run', '-d', 'app', 'top'])
  1733. container = self.project.get_service('app').containers(one_off=OneOffFilter.only)[0]
  1734. networks = container.get('NetworkSettings.Networks')
  1735. assert sorted(list(networks)) == [
  1736. '{}_{}'.format(self.project.name, name)
  1737. for name in ['back', 'front']
  1738. ]
  1739. for _, config in networks.items():
  1740. # TODO: once we drop support for API <1.24, this can be changed to:
  1741. # assert config['Aliases'] == [container.short_id]
  1742. aliases = set(config['Aliases'] or []) - set([container.short_id])
  1743. assert not aliases
  1744. assert self.lookup(container, 'app')
  1745. assert self.lookup(container, 'db')
  1746. def test_run_handles_sigint(self):
  1747. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1748. wait_on_condition(ContainerStateCondition(
  1749. self.project.client,
  1750. 'simple-composefile_simple_run_*',
  1751. 'running'))
  1752. os.kill(proc.pid, signal.SIGINT)
  1753. wait_on_condition(ContainerStateCondition(
  1754. self.project.client,
  1755. 'simple-composefile_simple_run_*',
  1756. 'exited'))
  1757. def test_run_handles_sigterm(self):
  1758. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1759. wait_on_condition(ContainerStateCondition(
  1760. self.project.client,
  1761. 'simple-composefile_simple_run_*',
  1762. 'running'))
  1763. os.kill(proc.pid, signal.SIGTERM)
  1764. wait_on_condition(ContainerStateCondition(
  1765. self.project.client,
  1766. 'simple-composefile_simple_run_*',
  1767. 'exited'))
  1768. def test_run_handles_sighup(self):
  1769. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1770. wait_on_condition(ContainerStateCondition(
  1771. self.project.client,
  1772. 'simple-composefile_simple_run_*',
  1773. 'running'))
  1774. os.kill(proc.pid, signal.SIGHUP)
  1775. wait_on_condition(ContainerStateCondition(
  1776. self.project.client,
  1777. 'simple-composefile_simple_run_*',
  1778. 'exited'))
  1779. @mock.patch.dict(os.environ)
  1780. def test_run_unicode_env_values_from_system(self):
  1781. value = 'ą, ć, ę, ł, ń, ó, ś, ź, ż'
  1782. if six.PY2: # os.environ doesn't support unicode values in Py2
  1783. os.environ['BAR'] = value.encode('utf-8')
  1784. else: # ... and doesn't support byte values in Py3
  1785. os.environ['BAR'] = value
  1786. self.base_dir = 'tests/fixtures/unicode-environment'
  1787. result = self.dispatch(['run', 'simple'])
  1788. if six.PY2: # Can't retrieve output on Py3. See issue #3670
  1789. assert value in result.stdout.strip()
  1790. container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
  1791. environment = container.get('Config.Env')
  1792. assert 'FOO={}'.format(value) in environment
  1793. @mock.patch.dict(os.environ)
  1794. def test_run_env_values_from_system(self):
  1795. os.environ['FOO'] = 'bar'
  1796. os.environ['BAR'] = 'baz'
  1797. self.dispatch(['run', '-e', 'FOO', 'simple', 'true'], None)
  1798. container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
  1799. environment = container.get('Config.Env')
  1800. assert 'FOO=bar' in environment
  1801. assert 'BAR=baz' not in environment
  1802. def test_run_label_flag(self):
  1803. self.base_dir = 'tests/fixtures/run-labels'
  1804. name = 'service'
  1805. self.dispatch(['run', '-l', 'default', '--label', 'foo=baz', name, '/bin/true'])
  1806. service = self.project.get_service(name)
  1807. container, = service.containers(stopped=True, one_off=OneOffFilter.only)
  1808. labels = container.labels
  1809. assert labels['default'] == ''
  1810. assert labels['foo'] == 'baz'
  1811. assert labels['hello'] == 'world'
  1812. def test_rm(self):
  1813. service = self.project.get_service('simple')
  1814. service.create_container()
  1815. kill_service(service)
  1816. assert len(service.containers(stopped=True)) == 1
  1817. self.dispatch(['rm', '--force'], None)
  1818. assert len(service.containers(stopped=True)) == 0
  1819. service = self.project.get_service('simple')
  1820. service.create_container()
  1821. kill_service(service)
  1822. assert len(service.containers(stopped=True)) == 1
  1823. self.dispatch(['rm', '-f'], None)
  1824. assert len(service.containers(stopped=True)) == 0
  1825. service = self.project.get_service('simple')
  1826. service.create_container()
  1827. self.dispatch(['rm', '-fs'], None)
  1828. assert len(service.containers(stopped=True)) == 0
  1829. def test_rm_stop(self):
  1830. self.dispatch(['up', '-d'], None)
  1831. simple = self.project.get_service('simple')
  1832. another = self.project.get_service('another')
  1833. assert len(simple.containers()) == 1
  1834. assert len(another.containers()) == 1
  1835. self.dispatch(['rm', '-fs'], None)
  1836. assert len(simple.containers(stopped=True)) == 0
  1837. assert len(another.containers(stopped=True)) == 0
  1838. self.dispatch(['up', '-d'], None)
  1839. assert len(simple.containers()) == 1
  1840. assert len(another.containers()) == 1
  1841. self.dispatch(['rm', '-fs', 'another'], None)
  1842. assert len(simple.containers()) == 1
  1843. assert len(another.containers(stopped=True)) == 0
  1844. def test_rm_all(self):
  1845. service = self.project.get_service('simple')
  1846. service.create_container(one_off=False)
  1847. service.create_container(one_off=True)
  1848. kill_service(service)
  1849. assert len(service.containers(stopped=True)) == 1
  1850. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 1
  1851. self.dispatch(['rm', '-f'], None)
  1852. assert len(service.containers(stopped=True)) == 0
  1853. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1854. service.create_container(one_off=False)
  1855. service.create_container(one_off=True)
  1856. kill_service(service)
  1857. assert len(service.containers(stopped=True)) == 1
  1858. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 1
  1859. self.dispatch(['rm', '-f', '--all'], None)
  1860. assert len(service.containers(stopped=True)) == 0
  1861. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1862. def test_stop(self):
  1863. self.dispatch(['up', '-d'], None)
  1864. service = self.project.get_service('simple')
  1865. assert len(service.containers()) == 1
  1866. assert service.containers()[0].is_running
  1867. self.dispatch(['stop', '-t', '1'], None)
  1868. assert len(service.containers(stopped=True)) == 1
  1869. assert not service.containers(stopped=True)[0].is_running
  1870. def test_stop_signal(self):
  1871. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  1872. self.dispatch(['up', '-d'], None)
  1873. service = self.project.get_service('simple')
  1874. assert len(service.containers()) == 1
  1875. assert service.containers()[0].is_running
  1876. self.dispatch(['stop', '-t', '1'], None)
  1877. assert len(service.containers(stopped=True)) == 1
  1878. assert not service.containers(stopped=True)[0].is_running
  1879. assert service.containers(stopped=True)[0].exit_code == 0
  1880. def test_start_no_containers(self):
  1881. result = self.dispatch(['start'], returncode=1)
  1882. assert 'failed' in result.stderr
  1883. assert 'No containers to start' in result.stderr
  1884. @v2_only()
  1885. def test_up_logging(self):
  1886. self.base_dir = 'tests/fixtures/logging-composefile'
  1887. self.dispatch(['up', '-d'])
  1888. simple = self.project.get_service('simple').containers()[0]
  1889. log_config = simple.get('HostConfig.LogConfig')
  1890. assert log_config
  1891. assert log_config.get('Type') == 'none'
  1892. another = self.project.get_service('another').containers()[0]
  1893. log_config = another.get('HostConfig.LogConfig')
  1894. assert log_config
  1895. assert log_config.get('Type') == 'json-file'
  1896. assert log_config.get('Config')['max-size'] == '10m'
  1897. def test_up_logging_legacy(self):
  1898. self.base_dir = 'tests/fixtures/logging-composefile-legacy'
  1899. self.dispatch(['up', '-d'])
  1900. simple = self.project.get_service('simple').containers()[0]
  1901. log_config = simple.get('HostConfig.LogConfig')
  1902. assert log_config
  1903. assert log_config.get('Type') == 'none'
  1904. another = self.project.get_service('another').containers()[0]
  1905. log_config = another.get('HostConfig.LogConfig')
  1906. assert log_config
  1907. assert log_config.get('Type') == 'json-file'
  1908. assert log_config.get('Config')['max-size'] == '10m'
  1909. def test_pause_unpause(self):
  1910. self.dispatch(['up', '-d'], None)
  1911. service = self.project.get_service('simple')
  1912. assert not service.containers()[0].is_paused
  1913. self.dispatch(['pause'], None)
  1914. assert service.containers()[0].is_paused
  1915. self.dispatch(['unpause'], None)
  1916. assert not service.containers()[0].is_paused
  1917. def test_pause_no_containers(self):
  1918. result = self.dispatch(['pause'], returncode=1)
  1919. assert 'No containers to pause' in result.stderr
  1920. def test_unpause_no_containers(self):
  1921. result = self.dispatch(['unpause'], returncode=1)
  1922. assert 'No containers to unpause' in result.stderr
  1923. def test_logs_invalid_service_name(self):
  1924. self.dispatch(['logs', 'madeupname'], returncode=1)
  1925. def test_logs_follow(self):
  1926. self.base_dir = 'tests/fixtures/echo-services'
  1927. self.dispatch(['up', '-d'])
  1928. result = self.dispatch(['logs', '-f'])
  1929. if not is_cluster(self.client):
  1930. assert result.stdout.count('\n') == 5
  1931. else:
  1932. # Sometimes logs are picked up from old containers that haven't yet
  1933. # been removed (removal in Swarm is async)
  1934. assert result.stdout.count('\n') >= 5
  1935. assert 'simple' in result.stdout
  1936. assert 'another' in result.stdout
  1937. assert 'exited with code 0' in result.stdout
  1938. @pytest.mark.skip(reason="race condition between up and logs")
  1939. def test_logs_follow_logs_from_new_containers(self):
  1940. self.base_dir = 'tests/fixtures/logs-composefile'
  1941. self.dispatch(['up', '-d', 'simple'])
  1942. proc = start_process(self.base_dir, ['logs', '-f'])
  1943. self.dispatch(['up', '-d', 'another'])
  1944. another_name = self.project.get_service('another').get_container().name_without_project
  1945. wait_on_condition(
  1946. ContainerStateCondition(
  1947. self.project.client,
  1948. 'logs-composefile_another_*',
  1949. 'exited'
  1950. )
  1951. )
  1952. simple_name = self.project.get_service('simple').get_container().name_without_project
  1953. self.dispatch(['kill', 'simple'])
  1954. result = wait_on_process(proc)
  1955. assert 'hello' in result.stdout
  1956. assert 'test' in result.stdout
  1957. assert '{} exited with code 0'.format(another_name) in result.stdout
  1958. assert '{} exited with code 137'.format(simple_name) in result.stdout
  1959. @pytest.mark.skip(reason="race condition between up and logs")
  1960. def test_logs_follow_logs_from_restarted_containers(self):
  1961. self.base_dir = 'tests/fixtures/logs-restart-composefile'
  1962. proc = start_process(self.base_dir, ['up'])
  1963. wait_on_condition(
  1964. ContainerStateCondition(
  1965. self.project.client,
  1966. 'logs-restart-composefile_another_*',
  1967. 'exited'
  1968. )
  1969. )
  1970. self.dispatch(['kill', 'simple'])
  1971. result = wait_on_process(proc)
  1972. assert result.stdout.count(
  1973. r'logs-restart-composefile_another_1 exited with code 1'
  1974. ) == 3
  1975. assert result.stdout.count('world') == 3
  1976. @pytest.mark.skip(reason="race condition between up and logs")
  1977. def test_logs_default(self):
  1978. self.base_dir = 'tests/fixtures/logs-composefile'
  1979. self.dispatch(['up', '-d'])
  1980. result = self.dispatch(['logs'])
  1981. assert 'hello' in result.stdout
  1982. assert 'test' in result.stdout
  1983. assert 'exited with' not in result.stdout
  1984. def test_logs_on_stopped_containers_exits(self):
  1985. self.base_dir = 'tests/fixtures/echo-services'
  1986. self.dispatch(['up'])
  1987. result = self.dispatch(['logs'])
  1988. assert 'simple' in result.stdout
  1989. assert 'another' in result.stdout
  1990. assert 'exited with' not in result.stdout
  1991. def test_logs_timestamps(self):
  1992. self.base_dir = 'tests/fixtures/echo-services'
  1993. self.dispatch(['up', '-d'])
  1994. result = self.dispatch(['logs', '-f', '-t'])
  1995. assert re.search(r'(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})', result.stdout)
  1996. def test_logs_tail(self):
  1997. self.base_dir = 'tests/fixtures/logs-tail-composefile'
  1998. self.dispatch(['up'])
  1999. result = self.dispatch(['logs', '--tail', '2'])
  2000. assert 'y\n' in result.stdout
  2001. assert 'z\n' in result.stdout
  2002. assert 'w\n' not in result.stdout
  2003. assert 'x\n' not in result.stdout
  2004. def test_kill(self):
  2005. self.dispatch(['up', '-d'], None)
  2006. service = self.project.get_service('simple')
  2007. assert len(service.containers()) == 1
  2008. assert service.containers()[0].is_running
  2009. self.dispatch(['kill'], None)
  2010. assert len(service.containers(stopped=True)) == 1
  2011. assert not service.containers(stopped=True)[0].is_running
  2012. def test_kill_signal_sigstop(self):
  2013. self.dispatch(['up', '-d'], None)
  2014. service = self.project.get_service('simple')
  2015. assert len(service.containers()) == 1
  2016. assert service.containers()[0].is_running
  2017. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  2018. assert len(service.containers()) == 1
  2019. # The container is still running. It has only been paused
  2020. assert service.containers()[0].is_running
  2021. def test_kill_stopped_service(self):
  2022. self.dispatch(['up', '-d'], None)
  2023. service = self.project.get_service('simple')
  2024. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  2025. assert service.containers()[0].is_running
  2026. self.dispatch(['kill', '-s', 'SIGKILL'], None)
  2027. assert len(service.containers(stopped=True)) == 1
  2028. assert not service.containers(stopped=True)[0].is_running
  2029. def test_restart(self):
  2030. service = self.project.get_service('simple')
  2031. container = service.create_container()
  2032. service.start_container(container)
  2033. started_at = container.dictionary['State']['StartedAt']
  2034. self.dispatch(['restart', '-t', '1'], None)
  2035. container.inspect()
  2036. assert container.dictionary['State']['FinishedAt'] != '0001-01-01T00:00:00Z'
  2037. assert container.dictionary['State']['StartedAt'] != started_at
  2038. def test_restart_stopped_container(self):
  2039. service = self.project.get_service('simple')
  2040. container = service.create_container()
  2041. container.start()
  2042. container.kill()
  2043. assert len(service.containers(stopped=True)) == 1
  2044. self.dispatch(['restart', '-t', '1'], None)
  2045. assert len(service.containers(stopped=False)) == 1
  2046. def test_restart_no_containers(self):
  2047. result = self.dispatch(['restart'], returncode=1)
  2048. assert 'No containers to restart' in result.stderr
  2049. def test_scale(self):
  2050. project = self.project
  2051. self.dispatch(['scale', 'simple=1'])
  2052. assert len(project.get_service('simple').containers()) == 1
  2053. self.dispatch(['scale', 'simple=3', 'another=2'])
  2054. assert len(project.get_service('simple').containers()) == 3
  2055. assert len(project.get_service('another').containers()) == 2
  2056. self.dispatch(['scale', 'simple=1', 'another=1'])
  2057. assert len(project.get_service('simple').containers()) == 1
  2058. assert len(project.get_service('another').containers()) == 1
  2059. self.dispatch(['scale', 'simple=1', 'another=1'])
  2060. assert len(project.get_service('simple').containers()) == 1
  2061. assert len(project.get_service('another').containers()) == 1
  2062. self.dispatch(['scale', 'simple=0', 'another=0'])
  2063. assert len(project.get_service('simple').containers()) == 0
  2064. assert len(project.get_service('another').containers()) == 0
  2065. def test_scale_v2_2(self):
  2066. self.base_dir = 'tests/fixtures/scale'
  2067. result = self.dispatch(['scale', 'web=1'], returncode=1)
  2068. assert 'incompatible with the v2.2 format' in result.stderr
  2069. def test_up_scale_scale_up(self):
  2070. self.base_dir = 'tests/fixtures/scale'
  2071. project = self.project
  2072. self.dispatch(['up', '-d'])
  2073. assert len(project.get_service('web').containers()) == 2
  2074. assert len(project.get_service('db').containers()) == 1
  2075. assert len(project.get_service('worker').containers()) == 0
  2076. self.dispatch(['up', '-d', '--scale', 'web=3', '--scale', 'worker=1'])
  2077. assert len(project.get_service('web').containers()) == 3
  2078. assert len(project.get_service('db').containers()) == 1
  2079. assert len(project.get_service('worker').containers()) == 1
  2080. def test_up_scale_scale_down(self):
  2081. self.base_dir = 'tests/fixtures/scale'
  2082. project = self.project
  2083. self.dispatch(['up', '-d'])
  2084. assert len(project.get_service('web').containers()) == 2
  2085. assert len(project.get_service('db').containers()) == 1
  2086. assert len(project.get_service('worker').containers()) == 0
  2087. self.dispatch(['up', '-d', '--scale', 'web=1'])
  2088. assert len(project.get_service('web').containers()) == 1
  2089. assert len(project.get_service('db').containers()) == 1
  2090. assert len(project.get_service('worker').containers()) == 0
  2091. def test_up_scale_reset(self):
  2092. self.base_dir = 'tests/fixtures/scale'
  2093. project = self.project
  2094. self.dispatch(['up', '-d', '--scale', 'web=3', '--scale', 'db=3', '--scale', 'worker=3'])
  2095. assert len(project.get_service('web').containers()) == 3
  2096. assert len(project.get_service('db').containers()) == 3
  2097. assert len(project.get_service('worker').containers()) == 3
  2098. self.dispatch(['up', '-d'])
  2099. assert len(project.get_service('web').containers()) == 2
  2100. assert len(project.get_service('db').containers()) == 1
  2101. assert len(project.get_service('worker').containers()) == 0
  2102. def test_up_scale_to_zero(self):
  2103. self.base_dir = 'tests/fixtures/scale'
  2104. project = self.project
  2105. self.dispatch(['up', '-d'])
  2106. assert len(project.get_service('web').containers()) == 2
  2107. assert len(project.get_service('db').containers()) == 1
  2108. assert len(project.get_service('worker').containers()) == 0
  2109. self.dispatch(['up', '-d', '--scale', 'web=0', '--scale', 'db=0', '--scale', 'worker=0'])
  2110. assert len(project.get_service('web').containers()) == 0
  2111. assert len(project.get_service('db').containers()) == 0
  2112. assert len(project.get_service('worker').containers()) == 0
  2113. def test_port(self):
  2114. self.base_dir = 'tests/fixtures/ports-composefile'
  2115. self.dispatch(['up', '-d'], None)
  2116. container = self.project.get_service('simple').get_container()
  2117. def get_port(number):
  2118. result = self.dispatch(['port', 'simple', str(number)])
  2119. return result.stdout.rstrip()
  2120. assert get_port(3000) == container.get_local_port(3000)
  2121. assert ':49152' in get_port(3001)
  2122. assert ':49153' in get_port(3002)
  2123. def test_expanded_port(self):
  2124. self.base_dir = 'tests/fixtures/ports-composefile'
  2125. self.dispatch(['-f', 'expanded-notation.yml', 'up', '-d'])
  2126. container = self.project.get_service('simple').get_container()
  2127. def get_port(number):
  2128. result = self.dispatch(['port', 'simple', str(number)])
  2129. return result.stdout.rstrip()
  2130. assert get_port(3000) == container.get_local_port(3000)
  2131. assert ':53222' in get_port(3001)
  2132. assert ':53223' in get_port(3002)
  2133. def test_port_with_scale(self):
  2134. self.base_dir = 'tests/fixtures/ports-composefile-scale'
  2135. self.dispatch(['scale', 'simple=2'], None)
  2136. containers = sorted(
  2137. self.project.containers(service_names=['simple']),
  2138. key=attrgetter('name'))
  2139. def get_port(number, index=None):
  2140. if index is None:
  2141. result = self.dispatch(['port', 'simple', str(number)])
  2142. else:
  2143. result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
  2144. return result.stdout.rstrip()
  2145. assert get_port(3000) in (containers[0].get_local_port(3000), containers[1].get_local_port(3000))
  2146. assert get_port(3000, index=containers[0].number) == containers[0].get_local_port(3000)
  2147. assert get_port(3000, index=containers[1].number) == containers[1].get_local_port(3000)
  2148. assert get_port(3002) == ""
  2149. def test_events_json(self):
  2150. events_proc = start_process(self.base_dir, ['events', '--json'])
  2151. self.dispatch(['up', '-d'])
  2152. wait_on_condition(ContainerCountCondition(self.project, 2))
  2153. os.kill(events_proc.pid, signal.SIGINT)
  2154. result = wait_on_process(events_proc, returncode=1)
  2155. lines = [json.loads(line) for line in result.stdout.rstrip().split('\n')]
  2156. assert Counter(e['action'] for e in lines) == {'create': 2, 'start': 2}
  2157. def test_events_human_readable(self):
  2158. def has_timestamp(string):
  2159. str_iso_date, str_iso_time, container_info = string.split(' ', 2)
  2160. try:
  2161. return isinstance(datetime.datetime.strptime(
  2162. '%s %s' % (str_iso_date, str_iso_time),
  2163. '%Y-%m-%d %H:%M:%S.%f'),
  2164. datetime.datetime)
  2165. except ValueError:
  2166. return False
  2167. events_proc = start_process(self.base_dir, ['events'])
  2168. self.dispatch(['up', '-d', 'simple'])
  2169. wait_on_condition(ContainerCountCondition(self.project, 1))
  2170. os.kill(events_proc.pid, signal.SIGINT)
  2171. result = wait_on_process(events_proc, returncode=1)
  2172. lines = result.stdout.rstrip().split('\n')
  2173. assert len(lines) == 2
  2174. container, = self.project.containers()
  2175. expected_template = ' container {} {}'
  2176. expected_meta_info = ['image=busybox:latest', 'name=simple-composefile_simple_']
  2177. assert expected_template.format('create', container.id) in lines[0]
  2178. assert expected_template.format('start', container.id) in lines[1]
  2179. for line in lines:
  2180. for info in expected_meta_info:
  2181. assert info in line
  2182. assert has_timestamp(lines[0])
  2183. def test_env_file_relative_to_compose_file(self):
  2184. config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
  2185. self.dispatch(['-f', config_path, 'up', '-d'], None)
  2186. self._project = get_project(self.base_dir, [config_path])
  2187. containers = self.project.containers(stopped=True)
  2188. assert len(containers) == 1
  2189. assert "FOO=1" in containers[0].get('Config.Env')
  2190. @mock.patch.dict(os.environ)
  2191. def test_home_and_env_var_in_volume_path(self):
  2192. os.environ['VOLUME_NAME'] = 'my-volume'
  2193. os.environ['HOME'] = '/tmp/home-dir'
  2194. self.base_dir = 'tests/fixtures/volume-path-interpolation'
  2195. self.dispatch(['up', '-d'], None)
  2196. container = self.project.containers(stopped=True)[0]
  2197. actual_host_path = container.get_mount('/container-path')['Source']
  2198. components = actual_host_path.split('/')
  2199. assert components[-2:] == ['home-dir', 'my-volume']
  2200. def test_up_with_default_override_file(self):
  2201. self.base_dir = 'tests/fixtures/override-files'
  2202. self.dispatch(['up', '-d'], None)
  2203. containers = self.project.containers()
  2204. assert len(containers) == 2
  2205. web, db = containers
  2206. assert web.human_readable_command == 'top'
  2207. assert db.human_readable_command == 'top'
  2208. def test_up_with_multiple_files(self):
  2209. self.base_dir = 'tests/fixtures/override-files'
  2210. config_paths = [
  2211. 'docker-compose.yml',
  2212. 'docker-compose.override.yml',
  2213. 'extra.yml',
  2214. ]
  2215. self._project = get_project(self.base_dir, config_paths)
  2216. self.dispatch(
  2217. [
  2218. '-f', config_paths[0],
  2219. '-f', config_paths[1],
  2220. '-f', config_paths[2],
  2221. 'up', '-d',
  2222. ],
  2223. None)
  2224. containers = self.project.containers()
  2225. assert len(containers) == 3
  2226. web, other, db = containers
  2227. assert web.human_readable_command == 'top'
  2228. assert db.human_readable_command == 'top'
  2229. assert other.human_readable_command == 'top'
  2230. def test_up_with_extends(self):
  2231. self.base_dir = 'tests/fixtures/extends'
  2232. self.dispatch(['up', '-d'], None)
  2233. assert set([s.name for s in self.project.services]) == set(['mydb', 'myweb'])
  2234. # Sort by name so we get [db, web]
  2235. containers = sorted(
  2236. self.project.containers(stopped=True),
  2237. key=lambda c: c.name,
  2238. )
  2239. assert len(containers) == 2
  2240. web = containers[1]
  2241. db_name = containers[0].name_without_project
  2242. assert set(get_links(web)) == set(
  2243. ['db', db_name, 'extends_{}'.format(db_name)]
  2244. )
  2245. expected_env = set([
  2246. "FOO=1",
  2247. "BAR=2",
  2248. "BAZ=2",
  2249. ])
  2250. assert expected_env <= set(web.get('Config.Env'))
  2251. def test_top_services_not_running(self):
  2252. self.base_dir = 'tests/fixtures/top'
  2253. result = self.dispatch(['top'])
  2254. assert len(result.stdout) == 0
  2255. def test_top_services_running(self):
  2256. self.base_dir = 'tests/fixtures/top'
  2257. self.dispatch(['up', '-d'])
  2258. result = self.dispatch(['top'])
  2259. assert 'top_service_a' in result.stdout
  2260. assert 'top_service_b' in result.stdout
  2261. assert 'top_not_a_service' not in result.stdout
  2262. def test_top_processes_running(self):
  2263. self.base_dir = 'tests/fixtures/top'
  2264. self.dispatch(['up', '-d'])
  2265. result = self.dispatch(['top'])
  2266. assert result.stdout.count("top") == 4
  2267. def test_forward_exitval(self):
  2268. self.base_dir = 'tests/fixtures/exit-code-from'
  2269. proc = start_process(
  2270. self.base_dir,
  2271. ['up', '--abort-on-container-exit', '--exit-code-from', 'another']
  2272. )
  2273. result = wait_on_process(proc, returncode=1)
  2274. assert 'exit-code-from_another_1 exited with code 1' in result.stdout
  2275. def test_exit_code_from_signal_stop(self):
  2276. self.base_dir = 'tests/fixtures/exit-code-from'
  2277. proc = start_process(
  2278. self.base_dir,
  2279. ['up', '--abort-on-container-exit', '--exit-code-from', 'simple']
  2280. )
  2281. result = wait_on_process(proc, returncode=137) # SIGKILL
  2282. name = self.project.get_service('another').containers(stopped=True)[0].name_without_project
  2283. assert '{} exited with code 1'.format(name) in result.stdout
  2284. def test_images(self):
  2285. self.project.get_service('simple').create_container()
  2286. result = self.dispatch(['images'])
  2287. assert 'busybox' in result.stdout
  2288. assert 'simple-composefile_simple_' in result.stdout
  2289. def test_images_default_composefile(self):
  2290. self.base_dir = 'tests/fixtures/multiple-composefiles'
  2291. self.dispatch(['up', '-d'])
  2292. result = self.dispatch(['images'])
  2293. assert 'busybox' in result.stdout
  2294. assert 'multiple-composefiles_another_1' in result.stdout
  2295. assert 'multiple-composefiles_simple_1' in result.stdout
  2296. @mock.patch.dict(os.environ)
  2297. def test_images_tagless_image(self):
  2298. self.base_dir = 'tests/fixtures/tagless-image'
  2299. stream = self.client.build(self.base_dir, decode=True)
  2300. img_id = None
  2301. for data in stream:
  2302. if 'aux' in data:
  2303. img_id = data['aux']['ID']
  2304. break
  2305. if 'stream' in data and 'Successfully built' in data['stream']:
  2306. img_id = self.client.inspect_image(data['stream'].split(' ')[2].strip())['Id']
  2307. assert img_id
  2308. os.environ['IMAGE_ID'] = img_id
  2309. self.project.get_service('foo').create_container()
  2310. result = self.dispatch(['images'])
  2311. assert '<none>' in result.stdout
  2312. assert 'tagless-image_foo_1' in result.stdout
  2313. def test_up_with_override_yaml(self):
  2314. self.base_dir = 'tests/fixtures/override-yaml-files'
  2315. self._project = get_project(self.base_dir, [])
  2316. self.dispatch(['up', '-d'], None)
  2317. containers = self.project.containers()
  2318. assert len(containers) == 2
  2319. web, db = containers
  2320. assert web.human_readable_command == 'sleep 100'
  2321. assert db.human_readable_command == 'top'
  2322. def test_up_with_duplicate_override_yaml_files(self):
  2323. self.base_dir = 'tests/fixtures/duplicate-override-yaml-files'
  2324. with pytest.raises(DuplicateOverrideFileFound):
  2325. get_project(self.base_dir, [])
  2326. self.base_dir = None
  2327. def test_images_use_service_tag(self):
  2328. pull_busybox(self.client)
  2329. self.base_dir = 'tests/fixtures/images-service-tag'
  2330. self.dispatch(['up', '-d', '--build'])
  2331. result = self.dispatch(['images'])
  2332. assert re.search(r'foo1.+test[ \t]+dev', result.stdout) is not None
  2333. assert re.search(r'foo2.+test[ \t]+prod', result.stdout) is not None
  2334. assert re.search(r'foo3.+_foo3[ \t]+latest', result.stdout) is not None