cli_test.py 30 KB

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