cli_test.py 118 KB

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