cli_test.py 80 KB

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