cli_test.py 109 KB

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