cli_test.py 32 KB

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