cli_test.py 75 KB

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