cli_test.py 83 KB

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