cli_test.py 102 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665
  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', '--quiet'
  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', '--quiet']).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_external_network_v3_5(self):
  300. self.base_dir = 'tests/fixtures/networks'
  301. result = self.dispatch(['-f', 'external-networks-v3-5.yml', 'config'])
  302. json_result = yaml.load(result.stdout)
  303. assert 'networks' in json_result
  304. assert json_result['networks'] == {
  305. 'foo': {
  306. 'external': True,
  307. 'name': 'some_foo',
  308. },
  309. 'bar': {
  310. 'external': True,
  311. 'name': 'some_bar',
  312. },
  313. }
  314. def test_config_v1(self):
  315. self.base_dir = 'tests/fixtures/v1-config'
  316. result = self.dispatch(['config'])
  317. assert yaml.load(result.stdout) == {
  318. 'version': '2.1',
  319. 'services': {
  320. 'net': {
  321. 'image': 'busybox',
  322. 'network_mode': 'bridge',
  323. },
  324. 'volume': {
  325. 'image': 'busybox',
  326. 'volumes': ['/data'],
  327. 'network_mode': 'bridge',
  328. },
  329. 'app': {
  330. 'image': 'busybox',
  331. 'volumes_from': ['service:volume:rw'],
  332. 'network_mode': 'service:net',
  333. },
  334. },
  335. }
  336. @v3_only()
  337. def test_config_v3(self):
  338. self.base_dir = 'tests/fixtures/v3-full'
  339. result = self.dispatch(['config'])
  340. assert yaml.load(result.stdout) == {
  341. 'version': '3.5',
  342. 'volumes': {
  343. 'foobar': {
  344. 'labels': {
  345. 'com.docker.compose.test': 'true',
  346. },
  347. },
  348. },
  349. 'services': {
  350. 'web': {
  351. 'image': 'busybox',
  352. 'deploy': {
  353. 'mode': 'replicated',
  354. 'replicas': 6,
  355. 'labels': ['FOO=BAR'],
  356. 'update_config': {
  357. 'parallelism': 3,
  358. 'delay': '10s',
  359. 'failure_action': 'continue',
  360. 'monitor': '60s',
  361. 'max_failure_ratio': 0.3,
  362. },
  363. 'resources': {
  364. 'limits': {
  365. 'cpus': '0.05',
  366. 'memory': '50M',
  367. },
  368. 'reservations': {
  369. 'cpus': '0.01',
  370. 'memory': '20M',
  371. },
  372. },
  373. 'restart_policy': {
  374. 'condition': 'on-failure',
  375. 'delay': '5s',
  376. 'max_attempts': 3,
  377. 'window': '120s',
  378. },
  379. 'placement': {
  380. 'constraints': [
  381. 'node.hostname==foo', 'node.role != manager'
  382. ],
  383. 'preferences': [{'spread': 'node.labels.datacenter'}]
  384. },
  385. },
  386. 'healthcheck': {
  387. 'test': 'cat /etc/passwd',
  388. 'interval': '10s',
  389. 'timeout': '1s',
  390. 'retries': 5,
  391. },
  392. 'volumes': [{
  393. 'read_only': True,
  394. 'source': '/host/path',
  395. 'target': '/container/path',
  396. 'type': 'bind'
  397. }, {
  398. 'source': 'foobar', 'target': '/container/volumepath', 'type': 'volume'
  399. }, {
  400. 'target': '/anonymous', 'type': 'volume'
  401. }, {
  402. 'source': 'foobar',
  403. 'target': '/container/volumepath2',
  404. 'type': 'volume',
  405. 'volume': {'nocopy': True}
  406. }],
  407. 'stop_grace_period': '20s',
  408. },
  409. },
  410. }
  411. def test_config_compatibility_mode(self):
  412. self.base_dir = 'tests/fixtures/compatibility-mode'
  413. result = self.dispatch(['--compatibility', 'config'])
  414. assert yaml.load(result.stdout) == {
  415. 'version': '2.3',
  416. 'volumes': {'foo': {'driver': 'default'}},
  417. 'services': {
  418. 'foo': {
  419. 'command': '/bin/true',
  420. 'image': 'alpine:3.7',
  421. 'scale': 3,
  422. 'restart': 'always:7',
  423. 'mem_limit': '300M',
  424. 'mem_reservation': '100M',
  425. 'cpus': 0.7,
  426. 'volumes': ['foo:/bar:rw']
  427. }
  428. }
  429. }
  430. def test_ps(self):
  431. self.project.get_service('simple').create_container()
  432. result = self.dispatch(['ps'])
  433. assert 'simple-composefile_simple_1' in result.stdout
  434. def test_ps_default_composefile(self):
  435. self.base_dir = 'tests/fixtures/multiple-composefiles'
  436. self.dispatch(['up', '-d'])
  437. result = self.dispatch(['ps'])
  438. assert 'multiple-composefiles_simple_1' in result.stdout
  439. assert 'multiple-composefiles_another_1' in result.stdout
  440. assert 'multiple-composefiles_yetanother_1' not in result.stdout
  441. def test_ps_alternate_composefile(self):
  442. config_path = os.path.abspath(
  443. 'tests/fixtures/multiple-composefiles/compose2.yml')
  444. self._project = get_project(self.base_dir, [config_path])
  445. self.base_dir = 'tests/fixtures/multiple-composefiles'
  446. self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
  447. result = self.dispatch(['-f', 'compose2.yml', 'ps'])
  448. assert 'multiple-composefiles_simple_1' not in result.stdout
  449. assert 'multiple-composefiles_another_1' not in result.stdout
  450. assert 'multiple-composefiles_yetanother_1' in result.stdout
  451. def test_ps_services_filter_option(self):
  452. self.base_dir = 'tests/fixtures/ps-services-filter'
  453. image = self.dispatch(['ps', '--services', '--filter', 'source=image'])
  454. build = self.dispatch(['ps', '--services', '--filter', 'source=build'])
  455. all_services = self.dispatch(['ps', '--services'])
  456. assert 'with_build' in all_services.stdout
  457. assert 'with_image' in all_services.stdout
  458. assert 'with_build' in build.stdout
  459. assert 'with_build' not in image.stdout
  460. assert 'with_image' in image.stdout
  461. assert 'with_image' not in build.stdout
  462. def test_ps_services_filter_status(self):
  463. self.base_dir = 'tests/fixtures/ps-services-filter'
  464. self.dispatch(['up', '-d'])
  465. self.dispatch(['pause', 'with_image'])
  466. paused = self.dispatch(['ps', '--services', '--filter', 'status=paused'])
  467. stopped = self.dispatch(['ps', '--services', '--filter', 'status=stopped'])
  468. running = self.dispatch(['ps', '--services', '--filter', 'status=running'])
  469. assert 'with_build' not in stopped.stdout
  470. assert 'with_image' not in stopped.stdout
  471. assert 'with_build' not in paused.stdout
  472. assert 'with_image' in paused.stdout
  473. assert 'with_build' in running.stdout
  474. assert 'with_image' in running.stdout
  475. def test_pull(self):
  476. result = self.dispatch(['pull'])
  477. assert 'Pulling simple' in result.stderr
  478. assert 'Pulling another' in result.stderr
  479. def test_pull_with_digest(self):
  480. result = self.dispatch(['-f', 'digest.yml', 'pull', '--no-parallel'])
  481. assert 'Pulling simple (busybox:latest)...' in result.stderr
  482. assert ('Pulling digest (busybox@'
  483. 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
  484. '04ee8502d)...') in result.stderr
  485. def test_pull_with_ignore_pull_failures(self):
  486. result = self.dispatch([
  487. '-f', 'ignore-pull-failures.yml',
  488. 'pull', '--ignore-pull-failures', '--no-parallel']
  489. )
  490. assert 'Pulling simple (busybox:latest)...' in result.stderr
  491. assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
  492. assert ('repository nonexisting-image not found' in result.stderr or
  493. 'image library/nonexisting-image:latest not found' in result.stderr or
  494. 'pull access denied for nonexisting-image' in result.stderr)
  495. def test_pull_with_quiet(self):
  496. assert self.dispatch(['pull', '--quiet']).stderr == ''
  497. assert self.dispatch(['pull', '--quiet']).stdout == ''
  498. def test_pull_with_parallel_failure(self):
  499. result = self.dispatch([
  500. '-f', 'ignore-pull-failures.yml', 'pull'],
  501. returncode=1
  502. )
  503. assert re.search(re.compile('^Pulling simple', re.MULTILINE), result.stderr)
  504. assert re.search(re.compile('^Pulling another', re.MULTILINE), result.stderr)
  505. assert re.search(
  506. re.compile('^ERROR: for another .*does not exist.*', re.MULTILINE),
  507. result.stderr
  508. )
  509. assert re.search(
  510. re.compile('''^(ERROR: )?(b')?.* nonexisting-image''', re.MULTILINE),
  511. result.stderr
  512. )
  513. def test_pull_with_no_deps(self):
  514. self.base_dir = 'tests/fixtures/links-composefile'
  515. result = self.dispatch(['pull', '--no-parallel', 'web'])
  516. assert sorted(result.stderr.split('\n'))[1:] == [
  517. 'Pulling web (busybox:latest)...',
  518. ]
  519. def test_pull_with_include_deps(self):
  520. self.base_dir = 'tests/fixtures/links-composefile'
  521. result = self.dispatch(['pull', '--no-parallel', '--include-deps', 'web'])
  522. assert sorted(result.stderr.split('\n'))[1:] == [
  523. 'Pulling db (busybox:latest)...',
  524. 'Pulling web (busybox:latest)...',
  525. ]
  526. def test_build_plain(self):
  527. self.base_dir = 'tests/fixtures/simple-dockerfile'
  528. self.dispatch(['build', 'simple'])
  529. result = self.dispatch(['build', 'simple'])
  530. assert BUILD_PULL_TEXT not in result.stdout
  531. def test_build_no_cache(self):
  532. self.base_dir = 'tests/fixtures/simple-dockerfile'
  533. self.dispatch(['build', 'simple'])
  534. result = self.dispatch(['build', '--no-cache', 'simple'])
  535. assert BUILD_CACHE_TEXT not in result.stdout
  536. assert BUILD_PULL_TEXT not in result.stdout
  537. def test_build_pull(self):
  538. # Make sure we have the latest busybox already
  539. pull_busybox(self.client)
  540. self.base_dir = 'tests/fixtures/simple-dockerfile'
  541. self.dispatch(['build', 'simple'], None)
  542. result = self.dispatch(['build', '--pull', 'simple'])
  543. if not is_cluster(self.client):
  544. # If previous build happened on another node, cache won't be available
  545. assert BUILD_CACHE_TEXT in result.stdout
  546. assert BUILD_PULL_TEXT in result.stdout
  547. def test_build_no_cache_pull(self):
  548. # Make sure we have the latest busybox already
  549. pull_busybox(self.client)
  550. self.base_dir = 'tests/fixtures/simple-dockerfile'
  551. self.dispatch(['build', 'simple'])
  552. result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
  553. assert BUILD_CACHE_TEXT not in result.stdout
  554. assert BUILD_PULL_TEXT in result.stdout
  555. def test_build_log_level(self):
  556. self.base_dir = 'tests/fixtures/simple-dockerfile'
  557. result = self.dispatch(['--log-level', 'warning', 'build', 'simple'])
  558. assert result.stderr == ''
  559. result = self.dispatch(['--log-level', 'debug', 'build', 'simple'])
  560. assert 'Building simple' in result.stderr
  561. assert 'Using configuration file' in result.stderr
  562. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  563. result = self.dispatch(['--log-level', 'critical', 'build', 'simple'], returncode=1)
  564. assert result.stderr == ''
  565. result = self.dispatch(['--log-level', 'debug', 'build', 'simple'], returncode=1)
  566. assert 'Building simple' in result.stderr
  567. assert 'non-zero code' in result.stderr
  568. def test_build_failed(self):
  569. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  570. self.dispatch(['build', 'simple'], returncode=1)
  571. labels = ["com.docker.compose.test_failing_image=true"]
  572. containers = [
  573. Container.from_ps(self.project.client, c)
  574. for c in self.project.client.containers(
  575. all=True,
  576. filters={"label": labels})
  577. ]
  578. assert len(containers) == 1
  579. def test_build_failed_forcerm(self):
  580. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  581. self.dispatch(['build', '--force-rm', 'simple'], returncode=1)
  582. labels = ["com.docker.compose.test_failing_image=true"]
  583. containers = [
  584. Container.from_ps(self.project.client, c)
  585. for c in self.project.client.containers(
  586. all=True,
  587. filters={"label": labels})
  588. ]
  589. assert not containers
  590. def test_build_shm_size_build_option(self):
  591. pull_busybox(self.client)
  592. self.base_dir = 'tests/fixtures/build-shm-size'
  593. result = self.dispatch(['build', '--no-cache'], None)
  594. assert 'shm_size: 96' in result.stdout
  595. def test_build_memory_build_option(self):
  596. pull_busybox(self.client)
  597. self.base_dir = 'tests/fixtures/build-memory'
  598. result = self.dispatch(['build', '--no-cache', '--memory', '96m', 'service'], None)
  599. assert 'memory: 100663296' in result.stdout # 96 * 1024 * 1024
  600. def test_build_with_buildarg_from_compose_file(self):
  601. pull_busybox(self.client)
  602. self.base_dir = 'tests/fixtures/build-args'
  603. result = self.dispatch(['build'], None)
  604. assert 'Favorite Touhou Character: mariya.kirisame' in result.stdout
  605. def test_build_with_buildarg_cli_override(self):
  606. pull_busybox(self.client)
  607. self.base_dir = 'tests/fixtures/build-args'
  608. result = self.dispatch(['build', '--build-arg', 'favorite_th_character=sakuya.izayoi'], None)
  609. assert 'Favorite Touhou Character: sakuya.izayoi' in result.stdout
  610. @mock.patch.dict(os.environ)
  611. def test_build_with_buildarg_old_api_version(self):
  612. pull_busybox(self.client)
  613. self.base_dir = 'tests/fixtures/build-args'
  614. os.environ['COMPOSE_API_VERSION'] = '1.24'
  615. result = self.dispatch(
  616. ['build', '--build-arg', 'favorite_th_character=reimu.hakurei'], None, returncode=1
  617. )
  618. assert '--build-arg is only supported when services are specified' in result.stderr
  619. result = self.dispatch(
  620. ['build', '--build-arg', 'favorite_th_character=hong.meiling', 'web'], None
  621. )
  622. assert 'Favorite Touhou Character: hong.meiling' in result.stdout
  623. def test_bundle_with_digests(self):
  624. self.base_dir = 'tests/fixtures/bundle-with-digests/'
  625. tmpdir = pytest.ensuretemp('cli_test_bundle')
  626. self.addCleanup(tmpdir.remove)
  627. filename = str(tmpdir.join('example.dab'))
  628. self.dispatch(['bundle', '--output', filename])
  629. with open(filename, 'r') as fh:
  630. bundle = json.load(fh)
  631. assert bundle == {
  632. 'Version': '0.1',
  633. 'Services': {
  634. 'web': {
  635. 'Image': ('dockercloud/hello-world@sha256:fe79a2cfbd17eefc3'
  636. '44fb8419420808df95a1e22d93b7f621a7399fd1e9dca1d'),
  637. 'Networks': ['default'],
  638. },
  639. 'redis': {
  640. 'Image': ('redis@sha256:a84cb8f53a70e19f61ff2e1d5e73fb7ae62d'
  641. '374b2b7392de1e7d77be26ef8f7b'),
  642. 'Networks': ['default'],
  643. }
  644. },
  645. }
  646. def test_build_override_dir(self):
  647. self.base_dir = 'tests/fixtures/build-path-override-dir'
  648. self.override_dir = os.path.abspath('tests/fixtures')
  649. result = self.dispatch([
  650. '--project-directory', self.override_dir,
  651. 'build'])
  652. assert 'Successfully built' in result.stdout
  653. def test_build_override_dir_invalid_path(self):
  654. config_path = os.path.abspath('tests/fixtures/build-path-override-dir/docker-compose.yml')
  655. result = self.dispatch([
  656. '-f', config_path,
  657. 'build'], returncode=1)
  658. assert 'does not exist, is not accessible, or is not a valid URL' in result.stderr
  659. def test_create(self):
  660. self.dispatch(['create'])
  661. service = self.project.get_service('simple')
  662. another = self.project.get_service('another')
  663. service_containers = service.containers(stopped=True)
  664. another_containers = another.containers(stopped=True)
  665. assert len(service_containers) == 1
  666. assert len(another_containers) == 1
  667. assert not service_containers[0].is_running
  668. assert not another_containers[0].is_running
  669. def test_create_with_force_recreate(self):
  670. self.dispatch(['create'], None)
  671. service = self.project.get_service('simple')
  672. service_containers = service.containers(stopped=True)
  673. assert len(service_containers) == 1
  674. assert not service_containers[0].is_running
  675. old_ids = [c.id for c in service.containers(stopped=True)]
  676. self.dispatch(['create', '--force-recreate'], None)
  677. service_containers = service.containers(stopped=True)
  678. assert len(service_containers) == 1
  679. assert not service_containers[0].is_running
  680. new_ids = [c.id for c in service_containers]
  681. assert old_ids != new_ids
  682. def test_create_with_no_recreate(self):
  683. self.dispatch(['create'], None)
  684. service = self.project.get_service('simple')
  685. service_containers = service.containers(stopped=True)
  686. assert len(service_containers) == 1
  687. assert not service_containers[0].is_running
  688. old_ids = [c.id for c in service.containers(stopped=True)]
  689. self.dispatch(['create', '--no-recreate'], None)
  690. service_containers = service.containers(stopped=True)
  691. assert len(service_containers) == 1
  692. assert not service_containers[0].is_running
  693. new_ids = [c.id for c in service_containers]
  694. assert old_ids == new_ids
  695. def test_run_one_off_with_volume(self):
  696. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  697. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  698. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  699. self.dispatch([
  700. 'run',
  701. '-v', '{}:/data'.format(volume_path),
  702. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  703. 'simple',
  704. 'test', '-f', '/data/example.txt'
  705. ], returncode=0)
  706. service = self.project.get_service('simple')
  707. container_data = service.containers(one_off=OneOffFilter.only, stopped=True)[0]
  708. mount = container_data.get('Mounts')[0]
  709. assert mount['Source'] == volume_path
  710. assert mount['Destination'] == '/data'
  711. assert mount['Type'] == 'bind'
  712. def test_run_one_off_with_multiple_volumes(self):
  713. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  714. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  715. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  716. self.dispatch([
  717. 'run',
  718. '-v', '{}:/data'.format(volume_path),
  719. '-v', '{}:/data1'.format(volume_path),
  720. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  721. 'simple',
  722. 'test', '-f', '/data/example.txt'
  723. ], returncode=0)
  724. self.dispatch([
  725. 'run',
  726. '-v', '{}:/data'.format(volume_path),
  727. '-v', '{}:/data1'.format(volume_path),
  728. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  729. 'simple',
  730. 'test', '-f' '/data1/example.txt'
  731. ], returncode=0)
  732. def test_run_one_off_with_volume_merge(self):
  733. self.base_dir = 'tests/fixtures/simple-composefile-volume-ready'
  734. volume_path = os.path.abspath(os.path.join(os.getcwd(), self.base_dir, 'files'))
  735. node = create_host_file(self.client, os.path.join(volume_path, 'example.txt'))
  736. self.dispatch([
  737. '-f', 'docker-compose.merge.yml',
  738. 'run',
  739. '-v', '{}:/data'.format(volume_path),
  740. '-e', 'constraint:node=={}'.format(node if node is not None else '*'),
  741. 'simple',
  742. 'test', '-f', '/data/example.txt'
  743. ], returncode=0)
  744. service = self.project.get_service('simple')
  745. container_data = service.containers(one_off=OneOffFilter.only, stopped=True)[0]
  746. mounts = container_data.get('Mounts')
  747. assert len(mounts) == 2
  748. config_mount = [m for m in mounts if m['Destination'] == '/data1'][0]
  749. override_mount = [m for m in mounts if m['Destination'] == '/data'][0]
  750. assert config_mount['Type'] == 'volume'
  751. assert override_mount['Source'] == volume_path
  752. assert override_mount['Type'] == 'bind'
  753. def test_create_with_force_recreate_and_no_recreate(self):
  754. self.dispatch(
  755. ['create', '--force-recreate', '--no-recreate'],
  756. returncode=1)
  757. def test_down_invalid_rmi_flag(self):
  758. result = self.dispatch(['down', '--rmi', 'bogus'], returncode=1)
  759. assert '--rmi flag must be' in result.stderr
  760. @v2_only()
  761. def test_down(self):
  762. self.base_dir = 'tests/fixtures/v2-full'
  763. self.dispatch(['up', '-d'])
  764. wait_on_condition(ContainerCountCondition(self.project, 2))
  765. self.dispatch(['run', 'web', 'true'])
  766. self.dispatch(['run', '-d', 'web', 'tail', '-f', '/dev/null'])
  767. assert len(self.project.containers(one_off=OneOffFilter.only, stopped=True)) == 2
  768. result = self.dispatch(['down', '--rmi=local', '--volumes'])
  769. assert 'Stopping v2-full_web_1' in result.stderr
  770. assert 'Stopping v2-full_other_1' in result.stderr
  771. assert 'Stopping v2-full_web_run_2' in result.stderr
  772. assert 'Removing v2-full_web_1' in result.stderr
  773. assert 'Removing v2-full_other_1' in result.stderr
  774. assert 'Removing v2-full_web_run_1' in result.stderr
  775. assert 'Removing v2-full_web_run_2' in result.stderr
  776. assert 'Removing volume v2-full_data' in result.stderr
  777. assert 'Removing image v2-full_web' in result.stderr
  778. assert 'Removing image busybox' not in result.stderr
  779. assert 'Removing network v2-full_default' in result.stderr
  780. assert 'Removing network v2-full_front' in result.stderr
  781. def test_down_timeout(self):
  782. self.dispatch(['up', '-d'], None)
  783. service = self.project.get_service('simple')
  784. assert len(service.containers()) == 1
  785. assert service.containers()[0].is_running
  786. ""
  787. self.dispatch(['down', '-t', '1'], None)
  788. assert len(service.containers(stopped=True)) == 0
  789. def test_down_signal(self):
  790. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  791. self.dispatch(['up', '-d'], None)
  792. service = self.project.get_service('simple')
  793. assert len(service.containers()) == 1
  794. assert service.containers()[0].is_running
  795. self.dispatch(['down', '-t', '1'], None)
  796. assert len(service.containers(stopped=True)) == 0
  797. def test_up_detached(self):
  798. self.dispatch(['up', '-d'])
  799. service = self.project.get_service('simple')
  800. another = self.project.get_service('another')
  801. assert len(service.containers()) == 1
  802. assert len(another.containers()) == 1
  803. # Ensure containers don't have stdin and stdout connected in -d mode
  804. container, = service.containers()
  805. assert not container.get('Config.AttachStderr')
  806. assert not container.get('Config.AttachStdout')
  807. assert not container.get('Config.AttachStdin')
  808. def test_up_detached_long_form(self):
  809. self.dispatch(['up', '--detach'])
  810. service = self.project.get_service('simple')
  811. another = self.project.get_service('another')
  812. assert len(service.containers()) == 1
  813. assert len(another.containers()) == 1
  814. # Ensure containers don't have stdin and stdout connected in -d mode
  815. container, = service.containers()
  816. assert not container.get('Config.AttachStderr')
  817. assert not container.get('Config.AttachStdout')
  818. assert not container.get('Config.AttachStdin')
  819. def test_up_attached(self):
  820. self.base_dir = 'tests/fixtures/echo-services'
  821. result = self.dispatch(['up', '--no-color'])
  822. assert 'simple_1 | simple' in result.stdout
  823. assert 'another_1 | another' in result.stdout
  824. assert 'simple_1 exited with code 0' in result.stdout
  825. assert 'another_1 exited with code 0' in result.stdout
  826. @v2_only()
  827. def test_up(self):
  828. self.base_dir = 'tests/fixtures/v2-simple'
  829. self.dispatch(['up', '-d'], None)
  830. services = self.project.get_services()
  831. network_name = self.project.networks.networks['default'].full_name
  832. networks = self.client.networks(names=[network_name])
  833. assert len(networks) == 1
  834. assert networks[0]['Driver'] == 'bridge' if not is_cluster(self.client) else 'overlay'
  835. assert 'com.docker.network.bridge.enable_icc' not in networks[0]['Options']
  836. network = self.client.inspect_network(networks[0]['Id'])
  837. for service in services:
  838. containers = service.containers()
  839. assert len(containers) == 1
  840. container = containers[0]
  841. assert container.id in network['Containers']
  842. networks = container.get('NetworkSettings.Networks')
  843. assert list(networks) == [network['Name']]
  844. assert sorted(networks[network['Name']]['Aliases']) == sorted(
  845. [service.name, container.short_id]
  846. )
  847. for service in services:
  848. assert self.lookup(container, service.name)
  849. @v2_only()
  850. def test_up_no_start(self):
  851. self.base_dir = 'tests/fixtures/v2-full'
  852. self.dispatch(['up', '--no-start'], None)
  853. services = self.project.get_services()
  854. default_network = self.project.networks.networks['default'].full_name
  855. front_network = self.project.networks.networks['front'].full_name
  856. networks = self.client.networks(names=[default_network, front_network])
  857. assert len(networks) == 2
  858. for service in services:
  859. containers = service.containers(stopped=True)
  860. assert len(containers) == 1
  861. container = containers[0]
  862. assert not container.is_running
  863. assert container.get('State.Status') == 'created'
  864. volumes = self.project.volumes.volumes
  865. assert 'data' in volumes
  866. volume = volumes['data']
  867. # The code below is a Swarm-compatible equivalent to volume.exists()
  868. remote_volumes = [
  869. v for v in self.client.volumes().get('Volumes', [])
  870. if v['Name'].split('/')[-1] == volume.full_name
  871. ]
  872. assert len(remote_volumes) > 0
  873. @v2_only()
  874. def test_up_no_ansi(self):
  875. self.base_dir = 'tests/fixtures/v2-simple'
  876. result = self.dispatch(['--no-ansi', 'up', '-d'], None)
  877. assert "%c[2K\r" % 27 not in result.stderr
  878. assert "%c[1A" % 27 not in result.stderr
  879. assert "%c[1B" % 27 not in result.stderr
  880. @v2_only()
  881. def test_up_with_default_network_config(self):
  882. filename = 'default-network-config.yml'
  883. self.base_dir = 'tests/fixtures/networks'
  884. self._project = get_project(self.base_dir, [filename])
  885. self.dispatch(['-f', filename, 'up', '-d'], None)
  886. network_name = self.project.networks.networks['default'].full_name
  887. networks = self.client.networks(names=[network_name])
  888. assert networks[0]['Options']['com.docker.network.bridge.enable_icc'] == 'false'
  889. @v2_only()
  890. def test_up_with_network_aliases(self):
  891. filename = 'network-aliases.yml'
  892. self.base_dir = 'tests/fixtures/networks'
  893. self.dispatch(['-f', filename, 'up', '-d'], None)
  894. back_name = '{}_back'.format(self.project.name)
  895. front_name = '{}_front'.format(self.project.name)
  896. networks = [
  897. n for n in self.client.networks()
  898. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  899. ]
  900. # Two networks were created: back and front
  901. assert sorted(n['Name'].split('/')[-1] for n in networks) == [back_name, front_name]
  902. web_container = self.project.get_service('web').containers()[0]
  903. back_aliases = web_container.get(
  904. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  905. )
  906. assert 'web' in back_aliases
  907. front_aliases = web_container.get(
  908. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  909. )
  910. assert 'web' in front_aliases
  911. assert 'forward_facing' in front_aliases
  912. assert 'ahead' in front_aliases
  913. @v2_only()
  914. def test_up_with_network_internal(self):
  915. self.require_api_version('1.23')
  916. filename = 'network-internal.yml'
  917. self.base_dir = 'tests/fixtures/networks'
  918. self.dispatch(['-f', filename, 'up', '-d'], None)
  919. internal_net = '{}_internal'.format(self.project.name)
  920. networks = [
  921. n for n in self.client.networks()
  922. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  923. ]
  924. # One network was created: internal
  925. assert sorted(n['Name'].split('/')[-1] for n in networks) == [internal_net]
  926. assert networks[0]['Internal'] is True
  927. @v2_only()
  928. def test_up_with_network_static_addresses(self):
  929. filename = 'network-static-addresses.yml'
  930. ipv4_address = '172.16.100.100'
  931. ipv6_address = 'fe80::1001:100'
  932. self.base_dir = 'tests/fixtures/networks'
  933. self.dispatch(['-f', filename, 'up', '-d'], None)
  934. static_net = '{}_static_test'.format(self.project.name)
  935. networks = [
  936. n for n in self.client.networks()
  937. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  938. ]
  939. # One networks was created: front
  940. assert sorted(n['Name'].split('/')[-1] for n in networks) == [static_net]
  941. web_container = self.project.get_service('web').containers()[0]
  942. ipam_config = web_container.get(
  943. 'NetworkSettings.Networks.{}.IPAMConfig'.format(static_net)
  944. )
  945. assert ipv4_address in ipam_config.values()
  946. assert ipv6_address in ipam_config.values()
  947. @v2_only()
  948. def test_up_with_networks(self):
  949. self.base_dir = 'tests/fixtures/networks'
  950. self.dispatch(['up', '-d'], None)
  951. back_name = '{}_back'.format(self.project.name)
  952. front_name = '{}_front'.format(self.project.name)
  953. networks = [
  954. n for n in self.client.networks()
  955. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  956. ]
  957. # Two networks were created: back and front
  958. assert sorted(n['Name'].split('/')[-1] for n in networks) == [back_name, front_name]
  959. # lookup by ID instead of name in case of duplicates
  960. back_network = self.client.inspect_network(
  961. [n for n in networks if n['Name'] == back_name][0]['Id']
  962. )
  963. front_network = self.client.inspect_network(
  964. [n for n in networks if n['Name'] == front_name][0]['Id']
  965. )
  966. web_container = self.project.get_service('web').containers()[0]
  967. app_container = self.project.get_service('app').containers()[0]
  968. db_container = self.project.get_service('db').containers()[0]
  969. for net_name in [front_name, back_name]:
  970. links = app_container.get('NetworkSettings.Networks.{}.Links'.format(net_name))
  971. assert '{}:database'.format(db_container.name) in links
  972. # db and app joined the back network
  973. assert sorted(back_network['Containers']) == sorted([db_container.id, app_container.id])
  974. # web and app joined the front network
  975. assert sorted(front_network['Containers']) == sorted([web_container.id, app_container.id])
  976. # web can see app but not db
  977. assert self.lookup(web_container, "app")
  978. assert not self.lookup(web_container, "db")
  979. # app can see db
  980. assert self.lookup(app_container, "db")
  981. # app has aliased db to "database"
  982. assert self.lookup(app_container, "database")
  983. @v2_only()
  984. def test_up_missing_network(self):
  985. self.base_dir = 'tests/fixtures/networks'
  986. result = self.dispatch(
  987. ['-f', 'missing-network.yml', 'up', '-d'],
  988. returncode=1)
  989. assert 'Service "web" uses an undefined network "foo"' in result.stderr
  990. @v2_only()
  991. @no_cluster('container networks not supported in Swarm')
  992. def test_up_with_network_mode(self):
  993. c = self.client.create_container(
  994. 'busybox', 'top', name='composetest_network_mode_container',
  995. host_config={}
  996. )
  997. self.addCleanup(self.client.remove_container, c, force=True)
  998. self.client.start(c)
  999. container_mode_source = 'container:{}'.format(c['Id'])
  1000. filename = 'network-mode.yml'
  1001. self.base_dir = 'tests/fixtures/networks'
  1002. self._project = get_project(self.base_dir, [filename])
  1003. self.dispatch(['-f', filename, 'up', '-d'], None)
  1004. networks = [
  1005. n for n in self.client.networks()
  1006. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1007. ]
  1008. assert not networks
  1009. for name in ['bridge', 'host', 'none']:
  1010. container = self.project.get_service(name).containers()[0]
  1011. assert list(container.get('NetworkSettings.Networks')) == [name]
  1012. assert container.get('HostConfig.NetworkMode') == name
  1013. service_mode_source = 'container:{}'.format(
  1014. self.project.get_service('bridge').containers()[0].id)
  1015. service_mode_container = self.project.get_service('service').containers()[0]
  1016. assert not service_mode_container.get('NetworkSettings.Networks')
  1017. assert service_mode_container.get('HostConfig.NetworkMode') == service_mode_source
  1018. container_mode_container = self.project.get_service('container').containers()[0]
  1019. assert not container_mode_container.get('NetworkSettings.Networks')
  1020. assert container_mode_container.get('HostConfig.NetworkMode') == container_mode_source
  1021. @v2_only()
  1022. def test_up_external_networks(self):
  1023. filename = 'external-networks.yml'
  1024. self.base_dir = 'tests/fixtures/networks'
  1025. self._project = get_project(self.base_dir, [filename])
  1026. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  1027. assert 'declared as external, but could not be found' in result.stderr
  1028. networks = [
  1029. n['Name'] for n in self.client.networks()
  1030. if n['Name'].startswith('{}_'.format(self.project.name))
  1031. ]
  1032. assert not networks
  1033. network_names = ['{}_{}'.format(self.project.name, n) for n in ['foo', 'bar']]
  1034. for name in network_names:
  1035. self.client.create_network(name, attachable=True)
  1036. self.dispatch(['-f', filename, 'up', '-d'])
  1037. container = self.project.containers()[0]
  1038. assert sorted(list(container.get('NetworkSettings.Networks'))) == sorted(network_names)
  1039. @v2_only()
  1040. def test_up_with_external_default_network(self):
  1041. filename = 'external-default.yml'
  1042. self.base_dir = 'tests/fixtures/networks'
  1043. self._project = get_project(self.base_dir, [filename])
  1044. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  1045. assert 'declared as external, but could not be found' in result.stderr
  1046. networks = [
  1047. n['Name'] for n in self.client.networks()
  1048. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1049. ]
  1050. assert not networks
  1051. network_name = 'composetest_external_network'
  1052. self.client.create_network(network_name, attachable=True)
  1053. self.dispatch(['-f', filename, 'up', '-d'])
  1054. container = self.project.containers()[0]
  1055. assert list(container.get('NetworkSettings.Networks')) == [network_name]
  1056. @v2_1_only()
  1057. def test_up_with_network_labels(self):
  1058. filename = 'network-label.yml'
  1059. self.base_dir = 'tests/fixtures/networks'
  1060. self._project = get_project(self.base_dir, [filename])
  1061. self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
  1062. network_with_label = '{}_network_with_label'.format(self.project.name)
  1063. networks = [
  1064. n for n in self.client.networks()
  1065. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1066. ]
  1067. assert [n['Name'].split('/')[-1] for n in networks] == [network_with_label]
  1068. assert 'label_key' in networks[0]['Labels']
  1069. assert networks[0]['Labels']['label_key'] == 'label_val'
  1070. @v2_1_only()
  1071. def test_up_with_volume_labels(self):
  1072. filename = 'volume-label.yml'
  1073. self.base_dir = 'tests/fixtures/volumes'
  1074. self._project = get_project(self.base_dir, [filename])
  1075. self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
  1076. volume_with_label = '{}_volume_with_label'.format(self.project.name)
  1077. volumes = [
  1078. v for v in self.client.volumes().get('Volumes', [])
  1079. if v['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1080. ]
  1081. assert set([v['Name'].split('/')[-1] for v in volumes]) == set([volume_with_label])
  1082. assert 'label_key' in volumes[0]['Labels']
  1083. assert volumes[0]['Labels']['label_key'] == 'label_val'
  1084. @v2_only()
  1085. def test_up_no_services(self):
  1086. self.base_dir = 'tests/fixtures/no-services'
  1087. self.dispatch(['up', '-d'], None)
  1088. network_names = [
  1089. n['Name'] for n in self.client.networks()
  1090. if n['Name'].split('/')[-1].startswith('{}_'.format(self.project.name))
  1091. ]
  1092. assert network_names == []
  1093. def test_up_with_links_v1(self):
  1094. self.base_dir = 'tests/fixtures/links-composefile'
  1095. self.dispatch(['up', '-d', 'web'], None)
  1096. # No network was created
  1097. network_name = self.project.networks.networks['default'].full_name
  1098. networks = self.client.networks(names=[network_name])
  1099. assert networks == []
  1100. web = self.project.get_service('web')
  1101. db = self.project.get_service('db')
  1102. console = self.project.get_service('console')
  1103. # console was not started
  1104. assert len(web.containers()) == 1
  1105. assert len(db.containers()) == 1
  1106. assert len(console.containers()) == 0
  1107. # web has links
  1108. web_container = web.containers()[0]
  1109. assert web_container.get('HostConfig.Links')
  1110. def test_up_with_net_is_invalid(self):
  1111. self.base_dir = 'tests/fixtures/net-container'
  1112. result = self.dispatch(
  1113. ['-f', 'v2-invalid.yml', 'up', '-d'],
  1114. returncode=1)
  1115. assert "Unsupported config option for services.bar: 'net'" in result.stderr
  1116. @no_cluster("Legacy networking not supported on Swarm")
  1117. def test_up_with_net_v1(self):
  1118. self.base_dir = 'tests/fixtures/net-container'
  1119. self.dispatch(['up', '-d'], None)
  1120. bar = self.project.get_service('bar')
  1121. bar_container = bar.containers()[0]
  1122. foo = self.project.get_service('foo')
  1123. foo_container = foo.containers()[0]
  1124. assert foo_container.get('HostConfig.NetworkMode') == 'container:{}'.format(
  1125. bar_container.id
  1126. )
  1127. @v3_only()
  1128. def test_up_with_healthcheck(self):
  1129. def wait_on_health_status(container, status):
  1130. def condition():
  1131. container.inspect()
  1132. return container.get('State.Health.Status') == status
  1133. return wait_on_condition(condition, delay=0.5)
  1134. self.base_dir = 'tests/fixtures/healthcheck'
  1135. self.dispatch(['up', '-d'], None)
  1136. passes = self.project.get_service('passes')
  1137. passes_container = passes.containers()[0]
  1138. assert passes_container.get('Config.Healthcheck') == {
  1139. "Test": ["CMD-SHELL", "/bin/true"],
  1140. "Interval": nanoseconds_from_time_seconds(1),
  1141. "Timeout": nanoseconds_from_time_seconds(30 * 60),
  1142. "Retries": 1,
  1143. }
  1144. wait_on_health_status(passes_container, 'healthy')
  1145. fails = self.project.get_service('fails')
  1146. fails_container = fails.containers()[0]
  1147. assert fails_container.get('Config.Healthcheck') == {
  1148. "Test": ["CMD", "/bin/false"],
  1149. "Interval": nanoseconds_from_time_seconds(2.5),
  1150. "Retries": 2,
  1151. }
  1152. wait_on_health_status(fails_container, 'unhealthy')
  1153. disabled = self.project.get_service('disabled')
  1154. disabled_container = disabled.containers()[0]
  1155. assert disabled_container.get('Config.Healthcheck') == {
  1156. "Test": ["NONE"],
  1157. }
  1158. assert 'Health' not in disabled_container.get('State')
  1159. def test_up_with_no_deps(self):
  1160. self.base_dir = 'tests/fixtures/links-composefile'
  1161. self.dispatch(['up', '-d', '--no-deps', 'web'], None)
  1162. web = self.project.get_service('web')
  1163. db = self.project.get_service('db')
  1164. console = self.project.get_service('console')
  1165. assert len(web.containers()) == 1
  1166. assert len(db.containers()) == 0
  1167. assert len(console.containers()) == 0
  1168. def test_up_with_force_recreate(self):
  1169. self.dispatch(['up', '-d'], None)
  1170. service = self.project.get_service('simple')
  1171. assert len(service.containers()) == 1
  1172. old_ids = [c.id for c in service.containers()]
  1173. self.dispatch(['up', '-d', '--force-recreate'], None)
  1174. assert len(service.containers()) == 1
  1175. new_ids = [c.id for c in service.containers()]
  1176. assert old_ids != new_ids
  1177. def test_up_with_no_recreate(self):
  1178. self.dispatch(['up', '-d'], None)
  1179. service = self.project.get_service('simple')
  1180. assert len(service.containers()) == 1
  1181. old_ids = [c.id for c in service.containers()]
  1182. self.dispatch(['up', '-d', '--no-recreate'], None)
  1183. assert len(service.containers()) == 1
  1184. new_ids = [c.id for c in service.containers()]
  1185. assert old_ids == new_ids
  1186. def test_up_with_force_recreate_and_no_recreate(self):
  1187. self.dispatch(
  1188. ['up', '-d', '--force-recreate', '--no-recreate'],
  1189. returncode=1)
  1190. def test_up_with_timeout(self):
  1191. self.dispatch(['up', '-d', '-t', '1'])
  1192. service = self.project.get_service('simple')
  1193. another = self.project.get_service('another')
  1194. assert len(service.containers()) == 1
  1195. assert len(another.containers()) == 1
  1196. @mock.patch.dict(os.environ)
  1197. def test_up_with_ignore_remove_orphans(self):
  1198. os.environ["COMPOSE_IGNORE_ORPHANS"] = "True"
  1199. result = self.dispatch(['up', '-d', '--remove-orphans'], returncode=1)
  1200. assert "COMPOSE_IGNORE_ORPHANS and --remove-orphans cannot be combined." in result.stderr
  1201. def test_up_handles_sigint(self):
  1202. proc = start_process(self.base_dir, ['up', '-t', '2'])
  1203. wait_on_condition(ContainerCountCondition(self.project, 2))
  1204. os.kill(proc.pid, signal.SIGINT)
  1205. wait_on_condition(ContainerCountCondition(self.project, 0))
  1206. def test_up_handles_sigterm(self):
  1207. proc = start_process(self.base_dir, ['up', '-t', '2'])
  1208. wait_on_condition(ContainerCountCondition(self.project, 2))
  1209. os.kill(proc.pid, signal.SIGTERM)
  1210. wait_on_condition(ContainerCountCondition(self.project, 0))
  1211. @v2_only()
  1212. def test_up_handles_force_shutdown(self):
  1213. self.base_dir = 'tests/fixtures/sleeps-composefile'
  1214. proc = start_process(self.base_dir, ['up', '-t', '200'])
  1215. wait_on_condition(ContainerCountCondition(self.project, 2))
  1216. os.kill(proc.pid, signal.SIGTERM)
  1217. time.sleep(0.1)
  1218. os.kill(proc.pid, signal.SIGTERM)
  1219. wait_on_condition(ContainerCountCondition(self.project, 0))
  1220. def test_up_handles_abort_on_container_exit(self):
  1221. self.base_dir = 'tests/fixtures/abort-on-container-exit-0'
  1222. proc = start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  1223. wait_on_condition(ContainerCountCondition(self.project, 0))
  1224. proc.wait()
  1225. assert proc.returncode == 0
  1226. def test_up_handles_abort_on_container_exit_code(self):
  1227. self.base_dir = 'tests/fixtures/abort-on-container-exit-1'
  1228. proc = start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  1229. wait_on_condition(ContainerCountCondition(self.project, 0))
  1230. proc.wait()
  1231. assert proc.returncode == 1
  1232. @v2_only()
  1233. @no_cluster('Container PID mode does not work across clusters')
  1234. def test_up_with_pid_mode(self):
  1235. c = self.client.create_container(
  1236. 'busybox', 'top', name='composetest_pid_mode_container',
  1237. host_config={}
  1238. )
  1239. self.addCleanup(self.client.remove_container, c, force=True)
  1240. self.client.start(c)
  1241. container_mode_source = 'container:{}'.format(c['Id'])
  1242. self.base_dir = 'tests/fixtures/pid-mode'
  1243. self.dispatch(['up', '-d'], None)
  1244. service_mode_source = 'container:{}'.format(
  1245. self.project.get_service('container').containers()[0].id)
  1246. service_mode_container = self.project.get_service('service').containers()[0]
  1247. assert service_mode_container.get('HostConfig.PidMode') == service_mode_source
  1248. container_mode_container = self.project.get_service('container').containers()[0]
  1249. assert container_mode_container.get('HostConfig.PidMode') == container_mode_source
  1250. host_mode_container = self.project.get_service('host').containers()[0]
  1251. assert host_mode_container.get('HostConfig.PidMode') == 'host'
  1252. def test_exec_without_tty(self):
  1253. self.base_dir = 'tests/fixtures/links-composefile'
  1254. self.dispatch(['up', '-d', 'console'])
  1255. assert len(self.project.containers()) == 1
  1256. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  1257. assert stderr == ""
  1258. assert stdout == "/\n"
  1259. def test_exec_detach_long_form(self):
  1260. self.base_dir = 'tests/fixtures/links-composefile'
  1261. self.dispatch(['up', '--detach', 'console'])
  1262. assert len(self.project.containers()) == 1
  1263. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  1264. assert stderr == ""
  1265. assert stdout == "/\n"
  1266. def test_exec_custom_user(self):
  1267. self.base_dir = 'tests/fixtures/links-composefile'
  1268. self.dispatch(['up', '-d', 'console'])
  1269. assert len(self.project.containers()) == 1
  1270. stdout, stderr = self.dispatch(['exec', '-T', '--user=operator', 'console', 'whoami'])
  1271. assert stdout == "operator\n"
  1272. assert stderr == ""
  1273. @v3_only()
  1274. def test_exec_workdir(self):
  1275. self.base_dir = 'tests/fixtures/links-composefile'
  1276. os.environ['COMPOSE_API_VERSION'] = '1.35'
  1277. self.dispatch(['up', '-d', 'console'])
  1278. assert len(self.project.containers()) == 1
  1279. stdout, stderr = self.dispatch(['exec', '-T', '--workdir', '/etc', 'console', 'ls'])
  1280. assert 'passwd' in stdout
  1281. @v2_2_only()
  1282. def test_exec_service_with_environment_overridden(self):
  1283. name = 'service'
  1284. self.base_dir = 'tests/fixtures/environment-exec'
  1285. self.dispatch(['up', '-d'])
  1286. assert len(self.project.containers()) == 1
  1287. stdout, stderr = self.dispatch([
  1288. 'exec',
  1289. '-T',
  1290. '-e', 'foo=notbar',
  1291. '--env', 'alpha=beta',
  1292. name,
  1293. 'env',
  1294. ])
  1295. # env overridden
  1296. assert 'foo=notbar' in stdout
  1297. # keep environment from yaml
  1298. assert 'hello=world' in stdout
  1299. # added option from command line
  1300. assert 'alpha=beta' in stdout
  1301. assert stderr == ''
  1302. def test_run_service_without_links(self):
  1303. self.base_dir = 'tests/fixtures/links-composefile'
  1304. self.dispatch(['run', 'console', '/bin/true'])
  1305. assert len(self.project.containers()) == 0
  1306. # Ensure stdin/out was open
  1307. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1308. config = container.inspect()['Config']
  1309. assert config['AttachStderr']
  1310. assert config['AttachStdout']
  1311. assert config['AttachStdin']
  1312. def test_run_service_with_links(self):
  1313. self.base_dir = 'tests/fixtures/links-composefile'
  1314. self.dispatch(['run', 'web', '/bin/true'], None)
  1315. db = self.project.get_service('db')
  1316. console = self.project.get_service('console')
  1317. assert len(db.containers()) == 1
  1318. assert len(console.containers()) == 0
  1319. @v2_only()
  1320. def test_run_service_with_dependencies(self):
  1321. self.base_dir = 'tests/fixtures/v2-dependencies'
  1322. self.dispatch(['run', 'web', '/bin/true'], None)
  1323. db = self.project.get_service('db')
  1324. console = self.project.get_service('console')
  1325. assert len(db.containers()) == 1
  1326. assert len(console.containers()) == 0
  1327. def test_run_service_with_scaled_dependencies(self):
  1328. self.base_dir = 'tests/fixtures/v2-dependencies'
  1329. self.dispatch(['up', '-d', '--scale', 'db=2', '--scale', 'console=0'])
  1330. db = self.project.get_service('db')
  1331. console = self.project.get_service('console')
  1332. assert len(db.containers()) == 2
  1333. assert len(console.containers()) == 0
  1334. self.dispatch(['run', 'web', '/bin/true'], None)
  1335. assert len(db.containers()) == 2
  1336. assert len(console.containers()) == 0
  1337. def test_run_with_no_deps(self):
  1338. self.base_dir = 'tests/fixtures/links-composefile'
  1339. self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
  1340. db = self.project.get_service('db')
  1341. assert len(db.containers()) == 0
  1342. def test_run_does_not_recreate_linked_containers(self):
  1343. self.base_dir = 'tests/fixtures/links-composefile'
  1344. self.dispatch(['up', '-d', 'db'])
  1345. db = self.project.get_service('db')
  1346. assert len(db.containers()) == 1
  1347. old_ids = [c.id for c in db.containers()]
  1348. self.dispatch(['run', 'web', '/bin/true'], None)
  1349. assert len(db.containers()) == 1
  1350. new_ids = [c.id for c in db.containers()]
  1351. assert old_ids == new_ids
  1352. def test_run_without_command(self):
  1353. self.base_dir = 'tests/fixtures/commands-composefile'
  1354. self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  1355. self.dispatch(['run', 'implicit'])
  1356. service = self.project.get_service('implicit')
  1357. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  1358. assert [c.human_readable_command for c in containers] == [u'/bin/sh -c echo "success"']
  1359. self.dispatch(['run', 'explicit'])
  1360. service = self.project.get_service('explicit')
  1361. containers = service.containers(stopped=True, one_off=OneOffFilter.only)
  1362. assert [c.human_readable_command for c in containers] == [u'/bin/true']
  1363. @pytest.mark.skipif(SWARM_SKIP_RM_VOLUMES, reason='Swarm DELETE /containers/<id> bug')
  1364. def test_run_rm(self):
  1365. self.base_dir = 'tests/fixtures/volume'
  1366. proc = start_process(self.base_dir, ['run', '--rm', 'test'])
  1367. wait_on_condition(ContainerStateCondition(
  1368. self.project.client,
  1369. 'volume_test_run_1',
  1370. 'running'))
  1371. service = self.project.get_service('test')
  1372. containers = service.containers(one_off=OneOffFilter.only)
  1373. assert len(containers) == 1
  1374. mounts = containers[0].get('Mounts')
  1375. for mount in mounts:
  1376. if mount['Destination'] == '/container-path':
  1377. anonymous_name = mount['Name']
  1378. break
  1379. os.kill(proc.pid, signal.SIGINT)
  1380. wait_on_process(proc, 1)
  1381. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1382. volumes = self.client.volumes()['Volumes']
  1383. assert volumes is not None
  1384. for volume in service.options.get('volumes'):
  1385. if volume.internal == '/container-named-path':
  1386. name = volume.external
  1387. break
  1388. volume_names = [v['Name'].split('/')[-1] for v in volumes]
  1389. assert name in volume_names
  1390. assert anonymous_name not in volume_names
  1391. def test_run_service_with_dockerfile_entrypoint(self):
  1392. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1393. self.dispatch(['run', 'test'])
  1394. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1395. assert container.get('Config.Entrypoint') == ['printf']
  1396. assert container.get('Config.Cmd') == ['default', 'args']
  1397. def test_run_service_with_unset_entrypoint(self):
  1398. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1399. self.dispatch(['run', '--entrypoint=""', 'test', 'true'])
  1400. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1401. assert container.get('Config.Entrypoint') is None
  1402. assert container.get('Config.Cmd') == ['true']
  1403. self.dispatch(['run', '--entrypoint', '""', 'test', 'true'])
  1404. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1405. assert container.get('Config.Entrypoint') is None
  1406. assert container.get('Config.Cmd') == ['true']
  1407. def test_run_service_with_dockerfile_entrypoint_overridden(self):
  1408. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1409. self.dispatch(['run', '--entrypoint', 'echo', 'test'])
  1410. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1411. assert container.get('Config.Entrypoint') == ['echo']
  1412. assert not container.get('Config.Cmd')
  1413. def test_run_service_with_dockerfile_entrypoint_and_command_overridden(self):
  1414. self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
  1415. self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
  1416. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1417. assert container.get('Config.Entrypoint') == ['echo']
  1418. assert container.get('Config.Cmd') == ['foo']
  1419. def test_run_service_with_compose_file_entrypoint(self):
  1420. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1421. self.dispatch(['run', 'test'])
  1422. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1423. assert container.get('Config.Entrypoint') == ['printf']
  1424. assert container.get('Config.Cmd') == ['default', 'args']
  1425. def test_run_service_with_compose_file_entrypoint_overridden(self):
  1426. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1427. self.dispatch(['run', '--entrypoint', 'echo', 'test'])
  1428. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1429. assert container.get('Config.Entrypoint') == ['echo']
  1430. assert not container.get('Config.Cmd')
  1431. def test_run_service_with_compose_file_entrypoint_and_command_overridden(self):
  1432. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1433. self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
  1434. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1435. assert container.get('Config.Entrypoint') == ['echo']
  1436. assert container.get('Config.Cmd') == ['foo']
  1437. def test_run_service_with_compose_file_entrypoint_and_empty_string_command(self):
  1438. self.base_dir = 'tests/fixtures/entrypoint-composefile'
  1439. self.dispatch(['run', '--entrypoint', 'echo', 'test', ''])
  1440. container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1441. assert container.get('Config.Entrypoint') == ['echo']
  1442. assert container.get('Config.Cmd') == ['']
  1443. def test_run_service_with_user_overridden(self):
  1444. self.base_dir = 'tests/fixtures/user-composefile'
  1445. name = 'service'
  1446. user = 'sshd'
  1447. self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
  1448. service = self.project.get_service(name)
  1449. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1450. assert user == container.get('Config.User')
  1451. def test_run_service_with_user_overridden_short_form(self):
  1452. self.base_dir = 'tests/fixtures/user-composefile'
  1453. name = 'service'
  1454. user = 'sshd'
  1455. self.dispatch(['run', '-u', user, name], returncode=1)
  1456. service = self.project.get_service(name)
  1457. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1458. assert user == container.get('Config.User')
  1459. def test_run_service_with_environment_overridden(self):
  1460. name = 'service'
  1461. self.base_dir = 'tests/fixtures/environment-composefile'
  1462. self.dispatch([
  1463. 'run', '-e', 'foo=notbar',
  1464. '-e', 'allo=moto=bobo',
  1465. '-e', 'alpha=beta',
  1466. name,
  1467. '/bin/true',
  1468. ])
  1469. service = self.project.get_service(name)
  1470. container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
  1471. # env overridden
  1472. assert 'notbar' == container.environment['foo']
  1473. # keep environment from yaml
  1474. assert 'world' == container.environment['hello']
  1475. # added option from command line
  1476. assert 'beta' == container.environment['alpha']
  1477. # make sure a value with a = don't crash out
  1478. assert 'moto=bobo' == container.environment['allo']
  1479. def test_run_service_without_map_ports(self):
  1480. # create one off container
  1481. self.base_dir = 'tests/fixtures/ports-composefile'
  1482. self.dispatch(['run', '-d', 'simple'])
  1483. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1484. # get port information
  1485. port_random = container.get_local_port(3000)
  1486. port_assigned = container.get_local_port(3001)
  1487. # close all one off containers we just created
  1488. container.stop()
  1489. # check the ports
  1490. assert port_random is None
  1491. assert port_assigned is None
  1492. def test_run_service_with_map_ports(self):
  1493. # create one off container
  1494. self.base_dir = 'tests/fixtures/ports-composefile'
  1495. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  1496. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1497. # get port information
  1498. port_random = container.get_local_port(3000)
  1499. port_assigned = container.get_local_port(3001)
  1500. port_range = container.get_local_port(3002), container.get_local_port(3003)
  1501. # close all one off containers we just created
  1502. container.stop()
  1503. # check the ports
  1504. assert port_random is not None
  1505. assert port_assigned.endswith(':49152')
  1506. assert port_range[0].endswith(':49153')
  1507. assert port_range[1].endswith(':49154')
  1508. def test_run_service_with_explicitly_mapped_ports(self):
  1509. # create one off container
  1510. self.base_dir = 'tests/fixtures/ports-composefile'
  1511. self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
  1512. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1513. # get port information
  1514. port_short = container.get_local_port(3000)
  1515. port_full = container.get_local_port(3001)
  1516. # close all one off containers we just created
  1517. container.stop()
  1518. # check the ports
  1519. assert port_short.endswith(':30000')
  1520. assert port_full.endswith(':30001')
  1521. def test_run_service_with_explicitly_mapped_ip_ports(self):
  1522. # create one off container
  1523. self.base_dir = 'tests/fixtures/ports-composefile'
  1524. self.dispatch([
  1525. 'run', '-d',
  1526. '-p', '127.0.0.1:30000:3000',
  1527. '--publish', '127.0.0.1:30001:3001',
  1528. 'simple'
  1529. ])
  1530. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1531. # get port information
  1532. port_short = container.get_local_port(3000)
  1533. port_full = container.get_local_port(3001)
  1534. # close all one off containers we just created
  1535. container.stop()
  1536. # check the ports
  1537. assert port_short == "127.0.0.1:30000"
  1538. assert port_full == "127.0.0.1:30001"
  1539. def test_run_with_expose_ports(self):
  1540. # create one off container
  1541. self.base_dir = 'tests/fixtures/expose-composefile'
  1542. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  1543. container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
  1544. ports = container.ports
  1545. assert len(ports) == 9
  1546. # exposed ports are not mapped to host ports
  1547. assert ports['3000/tcp'] is None
  1548. assert ports['3001/tcp'] is None
  1549. assert ports['3001/udp'] is None
  1550. assert ports['3002/tcp'] is None
  1551. assert ports['3003/tcp'] is None
  1552. assert ports['3004/tcp'] is None
  1553. assert ports['3005/tcp'] is None
  1554. assert ports['3006/udp'] is None
  1555. assert ports['3007/udp'] is None
  1556. # close all one off containers we just created
  1557. container.stop()
  1558. def test_run_with_custom_name(self):
  1559. self.base_dir = 'tests/fixtures/environment-composefile'
  1560. name = 'the-container-name'
  1561. self.dispatch(['run', '--name', name, 'service', '/bin/true'])
  1562. service = self.project.get_service('service')
  1563. container, = service.containers(stopped=True, one_off=OneOffFilter.only)
  1564. assert container.name == name
  1565. def test_run_service_with_workdir_overridden(self):
  1566. self.base_dir = 'tests/fixtures/run-workdir'
  1567. name = 'service'
  1568. workdir = '/var'
  1569. self.dispatch(['run', '--workdir={workdir}'.format(workdir=workdir), name])
  1570. service = self.project.get_service(name)
  1571. container = service.containers(stopped=True, one_off=True)[0]
  1572. assert workdir == container.get('Config.WorkingDir')
  1573. def test_run_service_with_workdir_overridden_short_form(self):
  1574. self.base_dir = 'tests/fixtures/run-workdir'
  1575. name = 'service'
  1576. workdir = '/var'
  1577. self.dispatch(['run', '-w', workdir, name])
  1578. service = self.project.get_service(name)
  1579. container = service.containers(stopped=True, one_off=True)[0]
  1580. assert workdir == container.get('Config.WorkingDir')
  1581. @v2_only()
  1582. def test_run_service_with_use_aliases(self):
  1583. filename = 'network-aliases.yml'
  1584. self.base_dir = 'tests/fixtures/networks'
  1585. self.dispatch(['-f', filename, 'run', '-d', '--use-aliases', 'web', 'top'])
  1586. back_name = '{}_back'.format(self.project.name)
  1587. front_name = '{}_front'.format(self.project.name)
  1588. web_container = self.project.get_service('web').containers(one_off=OneOffFilter.only)[0]
  1589. back_aliases = web_container.get(
  1590. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  1591. )
  1592. assert 'web' in back_aliases
  1593. front_aliases = web_container.get(
  1594. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  1595. )
  1596. assert 'web' in front_aliases
  1597. assert 'forward_facing' in front_aliases
  1598. assert 'ahead' in front_aliases
  1599. @v2_only()
  1600. def test_run_interactive_connects_to_network(self):
  1601. self.base_dir = 'tests/fixtures/networks'
  1602. self.dispatch(['up', '-d'])
  1603. self.dispatch(['run', 'app', 'nslookup', 'app'])
  1604. self.dispatch(['run', 'app', 'nslookup', 'db'])
  1605. containers = self.project.get_service('app').containers(
  1606. stopped=True, one_off=OneOffFilter.only)
  1607. assert len(containers) == 2
  1608. for container in containers:
  1609. networks = container.get('NetworkSettings.Networks')
  1610. assert sorted(list(networks)) == [
  1611. '{}_{}'.format(self.project.name, name)
  1612. for name in ['back', 'front']
  1613. ]
  1614. for _, config in networks.items():
  1615. # TODO: once we drop support for API <1.24, this can be changed to:
  1616. # assert config['Aliases'] == [container.short_id]
  1617. aliases = set(config['Aliases'] or []) - set([container.short_id])
  1618. assert not aliases
  1619. @v2_only()
  1620. def test_run_detached_connects_to_network(self):
  1621. self.base_dir = 'tests/fixtures/networks'
  1622. self.dispatch(['up', '-d'])
  1623. self.dispatch(['run', '-d', 'app', 'top'])
  1624. container = self.project.get_service('app').containers(one_off=OneOffFilter.only)[0]
  1625. networks = container.get('NetworkSettings.Networks')
  1626. assert sorted(list(networks)) == [
  1627. '{}_{}'.format(self.project.name, name)
  1628. for name in ['back', 'front']
  1629. ]
  1630. for _, config in networks.items():
  1631. # TODO: once we drop support for API <1.24, this can be changed to:
  1632. # assert config['Aliases'] == [container.short_id]
  1633. aliases = set(config['Aliases'] or []) - set([container.short_id])
  1634. assert not aliases
  1635. assert self.lookup(container, 'app')
  1636. assert self.lookup(container, 'db')
  1637. def test_run_handles_sigint(self):
  1638. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1639. wait_on_condition(ContainerStateCondition(
  1640. self.project.client,
  1641. 'simple-composefile_simple_run_1',
  1642. 'running'))
  1643. os.kill(proc.pid, signal.SIGINT)
  1644. wait_on_condition(ContainerStateCondition(
  1645. self.project.client,
  1646. 'simple-composefile_simple_run_1',
  1647. 'exited'))
  1648. def test_run_handles_sigterm(self):
  1649. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1650. wait_on_condition(ContainerStateCondition(
  1651. self.project.client,
  1652. 'simple-composefile_simple_run_1',
  1653. 'running'))
  1654. os.kill(proc.pid, signal.SIGTERM)
  1655. wait_on_condition(ContainerStateCondition(
  1656. self.project.client,
  1657. 'simple-composefile_simple_run_1',
  1658. 'exited'))
  1659. def test_run_handles_sighup(self):
  1660. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  1661. wait_on_condition(ContainerStateCondition(
  1662. self.project.client,
  1663. 'simple-composefile_simple_run_1',
  1664. 'running'))
  1665. os.kill(proc.pid, signal.SIGHUP)
  1666. wait_on_condition(ContainerStateCondition(
  1667. self.project.client,
  1668. 'simple-composefile_simple_run_1',
  1669. 'exited'))
  1670. @mock.patch.dict(os.environ)
  1671. def test_run_unicode_env_values_from_system(self):
  1672. value = 'ą, ć, ę, ł, ń, ó, ś, ź, ż'
  1673. if six.PY2: # os.environ doesn't support unicode values in Py2
  1674. os.environ['BAR'] = value.encode('utf-8')
  1675. else: # ... and doesn't support byte values in Py3
  1676. os.environ['BAR'] = value
  1677. self.base_dir = 'tests/fixtures/unicode-environment'
  1678. result = self.dispatch(['run', 'simple'])
  1679. if six.PY2: # Can't retrieve output on Py3. See issue #3670
  1680. assert value in result.stdout.strip()
  1681. container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
  1682. environment = container.get('Config.Env')
  1683. assert 'FOO={}'.format(value) in environment
  1684. @mock.patch.dict(os.environ)
  1685. def test_run_env_values_from_system(self):
  1686. os.environ['FOO'] = 'bar'
  1687. os.environ['BAR'] = 'baz'
  1688. self.dispatch(['run', '-e', 'FOO', 'simple', 'true'], None)
  1689. container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
  1690. environment = container.get('Config.Env')
  1691. assert 'FOO=bar' in environment
  1692. assert 'BAR=baz' not in environment
  1693. def test_run_label_flag(self):
  1694. self.base_dir = 'tests/fixtures/run-labels'
  1695. name = 'service'
  1696. self.dispatch(['run', '-l', 'default', '--label', 'foo=baz', name, '/bin/true'])
  1697. service = self.project.get_service(name)
  1698. container, = service.containers(stopped=True, one_off=OneOffFilter.only)
  1699. labels = container.labels
  1700. assert labels['default'] == ''
  1701. assert labels['foo'] == 'baz'
  1702. assert labels['hello'] == 'world'
  1703. def test_rm(self):
  1704. service = self.project.get_service('simple')
  1705. service.create_container()
  1706. kill_service(service)
  1707. assert len(service.containers(stopped=True)) == 1
  1708. self.dispatch(['rm', '--force'], None)
  1709. assert len(service.containers(stopped=True)) == 0
  1710. service = self.project.get_service('simple')
  1711. service.create_container()
  1712. kill_service(service)
  1713. assert len(service.containers(stopped=True)) == 1
  1714. self.dispatch(['rm', '-f'], None)
  1715. assert len(service.containers(stopped=True)) == 0
  1716. service = self.project.get_service('simple')
  1717. service.create_container()
  1718. self.dispatch(['rm', '-fs'], None)
  1719. assert len(service.containers(stopped=True)) == 0
  1720. def test_rm_stop(self):
  1721. self.dispatch(['up', '-d'], None)
  1722. simple = self.project.get_service('simple')
  1723. another = self.project.get_service('another')
  1724. assert len(simple.containers()) == 1
  1725. assert len(another.containers()) == 1
  1726. self.dispatch(['rm', '-fs'], None)
  1727. assert len(simple.containers(stopped=True)) == 0
  1728. assert len(another.containers(stopped=True)) == 0
  1729. self.dispatch(['up', '-d'], None)
  1730. assert len(simple.containers()) == 1
  1731. assert len(another.containers()) == 1
  1732. self.dispatch(['rm', '-fs', 'another'], None)
  1733. assert len(simple.containers()) == 1
  1734. assert len(another.containers(stopped=True)) == 0
  1735. def test_rm_all(self):
  1736. service = self.project.get_service('simple')
  1737. service.create_container(one_off=False)
  1738. service.create_container(one_off=True)
  1739. kill_service(service)
  1740. assert len(service.containers(stopped=True)) == 1
  1741. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 1
  1742. self.dispatch(['rm', '-f'], None)
  1743. assert len(service.containers(stopped=True)) == 0
  1744. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1745. service.create_container(one_off=False)
  1746. service.create_container(one_off=True)
  1747. kill_service(service)
  1748. assert len(service.containers(stopped=True)) == 1
  1749. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 1
  1750. self.dispatch(['rm', '-f', '--all'], None)
  1751. assert len(service.containers(stopped=True)) == 0
  1752. assert len(service.containers(stopped=True, one_off=OneOffFilter.only)) == 0
  1753. def test_stop(self):
  1754. self.dispatch(['up', '-d'], None)
  1755. service = self.project.get_service('simple')
  1756. assert len(service.containers()) == 1
  1757. assert service.containers()[0].is_running
  1758. self.dispatch(['stop', '-t', '1'], None)
  1759. assert len(service.containers(stopped=True)) == 1
  1760. assert not service.containers(stopped=True)[0].is_running
  1761. def test_stop_signal(self):
  1762. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  1763. self.dispatch(['up', '-d'], None)
  1764. service = self.project.get_service('simple')
  1765. assert len(service.containers()) == 1
  1766. assert service.containers()[0].is_running
  1767. self.dispatch(['stop', '-t', '1'], None)
  1768. assert len(service.containers(stopped=True)) == 1
  1769. assert not service.containers(stopped=True)[0].is_running
  1770. assert service.containers(stopped=True)[0].exit_code == 0
  1771. def test_start_no_containers(self):
  1772. result = self.dispatch(['start'], returncode=1)
  1773. assert 'No containers to start' in result.stderr
  1774. @v2_only()
  1775. def test_up_logging(self):
  1776. self.base_dir = 'tests/fixtures/logging-composefile'
  1777. self.dispatch(['up', '-d'])
  1778. simple = self.project.get_service('simple').containers()[0]
  1779. log_config = simple.get('HostConfig.LogConfig')
  1780. assert log_config
  1781. assert log_config.get('Type') == 'none'
  1782. another = self.project.get_service('another').containers()[0]
  1783. log_config = another.get('HostConfig.LogConfig')
  1784. assert log_config
  1785. assert log_config.get('Type') == 'json-file'
  1786. assert log_config.get('Config')['max-size'] == '10m'
  1787. def test_up_logging_legacy(self):
  1788. self.base_dir = 'tests/fixtures/logging-composefile-legacy'
  1789. self.dispatch(['up', '-d'])
  1790. simple = self.project.get_service('simple').containers()[0]
  1791. log_config = simple.get('HostConfig.LogConfig')
  1792. assert log_config
  1793. assert log_config.get('Type') == 'none'
  1794. another = self.project.get_service('another').containers()[0]
  1795. log_config = another.get('HostConfig.LogConfig')
  1796. assert log_config
  1797. assert log_config.get('Type') == 'json-file'
  1798. assert log_config.get('Config')['max-size'] == '10m'
  1799. def test_pause_unpause(self):
  1800. self.dispatch(['up', '-d'], None)
  1801. service = self.project.get_service('simple')
  1802. assert not service.containers()[0].is_paused
  1803. self.dispatch(['pause'], None)
  1804. assert service.containers()[0].is_paused
  1805. self.dispatch(['unpause'], None)
  1806. assert not service.containers()[0].is_paused
  1807. def test_pause_no_containers(self):
  1808. result = self.dispatch(['pause'], returncode=1)
  1809. assert 'No containers to pause' in result.stderr
  1810. def test_unpause_no_containers(self):
  1811. result = self.dispatch(['unpause'], returncode=1)
  1812. assert 'No containers to unpause' in result.stderr
  1813. def test_logs_invalid_service_name(self):
  1814. self.dispatch(['logs', 'madeupname'], returncode=1)
  1815. def test_logs_follow(self):
  1816. self.base_dir = 'tests/fixtures/echo-services'
  1817. self.dispatch(['up', '-d'])
  1818. result = self.dispatch(['logs', '-f'])
  1819. if not is_cluster(self.client):
  1820. assert result.stdout.count('\n') == 5
  1821. else:
  1822. # Sometimes logs are picked up from old containers that haven't yet
  1823. # been removed (removal in Swarm is async)
  1824. assert result.stdout.count('\n') >= 5
  1825. assert 'simple' in result.stdout
  1826. assert 'another' in result.stdout
  1827. assert 'exited with code 0' in result.stdout
  1828. def test_logs_follow_logs_from_new_containers(self):
  1829. self.base_dir = 'tests/fixtures/logs-composefile'
  1830. self.dispatch(['up', '-d', 'simple'])
  1831. proc = start_process(self.base_dir, ['logs', '-f'])
  1832. self.dispatch(['up', '-d', 'another'])
  1833. wait_on_condition(ContainerStateCondition(
  1834. self.project.client,
  1835. 'logs-composefile_another_1',
  1836. 'exited'))
  1837. self.dispatch(['kill', 'simple'])
  1838. result = wait_on_process(proc)
  1839. assert 'hello' in result.stdout
  1840. assert 'test' in result.stdout
  1841. assert 'logs-composefile_another_1 exited with code 0' in result.stdout
  1842. assert 'logs-composefile_simple_1 exited with code 137' in result.stdout
  1843. def test_logs_default(self):
  1844. self.base_dir = 'tests/fixtures/logs-composefile'
  1845. self.dispatch(['up', '-d'])
  1846. result = self.dispatch(['logs'])
  1847. assert 'hello' in result.stdout
  1848. assert 'test' in result.stdout
  1849. assert 'exited with' not in result.stdout
  1850. def test_logs_on_stopped_containers_exits(self):
  1851. self.base_dir = 'tests/fixtures/echo-services'
  1852. self.dispatch(['up'])
  1853. result = self.dispatch(['logs'])
  1854. assert 'simple' in result.stdout
  1855. assert 'another' in result.stdout
  1856. assert 'exited with' not in result.stdout
  1857. def test_logs_timestamps(self):
  1858. self.base_dir = 'tests/fixtures/echo-services'
  1859. self.dispatch(['up', '-d'])
  1860. result = self.dispatch(['logs', '-f', '-t'])
  1861. assert re.search('(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})', result.stdout)
  1862. def test_logs_tail(self):
  1863. self.base_dir = 'tests/fixtures/logs-tail-composefile'
  1864. self.dispatch(['up'])
  1865. result = self.dispatch(['logs', '--tail', '2'])
  1866. assert 'c\n' in result.stdout
  1867. assert 'd\n' in result.stdout
  1868. assert 'a\n' not in result.stdout
  1869. assert 'b\n' not in result.stdout
  1870. def test_kill(self):
  1871. self.dispatch(['up', '-d'], None)
  1872. service = self.project.get_service('simple')
  1873. assert len(service.containers()) == 1
  1874. assert service.containers()[0].is_running
  1875. self.dispatch(['kill'], None)
  1876. assert len(service.containers(stopped=True)) == 1
  1877. assert not service.containers(stopped=True)[0].is_running
  1878. def test_kill_signal_sigstop(self):
  1879. self.dispatch(['up', '-d'], None)
  1880. service = self.project.get_service('simple')
  1881. assert len(service.containers()) == 1
  1882. assert service.containers()[0].is_running
  1883. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1884. assert len(service.containers()) == 1
  1885. # The container is still running. It has only been paused
  1886. assert service.containers()[0].is_running
  1887. def test_kill_stopped_service(self):
  1888. self.dispatch(['up', '-d'], None)
  1889. service = self.project.get_service('simple')
  1890. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1891. assert service.containers()[0].is_running
  1892. self.dispatch(['kill', '-s', 'SIGKILL'], None)
  1893. assert len(service.containers(stopped=True)) == 1
  1894. assert not service.containers(stopped=True)[0].is_running
  1895. def test_restart(self):
  1896. service = self.project.get_service('simple')
  1897. container = service.create_container()
  1898. service.start_container(container)
  1899. started_at = container.dictionary['State']['StartedAt']
  1900. self.dispatch(['restart', '-t', '1'], None)
  1901. container.inspect()
  1902. assert container.dictionary['State']['FinishedAt'] != '0001-01-01T00:00:00Z'
  1903. assert container.dictionary['State']['StartedAt'] != started_at
  1904. def test_restart_stopped_container(self):
  1905. service = self.project.get_service('simple')
  1906. container = service.create_container()
  1907. container.start()
  1908. container.kill()
  1909. assert len(service.containers(stopped=True)) == 1
  1910. self.dispatch(['restart', '-t', '1'], None)
  1911. assert len(service.containers(stopped=False)) == 1
  1912. def test_restart_no_containers(self):
  1913. result = self.dispatch(['restart'], returncode=1)
  1914. assert 'No containers to restart' in result.stderr
  1915. def test_scale(self):
  1916. project = self.project
  1917. self.dispatch(['scale', 'simple=1'])
  1918. assert len(project.get_service('simple').containers()) == 1
  1919. self.dispatch(['scale', 'simple=3', 'another=2'])
  1920. assert len(project.get_service('simple').containers()) == 3
  1921. assert len(project.get_service('another').containers()) == 2
  1922. self.dispatch(['scale', 'simple=1', 'another=1'])
  1923. assert len(project.get_service('simple').containers()) == 1
  1924. assert len(project.get_service('another').containers()) == 1
  1925. self.dispatch(['scale', 'simple=1', 'another=1'])
  1926. assert len(project.get_service('simple').containers()) == 1
  1927. assert len(project.get_service('another').containers()) == 1
  1928. self.dispatch(['scale', 'simple=0', 'another=0'])
  1929. assert len(project.get_service('simple').containers()) == 0
  1930. assert len(project.get_service('another').containers()) == 0
  1931. def test_scale_v2_2(self):
  1932. self.base_dir = 'tests/fixtures/scale'
  1933. result = self.dispatch(['scale', 'web=1'], returncode=1)
  1934. assert 'incompatible with the v2.2 format' in result.stderr
  1935. def test_up_scale_scale_up(self):
  1936. self.base_dir = 'tests/fixtures/scale'
  1937. project = self.project
  1938. self.dispatch(['up', '-d'])
  1939. assert len(project.get_service('web').containers()) == 2
  1940. assert len(project.get_service('db').containers()) == 1
  1941. self.dispatch(['up', '-d', '--scale', 'web=3'])
  1942. assert len(project.get_service('web').containers()) == 3
  1943. assert len(project.get_service('db').containers()) == 1
  1944. def test_up_scale_scale_down(self):
  1945. self.base_dir = 'tests/fixtures/scale'
  1946. project = self.project
  1947. self.dispatch(['up', '-d'])
  1948. assert len(project.get_service('web').containers()) == 2
  1949. assert len(project.get_service('db').containers()) == 1
  1950. self.dispatch(['up', '-d', '--scale', 'web=1'])
  1951. assert len(project.get_service('web').containers()) == 1
  1952. assert len(project.get_service('db').containers()) == 1
  1953. def test_up_scale_reset(self):
  1954. self.base_dir = 'tests/fixtures/scale'
  1955. project = self.project
  1956. self.dispatch(['up', '-d', '--scale', 'web=3', '--scale', 'db=3'])
  1957. assert len(project.get_service('web').containers()) == 3
  1958. assert len(project.get_service('db').containers()) == 3
  1959. self.dispatch(['up', '-d'])
  1960. assert len(project.get_service('web').containers()) == 2
  1961. assert len(project.get_service('db').containers()) == 1
  1962. def test_up_scale_to_zero(self):
  1963. self.base_dir = 'tests/fixtures/scale'
  1964. project = self.project
  1965. self.dispatch(['up', '-d'])
  1966. assert len(project.get_service('web').containers()) == 2
  1967. assert len(project.get_service('db').containers()) == 1
  1968. self.dispatch(['up', '-d', '--scale', 'web=0', '--scale', 'db=0'])
  1969. assert len(project.get_service('web').containers()) == 0
  1970. assert len(project.get_service('db').containers()) == 0
  1971. def test_port(self):
  1972. self.base_dir = 'tests/fixtures/ports-composefile'
  1973. self.dispatch(['up', '-d'], None)
  1974. container = self.project.get_service('simple').get_container()
  1975. def get_port(number):
  1976. result = self.dispatch(['port', 'simple', str(number)])
  1977. return result.stdout.rstrip()
  1978. assert get_port(3000) == container.get_local_port(3000)
  1979. assert ':49152' in get_port(3001)
  1980. assert ':49153' in get_port(3002)
  1981. def test_expanded_port(self):
  1982. self.base_dir = 'tests/fixtures/ports-composefile'
  1983. self.dispatch(['-f', 'expanded-notation.yml', 'up', '-d'])
  1984. container = self.project.get_service('simple').get_container()
  1985. def get_port(number):
  1986. result = self.dispatch(['port', 'simple', str(number)])
  1987. return result.stdout.rstrip()
  1988. assert get_port(3000) == container.get_local_port(3000)
  1989. assert ':53222' in get_port(3001)
  1990. assert ':53223' in get_port(3002)
  1991. def test_port_with_scale(self):
  1992. self.base_dir = 'tests/fixtures/ports-composefile-scale'
  1993. self.dispatch(['scale', 'simple=2'], None)
  1994. containers = sorted(
  1995. self.project.containers(service_names=['simple']),
  1996. key=attrgetter('name'))
  1997. def get_port(number, index=None):
  1998. if index is None:
  1999. result = self.dispatch(['port', 'simple', str(number)])
  2000. else:
  2001. result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
  2002. return result.stdout.rstrip()
  2003. assert get_port(3000) == containers[0].get_local_port(3000)
  2004. assert get_port(3000, index=1) == containers[0].get_local_port(3000)
  2005. assert get_port(3000, index=2) == containers[1].get_local_port(3000)
  2006. assert get_port(3002) == ""
  2007. def test_events_json(self):
  2008. events_proc = start_process(self.base_dir, ['events', '--json'])
  2009. self.dispatch(['up', '-d'])
  2010. wait_on_condition(ContainerCountCondition(self.project, 2))
  2011. os.kill(events_proc.pid, signal.SIGINT)
  2012. result = wait_on_process(events_proc, returncode=1)
  2013. lines = [json.loads(line) for line in result.stdout.rstrip().split('\n')]
  2014. assert Counter(e['action'] for e in lines) == {'create': 2, 'start': 2}
  2015. def test_events_human_readable(self):
  2016. def has_timestamp(string):
  2017. str_iso_date, str_iso_time, container_info = string.split(' ', 2)
  2018. try:
  2019. return isinstance(datetime.datetime.strptime(
  2020. '%s %s' % (str_iso_date, str_iso_time),
  2021. '%Y-%m-%d %H:%M:%S.%f'),
  2022. datetime.datetime)
  2023. except ValueError:
  2024. return False
  2025. events_proc = start_process(self.base_dir, ['events'])
  2026. self.dispatch(['up', '-d', 'simple'])
  2027. wait_on_condition(ContainerCountCondition(self.project, 1))
  2028. os.kill(events_proc.pid, signal.SIGINT)
  2029. result = wait_on_process(events_proc, returncode=1)
  2030. lines = result.stdout.rstrip().split('\n')
  2031. assert len(lines) == 2
  2032. container, = self.project.containers()
  2033. expected_template = ' container {} {}'
  2034. expected_meta_info = ['image=busybox:latest', 'name=simple-composefile_simple_1']
  2035. assert expected_template.format('create', container.id) in lines[0]
  2036. assert expected_template.format('start', container.id) in lines[1]
  2037. for line in lines:
  2038. for info in expected_meta_info:
  2039. assert info in line
  2040. assert has_timestamp(lines[0])
  2041. def test_env_file_relative_to_compose_file(self):
  2042. config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
  2043. self.dispatch(['-f', config_path, 'up', '-d'], None)
  2044. self._project = get_project(self.base_dir, [config_path])
  2045. containers = self.project.containers(stopped=True)
  2046. assert len(containers) == 1
  2047. assert "FOO=1" in containers[0].get('Config.Env')
  2048. @mock.patch.dict(os.environ)
  2049. def test_home_and_env_var_in_volume_path(self):
  2050. os.environ['VOLUME_NAME'] = 'my-volume'
  2051. os.environ['HOME'] = '/tmp/home-dir'
  2052. self.base_dir = 'tests/fixtures/volume-path-interpolation'
  2053. self.dispatch(['up', '-d'], None)
  2054. container = self.project.containers(stopped=True)[0]
  2055. actual_host_path = container.get_mount('/container-path')['Source']
  2056. components = actual_host_path.split('/')
  2057. assert components[-2:] == ['home-dir', 'my-volume']
  2058. def test_up_with_default_override_file(self):
  2059. self.base_dir = 'tests/fixtures/override-files'
  2060. self.dispatch(['up', '-d'], None)
  2061. containers = self.project.containers()
  2062. assert len(containers) == 2
  2063. web, db = containers
  2064. assert web.human_readable_command == 'top'
  2065. assert db.human_readable_command == 'top'
  2066. def test_up_with_multiple_files(self):
  2067. self.base_dir = 'tests/fixtures/override-files'
  2068. config_paths = [
  2069. 'docker-compose.yml',
  2070. 'docker-compose.override.yml',
  2071. 'extra.yml',
  2072. ]
  2073. self._project = get_project(self.base_dir, config_paths)
  2074. self.dispatch(
  2075. [
  2076. '-f', config_paths[0],
  2077. '-f', config_paths[1],
  2078. '-f', config_paths[2],
  2079. 'up', '-d',
  2080. ],
  2081. None)
  2082. containers = self.project.containers()
  2083. assert len(containers) == 3
  2084. web, other, db = containers
  2085. assert web.human_readable_command == 'top'
  2086. assert db.human_readable_command == 'top'
  2087. assert other.human_readable_command == 'top'
  2088. def test_up_with_extends(self):
  2089. self.base_dir = 'tests/fixtures/extends'
  2090. self.dispatch(['up', '-d'], None)
  2091. assert set([s.name for s in self.project.services]) == set(['mydb', 'myweb'])
  2092. # Sort by name so we get [db, web]
  2093. containers = sorted(
  2094. self.project.containers(stopped=True),
  2095. key=lambda c: c.name,
  2096. )
  2097. assert len(containers) == 2
  2098. web = containers[1]
  2099. assert set(get_links(web)) == set(['db', 'mydb_1', 'extends_mydb_1'])
  2100. expected_env = set([
  2101. "FOO=1",
  2102. "BAR=2",
  2103. "BAZ=2",
  2104. ])
  2105. assert expected_env <= set(web.get('Config.Env'))
  2106. def test_top_services_not_running(self):
  2107. self.base_dir = 'tests/fixtures/top'
  2108. result = self.dispatch(['top'])
  2109. assert len(result.stdout) == 0
  2110. def test_top_services_running(self):
  2111. self.base_dir = 'tests/fixtures/top'
  2112. self.dispatch(['up', '-d'])
  2113. result = self.dispatch(['top'])
  2114. assert 'top_service_a' in result.stdout
  2115. assert 'top_service_b' in result.stdout
  2116. assert 'top_not_a_service' not in result.stdout
  2117. def test_top_processes_running(self):
  2118. self.base_dir = 'tests/fixtures/top'
  2119. self.dispatch(['up', '-d'])
  2120. result = self.dispatch(['top'])
  2121. assert result.stdout.count("top") == 4
  2122. def test_forward_exitval(self):
  2123. self.base_dir = 'tests/fixtures/exit-code-from'
  2124. proc = start_process(
  2125. self.base_dir,
  2126. ['up', '--abort-on-container-exit', '--exit-code-from', 'another'])
  2127. result = wait_on_process(proc, returncode=1)
  2128. assert 'exit-code-from_another_1 exited with code 1' in result.stdout
  2129. def test_images(self):
  2130. self.project.get_service('simple').create_container()
  2131. result = self.dispatch(['images'])
  2132. assert 'busybox' in result.stdout
  2133. assert 'simple-composefile_simple_1' in result.stdout
  2134. def test_images_default_composefile(self):
  2135. self.base_dir = 'tests/fixtures/multiple-composefiles'
  2136. self.dispatch(['up', '-d'])
  2137. result = self.dispatch(['images'])
  2138. assert 'busybox' in result.stdout
  2139. assert 'multiple-composefiles_another_1' in result.stdout
  2140. assert 'multiple-composefiles_simple_1' in result.stdout
  2141. @mock.patch.dict(os.environ)
  2142. def test_images_tagless_image(self):
  2143. self.base_dir = 'tests/fixtures/tagless-image'
  2144. stream = self.client.build(self.base_dir, decode=True)
  2145. img_id = None
  2146. for data in stream:
  2147. if 'aux' in data:
  2148. img_id = data['aux']['ID']
  2149. break
  2150. if 'stream' in data and 'Successfully built' in data['stream']:
  2151. img_id = self.client.inspect_image(data['stream'].split(' ')[2].strip())['Id']
  2152. assert img_id
  2153. os.environ['IMAGE_ID'] = img_id
  2154. self.project.get_service('foo').create_container()
  2155. result = self.dispatch(['images'])
  2156. assert '<none>' in result.stdout
  2157. assert 'tagless-image_foo_1' in result.stdout
  2158. def test_up_with_override_yaml(self):
  2159. self.base_dir = 'tests/fixtures/override-yaml-files'
  2160. self._project = get_project(self.base_dir, [])
  2161. self.dispatch(['up', '-d'], None)
  2162. containers = self.project.containers()
  2163. assert len(containers) == 2
  2164. web, db = containers
  2165. assert web.human_readable_command == 'sleep 100'
  2166. assert db.human_readable_command == 'top'
  2167. def test_up_with_duplicate_override_yaml_files(self):
  2168. self.base_dir = 'tests/fixtures/duplicate-override-yaml-files'
  2169. with pytest.raises(DuplicateOverrideFileFound):
  2170. get_project(self.base_dir, [])
  2171. self.base_dir = None