cli_test.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711
  1. from __future__ import absolute_import
  2. import os
  3. import shlex
  4. import subprocess
  5. from collections import namedtuple
  6. from operator import attrgetter
  7. from .. import mock
  8. from compose.cli.command import get_project
  9. from compose.cli.docker_client import docker_client
  10. from tests.integration.testcases import DockerClientTestCase
  11. ProcessResult = namedtuple('ProcessResult', 'stdout stderr')
  12. BUILD_CACHE_TEXT = 'Using cache'
  13. BUILD_PULL_TEXT = 'Status: Image is up to date for busybox:latest'
  14. class CLITestCase(DockerClientTestCase):
  15. def setUp(self):
  16. super(CLITestCase, self).setUp()
  17. self.base_dir = 'tests/fixtures/simple-composefile'
  18. def tearDown(self):
  19. self.project.kill()
  20. self.project.remove_stopped()
  21. for container in self.project.containers(stopped=True, one_off=True):
  22. container.remove(force=True)
  23. super(CLITestCase, self).tearDown()
  24. @property
  25. def project(self):
  26. # Hack: allow project to be overridden
  27. if not hasattr(self, '_project'):
  28. self._project = get_project(self.base_dir)
  29. return self._project
  30. def dispatch(self, options, project_options=None, returncode=0):
  31. project_options = project_options or []
  32. proc = subprocess.Popen(
  33. ['docker-compose'] + project_options + options,
  34. stdout=subprocess.PIPE,
  35. stderr=subprocess.PIPE,
  36. cwd=self.base_dir)
  37. print("Running process: %s" % proc.pid)
  38. stdout, stderr = proc.communicate()
  39. if proc.returncode != returncode:
  40. print(stderr)
  41. assert proc.returncode == returncode
  42. return ProcessResult(stdout.decode('utf-8'), stderr.decode('utf-8'))
  43. def test_help(self):
  44. old_base_dir = self.base_dir
  45. self.base_dir = 'tests/fixtures/no-composefile'
  46. result = self.dispatch(['help', 'up'], returncode=1)
  47. assert 'Usage: up [options] [SERVICE...]' in result.stderr
  48. # self.project.kill() fails during teardown
  49. # unless there is a composefile.
  50. self.base_dir = old_base_dir
  51. def test_ps(self):
  52. self.project.get_service('simple').create_container()
  53. result = self.dispatch(['ps'])
  54. assert 'simplecomposefile_simple_1' in result.stdout
  55. def test_ps_default_composefile(self):
  56. self.base_dir = 'tests/fixtures/multiple-composefiles'
  57. self.dispatch(['up', '-d'])
  58. result = self.dispatch(['ps'])
  59. self.assertIn('multiplecomposefiles_simple_1', result.stdout)
  60. self.assertIn('multiplecomposefiles_another_1', result.stdout)
  61. self.assertNotIn('multiplecomposefiles_yetanother_1', result.stdout)
  62. def test_ps_alternate_composefile(self):
  63. config_path = os.path.abspath(
  64. 'tests/fixtures/multiple-composefiles/compose2.yml')
  65. self._project = get_project(self.base_dir, [config_path])
  66. self.base_dir = 'tests/fixtures/multiple-composefiles'
  67. self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
  68. result = self.dispatch(['-f', 'compose2.yml', 'ps'])
  69. self.assertNotIn('multiplecomposefiles_simple_1', result.stdout)
  70. self.assertNotIn('multiplecomposefiles_another_1', result.stdout)
  71. self.assertIn('multiplecomposefiles_yetanother_1', result.stdout)
  72. def test_pull(self):
  73. result = self.dispatch(['pull'])
  74. assert sorted(result.stderr.split('\n'))[1:] == [
  75. 'Pulling another (busybox:latest)...',
  76. 'Pulling simple (busybox:latest)...',
  77. ]
  78. def test_pull_with_digest(self):
  79. result = self.dispatch(['-f', 'digest.yml', 'pull'])
  80. assert 'Pulling simple (busybox:latest)...' in result.stderr
  81. assert ('Pulling digest (busybox@'
  82. 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
  83. '04ee8502d)...') in result.stderr
  84. def test_pull_with_ignore_pull_failures(self):
  85. result = self.dispatch([
  86. '-f', 'ignore-pull-failures.yml',
  87. 'pull', '--ignore-pull-failures'])
  88. assert 'Pulling simple (busybox:latest)...' in result.stderr
  89. assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
  90. assert 'Error: image library/nonexisting-image:latest not found' in result.stderr
  91. def test_build_plain(self):
  92. self.base_dir = 'tests/fixtures/simple-dockerfile'
  93. self.dispatch(['build', 'simple'])
  94. result = self.dispatch(['build', 'simple'])
  95. assert BUILD_CACHE_TEXT in result.stdout
  96. assert BUILD_PULL_TEXT not in result.stdout
  97. def test_build_no_cache(self):
  98. self.base_dir = 'tests/fixtures/simple-dockerfile'
  99. self.dispatch(['build', 'simple'])
  100. result = self.dispatch(['build', '--no-cache', 'simple'])
  101. assert BUILD_CACHE_TEXT not in result.stdout
  102. assert BUILD_PULL_TEXT not in result.stdout
  103. def test_build_pull(self):
  104. self.base_dir = 'tests/fixtures/simple-dockerfile'
  105. self.dispatch(['build', 'simple'], None)
  106. result = self.dispatch(['build', '--pull', 'simple'])
  107. assert BUILD_CACHE_TEXT in result.stdout
  108. assert BUILD_PULL_TEXT in result.stdout
  109. def test_build_no_cache_pull(self):
  110. self.base_dir = 'tests/fixtures/simple-dockerfile'
  111. self.dispatch(['build', 'simple'])
  112. result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
  113. assert BUILD_CACHE_TEXT not in result.stdout
  114. assert BUILD_PULL_TEXT in result.stdout
  115. def test_up_detached(self):
  116. self.dispatch(['up', '-d'])
  117. service = self.project.get_service('simple')
  118. another = self.project.get_service('another')
  119. self.assertEqual(len(service.containers()), 1)
  120. self.assertEqual(len(another.containers()), 1)
  121. # Ensure containers don't have stdin and stdout connected in -d mode
  122. container, = service.containers()
  123. self.assertFalse(container.get('Config.AttachStderr'))
  124. self.assertFalse(container.get('Config.AttachStdout'))
  125. self.assertFalse(container.get('Config.AttachStdin'))
  126. def test_up_attached(self):
  127. self.base_dir = 'tests/fixtures/echo-services'
  128. result = self.dispatch(['up', '--no-color'])
  129. assert 'simple_1 | simple' in result.stdout
  130. assert 'another_1 | another' in result.stdout
  131. def test_up_without_networking(self):
  132. self.require_api_version('1.21')
  133. self.base_dir = 'tests/fixtures/links-composefile'
  134. self.dispatch(['up', '-d'], None)
  135. client = docker_client(version='1.21')
  136. networks = client.networks(names=[self.project.name])
  137. self.assertEqual(len(networks), 0)
  138. for service in self.project.get_services():
  139. containers = service.containers()
  140. self.assertEqual(len(containers), 1)
  141. self.assertNotEqual(containers[0].get('Config.Hostname'), service.name)
  142. web_container = self.project.get_service('web').containers()[0]
  143. self.assertTrue(web_container.get('HostConfig.Links'))
  144. def test_up_with_networking(self):
  145. self.require_api_version('1.21')
  146. self.base_dir = 'tests/fixtures/links-composefile'
  147. self.dispatch(['--x-networking', 'up', '-d'], None)
  148. client = docker_client(version='1.21')
  149. services = self.project.get_services()
  150. networks = client.networks(names=[self.project.name])
  151. for n in networks:
  152. self.addCleanup(client.remove_network, n['Id'])
  153. self.assertEqual(len(networks), 1)
  154. self.assertEqual(networks[0]['Driver'], 'bridge')
  155. network = client.inspect_network(networks[0]['Id'])
  156. self.assertEqual(len(network['Containers']), len(services))
  157. for service in services:
  158. containers = service.containers()
  159. self.assertEqual(len(containers), 1)
  160. self.assertIn(containers[0].id, network['Containers'])
  161. web_container = self.project.get_service('web').containers()[0]
  162. self.assertFalse(web_container.get('HostConfig.Links'))
  163. def test_up_with_links(self):
  164. self.base_dir = 'tests/fixtures/links-composefile'
  165. self.dispatch(['up', '-d', 'web'], None)
  166. web = self.project.get_service('web')
  167. db = self.project.get_service('db')
  168. console = self.project.get_service('console')
  169. self.assertEqual(len(web.containers()), 1)
  170. self.assertEqual(len(db.containers()), 1)
  171. self.assertEqual(len(console.containers()), 0)
  172. def test_up_with_no_deps(self):
  173. self.base_dir = 'tests/fixtures/links-composefile'
  174. self.dispatch(['up', '-d', '--no-deps', 'web'], None)
  175. web = self.project.get_service('web')
  176. db = self.project.get_service('db')
  177. console = self.project.get_service('console')
  178. self.assertEqual(len(web.containers()), 1)
  179. self.assertEqual(len(db.containers()), 0)
  180. self.assertEqual(len(console.containers()), 0)
  181. def test_up_with_force_recreate(self):
  182. self.dispatch(['up', '-d'], None)
  183. service = self.project.get_service('simple')
  184. self.assertEqual(len(service.containers()), 1)
  185. old_ids = [c.id for c in service.containers()]
  186. self.dispatch(['up', '-d', '--force-recreate'], None)
  187. self.assertEqual(len(service.containers()), 1)
  188. new_ids = [c.id for c in service.containers()]
  189. self.assertNotEqual(old_ids, new_ids)
  190. def test_up_with_no_recreate(self):
  191. self.dispatch(['up', '-d'], None)
  192. service = self.project.get_service('simple')
  193. self.assertEqual(len(service.containers()), 1)
  194. old_ids = [c.id for c in service.containers()]
  195. self.dispatch(['up', '-d', '--no-recreate'], None)
  196. self.assertEqual(len(service.containers()), 1)
  197. new_ids = [c.id for c in service.containers()]
  198. self.assertEqual(old_ids, new_ids)
  199. def test_up_with_force_recreate_and_no_recreate(self):
  200. self.dispatch(
  201. ['up', '-d', '--force-recreate', '--no-recreate'],
  202. returncode=1)
  203. def test_up_with_timeout(self):
  204. self.dispatch(['up', '-d', '-t', '1'], None)
  205. service = self.project.get_service('simple')
  206. another = self.project.get_service('another')
  207. self.assertEqual(len(service.containers()), 1)
  208. self.assertEqual(len(another.containers()), 1)
  209. # Ensure containers don't have stdin and stdout connected in -d mode
  210. config = service.containers()[0].inspect()['Config']
  211. self.assertFalse(config['AttachStderr'])
  212. self.assertFalse(config['AttachStdout'])
  213. self.assertFalse(config['AttachStdin'])
  214. def test_run_service_without_links(self):
  215. self.base_dir = 'tests/fixtures/links-composefile'
  216. self.dispatch(['run', 'console', '/bin/true'])
  217. self.assertEqual(len(self.project.containers()), 0)
  218. # Ensure stdin/out was open
  219. container = self.project.containers(stopped=True, one_off=True)[0]
  220. config = container.inspect()['Config']
  221. self.assertTrue(config['AttachStderr'])
  222. self.assertTrue(config['AttachStdout'])
  223. self.assertTrue(config['AttachStdin'])
  224. def test_run_service_with_links(self):
  225. self.base_dir = 'tests/fixtures/links-composefile'
  226. self.dispatch(['run', 'web', '/bin/true'], None)
  227. db = self.project.get_service('db')
  228. console = self.project.get_service('console')
  229. self.assertEqual(len(db.containers()), 1)
  230. self.assertEqual(len(console.containers()), 0)
  231. def test_run_with_no_deps(self):
  232. self.base_dir = 'tests/fixtures/links-composefile'
  233. self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
  234. db = self.project.get_service('db')
  235. self.assertEqual(len(db.containers()), 0)
  236. def test_run_does_not_recreate_linked_containers(self):
  237. self.base_dir = 'tests/fixtures/links-composefile'
  238. self.dispatch(['up', '-d', 'db'])
  239. db = self.project.get_service('db')
  240. self.assertEqual(len(db.containers()), 1)
  241. old_ids = [c.id for c in db.containers()]
  242. self.dispatch(['run', 'web', '/bin/true'], None)
  243. self.assertEqual(len(db.containers()), 1)
  244. new_ids = [c.id for c in db.containers()]
  245. self.assertEqual(old_ids, new_ids)
  246. def test_run_without_command(self):
  247. self.base_dir = 'tests/fixtures/commands-composefile'
  248. self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
  249. self.dispatch(['run', 'implicit'])
  250. service = self.project.get_service('implicit')
  251. containers = service.containers(stopped=True, one_off=True)
  252. self.assertEqual(
  253. [c.human_readable_command for c in containers],
  254. [u'/bin/sh -c echo "success"'],
  255. )
  256. self.dispatch(['run', 'explicit'])
  257. service = self.project.get_service('explicit')
  258. containers = service.containers(stopped=True, one_off=True)
  259. self.assertEqual(
  260. [c.human_readable_command for c in containers],
  261. [u'/bin/true'],
  262. )
  263. def test_run_service_with_entrypoint_overridden(self):
  264. self.base_dir = 'tests/fixtures/dockerfile_with_entrypoint'
  265. name = 'service'
  266. self.dispatch(['run', '--entrypoint', '/bin/echo', name, 'helloworld'])
  267. service = self.project.get_service(name)
  268. container = service.containers(stopped=True, one_off=True)[0]
  269. self.assertEqual(
  270. shlex.split(container.human_readable_command),
  271. [u'/bin/echo', u'helloworld'],
  272. )
  273. def test_run_service_with_user_overridden(self):
  274. self.base_dir = 'tests/fixtures/user-composefile'
  275. name = 'service'
  276. user = 'sshd'
  277. self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
  278. service = self.project.get_service(name)
  279. container = service.containers(stopped=True, one_off=True)[0]
  280. self.assertEqual(user, container.get('Config.User'))
  281. def test_run_service_with_user_overridden_short_form(self):
  282. self.base_dir = 'tests/fixtures/user-composefile'
  283. name = 'service'
  284. user = 'sshd'
  285. self.dispatch(['run', '-u', user, name], returncode=1)
  286. service = self.project.get_service(name)
  287. container = service.containers(stopped=True, one_off=True)[0]
  288. self.assertEqual(user, container.get('Config.User'))
  289. def test_run_service_with_environement_overridden(self):
  290. name = 'service'
  291. self.base_dir = 'tests/fixtures/environment-composefile'
  292. self.dispatch([
  293. 'run', '-e', 'foo=notbar',
  294. '-e', 'allo=moto=bobo',
  295. '-e', 'alpha=beta',
  296. name,
  297. '/bin/true',
  298. ])
  299. service = self.project.get_service(name)
  300. container = service.containers(stopped=True, one_off=True)[0]
  301. # env overriden
  302. self.assertEqual('notbar', container.environment['foo'])
  303. # keep environement from yaml
  304. self.assertEqual('world', container.environment['hello'])
  305. # added option from command line
  306. self.assertEqual('beta', container.environment['alpha'])
  307. # make sure a value with a = don't crash out
  308. self.assertEqual('moto=bobo', container.environment['allo'])
  309. def test_run_service_without_map_ports(self):
  310. # create one off container
  311. self.base_dir = 'tests/fixtures/ports-composefile'
  312. self.dispatch(['run', '-d', 'simple'])
  313. container = self.project.get_service('simple').containers(one_off=True)[0]
  314. # get port information
  315. port_random = container.get_local_port(3000)
  316. port_assigned = container.get_local_port(3001)
  317. # close all one off containers we just created
  318. container.stop()
  319. # check the ports
  320. self.assertEqual(port_random, None)
  321. self.assertEqual(port_assigned, None)
  322. def test_run_service_with_map_ports(self):
  323. # create one off container
  324. self.base_dir = 'tests/fixtures/ports-composefile'
  325. self.dispatch(['run', '-d', '--service-ports', 'simple'])
  326. container = self.project.get_service('simple').containers(one_off=True)[0]
  327. # get port information
  328. port_random = container.get_local_port(3000)
  329. port_assigned = container.get_local_port(3001)
  330. port_range = container.get_local_port(3002), container.get_local_port(3003)
  331. # close all one off containers we just created
  332. container.stop()
  333. # check the ports
  334. self.assertNotEqual(port_random, None)
  335. self.assertIn("0.0.0.0", port_random)
  336. self.assertEqual(port_assigned, "0.0.0.0:49152")
  337. self.assertEqual(port_range[0], "0.0.0.0:49153")
  338. self.assertEqual(port_range[1], "0.0.0.0:49154")
  339. def test_run_service_with_explicitly_maped_ports(self):
  340. # create one off container
  341. self.base_dir = 'tests/fixtures/ports-composefile'
  342. self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
  343. container = self.project.get_service('simple').containers(one_off=True)[0]
  344. # get port information
  345. port_short = container.get_local_port(3000)
  346. port_full = container.get_local_port(3001)
  347. # close all one off containers we just created
  348. container.stop()
  349. # check the ports
  350. self.assertEqual(port_short, "0.0.0.0:30000")
  351. self.assertEqual(port_full, "0.0.0.0:30001")
  352. def test_run_service_with_explicitly_maped_ip_ports(self):
  353. # create one off container
  354. self.base_dir = 'tests/fixtures/ports-composefile'
  355. self.dispatch(['run', '-d', '-p', '127.0.0.1:30000:3000', '--publish', '127.0.0.1:30001:3001', 'simple'], None)
  356. container = self.project.get_service('simple').containers(one_off=True)[0]
  357. # get port information
  358. port_short = container.get_local_port(3000)
  359. port_full = container.get_local_port(3001)
  360. # close all one off containers we just created
  361. container.stop()
  362. # check the ports
  363. self.assertEqual(port_short, "127.0.0.1:30000")
  364. self.assertEqual(port_full, "127.0.0.1:30001")
  365. def test_run_with_custom_name(self):
  366. self.base_dir = 'tests/fixtures/environment-composefile'
  367. name = 'the-container-name'
  368. self.dispatch(['run', '--name', name, 'service', '/bin/true'])
  369. service = self.project.get_service('service')
  370. container, = service.containers(stopped=True, one_off=True)
  371. self.assertEqual(container.name, name)
  372. def test_run_with_networking(self):
  373. self.require_api_version('1.21')
  374. client = docker_client(version='1.21')
  375. self.base_dir = 'tests/fixtures/simple-dockerfile'
  376. self.dispatch(['--x-networking', 'run', 'simple', 'true'], None)
  377. service = self.project.get_service('simple')
  378. container, = service.containers(stopped=True, one_off=True)
  379. networks = client.networks(names=[self.project.name])
  380. for n in networks:
  381. self.addCleanup(client.remove_network, n['Id'])
  382. self.assertEqual(len(networks), 1)
  383. self.assertEqual(container.human_readable_command, u'true')
  384. def test_rm(self):
  385. service = self.project.get_service('simple')
  386. service.create_container()
  387. service.kill()
  388. self.assertEqual(len(service.containers(stopped=True)), 1)
  389. self.dispatch(['rm', '--force'], None)
  390. self.assertEqual(len(service.containers(stopped=True)), 0)
  391. service = self.project.get_service('simple')
  392. service.create_container()
  393. service.kill()
  394. self.assertEqual(len(service.containers(stopped=True)), 1)
  395. self.dispatch(['rm', '-f'], None)
  396. self.assertEqual(len(service.containers(stopped=True)), 0)
  397. def test_stop(self):
  398. self.dispatch(['up', '-d'], None)
  399. service = self.project.get_service('simple')
  400. self.assertEqual(len(service.containers()), 1)
  401. self.assertTrue(service.containers()[0].is_running)
  402. self.dispatch(['stop', '-t', '1'], None)
  403. self.assertEqual(len(service.containers(stopped=True)), 1)
  404. self.assertFalse(service.containers(stopped=True)[0].is_running)
  405. def test_pause_unpause(self):
  406. self.dispatch(['up', '-d'], None)
  407. service = self.project.get_service('simple')
  408. self.assertFalse(service.containers()[0].is_paused)
  409. self.dispatch(['pause'], None)
  410. self.assertTrue(service.containers()[0].is_paused)
  411. self.dispatch(['unpause'], None)
  412. self.assertFalse(service.containers()[0].is_paused)
  413. def test_logs_invalid_service_name(self):
  414. self.dispatch(['logs', 'madeupname'], returncode=1)
  415. def test_kill(self):
  416. self.dispatch(['up', '-d'], None)
  417. service = self.project.get_service('simple')
  418. self.assertEqual(len(service.containers()), 1)
  419. self.assertTrue(service.containers()[0].is_running)
  420. self.dispatch(['kill'], None)
  421. self.assertEqual(len(service.containers(stopped=True)), 1)
  422. self.assertFalse(service.containers(stopped=True)[0].is_running)
  423. def test_kill_signal_sigstop(self):
  424. self.dispatch(['up', '-d'], None)
  425. service = self.project.get_service('simple')
  426. self.assertEqual(len(service.containers()), 1)
  427. self.assertTrue(service.containers()[0].is_running)
  428. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  429. self.assertEqual(len(service.containers()), 1)
  430. # The container is still running. It has only been paused
  431. self.assertTrue(service.containers()[0].is_running)
  432. def test_kill_stopped_service(self):
  433. self.dispatch(['up', '-d'], None)
  434. service = self.project.get_service('simple')
  435. self.dispatch(['kill', '-s', 'SIGSTOP'], None)
  436. self.assertTrue(service.containers()[0].is_running)
  437. self.dispatch(['kill', '-s', 'SIGKILL'], None)
  438. self.assertEqual(len(service.containers(stopped=True)), 1)
  439. self.assertFalse(service.containers(stopped=True)[0].is_running)
  440. def test_restart(self):
  441. service = self.project.get_service('simple')
  442. container = service.create_container()
  443. container.start()
  444. started_at = container.dictionary['State']['StartedAt']
  445. self.dispatch(['restart', '-t', '1'], None)
  446. container.inspect()
  447. self.assertNotEqual(
  448. container.dictionary['State']['FinishedAt'],
  449. '0001-01-01T00:00:00Z',
  450. )
  451. self.assertNotEqual(
  452. container.dictionary['State']['StartedAt'],
  453. started_at,
  454. )
  455. def test_scale(self):
  456. project = self.project
  457. self.dispatch(['scale', 'simple=1'])
  458. self.assertEqual(len(project.get_service('simple').containers()), 1)
  459. self.dispatch(['scale', 'simple=3', 'another=2'])
  460. self.assertEqual(len(project.get_service('simple').containers()), 3)
  461. self.assertEqual(len(project.get_service('another').containers()), 2)
  462. self.dispatch(['scale', 'simple=1', 'another=1'])
  463. self.assertEqual(len(project.get_service('simple').containers()), 1)
  464. self.assertEqual(len(project.get_service('another').containers()), 1)
  465. self.dispatch(['scale', 'simple=1', 'another=1'])
  466. self.assertEqual(len(project.get_service('simple').containers()), 1)
  467. self.assertEqual(len(project.get_service('another').containers()), 1)
  468. self.dispatch(['scale', 'simple=0', 'another=0'])
  469. self.assertEqual(len(project.get_service('simple').containers()), 0)
  470. self.assertEqual(len(project.get_service('another').containers()), 0)
  471. def test_port(self):
  472. self.base_dir = 'tests/fixtures/ports-composefile'
  473. self.dispatch(['up', '-d'], None)
  474. container = self.project.get_service('simple').get_container()
  475. def get_port(number):
  476. result = self.dispatch(['port', 'simple', str(number)])
  477. return result.stdout.rstrip()
  478. self.assertEqual(get_port(3000), container.get_local_port(3000))
  479. self.assertEqual(get_port(3001), "0.0.0.0:49152")
  480. self.assertEqual(get_port(3002), "0.0.0.0:49153")
  481. def test_port_with_scale(self):
  482. self.base_dir = 'tests/fixtures/ports-composefile-scale'
  483. self.dispatch(['scale', 'simple=2'], None)
  484. containers = sorted(
  485. self.project.containers(service_names=['simple']),
  486. key=attrgetter('name'))
  487. def get_port(number, index=None):
  488. if index is None:
  489. result = self.dispatch(['port', 'simple', str(number)])
  490. else:
  491. result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
  492. return result.stdout.rstrip()
  493. self.assertEqual(get_port(3000), containers[0].get_local_port(3000))
  494. self.assertEqual(get_port(3000, index=1), containers[0].get_local_port(3000))
  495. self.assertEqual(get_port(3000, index=2), containers[1].get_local_port(3000))
  496. self.assertEqual(get_port(3002), "")
  497. def test_env_file_relative_to_compose_file(self):
  498. config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
  499. self.dispatch(['-f', config_path, 'up', '-d'], None)
  500. self._project = get_project(self.base_dir, [config_path])
  501. containers = self.project.containers(stopped=True)
  502. self.assertEqual(len(containers), 1)
  503. self.assertIn("FOO=1", containers[0].get('Config.Env'))
  504. @mock.patch.dict(os.environ)
  505. def test_home_and_env_var_in_volume_path(self):
  506. os.environ['VOLUME_NAME'] = 'my-volume'
  507. os.environ['HOME'] = '/tmp/home-dir'
  508. self.base_dir = 'tests/fixtures/volume-path-interpolation'
  509. self.dispatch(['up', '-d'], None)
  510. container = self.project.containers(stopped=True)[0]
  511. actual_host_path = container.get('Volumes')['/container-path']
  512. components = actual_host_path.split('/')
  513. assert components[-2:] == ['home-dir', 'my-volume']
  514. def test_up_with_default_override_file(self):
  515. self.base_dir = 'tests/fixtures/override-files'
  516. self.dispatch(['up', '-d'], None)
  517. containers = self.project.containers()
  518. self.assertEqual(len(containers), 2)
  519. web, db = containers
  520. self.assertEqual(web.human_readable_command, 'top')
  521. self.assertEqual(db.human_readable_command, 'top')
  522. def test_up_with_multiple_files(self):
  523. self.base_dir = 'tests/fixtures/override-files'
  524. config_paths = [
  525. 'docker-compose.yml',
  526. 'docker-compose.override.yml',
  527. 'extra.yml',
  528. ]
  529. self._project = get_project(self.base_dir, config_paths)
  530. self.dispatch(
  531. [
  532. '-f', config_paths[0],
  533. '-f', config_paths[1],
  534. '-f', config_paths[2],
  535. 'up', '-d',
  536. ],
  537. None)
  538. containers = self.project.containers()
  539. self.assertEqual(len(containers), 3)
  540. web, other, db = containers
  541. self.assertEqual(web.human_readable_command, 'top')
  542. self.assertTrue({'db', 'other'} <= set(web.links()))
  543. self.assertEqual(db.human_readable_command, 'top')
  544. self.assertEqual(other.human_readable_command, 'top')
  545. def test_up_with_extends(self):
  546. self.base_dir = 'tests/fixtures/extends'
  547. self.dispatch(['up', '-d'], None)
  548. self.assertEqual(
  549. set([s.name for s in self.project.services]),
  550. set(['mydb', 'myweb']),
  551. )
  552. # Sort by name so we get [db, web]
  553. containers = sorted(
  554. self.project.containers(stopped=True),
  555. key=lambda c: c.name,
  556. )
  557. self.assertEqual(len(containers), 2)
  558. web = containers[1]
  559. self.assertEqual(set(web.links()), set(['db', 'mydb_1', 'extends_mydb_1']))
  560. expected_env = set([
  561. "FOO=1",
  562. "BAR=2",
  563. "BAZ=2",
  564. ])
  565. self.assertTrue(expected_env <= set(web.get('Config.Env')))