cli_test.py 118 KB

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