cli_test.py 94 KB

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