cli_test.py 110 KB

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