cli_test.py 110 KB

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