cli_test.py 32 KB

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