cli_test.py 94 KB

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