cli_test.py 110 KB

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