cli_test.py 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import datetime
  4. import json
  5. import os
  6. import shlex
  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 yaml
  14. from docker import errors
  15. from .. import mock
  16. from compose.cli.command import get_project
  17. from compose.container import Container
  18. from tests.integration.testcases import DockerClientTestCase
  19. from tests.integration.testcases import get_links
  20. from tests.integration.testcases import pull_busybox
  21. from tests.integration.testcases import v2_only
  22. ProcessResult = namedtuple('ProcessResult', 'stdout stderr')
  23. BUILD_CACHE_TEXT = 'Using cache'
  24. BUILD_PULL_TEXT = 'Status: Image is up to date for busybox:latest'
  25. def start_process(base_dir, options):
  26. proc = subprocess.Popen(
  27. ['docker-compose'] + options,
  28. stdout=subprocess.PIPE,
  29. stderr=subprocess.PIPE,
  30. cwd=base_dir)
  31. print("Running process: %s" % proc.pid)
  32. return proc
  33. def wait_on_process(proc, returncode=0):
  34. stdout, stderr = proc.communicate()
  35. if proc.returncode != returncode:
  36. print("Stderr: {}".format(stderr))
  37. print("Stdout: {}".format(stdout))
  38. assert proc.returncode == returncode
  39. return ProcessResult(stdout.decode('utf-8'), stderr.decode('utf-8'))
  40. def wait_on_condition(condition, delay=0.1, timeout=40):
  41. start_time = time.time()
  42. while not condition():
  43. if time.time() - start_time > timeout:
  44. raise AssertionError("Timeout: %s" % condition)
  45. time.sleep(delay)
  46. def kill_service(service):
  47. for container in service.containers():
  48. container.kill()
  49. class ContainerCountCondition(object):
  50. def __init__(self, project, expected):
  51. self.project = project
  52. self.expected = expected
  53. def __call__(self):
  54. return len(self.project.containers()) == self.expected
  55. def __str__(self):
  56. return "waiting for counter count == %s" % self.expected
  57. class ContainerStateCondition(object):
  58. def __init__(self, client, name, status):
  59. self.client = client
  60. self.name = name
  61. self.status = status
  62. def __call__(self):
  63. try:
  64. container = self.client.inspect_container(self.name)
  65. return container['State']['Status'] == self.status
  66. except errors.APIError:
  67. return False
  68. def __str__(self):
  69. return "waiting for container to be %s" % self.status
  70. class CLITestCase(DockerClientTestCase):
  71. def setUp(self):
  72. super(CLITestCase, self).setUp()
  73. self.base_dir = 'tests/fixtures/simple-composefile'
  74. def tearDown(self):
  75. if self.base_dir:
  76. self.project.kill()
  77. self.project.remove_stopped()
  78. for container in self.project.containers(stopped=True, one_off=True):
  79. container.remove(force=True)
  80. networks = self.client.networks()
  81. for n in networks:
  82. if n['Name'].startswith('{}_'.format(self.project.name)):
  83. self.client.remove_network(n['Name'])
  84. super(CLITestCase, self).tearDown()
  85. @property
  86. def project(self):
  87. # Hack: allow project to be overridden
  88. if not hasattr(self, '_project'):
  89. self._project = get_project(self.base_dir)
  90. return self._project
  91. def dispatch(self, options, project_options=None, returncode=0):
  92. project_options = project_options or []
  93. proc = start_process(self.base_dir, project_options + options)
  94. return wait_on_process(proc, returncode=returncode)
  95. def execute(self, container, cmd):
  96. # Remove once Hijack and CloseNotifier sign a peace treaty
  97. self.client.close()
  98. exc = self.client.exec_create(container.id, cmd)
  99. self.client.exec_start(exc)
  100. return self.client.exec_inspect(exc)['ExitCode']
  101. def lookup(self, container, hostname):
  102. return self.execute(container, ["nslookup", hostname]) == 0
  103. def test_help(self):
  104. self.base_dir = 'tests/fixtures/no-composefile'
  105. result = self.dispatch(['help', 'up'], returncode=1)
  106. assert 'Usage: up [options] [SERVICE...]' in result.stderr
  107. # Prevent tearDown from trying to create a project
  108. self.base_dir = None
  109. # TODO: this shouldn't be v2-dependent
  110. @v2_only()
  111. def test_config_list_services(self):
  112. self.base_dir = 'tests/fixtures/v2-full'
  113. result = self.dispatch(['config', '--services'])
  114. assert set(result.stdout.rstrip().split('\n')) == {'web', 'other'}
  115. # TODO: this shouldn't be v2-dependent
  116. @v2_only()
  117. def test_config_quiet_with_error(self):
  118. self.base_dir = None
  119. result = self.dispatch([
  120. '-f', 'tests/fixtures/invalid-composefile/invalid.yml',
  121. 'config', '-q'
  122. ], returncode=1)
  123. assert "'notaservice' must be a mapping" in result.stderr
  124. # TODO: this shouldn't be v2-dependent
  125. @v2_only()
  126. def test_config_quiet(self):
  127. self.base_dir = 'tests/fixtures/v2-full'
  128. assert self.dispatch(['config', '-q']).stdout == ''
  129. # TODO: this shouldn't be v2-dependent
  130. @v2_only()
  131. def test_config_default(self):
  132. self.base_dir = 'tests/fixtures/v2-full'
  133. result = self.dispatch(['config'])
  134. # assert there are no python objects encoded in the output
  135. assert '!!' not in result.stdout
  136. output = yaml.load(result.stdout)
  137. expected = {
  138. 'version': '2.0',
  139. 'volumes': {'data': {'driver': 'local'}},
  140. 'networks': {'front': {}},
  141. 'services': {
  142. 'web': {
  143. 'build': {
  144. 'context': os.path.abspath(self.base_dir),
  145. },
  146. 'networks': {'front': None, 'default': None},
  147. 'volumes_from': ['service:other:rw'],
  148. },
  149. 'other': {
  150. 'image': 'busybox:latest',
  151. 'command': 'top',
  152. 'volumes': ['/data:rw'],
  153. },
  154. },
  155. }
  156. assert output == expected
  157. def test_ps(self):
  158. self.project.get_service('simple').create_container()
  159. result = self.dispatch(['ps'])
  160. assert 'simplecomposefile_simple_1' in result.stdout
  161. def test_ps_default_composefile(self):
  162. self.base_dir = 'tests/fixtures/multiple-composefiles'
  163. self.dispatch(['up', '-d'])
  164. result = self.dispatch(['ps'])
  165. self.assertIn('multiplecomposefiles_simple_1', result.stdout)
  166. self.assertIn('multiplecomposefiles_another_1', result.stdout)
  167. self.assertNotIn('multiplecomposefiles_yetanother_1', result.stdout)
  168. def test_ps_alternate_composefile(self):
  169. config_path = os.path.abspath(
  170. 'tests/fixtures/multiple-composefiles/compose2.yml')
  171. self._project = get_project(self.base_dir, [config_path])
  172. self.base_dir = 'tests/fixtures/multiple-composefiles'
  173. self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
  174. result = self.dispatch(['-f', 'compose2.yml', 'ps'])
  175. self.assertNotIn('multiplecomposefiles_simple_1', result.stdout)
  176. self.assertNotIn('multiplecomposefiles_another_1', result.stdout)
  177. self.assertIn('multiplecomposefiles_yetanother_1', result.stdout)
  178. def test_pull(self):
  179. result = self.dispatch(['pull'])
  180. assert sorted(result.stderr.split('\n'))[1:] == [
  181. 'Pulling another (busybox:latest)...',
  182. 'Pulling simple (busybox:latest)...',
  183. ]
  184. def test_pull_with_digest(self):
  185. result = self.dispatch(['-f', 'digest.yml', 'pull'])
  186. assert 'Pulling simple (busybox:latest)...' in result.stderr
  187. assert ('Pulling digest (busybox@'
  188. 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
  189. '04ee8502d)...') in result.stderr
  190. def test_pull_with_ignore_pull_failures(self):
  191. result = self.dispatch([
  192. '-f', 'ignore-pull-failures.yml',
  193. 'pull', '--ignore-pull-failures'])
  194. assert 'Pulling simple (busybox:latest)...' in result.stderr
  195. assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
  196. assert 'Error: image library/nonexisting-image' in result.stderr
  197. assert 'not found' in result.stderr
  198. def test_build_plain(self):
  199. self.base_dir = 'tests/fixtures/simple-dockerfile'
  200. self.dispatch(['build', 'simple'])
  201. result = self.dispatch(['build', 'simple'])
  202. assert BUILD_CACHE_TEXT in result.stdout
  203. assert BUILD_PULL_TEXT not in result.stdout
  204. def test_build_no_cache(self):
  205. self.base_dir = 'tests/fixtures/simple-dockerfile'
  206. self.dispatch(['build', 'simple'])
  207. result = self.dispatch(['build', '--no-cache', 'simple'])
  208. assert BUILD_CACHE_TEXT not in result.stdout
  209. assert BUILD_PULL_TEXT not in result.stdout
  210. def test_build_pull(self):
  211. # Make sure we have the latest busybox already
  212. pull_busybox(self.client)
  213. self.base_dir = 'tests/fixtures/simple-dockerfile'
  214. self.dispatch(['build', 'simple'], None)
  215. result = self.dispatch(['build', '--pull', 'simple'])
  216. assert BUILD_CACHE_TEXT in result.stdout
  217. assert BUILD_PULL_TEXT in result.stdout
  218. def test_build_no_cache_pull(self):
  219. # Make sure we have the latest busybox already
  220. pull_busybox(self.client)
  221. self.base_dir = 'tests/fixtures/simple-dockerfile'
  222. self.dispatch(['build', 'simple'])
  223. result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
  224. assert BUILD_CACHE_TEXT not in result.stdout
  225. assert BUILD_PULL_TEXT in result.stdout
  226. def test_build_failed(self):
  227. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  228. self.dispatch(['build', 'simple'], returncode=1)
  229. labels = ["com.docker.compose.test_failing_image=true"]
  230. containers = [
  231. Container.from_ps(self.project.client, c)
  232. for c in self.project.client.containers(
  233. all=True,
  234. filters={"label": labels})
  235. ]
  236. assert len(containers) == 1
  237. def test_build_failed_forcerm(self):
  238. self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
  239. self.dispatch(['build', '--force-rm', 'simple'], returncode=1)
  240. labels = ["com.docker.compose.test_failing_image=true"]
  241. containers = [
  242. Container.from_ps(self.project.client, c)
  243. for c in self.project.client.containers(
  244. all=True,
  245. filters={"label": labels})
  246. ]
  247. assert not containers
  248. def test_create(self):
  249. self.dispatch(['create'])
  250. service = self.project.get_service('simple')
  251. another = self.project.get_service('another')
  252. self.assertEqual(len(service.containers()), 0)
  253. self.assertEqual(len(another.containers()), 0)
  254. self.assertEqual(len(service.containers(stopped=True)), 1)
  255. self.assertEqual(len(another.containers(stopped=True)), 1)
  256. def test_create_with_force_recreate(self):
  257. self.dispatch(['create'], None)
  258. service = self.project.get_service('simple')
  259. self.assertEqual(len(service.containers()), 0)
  260. self.assertEqual(len(service.containers(stopped=True)), 1)
  261. old_ids = [c.id for c in service.containers(stopped=True)]
  262. self.dispatch(['create', '--force-recreate'], None)
  263. self.assertEqual(len(service.containers()), 0)
  264. self.assertEqual(len(service.containers(stopped=True)), 1)
  265. new_ids = [c.id for c in service.containers(stopped=True)]
  266. self.assertNotEqual(old_ids, new_ids)
  267. def test_create_with_no_recreate(self):
  268. self.dispatch(['create'], None)
  269. service = self.project.get_service('simple')
  270. self.assertEqual(len(service.containers()), 0)
  271. self.assertEqual(len(service.containers(stopped=True)), 1)
  272. old_ids = [c.id for c in service.containers(stopped=True)]
  273. self.dispatch(['create', '--no-recreate'], None)
  274. self.assertEqual(len(service.containers()), 0)
  275. self.assertEqual(len(service.containers(stopped=True)), 1)
  276. new_ids = [c.id for c in service.containers(stopped=True)]
  277. self.assertEqual(old_ids, new_ids)
  278. def test_create_with_force_recreate_and_no_recreate(self):
  279. self.dispatch(
  280. ['create', '--force-recreate', '--no-recreate'],
  281. returncode=1)
  282. def test_down_invalid_rmi_flag(self):
  283. result = self.dispatch(['down', '--rmi', 'bogus'], returncode=1)
  284. assert '--rmi flag must be' in result.stderr
  285. @v2_only()
  286. def test_down(self):
  287. self.base_dir = 'tests/fixtures/v2-full'
  288. self.dispatch(['up', '-d'])
  289. wait_on_condition(ContainerCountCondition(self.project, 2))
  290. result = self.dispatch(['down', '--rmi=local', '--volumes'])
  291. assert 'Stopping v2full_web_1' in result.stderr
  292. assert 'Stopping v2full_other_1' in result.stderr
  293. assert 'Removing v2full_web_1' in result.stderr
  294. assert 'Removing v2full_other_1' in result.stderr
  295. assert 'Removing volume v2full_data' in result.stderr
  296. assert 'Removing image v2full_web' in result.stderr
  297. assert 'Removing image busybox' not in result.stderr
  298. assert 'Removing network v2full_default' in result.stderr
  299. assert 'Removing network v2full_front' in result.stderr
  300. def test_up_detached(self):
  301. self.dispatch(['up', '-d'])
  302. service = self.project.get_service('simple')
  303. another = self.project.get_service('another')
  304. self.assertEqual(len(service.containers()), 1)
  305. self.assertEqual(len(another.containers()), 1)
  306. # Ensure containers don't have stdin and stdout connected in -d mode
  307. container, = service.containers()
  308. self.assertFalse(container.get('Config.AttachStderr'))
  309. self.assertFalse(container.get('Config.AttachStdout'))
  310. self.assertFalse(container.get('Config.AttachStdin'))
  311. def test_up_attached(self):
  312. self.base_dir = 'tests/fixtures/echo-services'
  313. result = self.dispatch(['up', '--no-color'])
  314. assert 'simple_1 | simple' in result.stdout
  315. assert 'another_1 | another' in result.stdout
  316. assert 'simple_1 exited with code 0' in result.stdout
  317. assert 'another_1 exited with code 0' in result.stdout
  318. @v2_only()
  319. def test_up(self):
  320. self.base_dir = 'tests/fixtures/v2-simple'
  321. self.dispatch(['up', '-d'], None)
  322. services = self.project.get_services()
  323. network_name = self.project.networks.networks['default'].full_name
  324. networks = self.client.networks(names=[network_name])
  325. self.assertEqual(len(networks), 1)
  326. self.assertEqual(networks[0]['Driver'], 'bridge')
  327. assert 'com.docker.network.bridge.enable_icc' not in networks[0]['Options']
  328. network = self.client.inspect_network(networks[0]['Id'])
  329. for service in services:
  330. containers = service.containers()
  331. self.assertEqual(len(containers), 1)
  332. container = containers[0]
  333. self.assertIn(container.id, network['Containers'])
  334. networks = container.get('NetworkSettings.Networks')
  335. self.assertEqual(list(networks), [network['Name']])
  336. self.assertEqual(
  337. sorted(networks[network['Name']]['Aliases']),
  338. sorted([service.name, container.short_id]))
  339. for service in services:
  340. assert self.lookup(container, service.name)
  341. @v2_only()
  342. def test_up_with_default_network_config(self):
  343. filename = 'default-network-config.yml'
  344. self.base_dir = 'tests/fixtures/networks'
  345. self._project = get_project(self.base_dir, [filename])
  346. self.dispatch(['-f', filename, 'up', '-d'], None)
  347. network_name = self.project.networks.networks['default'].full_name
  348. networks = self.client.networks(names=[network_name])
  349. assert networks[0]['Options']['com.docker.network.bridge.enable_icc'] == 'false'
  350. @v2_only()
  351. def test_up_with_network_aliases(self):
  352. filename = 'network-aliases.yml'
  353. self.base_dir = 'tests/fixtures/networks'
  354. self.dispatch(['-f', filename, 'up', '-d'], None)
  355. back_name = '{}_back'.format(self.project.name)
  356. front_name = '{}_front'.format(self.project.name)
  357. networks = [
  358. n for n in self.client.networks()
  359. if n['Name'].startswith('{}_'.format(self.project.name))
  360. ]
  361. # Two networks were created: back and front
  362. assert sorted(n['Name'] for n in networks) == [back_name, front_name]
  363. web_container = self.project.get_service('web').containers()[0]
  364. back_aliases = web_container.get(
  365. 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
  366. )
  367. assert 'web' in back_aliases
  368. front_aliases = web_container.get(
  369. 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
  370. )
  371. assert 'web' in front_aliases
  372. assert 'forward_facing' in front_aliases
  373. assert 'ahead' in front_aliases
  374. @v2_only()
  375. def test_up_with_network_static_addresses(self):
  376. filename = 'network-static-addresses.yml'
  377. ipv4_address = '172.16.100.100'
  378. ipv6_address = 'fe80::1001:100'
  379. self.base_dir = 'tests/fixtures/networks'
  380. self.dispatch(['-f', filename, 'up', '-d'], None)
  381. static_net = '{}_static_test'.format(self.project.name)
  382. networks = [
  383. n for n in self.client.networks()
  384. if n['Name'].startswith('{}_'.format(self.project.name))
  385. ]
  386. # One networks was created: front
  387. assert sorted(n['Name'] for n in networks) == [static_net]
  388. web_container = self.project.get_service('web').containers()[0]
  389. ipam_config = web_container.get(
  390. 'NetworkSettings.Networks.{}.IPAMConfig'.format(static_net)
  391. )
  392. assert ipv4_address in ipam_config.values()
  393. assert ipv6_address in ipam_config.values()
  394. @v2_only()
  395. def test_up_with_networks(self):
  396. self.base_dir = 'tests/fixtures/networks'
  397. self.dispatch(['up', '-d'], None)
  398. back_name = '{}_back'.format(self.project.name)
  399. front_name = '{}_front'.format(self.project.name)
  400. networks = [
  401. n for n in self.client.networks()
  402. if n['Name'].startswith('{}_'.format(self.project.name))
  403. ]
  404. # Two networks were created: back and front
  405. assert sorted(n['Name'] for n in networks) == [back_name, front_name]
  406. back_network = [n for n in networks if n['Name'] == back_name][0]
  407. front_network = [n for n in networks if n['Name'] == front_name][0]
  408. web_container = self.project.get_service('web').containers()[0]
  409. app_container = self.project.get_service('app').containers()[0]
  410. db_container = self.project.get_service('db').containers()[0]
  411. for net_name in [front_name, back_name]:
  412. links = app_container.get('NetworkSettings.Networks.{}.Links'.format(net_name))
  413. assert '{}:database'.format(db_container.name) in links
  414. # db and app joined the back network
  415. assert sorted(back_network['Containers']) == sorted([db_container.id, app_container.id])
  416. # web and app joined the front network
  417. assert sorted(front_network['Containers']) == sorted([web_container.id, app_container.id])
  418. # web can see app but not db
  419. assert self.lookup(web_container, "app")
  420. assert not self.lookup(web_container, "db")
  421. # app can see db
  422. assert self.lookup(app_container, "db")
  423. # app has aliased db to "database"
  424. assert self.lookup(app_container, "database")
  425. @v2_only()
  426. def test_up_missing_network(self):
  427. self.base_dir = 'tests/fixtures/networks'
  428. result = self.dispatch(
  429. ['-f', 'missing-network.yml', 'up', '-d'],
  430. returncode=1)
  431. assert 'Service "web" uses an undefined network "foo"' in result.stderr
  432. @v2_only()
  433. def test_up_with_network_mode(self):
  434. c = self.client.create_container('busybox', 'top', name='composetest_network_mode_container')
  435. self.addCleanup(self.client.remove_container, c, force=True)
  436. self.client.start(c)
  437. container_mode_source = 'container:{}'.format(c['Id'])
  438. filename = 'network-mode.yml'
  439. self.base_dir = 'tests/fixtures/networks'
  440. self._project = get_project(self.base_dir, [filename])
  441. self.dispatch(['-f', filename, 'up', '-d'], None)
  442. networks = [
  443. n for n in self.client.networks()
  444. if n['Name'].startswith('{}_'.format(self.project.name))
  445. ]
  446. assert not networks
  447. for name in ['bridge', 'host', 'none']:
  448. container = self.project.get_service(name).containers()[0]
  449. assert list(container.get('NetworkSettings.Networks')) == [name]
  450. assert container.get('HostConfig.NetworkMode') == name
  451. service_mode_source = 'container:{}'.format(
  452. self.project.get_service('bridge').containers()[0].id)
  453. service_mode_container = self.project.get_service('service').containers()[0]
  454. assert not service_mode_container.get('NetworkSettings.Networks')
  455. assert service_mode_container.get('HostConfig.NetworkMode') == service_mode_source
  456. container_mode_container = self.project.get_service('container').containers()[0]
  457. assert not container_mode_container.get('NetworkSettings.Networks')
  458. assert container_mode_container.get('HostConfig.NetworkMode') == container_mode_source
  459. @v2_only()
  460. def test_up_external_networks(self):
  461. filename = 'external-networks.yml'
  462. self.base_dir = 'tests/fixtures/networks'
  463. self._project = get_project(self.base_dir, [filename])
  464. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  465. assert 'declared as external, but could not be found' in result.stderr
  466. networks = [
  467. n['Name'] for n in self.client.networks()
  468. if n['Name'].startswith('{}_'.format(self.project.name))
  469. ]
  470. assert not networks
  471. network_names = ['{}_{}'.format(self.project.name, n) for n in ['foo', 'bar']]
  472. for name in network_names:
  473. self.client.create_network(name)
  474. self.dispatch(['-f', filename, 'up', '-d'])
  475. container = self.project.containers()[0]
  476. assert sorted(list(container.get('NetworkSettings.Networks'))) == sorted(network_names)
  477. @v2_only()
  478. def test_up_with_external_default_network(self):
  479. filename = 'external-default.yml'
  480. self.base_dir = 'tests/fixtures/networks'
  481. self._project = get_project(self.base_dir, [filename])
  482. result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
  483. assert 'declared as external, but could not be found' in result.stderr
  484. networks = [
  485. n['Name'] for n in self.client.networks()
  486. if n['Name'].startswith('{}_'.format(self.project.name))
  487. ]
  488. assert not networks
  489. network_name = 'composetest_external_network'
  490. self.client.create_network(network_name)
  491. self.dispatch(['-f', filename, 'up', '-d'])
  492. container = self.project.containers()[0]
  493. assert list(container.get('NetworkSettings.Networks')) == [network_name]
  494. @v2_only()
  495. def test_up_no_services(self):
  496. self.base_dir = 'tests/fixtures/no-services'
  497. self.dispatch(['up', '-d'], None)
  498. network_names = [
  499. n['Name'] for n in self.client.networks()
  500. if n['Name'].startswith('{}_'.format(self.project.name))
  501. ]
  502. assert network_names == []
  503. def test_up_with_links_v1(self):
  504. self.base_dir = 'tests/fixtures/links-composefile'
  505. self.dispatch(['up', '-d', 'web'], None)
  506. # No network was created
  507. network_name = self.project.networks.networks['default'].full_name
  508. networks = self.client.networks(names=[network_name])
  509. assert networks == []
  510. web = self.project.get_service('web')
  511. db = self.project.get_service('db')
  512. console = self.project.get_service('console')
  513. # console was not started
  514. self.assertEqual(len(web.containers()), 1)
  515. self.assertEqual(len(db.containers()), 1)
  516. self.assertEqual(len(console.containers()), 0)
  517. # web has links
  518. web_container = web.containers()[0]
  519. self.assertTrue(web_container.get('HostConfig.Links'))
  520. def test_up_with_net_is_invalid(self):
  521. self.base_dir = 'tests/fixtures/net-container'
  522. result = self.dispatch(
  523. ['-f', 'v2-invalid.yml', 'up', '-d'],
  524. returncode=1)
  525. # TODO: fix validation error messages for v2 files
  526. # assert "Unsupported config option for service 'web': 'net'" in exc.exconly()
  527. assert "Unsupported config option" in result.stderr
  528. def test_up_with_net_v1(self):
  529. self.base_dir = 'tests/fixtures/net-container'
  530. self.dispatch(['up', '-d'], None)
  531. bar = self.project.get_service('bar')
  532. bar_container = bar.containers()[0]
  533. foo = self.project.get_service('foo')
  534. foo_container = foo.containers()[0]
  535. assert foo_container.get('HostConfig.NetworkMode') == \
  536. 'container:{}'.format(bar_container.id)
  537. def test_up_with_no_deps(self):
  538. self.base_dir = 'tests/fixtures/links-composefile'
  539. self.dispatch(['up', '-d', '--no-deps', 'web'], None)
  540. web = self.project.get_service('web')
  541. db = self.project.get_service('db')
  542. console = self.project.get_service('console')
  543. self.assertEqual(len(web.containers()), 1)
  544. self.assertEqual(len(db.containers()), 0)
  545. self.assertEqual(len(console.containers()), 0)
  546. def test_up_with_force_recreate(self):
  547. self.dispatch(['up', '-d'], None)
  548. service = self.project.get_service('simple')
  549. self.assertEqual(len(service.containers()), 1)
  550. old_ids = [c.id for c in service.containers()]
  551. self.dispatch(['up', '-d', '--force-recreate'], None)
  552. self.assertEqual(len(service.containers()), 1)
  553. new_ids = [c.id for c in service.containers()]
  554. self.assertNotEqual(old_ids, new_ids)
  555. def test_up_with_no_recreate(self):
  556. self.dispatch(['up', '-d'], None)
  557. service = self.project.get_service('simple')
  558. self.assertEqual(len(service.containers()), 1)
  559. old_ids = [c.id for c in service.containers()]
  560. self.dispatch(['up', '-d', '--no-recreate'], None)
  561. self.assertEqual(len(service.containers()), 1)
  562. new_ids = [c.id for c in service.containers()]
  563. self.assertEqual(old_ids, new_ids)
  564. def test_up_with_force_recreate_and_no_recreate(self):
  565. self.dispatch(
  566. ['up', '-d', '--force-recreate', '--no-recreate'],
  567. returncode=1)
  568. def test_up_with_timeout(self):
  569. self.dispatch(['up', '-d', '-t', '1'])
  570. service = self.project.get_service('simple')
  571. another = self.project.get_service('another')
  572. self.assertEqual(len(service.containers()), 1)
  573. self.assertEqual(len(another.containers()), 1)
  574. # Ensure containers don't have stdin and stdout connected in -d mode
  575. config = service.containers()[0].inspect()['Config']
  576. self.assertFalse(config['AttachStderr'])
  577. self.assertFalse(config['AttachStdout'])
  578. self.assertFalse(config['AttachStdin'])
  579. def test_up_handles_sigint(self):
  580. proc = start_process(self.base_dir, ['up', '-t', '2'])
  581. wait_on_condition(ContainerCountCondition(self.project, 2))
  582. os.kill(proc.pid, signal.SIGINT)
  583. wait_on_condition(ContainerCountCondition(self.project, 0))
  584. def test_up_handles_sigterm(self):
  585. proc = start_process(self.base_dir, ['up', '-t', '2'])
  586. wait_on_condition(ContainerCountCondition(self.project, 2))
  587. os.kill(proc.pid, signal.SIGTERM)
  588. wait_on_condition(ContainerCountCondition(self.project, 0))
  589. @v2_only()
  590. def test_up_handles_force_shutdown(self):
  591. self.base_dir = 'tests/fixtures/sleeps-composefile'
  592. proc = start_process(self.base_dir, ['up', '-t', '200'])
  593. wait_on_condition(ContainerCountCondition(self.project, 2))
  594. os.kill(proc.pid, signal.SIGTERM)
  595. time.sleep(0.1)
  596. os.kill(proc.pid, signal.SIGTERM)
  597. wait_on_condition(ContainerCountCondition(self.project, 0))
  598. def test_up_handles_abort_on_container_exit(self):
  599. start_process(self.base_dir, ['up', '--abort-on-container-exit'])
  600. wait_on_condition(ContainerCountCondition(self.project, 2))
  601. self.project.stop(['simple'])
  602. wait_on_condition(ContainerCountCondition(self.project, 0))
  603. def test_exec_without_tty(self):
  604. self.base_dir = 'tests/fixtures/links-composefile'
  605. self.dispatch(['up', '-d', 'console'])
  606. self.assertEqual(len(self.project.containers()), 1)
  607. stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
  608. self.assertEquals(stdout, "/\n")
  609. self.assertEquals(stderr, "")
  610. def test_exec_custom_user(self):
  611. self.base_dir = 'tests/fixtures/links-composefile'
  612. self.dispatch(['up', '-d', 'console'])
  613. self.assertEqual(len(self.project.containers()), 1)
  614. stdout, stderr = self.dispatch(['exec', '-T', '--user=operator', 'console', 'whoami'])
  615. self.assertEquals(stdout, "operator\n")
  616. self.assertEquals(stderr, "")
  617. def test_run_service_without_links(self):
  618. self.base_dir = 'tests/fixtures/links-composefile'
  619. self.dispatch(['run', 'console', '/bin/true'])
  620. self.assertEqual(len(self.project.containers()), 0)
  621. # Ensure stdin/out was open
  622. container = self.project.containers(stopped=True, one_off=True)[0]
  623. config = container.inspect()['Config']
  624. self.assertTrue(config['AttachStderr'])
  625. self.assertTrue(config['AttachStdout'])
  626. self.assertTrue(config['AttachStdin'])
  627. def test_run_service_with_links(self):
  628. self.base_dir = 'tests/fixtures/links-composefile'
  629. self.dispatch(['run', 'web', '/bin/true'], None)
  630. db = self.project.get_service('db')
  631. console = self.project.get_service('console')
  632. self.assertEqual(len(db.containers()), 1)
  633. self.assertEqual(len(console.containers()), 0)
  634. @v2_only()
  635. def test_run_service_with_dependencies(self):
  636. self.base_dir = 'tests/fixtures/v2-dependencies'
  637. self.dispatch(['run', 'web', '/bin/true'], None)
  638. db = self.project.get_service('db')
  639. console = self.project.get_service('console')
  640. self.assertEqual(len(db.containers()), 1)
  641. self.assertEqual(len(console.containers()), 0)
  642. def test_run_with_no_deps(self):
  643. self.base_dir = 'tests/fixtures/links-composefile'
  644. self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
  645. db = self.project.get_service('db')
  646. self.assertEqual(len(db.containers()), 0)
  647. def test_run_does_not_recreate_linked_containers(self):
  648. self.base_dir = 'tests/fixtures/links-composefile'
  649. self.dispatch(['up', '-d', 'db'])
  650. db = self.project.get_service('db')
  651. self.assertEqual(len(db.containers()), 1)
  652. old_ids = [c.id for c in db.containers()]
  653. self.dispatch(['run', 'web', '/bin/true'], None)
  654. self.assertEqual(len(db.containers()), 1)
  655. new_ids = [c.id for c in db.containers()]
  656. self.assertEqual(old_ids, new_ids)
  657. def test_run_without_command(self):
  658. self.base_dir = 'tests/fixtures/commands-composefile'
  659. self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  660. self.dispatch(['run', 'implicit'])
  661. service = self.project.get_service('implicit')
  662. containers = service.containers(stopped=True, one_off=True)
  663. self.assertEqual(
  664. [c.human_readable_command for c in containers],
  665. [u'/bin/sh -c echo "success"'],
  666. )
  667. self.dispatch(['run', 'explicit'])
  668. service = self.project.get_service('explicit')
  669. containers = service.containers(stopped=True, one_off=True)
  670. self.assertEqual(
  671. [c.human_readable_command for c in containers],
  672. [u'/bin/true'],
  673. )
  674. def test_run_service_with_entrypoint_overridden(self):
  675. self.base_dir = 'tests/fixtures/dockerfile_with_entrypoint'
  676. name = 'service'
  677. self.dispatch(['run', '--entrypoint', '/bin/echo', name, 'helloworld'])
  678. service = self.project.get_service(name)
  679. container = service.containers(stopped=True, one_off=True)[0]
  680. self.assertEqual(
  681. shlex.split(container.human_readable_command),
  682. [u'/bin/echo', u'helloworld'],
  683. )
  684. def test_run_service_with_user_overridden(self):
  685. self.base_dir = 'tests/fixtures/user-composefile'
  686. name = 'service'
  687. user = 'sshd'
  688. self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
  689. service = self.project.get_service(name)
  690. container = service.containers(stopped=True, one_off=True)[0]
  691. self.assertEqual(user, container.get('Config.User'))
  692. def test_run_service_with_user_overridden_short_form(self):
  693. self.base_dir = 'tests/fixtures/user-composefile'
  694. name = 'service'
  695. user = 'sshd'
  696. self.dispatch(['run', '-u', user, name], returncode=1)
  697. service = self.project.get_service(name)
  698. container = service.containers(stopped=True, one_off=True)[0]
  699. self.assertEqual(user, container.get('Config.User'))
  700. def test_run_service_with_environement_overridden(self):
  701. name = 'service'
  702. self.base_dir = 'tests/fixtures/environment-composefile'
  703. self.dispatch([
  704. 'run', '-e', 'foo=notbar',
  705. '-e', 'allo=moto=bobo',
  706. '-e', 'alpha=beta',
  707. name,
  708. '/bin/true',
  709. ])
  710. service = self.project.get_service(name)
  711. container = service.containers(stopped=True, one_off=True)[0]
  712. # env overriden
  713. self.assertEqual('notbar', container.environment['foo'])
  714. # keep environement from yaml
  715. self.assertEqual('world', container.environment['hello'])
  716. # added option from command line
  717. self.assertEqual('beta', container.environment['alpha'])
  718. # make sure a value with a = don't crash out
  719. self.assertEqual('moto=bobo', container.environment['allo'])
  720. def test_run_service_without_map_ports(self):
  721. # create one off container
  722. self.base_dir = 'tests/fixtures/ports-composefile'
  723. self.dispatch(['run', '-d', 'simple'])
  724. container = self.project.get_service('simple').containers(one_off=True)[0]
  725. # get port information
  726. port_random = container.get_local_port(3000)
  727. port_assigned = container.get_local_port(3001)
  728. # close all one off containers we just created
  729. container.stop()
  730. # check the ports
  731. self.assertEqual(port_random, None)
  732. self.assertEqual(port_assigned, None)
  733. def test_run_service_with_map_ports(self):
  734. # create one off container
  735. self.base_dir = 'tests/fixtures/ports-composefile'
  736. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  737. container = self.project.get_service('simple').containers(one_off=True)[0]
  738. # get port information
  739. port_random = container.get_local_port(3000)
  740. port_assigned = container.get_local_port(3001)
  741. port_range = container.get_local_port(3002), container.get_local_port(3003)
  742. # close all one off containers we just created
  743. container.stop()
  744. # check the ports
  745. self.assertNotEqual(port_random, None)
  746. self.assertIn("0.0.0.0", port_random)
  747. self.assertEqual(port_assigned, "0.0.0.0:49152")
  748. self.assertEqual(port_range[0], "0.0.0.0:49153")
  749. self.assertEqual(port_range[1], "0.0.0.0:49154")
  750. def test_run_service_with_explicitly_maped_ports(self):
  751. # create one off container
  752. self.base_dir = 'tests/fixtures/ports-composefile'
  753. self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
  754. container = self.project.get_service('simple').containers(one_off=True)[0]
  755. # get port information
  756. port_short = container.get_local_port(3000)
  757. port_full = container.get_local_port(3001)
  758. # close all one off containers we just created
  759. container.stop()
  760. # check the ports
  761. self.assertEqual(port_short, "0.0.0.0:30000")
  762. self.assertEqual(port_full, "0.0.0.0:30001")
  763. def test_run_service_with_explicitly_maped_ip_ports(self):
  764. # create one off container
  765. self.base_dir = 'tests/fixtures/ports-composefile'
  766. self.dispatch([
  767. 'run', '-d',
  768. '-p', '127.0.0.1:30000:3000',
  769. '--publish', '127.0.0.1:30001:3001',
  770. 'simple'
  771. ])
  772. container = self.project.get_service('simple').containers(one_off=True)[0]
  773. # get port information
  774. port_short = container.get_local_port(3000)
  775. port_full = container.get_local_port(3001)
  776. # close all one off containers we just created
  777. container.stop()
  778. # check the ports
  779. self.assertEqual(port_short, "127.0.0.1:30000")
  780. self.assertEqual(port_full, "127.0.0.1:30001")
  781. def test_run_with_expose_ports(self):
  782. # create one off container
  783. self.base_dir = 'tests/fixtures/expose-composefile'
  784. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  785. container = self.project.get_service('simple').containers(one_off=True)[0]
  786. ports = container.ports
  787. self.assertEqual(len(ports), 9)
  788. # exposed ports are not mapped to host ports
  789. assert ports['3000/tcp'] is None
  790. assert ports['3001/tcp'] is None
  791. assert ports['3001/udp'] is None
  792. assert ports['3002/tcp'] is None
  793. assert ports['3003/tcp'] is None
  794. assert ports['3004/tcp'] is None
  795. assert ports['3005/tcp'] is None
  796. assert ports['3006/udp'] is None
  797. assert ports['3007/udp'] is None
  798. # close all one off containers we just created
  799. container.stop()
  800. def test_run_with_custom_name(self):
  801. self.base_dir = 'tests/fixtures/environment-composefile'
  802. name = 'the-container-name'
  803. self.dispatch(['run', '--name', name, 'service', '/bin/true'])
  804. service = self.project.get_service('service')
  805. container, = service.containers(stopped=True, one_off=True)
  806. self.assertEqual(container.name, name)
  807. def test_run_service_with_workdir_overridden(self):
  808. self.base_dir = 'tests/fixtures/run-workdir'
  809. name = 'service'
  810. workdir = '/var'
  811. self.dispatch(['run', '--workdir={workdir}'.format(workdir=workdir), name])
  812. service = self.project.get_service(name)
  813. container = service.containers(stopped=True, one_off=True)[0]
  814. self.assertEqual(workdir, container.get('Config.WorkingDir'))
  815. def test_run_service_with_workdir_overridden_short_form(self):
  816. self.base_dir = 'tests/fixtures/run-workdir'
  817. name = 'service'
  818. workdir = '/var'
  819. self.dispatch(['run', '-w', workdir, name])
  820. service = self.project.get_service(name)
  821. container = service.containers(stopped=True, one_off=True)[0]
  822. self.assertEqual(workdir, container.get('Config.WorkingDir'))
  823. @v2_only()
  824. def test_run_interactive_connects_to_network(self):
  825. self.base_dir = 'tests/fixtures/networks'
  826. self.dispatch(['up', '-d'])
  827. self.dispatch(['run', 'app', 'nslookup', 'app'])
  828. self.dispatch(['run', 'app', 'nslookup', 'db'])
  829. containers = self.project.get_service('app').containers(
  830. stopped=True, one_off=True)
  831. assert len(containers) == 2
  832. for container in containers:
  833. networks = container.get('NetworkSettings.Networks')
  834. assert sorted(list(networks)) == [
  835. '{}_{}'.format(self.project.name, name)
  836. for name in ['back', 'front']
  837. ]
  838. for _, config in networks.items():
  839. assert not config['Aliases']
  840. @v2_only()
  841. def test_run_detached_connects_to_network(self):
  842. self.base_dir = 'tests/fixtures/networks'
  843. self.dispatch(['up', '-d'])
  844. self.dispatch(['run', '-d', 'app', 'top'])
  845. container = self.project.get_service('app').containers(one_off=True)[0]
  846. networks = container.get('NetworkSettings.Networks')
  847. assert sorted(list(networks)) == [
  848. '{}_{}'.format(self.project.name, name)
  849. for name in ['back', 'front']
  850. ]
  851. for _, config in networks.items():
  852. assert not config['Aliases']
  853. assert self.lookup(container, 'app')
  854. assert self.lookup(container, 'db')
  855. def test_run_handles_sigint(self):
  856. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  857. wait_on_condition(ContainerStateCondition(
  858. self.project.client,
  859. 'simplecomposefile_simple_run_1',
  860. 'running'))
  861. os.kill(proc.pid, signal.SIGINT)
  862. wait_on_condition(ContainerStateCondition(
  863. self.project.client,
  864. 'simplecomposefile_simple_run_1',
  865. 'exited'))
  866. def test_run_handles_sigterm(self):
  867. proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
  868. wait_on_condition(ContainerStateCondition(
  869. self.project.client,
  870. 'simplecomposefile_simple_run_1',
  871. 'running'))
  872. os.kill(proc.pid, signal.SIGTERM)
  873. wait_on_condition(ContainerStateCondition(
  874. self.project.client,
  875. 'simplecomposefile_simple_run_1',
  876. 'exited'))
  877. def test_rm(self):
  878. service = self.project.get_service('simple')
  879. service.create_container()
  880. kill_service(service)
  881. self.assertEqual(len(service.containers(stopped=True)), 1)
  882. self.dispatch(['rm', '--force'], None)
  883. self.assertEqual(len(service.containers(stopped=True)), 0)
  884. service = self.project.get_service('simple')
  885. service.create_container()
  886. kill_service(service)
  887. self.assertEqual(len(service.containers(stopped=True)), 1)
  888. self.dispatch(['rm', '-f'], None)
  889. self.assertEqual(len(service.containers(stopped=True)), 0)
  890. def test_stop(self):
  891. self.dispatch(['up', '-d'], None)
  892. service = self.project.get_service('simple')
  893. self.assertEqual(len(service.containers()), 1)
  894. self.assertTrue(service.containers()[0].is_running)
  895. self.dispatch(['stop', '-t', '1'], None)
  896. self.assertEqual(len(service.containers(stopped=True)), 1)
  897. self.assertFalse(service.containers(stopped=True)[0].is_running)
  898. def test_stop_signal(self):
  899. self.base_dir = 'tests/fixtures/stop-signal-composefile'
  900. self.dispatch(['up', '-d'], None)
  901. service = self.project.get_service('simple')
  902. self.assertEqual(len(service.containers()), 1)
  903. self.assertTrue(service.containers()[0].is_running)
  904. self.dispatch(['stop', '-t', '1'], None)
  905. self.assertEqual(len(service.containers(stopped=True)), 1)
  906. self.assertFalse(service.containers(stopped=True)[0].is_running)
  907. self.assertEqual(service.containers(stopped=True)[0].exit_code, 0)
  908. def test_start_no_containers(self):
  909. result = self.dispatch(['start'], returncode=1)
  910. assert 'No containers to start' in result.stderr
  911. @v2_only()
  912. def test_up_logging(self):
  913. self.base_dir = 'tests/fixtures/logging-composefile'
  914. self.dispatch(['up', '-d'])
  915. simple = self.project.get_service('simple').containers()[0]
  916. log_config = simple.get('HostConfig.LogConfig')
  917. self.assertTrue(log_config)
  918. self.assertEqual(log_config.get('Type'), 'none')
  919. another = self.project.get_service('another').containers()[0]
  920. log_config = another.get('HostConfig.LogConfig')
  921. self.assertTrue(log_config)
  922. self.assertEqual(log_config.get('Type'), 'json-file')
  923. self.assertEqual(log_config.get('Config')['max-size'], '10m')
  924. def test_up_logging_legacy(self):
  925. self.base_dir = 'tests/fixtures/logging-composefile-legacy'
  926. self.dispatch(['up', '-d'])
  927. simple = self.project.get_service('simple').containers()[0]
  928. log_config = simple.get('HostConfig.LogConfig')
  929. self.assertTrue(log_config)
  930. self.assertEqual(log_config.get('Type'), 'none')
  931. another = self.project.get_service('another').containers()[0]
  932. log_config = another.get('HostConfig.LogConfig')
  933. self.assertTrue(log_config)
  934. self.assertEqual(log_config.get('Type'), 'json-file')
  935. self.assertEqual(log_config.get('Config')['max-size'], '10m')
  936. def test_pause_unpause(self):
  937. self.dispatch(['up', '-d'], None)
  938. service = self.project.get_service('simple')
  939. self.assertFalse(service.containers()[0].is_paused)
  940. self.dispatch(['pause'], None)
  941. self.assertTrue(service.containers()[0].is_paused)
  942. self.dispatch(['unpause'], None)
  943. self.assertFalse(service.containers()[0].is_paused)
  944. def test_pause_no_containers(self):
  945. result = self.dispatch(['pause'], returncode=1)
  946. assert 'No containers to pause' in result.stderr
  947. def test_unpause_no_containers(self):
  948. result = self.dispatch(['unpause'], returncode=1)
  949. assert 'No containers to unpause' in result.stderr
  950. def test_logs_invalid_service_name(self):
  951. self.dispatch(['logs', 'madeupname'], returncode=1)
  952. def test_logs_follow(self):
  953. self.base_dir = 'tests/fixtures/echo-services'
  954. self.dispatch(['up', '-d'])
  955. result = self.dispatch(['logs', '-f'])
  956. assert result.stdout.count('\n') == 5
  957. assert 'simple' in result.stdout
  958. assert 'another' in result.stdout
  959. assert 'exited with code 0' in result.stdout
  960. def test_logs_follow_logs_from_new_containers(self):
  961. self.base_dir = 'tests/fixtures/logs-composefile'
  962. self.dispatch(['up', '-d', 'simple'])
  963. proc = start_process(self.base_dir, ['logs', '-f'])
  964. self.dispatch(['up', '-d', 'another'])
  965. wait_on_condition(ContainerStateCondition(
  966. self.project.client,
  967. 'logscomposefile_another_1',
  968. 'exited'))
  969. # sleep for a short period to allow the tailing thread to receive the
  970. # event. This is not great, but there isn't an easy way to do this
  971. # without being able to stream stdout from the process.
  972. time.sleep(0.5)
  973. os.kill(proc.pid, signal.SIGINT)
  974. result = wait_on_process(proc, returncode=1)
  975. assert 'test' in result.stdout
  976. def test_logs_default(self):
  977. self.base_dir = 'tests/fixtures/logs-composefile'
  978. self.dispatch(['up', '-d'])
  979. result = self.dispatch(['logs'])
  980. assert 'hello' in result.stdout
  981. assert 'test' in result.stdout
  982. assert 'exited with' not in result.stdout
  983. def test_logs_on_stopped_containers_exits(self):
  984. self.base_dir = 'tests/fixtures/echo-services'
  985. self.dispatch(['up'])
  986. result = self.dispatch(['logs'])
  987. assert 'simple' in result.stdout
  988. assert 'another' in result.stdout
  989. assert 'exited with' not in result.stdout
  990. def test_logs_timestamps(self):
  991. self.base_dir = 'tests/fixtures/echo-services'
  992. self.dispatch(['up', '-d'])
  993. result = self.dispatch(['logs', '-f', '-t'])
  994. self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')
  995. def test_logs_tail(self):
  996. self.base_dir = 'tests/fixtures/logs-tail-composefile'
  997. self.dispatch(['up'])
  998. result = self.dispatch(['logs', '--tail', '2'])
  999. assert result.stdout.count('\n') == 3
  1000. def test_kill(self):
  1001. self.dispatch(['up', '-d'], None)
  1002. service = self.project.get_service('simple')
  1003. self.assertEqual(len(service.containers()), 1)
  1004. self.assertTrue(service.containers()[0].is_running)
  1005. self.dispatch(['kill'], None)
  1006. self.assertEqual(len(service.containers(stopped=True)), 1)
  1007. self.assertFalse(service.containers(stopped=True)[0].is_running)
  1008. def test_kill_signal_sigstop(self):
  1009. self.dispatch(['up', '-d'], None)
  1010. service = self.project.get_service('simple')
  1011. self.assertEqual(len(service.containers()), 1)
  1012. self.assertTrue(service.containers()[0].is_running)
  1013. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1014. self.assertEqual(len(service.containers()), 1)
  1015. # The container is still running. It has only been paused
  1016. self.assertTrue(service.containers()[0].is_running)
  1017. def test_kill_stopped_service(self):
  1018. self.dispatch(['up', '-d'], None)
  1019. service = self.project.get_service('simple')
  1020. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  1021. self.assertTrue(service.containers()[0].is_running)
  1022. self.dispatch(['kill', '-s', 'SIGKILL'], None)
  1023. self.assertEqual(len(service.containers(stopped=True)), 1)
  1024. self.assertFalse(service.containers(stopped=True)[0].is_running)
  1025. def test_restart(self):
  1026. service = self.project.get_service('simple')
  1027. container = service.create_container()
  1028. service.start_container(container)
  1029. started_at = container.dictionary['State']['StartedAt']
  1030. self.dispatch(['restart', '-t', '1'], None)
  1031. container.inspect()
  1032. self.assertNotEqual(
  1033. container.dictionary['State']['FinishedAt'],
  1034. '0001-01-01T00:00:00Z',
  1035. )
  1036. self.assertNotEqual(
  1037. container.dictionary['State']['StartedAt'],
  1038. started_at,
  1039. )
  1040. def test_restart_stopped_container(self):
  1041. service = self.project.get_service('simple')
  1042. container = service.create_container()
  1043. container.start()
  1044. container.kill()
  1045. self.assertEqual(len(service.containers(stopped=True)), 1)
  1046. self.dispatch(['restart', '-t', '1'], None)
  1047. self.assertEqual(len(service.containers(stopped=False)), 1)
  1048. def test_restart_no_containers(self):
  1049. result = self.dispatch(['restart'], returncode=1)
  1050. assert 'No containers to restart' in result.stderr
  1051. def test_scale(self):
  1052. project = self.project
  1053. self.dispatch(['scale', 'simple=1'])
  1054. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1055. self.dispatch(['scale', 'simple=3', 'another=2'])
  1056. self.assertEqual(len(project.get_service('simple').containers()), 3)
  1057. self.assertEqual(len(project.get_service('another').containers()), 2)
  1058. self.dispatch(['scale', 'simple=1', 'another=1'])
  1059. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1060. self.assertEqual(len(project.get_service('another').containers()), 1)
  1061. self.dispatch(['scale', 'simple=1', 'another=1'])
  1062. self.assertEqual(len(project.get_service('simple').containers()), 1)
  1063. self.assertEqual(len(project.get_service('another').containers()), 1)
  1064. self.dispatch(['scale', 'simple=0', 'another=0'])
  1065. self.assertEqual(len(project.get_service('simple').containers()), 0)
  1066. self.assertEqual(len(project.get_service('another').containers()), 0)
  1067. def test_port(self):
  1068. self.base_dir = 'tests/fixtures/ports-composefile'
  1069. self.dispatch(['up', '-d'], None)
  1070. container = self.project.get_service('simple').get_container()
  1071. def get_port(number):
  1072. result = self.dispatch(['port', 'simple', str(number)])
  1073. return result.stdout.rstrip()
  1074. self.assertEqual(get_port(3000), container.get_local_port(3000))
  1075. self.assertEqual(get_port(3001), "0.0.0.0:49152")
  1076. self.assertEqual(get_port(3002), "0.0.0.0:49153")
  1077. def test_port_with_scale(self):
  1078. self.base_dir = 'tests/fixtures/ports-composefile-scale'
  1079. self.dispatch(['scale', 'simple=2'], None)
  1080. containers = sorted(
  1081. self.project.containers(service_names=['simple']),
  1082. key=attrgetter('name'))
  1083. def get_port(number, index=None):
  1084. if index is None:
  1085. result = self.dispatch(['port', 'simple', str(number)])
  1086. else:
  1087. result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
  1088. return result.stdout.rstrip()
  1089. self.assertEqual(get_port(3000), containers[0].get_local_port(3000))
  1090. self.assertEqual(get_port(3000, index=1), containers[0].get_local_port(3000))
  1091. self.assertEqual(get_port(3000, index=2), containers[1].get_local_port(3000))
  1092. self.assertEqual(get_port(3002), "")
  1093. def test_events_json(self):
  1094. events_proc = start_process(self.base_dir, ['events', '--json'])
  1095. self.dispatch(['up', '-d'])
  1096. wait_on_condition(ContainerCountCondition(self.project, 2))
  1097. os.kill(events_proc.pid, signal.SIGINT)
  1098. result = wait_on_process(events_proc, returncode=1)
  1099. lines = [json.loads(line) for line in result.stdout.rstrip().split('\n')]
  1100. assert Counter(e['action'] for e in lines) == {'create': 2, 'start': 2}
  1101. def test_events_human_readable(self):
  1102. events_proc = start_process(self.base_dir, ['events'])
  1103. self.dispatch(['up', '-d', 'simple'])
  1104. wait_on_condition(ContainerCountCondition(self.project, 1))
  1105. os.kill(events_proc.pid, signal.SIGINT)
  1106. result = wait_on_process(events_proc, returncode=1)
  1107. lines = result.stdout.rstrip().split('\n')
  1108. assert len(lines) == 2
  1109. container, = self.project.containers()
  1110. expected_template = (
  1111. ' container {} {} (image=busybox:latest, '
  1112. 'name=simplecomposefile_simple_1)')
  1113. assert expected_template.format('create', container.id) in lines[0]
  1114. assert expected_template.format('start', container.id) in lines[1]
  1115. assert lines[0].startswith(datetime.date.today().isoformat())
  1116. def test_env_file_relative_to_compose_file(self):
  1117. config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
  1118. self.dispatch(['-f', config_path, 'up', '-d'], None)
  1119. self._project = get_project(self.base_dir, [config_path])
  1120. containers = self.project.containers(stopped=True)
  1121. self.assertEqual(len(containers), 1)
  1122. self.assertIn("FOO=1", containers[0].get('Config.Env'))
  1123. @mock.patch.dict(os.environ)
  1124. def test_home_and_env_var_in_volume_path(self):
  1125. os.environ['VOLUME_NAME'] = 'my-volume'
  1126. os.environ['HOME'] = '/tmp/home-dir'
  1127. self.base_dir = 'tests/fixtures/volume-path-interpolation'
  1128. self.dispatch(['up', '-d'], None)
  1129. container = self.project.containers(stopped=True)[0]
  1130. actual_host_path = container.get_mount('/container-path')['Source']
  1131. components = actual_host_path.split('/')
  1132. assert components[-2:] == ['home-dir', 'my-volume']
  1133. def test_up_with_default_override_file(self):
  1134. self.base_dir = 'tests/fixtures/override-files'
  1135. self.dispatch(['up', '-d'], None)
  1136. containers = self.project.containers()
  1137. self.assertEqual(len(containers), 2)
  1138. web, db = containers
  1139. self.assertEqual(web.human_readable_command, 'top')
  1140. self.assertEqual(db.human_readable_command, 'top')
  1141. def test_up_with_multiple_files(self):
  1142. self.base_dir = 'tests/fixtures/override-files'
  1143. config_paths = [
  1144. 'docker-compose.yml',
  1145. 'docker-compose.override.yml',
  1146. 'extra.yml',
  1147. ]
  1148. self._project = get_project(self.base_dir, config_paths)
  1149. self.dispatch(
  1150. [
  1151. '-f', config_paths[0],
  1152. '-f', config_paths[1],
  1153. '-f', config_paths[2],
  1154. 'up', '-d',
  1155. ],
  1156. None)
  1157. containers = self.project.containers()
  1158. self.assertEqual(len(containers), 3)
  1159. web, other, db = containers
  1160. self.assertEqual(web.human_readable_command, 'top')
  1161. self.assertTrue({'db', 'other'} <= set(get_links(web)))
  1162. self.assertEqual(db.human_readable_command, 'top')
  1163. self.assertEqual(other.human_readable_command, 'top')
  1164. def test_up_with_extends(self):
  1165. self.base_dir = 'tests/fixtures/extends'
  1166. self.dispatch(['up', '-d'], None)
  1167. self.assertEqual(
  1168. set([s.name for s in self.project.services]),
  1169. set(['mydb', 'myweb']),
  1170. )
  1171. # Sort by name so we get [db, web]
  1172. containers = sorted(
  1173. self.project.containers(stopped=True),
  1174. key=lambda c: c.name,
  1175. )
  1176. self.assertEqual(len(containers), 2)
  1177. web = containers[1]
  1178. self.assertEqual(
  1179. set(get_links(web)),
  1180. set(['db', 'mydb_1', 'extends_mydb_1']))
  1181. expected_env = set([
  1182. "FOO=1",
  1183. "BAR=2",
  1184. "BAZ=2",
  1185. ])
  1186. self.assertTrue(expected_env <= set(web.get('Config.Env')))