cli_test.py 60 KB

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