cli_test.py 33 KB

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