cli_test.py 29 KB

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