cli_test.py 66 KB

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