cli_test.py 93 KB

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