cli_test.py 122 KB

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