1
0

cli_test.py 65 KB

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