cli_test.py 28 KB

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