cli_test.py 85 KB

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