cli_test.py 88 KB

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