project_test.py 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import random
  4. import py
  5. import pytest
  6. from docker.errors import NotFound
  7. from .. import mock
  8. from ..helpers import build_config
  9. from .testcases import DockerClientTestCase
  10. from compose.config import config
  11. from compose.config import ConfigurationError
  12. from compose.config.config import V2_0
  13. from compose.config.config import V2_1
  14. from compose.config.types import VolumeFromSpec
  15. from compose.config.types import VolumeSpec
  16. from compose.const import LABEL_PROJECT
  17. from compose.const import LABEL_SERVICE
  18. from compose.container import Container
  19. from compose.project import Project
  20. from compose.project import ProjectError
  21. from compose.service import ConvergenceStrategy
  22. from tests.integration.testcases import v2_1_only
  23. from tests.integration.testcases import v2_only
  24. class ProjectTest(DockerClientTestCase):
  25. def test_containers(self):
  26. web = self.create_service('web')
  27. db = self.create_service('db')
  28. project = Project('composetest', [web, db], self.client)
  29. project.up()
  30. containers = project.containers()
  31. self.assertEqual(len(containers), 2)
  32. def test_containers_with_service_names(self):
  33. web = self.create_service('web')
  34. db = self.create_service('db')
  35. project = Project('composetest', [web, db], self.client)
  36. project.up()
  37. containers = project.containers(['web'])
  38. self.assertEqual(
  39. [c.name for c in containers],
  40. ['composetest_web_1'])
  41. def test_containers_with_extra_service(self):
  42. web = self.create_service('web')
  43. web_1 = web.create_container()
  44. db = self.create_service('db')
  45. db_1 = db.create_container()
  46. self.create_service('extra').create_container()
  47. project = Project('composetest', [web, db], self.client)
  48. self.assertEqual(
  49. set(project.containers(stopped=True)),
  50. set([web_1, db_1]),
  51. )
  52. def test_volumes_from_service(self):
  53. project = Project.from_config(
  54. name='composetest',
  55. config_data=build_config({
  56. 'data': {
  57. 'image': 'busybox:latest',
  58. 'volumes': ['/var/data'],
  59. },
  60. 'db': {
  61. 'image': 'busybox:latest',
  62. 'volumes_from': ['data'],
  63. },
  64. }),
  65. client=self.client,
  66. )
  67. db = project.get_service('db')
  68. data = project.get_service('data')
  69. self.assertEqual(db.volumes_from, [VolumeFromSpec(data, 'rw', 'service')])
  70. def test_volumes_from_container(self):
  71. data_container = Container.create(
  72. self.client,
  73. image='busybox:latest',
  74. volumes=['/var/data'],
  75. name='composetest_data_container',
  76. labels={LABEL_PROJECT: 'composetest'},
  77. )
  78. project = Project.from_config(
  79. name='composetest',
  80. config_data=build_config({
  81. 'db': {
  82. 'image': 'busybox:latest',
  83. 'volumes_from': ['composetest_data_container'],
  84. },
  85. }),
  86. client=self.client,
  87. )
  88. db = project.get_service('db')
  89. self.assertEqual(db._get_volumes_from(), [data_container.id + ':rw'])
  90. @v2_only()
  91. def test_network_mode_from_service(self):
  92. project = Project.from_config(
  93. name='composetest',
  94. client=self.client,
  95. config_data=build_config({
  96. 'version': V2_0,
  97. 'services': {
  98. 'net': {
  99. 'image': 'busybox:latest',
  100. 'command': ["top"]
  101. },
  102. 'web': {
  103. 'image': 'busybox:latest',
  104. 'network_mode': 'service:net',
  105. 'command': ["top"]
  106. },
  107. },
  108. }),
  109. )
  110. project.up()
  111. web = project.get_service('web')
  112. net = project.get_service('net')
  113. self.assertEqual(web.network_mode.mode, 'container:' + net.containers()[0].id)
  114. @v2_only()
  115. def test_network_mode_from_container(self):
  116. def get_project():
  117. return Project.from_config(
  118. name='composetest',
  119. config_data=build_config({
  120. 'version': V2_0,
  121. 'services': {
  122. 'web': {
  123. 'image': 'busybox:latest',
  124. 'network_mode': 'container:composetest_net_container'
  125. },
  126. },
  127. }),
  128. client=self.client,
  129. )
  130. with pytest.raises(ConfigurationError) as excinfo:
  131. get_project()
  132. assert "container 'composetest_net_container' which does not exist" in excinfo.exconly()
  133. net_container = Container.create(
  134. self.client,
  135. image='busybox:latest',
  136. name='composetest_net_container',
  137. command='top',
  138. labels={LABEL_PROJECT: 'composetest'},
  139. )
  140. net_container.start()
  141. project = get_project()
  142. project.up()
  143. web = project.get_service('web')
  144. self.assertEqual(web.network_mode.mode, 'container:' + net_container.id)
  145. def test_net_from_service_v1(self):
  146. project = Project.from_config(
  147. name='composetest',
  148. config_data=build_config({
  149. 'net': {
  150. 'image': 'busybox:latest',
  151. 'command': ["top"]
  152. },
  153. 'web': {
  154. 'image': 'busybox:latest',
  155. 'net': 'container:net',
  156. 'command': ["top"]
  157. },
  158. }),
  159. client=self.client,
  160. )
  161. project.up()
  162. web = project.get_service('web')
  163. net = project.get_service('net')
  164. self.assertEqual(web.network_mode.mode, 'container:' + net.containers()[0].id)
  165. def test_net_from_container_v1(self):
  166. def get_project():
  167. return Project.from_config(
  168. name='composetest',
  169. config_data=build_config({
  170. 'web': {
  171. 'image': 'busybox:latest',
  172. 'net': 'container:composetest_net_container'
  173. },
  174. }),
  175. client=self.client,
  176. )
  177. with pytest.raises(ConfigurationError) as excinfo:
  178. get_project()
  179. assert "container 'composetest_net_container' which does not exist" in excinfo.exconly()
  180. net_container = Container.create(
  181. self.client,
  182. image='busybox:latest',
  183. name='composetest_net_container',
  184. command='top',
  185. labels={LABEL_PROJECT: 'composetest'},
  186. )
  187. net_container.start()
  188. project = get_project()
  189. project.up()
  190. web = project.get_service('web')
  191. self.assertEqual(web.network_mode.mode, 'container:' + net_container.id)
  192. def test_start_pause_unpause_stop_kill_remove(self):
  193. web = self.create_service('web')
  194. db = self.create_service('db')
  195. project = Project('composetest', [web, db], self.client)
  196. project.start()
  197. self.assertEqual(len(web.containers()), 0)
  198. self.assertEqual(len(db.containers()), 0)
  199. web_container_1 = web.create_container()
  200. web_container_2 = web.create_container()
  201. db_container = db.create_container()
  202. project.start(service_names=['web'])
  203. self.assertEqual(
  204. set(c.name for c in project.containers()),
  205. set([web_container_1.name, web_container_2.name]))
  206. project.start()
  207. self.assertEqual(
  208. set(c.name for c in project.containers()),
  209. set([web_container_1.name, web_container_2.name, db_container.name]))
  210. project.pause(service_names=['web'])
  211. self.assertEqual(
  212. set([c.name for c in project.containers() if c.is_paused]),
  213. set([web_container_1.name, web_container_2.name]))
  214. project.pause()
  215. self.assertEqual(
  216. set([c.name for c in project.containers() if c.is_paused]),
  217. set([web_container_1.name, web_container_2.name, db_container.name]))
  218. project.unpause(service_names=['db'])
  219. self.assertEqual(len([c.name for c in project.containers() if c.is_paused]), 2)
  220. project.unpause()
  221. self.assertEqual(len([c.name for c in project.containers() if c.is_paused]), 0)
  222. project.stop(service_names=['web'], timeout=1)
  223. self.assertEqual(set(c.name for c in project.containers()), set([db_container.name]))
  224. project.kill(service_names=['db'])
  225. self.assertEqual(len(project.containers()), 0)
  226. self.assertEqual(len(project.containers(stopped=True)), 3)
  227. project.remove_stopped(service_names=['web'])
  228. self.assertEqual(len(project.containers(stopped=True)), 1)
  229. project.remove_stopped()
  230. self.assertEqual(len(project.containers(stopped=True)), 0)
  231. def test_create(self):
  232. web = self.create_service('web')
  233. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  234. project = Project('composetest', [web, db], self.client)
  235. project.create(['db'])
  236. self.assertEqual(len(project.containers()), 0)
  237. self.assertEqual(len(project.containers(stopped=True)), 1)
  238. self.assertEqual(len(db.containers()), 0)
  239. self.assertEqual(len(db.containers(stopped=True)), 1)
  240. self.assertEqual(len(web.containers(stopped=True)), 0)
  241. def test_create_twice(self):
  242. web = self.create_service('web')
  243. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  244. project = Project('composetest', [web, db], self.client)
  245. project.create(['db', 'web'])
  246. project.create(['db', 'web'])
  247. self.assertEqual(len(project.containers()), 0)
  248. self.assertEqual(len(project.containers(stopped=True)), 2)
  249. self.assertEqual(len(db.containers()), 0)
  250. self.assertEqual(len(db.containers(stopped=True)), 1)
  251. self.assertEqual(len(web.containers()), 0)
  252. self.assertEqual(len(web.containers(stopped=True)), 1)
  253. def test_create_with_links(self):
  254. db = self.create_service('db')
  255. web = self.create_service('web', links=[(db, 'db')])
  256. project = Project('composetest', [db, web], self.client)
  257. project.create(['web'])
  258. self.assertEqual(len(project.containers()), 0)
  259. self.assertEqual(len(project.containers(stopped=True)), 2)
  260. self.assertEqual(len(db.containers()), 0)
  261. self.assertEqual(len(db.containers(stopped=True)), 1)
  262. self.assertEqual(len(web.containers()), 0)
  263. self.assertEqual(len(web.containers(stopped=True)), 1)
  264. def test_create_strategy_always(self):
  265. db = self.create_service('db')
  266. project = Project('composetest', [db], self.client)
  267. project.create(['db'])
  268. old_id = project.containers(stopped=True)[0].id
  269. project.create(['db'], strategy=ConvergenceStrategy.always)
  270. self.assertEqual(len(project.containers()), 0)
  271. self.assertEqual(len(project.containers(stopped=True)), 1)
  272. db_container = project.containers(stopped=True)[0]
  273. self.assertNotEqual(db_container.id, old_id)
  274. def test_create_strategy_never(self):
  275. db = self.create_service('db')
  276. project = Project('composetest', [db], self.client)
  277. project.create(['db'])
  278. old_id = project.containers(stopped=True)[0].id
  279. project.create(['db'], strategy=ConvergenceStrategy.never)
  280. self.assertEqual(len(project.containers()), 0)
  281. self.assertEqual(len(project.containers(stopped=True)), 1)
  282. db_container = project.containers(stopped=True)[0]
  283. self.assertEqual(db_container.id, old_id)
  284. def test_project_up(self):
  285. web = self.create_service('web')
  286. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  287. project = Project('composetest', [web, db], self.client)
  288. project.start()
  289. self.assertEqual(len(project.containers()), 0)
  290. project.up(['db'])
  291. self.assertEqual(len(project.containers()), 1)
  292. self.assertEqual(len(db.containers()), 1)
  293. self.assertEqual(len(web.containers()), 0)
  294. def test_project_up_starts_uncreated_services(self):
  295. db = self.create_service('db')
  296. web = self.create_service('web', links=[(db, 'db')])
  297. project = Project('composetest', [db, web], self.client)
  298. project.up(['db'])
  299. self.assertEqual(len(project.containers()), 1)
  300. project.up()
  301. self.assertEqual(len(project.containers()), 2)
  302. self.assertEqual(len(db.containers()), 1)
  303. self.assertEqual(len(web.containers()), 1)
  304. def test_recreate_preserves_volumes(self):
  305. web = self.create_service('web')
  306. db = self.create_service('db', volumes=[VolumeSpec.parse('/etc')])
  307. project = Project('composetest', [web, db], self.client)
  308. project.start()
  309. self.assertEqual(len(project.containers()), 0)
  310. project.up(['db'])
  311. self.assertEqual(len(project.containers()), 1)
  312. old_db_id = project.containers()[0].id
  313. db_volume_path = project.containers()[0].get('Volumes./etc')
  314. project.up(strategy=ConvergenceStrategy.always)
  315. self.assertEqual(len(project.containers()), 2)
  316. db_container = [c for c in project.containers() if 'db' in c.name][0]
  317. self.assertNotEqual(db_container.id, old_db_id)
  318. self.assertEqual(db_container.get('Volumes./etc'), db_volume_path)
  319. def test_project_up_with_no_recreate_running(self):
  320. web = self.create_service('web')
  321. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  322. project = Project('composetest', [web, db], self.client)
  323. project.start()
  324. self.assertEqual(len(project.containers()), 0)
  325. project.up(['db'])
  326. self.assertEqual(len(project.containers()), 1)
  327. old_db_id = project.containers()[0].id
  328. container, = project.containers()
  329. db_volume_path = container.get_mount('/var/db')['Source']
  330. project.up(strategy=ConvergenceStrategy.never)
  331. self.assertEqual(len(project.containers()), 2)
  332. db_container = [c for c in project.containers() if 'db' in c.name][0]
  333. self.assertEqual(db_container.id, old_db_id)
  334. self.assertEqual(
  335. db_container.get_mount('/var/db')['Source'],
  336. db_volume_path)
  337. def test_project_up_with_no_recreate_stopped(self):
  338. web = self.create_service('web')
  339. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  340. project = Project('composetest', [web, db], self.client)
  341. project.start()
  342. self.assertEqual(len(project.containers()), 0)
  343. project.up(['db'])
  344. project.kill()
  345. old_containers = project.containers(stopped=True)
  346. self.assertEqual(len(old_containers), 1)
  347. old_container, = old_containers
  348. old_db_id = old_container.id
  349. db_volume_path = old_container.get_mount('/var/db')['Source']
  350. project.up(strategy=ConvergenceStrategy.never)
  351. new_containers = project.containers(stopped=True)
  352. self.assertEqual(len(new_containers), 2)
  353. self.assertEqual([c.is_running for c in new_containers], [True, True])
  354. db_container = [c for c in new_containers if 'db' in c.name][0]
  355. self.assertEqual(db_container.id, old_db_id)
  356. self.assertEqual(
  357. db_container.get_mount('/var/db')['Source'],
  358. db_volume_path)
  359. def test_project_up_without_all_services(self):
  360. console = self.create_service('console')
  361. db = self.create_service('db')
  362. project = Project('composetest', [console, db], self.client)
  363. project.start()
  364. self.assertEqual(len(project.containers()), 0)
  365. project.up()
  366. self.assertEqual(len(project.containers()), 2)
  367. self.assertEqual(len(db.containers()), 1)
  368. self.assertEqual(len(console.containers()), 1)
  369. def test_project_up_starts_links(self):
  370. console = self.create_service('console')
  371. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  372. web = self.create_service('web', links=[(db, 'db')])
  373. project = Project('composetest', [web, db, console], self.client)
  374. project.start()
  375. self.assertEqual(len(project.containers()), 0)
  376. project.up(['web'])
  377. self.assertEqual(len(project.containers()), 2)
  378. self.assertEqual(len(web.containers()), 1)
  379. self.assertEqual(len(db.containers()), 1)
  380. self.assertEqual(len(console.containers()), 0)
  381. def test_project_up_starts_depends(self):
  382. project = Project.from_config(
  383. name='composetest',
  384. config_data=build_config({
  385. 'console': {
  386. 'image': 'busybox:latest',
  387. 'command': ["top"],
  388. },
  389. 'data': {
  390. 'image': 'busybox:latest',
  391. 'command': ["top"]
  392. },
  393. 'db': {
  394. 'image': 'busybox:latest',
  395. 'command': ["top"],
  396. 'volumes_from': ['data'],
  397. },
  398. 'web': {
  399. 'image': 'busybox:latest',
  400. 'command': ["top"],
  401. 'links': ['db'],
  402. },
  403. }),
  404. client=self.client,
  405. )
  406. project.start()
  407. self.assertEqual(len(project.containers()), 0)
  408. project.up(['web'])
  409. self.assertEqual(len(project.containers()), 3)
  410. self.assertEqual(len(project.get_service('web').containers()), 1)
  411. self.assertEqual(len(project.get_service('db').containers()), 1)
  412. self.assertEqual(len(project.get_service('data').containers()), 1)
  413. self.assertEqual(len(project.get_service('console').containers()), 0)
  414. def test_project_up_with_no_deps(self):
  415. project = Project.from_config(
  416. name='composetest',
  417. config_data=build_config({
  418. 'console': {
  419. 'image': 'busybox:latest',
  420. 'command': ["top"],
  421. },
  422. 'data': {
  423. 'image': 'busybox:latest',
  424. 'command': ["top"]
  425. },
  426. 'db': {
  427. 'image': 'busybox:latest',
  428. 'command': ["top"],
  429. 'volumes_from': ['data'],
  430. },
  431. 'web': {
  432. 'image': 'busybox:latest',
  433. 'command': ["top"],
  434. 'links': ['db'],
  435. },
  436. }),
  437. client=self.client,
  438. )
  439. project.start()
  440. self.assertEqual(len(project.containers()), 0)
  441. project.up(['db'], start_deps=False)
  442. self.assertEqual(len(project.containers(stopped=True)), 2)
  443. self.assertEqual(len(project.get_service('web').containers()), 0)
  444. self.assertEqual(len(project.get_service('db').containers()), 1)
  445. self.assertEqual(len(project.get_service('data').containers()), 0)
  446. self.assertEqual(len(project.get_service('data').containers(stopped=True)), 1)
  447. self.assertEqual(len(project.get_service('console').containers()), 0)
  448. def test_unscale_after_restart(self):
  449. web = self.create_service('web')
  450. project = Project('composetest', [web], self.client)
  451. project.start()
  452. service = project.get_service('web')
  453. service.scale(1)
  454. self.assertEqual(len(service.containers()), 1)
  455. service.scale(3)
  456. self.assertEqual(len(service.containers()), 3)
  457. project.up()
  458. service = project.get_service('web')
  459. self.assertEqual(len(service.containers()), 3)
  460. service.scale(1)
  461. self.assertEqual(len(service.containers()), 1)
  462. project.up()
  463. service = project.get_service('web')
  464. self.assertEqual(len(service.containers()), 1)
  465. # does scale=0 ,makes any sense? after recreating at least 1 container is running
  466. service.scale(0)
  467. project.up()
  468. service = project.get_service('web')
  469. self.assertEqual(len(service.containers()), 1)
  470. @v2_only()
  471. def test_project_up_networks(self):
  472. config_data = config.Config(
  473. version=V2_0,
  474. services=[{
  475. 'name': 'web',
  476. 'image': 'busybox:latest',
  477. 'command': 'top',
  478. 'networks': {
  479. 'foo': None,
  480. 'bar': None,
  481. 'baz': {'aliases': ['extra']},
  482. },
  483. }],
  484. volumes={},
  485. networks={
  486. 'foo': {'driver': 'bridge'},
  487. 'bar': {'driver': None},
  488. 'baz': {},
  489. },
  490. )
  491. project = Project.from_config(
  492. client=self.client,
  493. name='composetest',
  494. config_data=config_data,
  495. )
  496. project.up()
  497. containers = project.containers()
  498. assert len(containers) == 1
  499. container, = containers
  500. for net_name in ['foo', 'bar', 'baz']:
  501. full_net_name = 'composetest_{}'.format(net_name)
  502. network_data = self.client.inspect_network(full_net_name)
  503. assert network_data['Name'] == full_net_name
  504. aliases_key = 'NetworkSettings.Networks.{net}.Aliases'
  505. assert 'web' in container.get(aliases_key.format(net='composetest_foo'))
  506. assert 'web' in container.get(aliases_key.format(net='composetest_baz'))
  507. assert 'extra' in container.get(aliases_key.format(net='composetest_baz'))
  508. foo_data = self.client.inspect_network('composetest_foo')
  509. assert foo_data['Driver'] == 'bridge'
  510. @v2_only()
  511. def test_up_with_ipam_config(self):
  512. config_data = config.Config(
  513. version=V2_0,
  514. services=[{
  515. 'name': 'web',
  516. 'image': 'busybox:latest',
  517. 'networks': {'front': None},
  518. }],
  519. volumes={},
  520. networks={
  521. 'front': {
  522. 'driver': 'bridge',
  523. 'driver_opts': {
  524. "com.docker.network.bridge.enable_icc": "false",
  525. },
  526. 'ipam': {
  527. 'driver': 'default',
  528. 'config': [{
  529. "subnet": "172.28.0.0/16",
  530. "ip_range": "172.28.5.0/24",
  531. "gateway": "172.28.5.254",
  532. "aux_addresses": {
  533. "a": "172.28.1.5",
  534. "b": "172.28.1.6",
  535. "c": "172.28.1.7",
  536. },
  537. }],
  538. },
  539. },
  540. },
  541. )
  542. project = Project.from_config(
  543. client=self.client,
  544. name='composetest',
  545. config_data=config_data,
  546. )
  547. project.up()
  548. network = self.client.networks(names=['composetest_front'])[0]
  549. assert network['Options'] == {
  550. "com.docker.network.bridge.enable_icc": "false"
  551. }
  552. assert network['IPAM'] == {
  553. 'Driver': 'default',
  554. 'Options': None,
  555. 'Config': [{
  556. 'Subnet': "172.28.0.0/16",
  557. 'IPRange': "172.28.5.0/24",
  558. 'Gateway': "172.28.5.254",
  559. 'AuxiliaryAddresses': {
  560. 'a': '172.28.1.5',
  561. 'b': '172.28.1.6',
  562. 'c': '172.28.1.7',
  563. },
  564. }],
  565. }
  566. @v2_only()
  567. def test_up_with_network_static_addresses(self):
  568. config_data = config.Config(
  569. version=V2_0,
  570. services=[{
  571. 'name': 'web',
  572. 'image': 'busybox:latest',
  573. 'command': 'top',
  574. 'networks': {
  575. 'static_test': {
  576. 'ipv4_address': '172.16.100.100',
  577. 'ipv6_address': 'fe80::1001:102'
  578. }
  579. },
  580. }],
  581. volumes={},
  582. networks={
  583. 'static_test': {
  584. 'driver': 'bridge',
  585. 'driver_opts': {
  586. "com.docker.network.enable_ipv6": "true",
  587. },
  588. 'ipam': {
  589. 'driver': 'default',
  590. 'config': [
  591. {"subnet": "172.16.100.0/24",
  592. "gateway": "172.16.100.1"},
  593. {"subnet": "fe80::/64",
  594. "gateway": "fe80::1001:1"}
  595. ]
  596. }
  597. }
  598. }
  599. )
  600. project = Project.from_config(
  601. client=self.client,
  602. name='composetest',
  603. config_data=config_data,
  604. )
  605. project.up(detached=True)
  606. network = self.client.networks(names=['static_test'])[0]
  607. service_container = project.get_service('web').containers()[0]
  608. assert network['Options'] == {
  609. "com.docker.network.enable_ipv6": "true"
  610. }
  611. IPAMConfig = (service_container.inspect().get('NetworkSettings', {}).
  612. get('Networks', {}).get('composetest_static_test', {}).
  613. get('IPAMConfig', {}))
  614. assert IPAMConfig.get('IPv4Address') == '172.16.100.100'
  615. assert IPAMConfig.get('IPv6Address') == 'fe80::1001:102'
  616. @v2_only()
  617. def test_up_with_network_static_addresses_missing_subnet(self):
  618. config_data = config.Config(
  619. version=V2_0,
  620. services=[{
  621. 'name': 'web',
  622. 'image': 'busybox:latest',
  623. 'networks': {
  624. 'static_test': {
  625. 'ipv4_address': '172.16.100.100',
  626. 'ipv6_address': 'fe80::1001:101'
  627. }
  628. },
  629. }],
  630. volumes={},
  631. networks={
  632. 'static_test': {
  633. 'driver': 'bridge',
  634. 'driver_opts': {
  635. "com.docker.network.enable_ipv6": "true",
  636. },
  637. 'ipam': {
  638. 'driver': 'default',
  639. },
  640. },
  641. },
  642. )
  643. project = Project.from_config(
  644. client=self.client,
  645. name='composetest',
  646. config_data=config_data,
  647. )
  648. with self.assertRaises(ProjectError):
  649. project.up()
  650. @v2_1_only()
  651. def test_up_with_network_link_local_ips(self):
  652. config_data = config.Config(
  653. version=V2_1,
  654. services=[{
  655. 'name': 'web',
  656. 'image': 'busybox:latest',
  657. 'networks': {
  658. 'linklocaltest': {
  659. 'link_local_ips': ['169.254.8.8']
  660. }
  661. }
  662. }],
  663. volumes={},
  664. networks={
  665. 'linklocaltest': {'driver': 'bridge'}
  666. }
  667. )
  668. project = Project.from_config(
  669. client=self.client,
  670. name='composetest',
  671. config_data=config_data
  672. )
  673. project.up()
  674. service_container = project.get_service('web').containers()[0]
  675. ipam_config = service_container.inspect().get(
  676. 'NetworkSettings', {}
  677. ).get(
  678. 'Networks', {}
  679. ).get(
  680. 'composetest_linklocaltest', {}
  681. ).get('IPAMConfig', {})
  682. assert 'LinkLocalIPs' in ipam_config
  683. assert ipam_config['LinkLocalIPs'] == ['169.254.8.8']
  684. @v2_1_only()
  685. def test_up_with_isolation(self):
  686. self.require_api_version('1.24')
  687. config_data = config.Config(
  688. version=V2_1,
  689. services=[{
  690. 'name': 'web',
  691. 'image': 'busybox:latest',
  692. 'isolation': 'default'
  693. }],
  694. volumes={},
  695. networks={}
  696. )
  697. project = Project.from_config(
  698. client=self.client,
  699. name='composetest',
  700. config_data=config_data
  701. )
  702. project.up()
  703. service_container = project.get_service('web').containers()[0]
  704. assert service_container.inspect()['HostConfig']['Isolation'] == 'default'
  705. @v2_1_only()
  706. def test_up_with_invalid_isolation(self):
  707. self.require_api_version('1.24')
  708. config_data = config.Config(
  709. version=V2_1,
  710. services=[{
  711. 'name': 'web',
  712. 'image': 'busybox:latest',
  713. 'isolation': 'foobar'
  714. }],
  715. volumes={},
  716. networks={}
  717. )
  718. project = Project.from_config(
  719. client=self.client,
  720. name='composetest',
  721. config_data=config_data
  722. )
  723. with self.assertRaises(ProjectError):
  724. project.up()
  725. @v2_only()
  726. def test_project_up_with_network_internal(self):
  727. self.require_api_version('1.23')
  728. config_data = config.Config(
  729. version=V2_0,
  730. services=[{
  731. 'name': 'web',
  732. 'image': 'busybox:latest',
  733. 'networks': {'internal': None},
  734. }],
  735. volumes={},
  736. networks={
  737. 'internal': {'driver': 'bridge', 'internal': True},
  738. },
  739. )
  740. project = Project.from_config(
  741. client=self.client,
  742. name='composetest',
  743. config_data=config_data,
  744. )
  745. project.up()
  746. network = self.client.networks(names=['composetest_internal'])[0]
  747. assert network['Internal'] is True
  748. @v2_only()
  749. def test_project_up_volumes(self):
  750. vol_name = '{0:x}'.format(random.getrandbits(32))
  751. full_vol_name = 'composetest_{0}'.format(vol_name)
  752. config_data = config.Config(
  753. version=V2_0,
  754. services=[{
  755. 'name': 'web',
  756. 'image': 'busybox:latest',
  757. 'command': 'top'
  758. }],
  759. volumes={vol_name: {'driver': 'local'}},
  760. networks={},
  761. )
  762. project = Project.from_config(
  763. name='composetest',
  764. config_data=config_data, client=self.client
  765. )
  766. project.up()
  767. self.assertEqual(len(project.containers()), 1)
  768. volume_data = self.client.inspect_volume(full_vol_name)
  769. self.assertEqual(volume_data['Name'], full_vol_name)
  770. self.assertEqual(volume_data['Driver'], 'local')
  771. @v2_only()
  772. def test_project_up_logging_with_multiple_files(self):
  773. base_file = config.ConfigFile(
  774. 'base.yml',
  775. {
  776. 'version': V2_0,
  777. 'services': {
  778. 'simple': {'image': 'busybox:latest', 'command': 'top'},
  779. 'another': {
  780. 'image': 'busybox:latest',
  781. 'command': 'top',
  782. 'logging': {
  783. 'driver': "json-file",
  784. 'options': {
  785. 'max-size': "10m"
  786. }
  787. }
  788. }
  789. }
  790. })
  791. override_file = config.ConfigFile(
  792. 'override.yml',
  793. {
  794. 'version': V2_0,
  795. 'services': {
  796. 'another': {
  797. 'logging': {
  798. 'driver': "none"
  799. }
  800. }
  801. }
  802. })
  803. details = config.ConfigDetails('.', [base_file, override_file])
  804. tmpdir = py.test.ensuretemp('logging_test')
  805. self.addCleanup(tmpdir.remove)
  806. with tmpdir.as_cwd():
  807. config_data = config.load(details)
  808. project = Project.from_config(
  809. name='composetest', config_data=config_data, client=self.client
  810. )
  811. project.up()
  812. containers = project.containers()
  813. self.assertEqual(len(containers), 2)
  814. another = project.get_service('another').containers()[0]
  815. log_config = another.get('HostConfig.LogConfig')
  816. self.assertTrue(log_config)
  817. self.assertEqual(log_config.get('Type'), 'none')
  818. @v2_only()
  819. def test_project_up_port_mappings_with_multiple_files(self):
  820. base_file = config.ConfigFile(
  821. 'base.yml',
  822. {
  823. 'version': V2_0,
  824. 'services': {
  825. 'simple': {
  826. 'image': 'busybox:latest',
  827. 'command': 'top',
  828. 'ports': ['1234:1234']
  829. },
  830. },
  831. })
  832. override_file = config.ConfigFile(
  833. 'override.yml',
  834. {
  835. 'version': V2_0,
  836. 'services': {
  837. 'simple': {
  838. 'ports': ['1234:1234']
  839. }
  840. }
  841. })
  842. details = config.ConfigDetails('.', [base_file, override_file])
  843. config_data = config.load(details)
  844. project = Project.from_config(
  845. name='composetest', config_data=config_data, client=self.client
  846. )
  847. project.up()
  848. containers = project.containers()
  849. self.assertEqual(len(containers), 1)
  850. @v2_only()
  851. def test_initialize_volumes(self):
  852. vol_name = '{0:x}'.format(random.getrandbits(32))
  853. full_vol_name = 'composetest_{0}'.format(vol_name)
  854. config_data = config.Config(
  855. version=V2_0,
  856. services=[{
  857. 'name': 'web',
  858. 'image': 'busybox:latest',
  859. 'command': 'top'
  860. }],
  861. volumes={vol_name: {}},
  862. networks={},
  863. )
  864. project = Project.from_config(
  865. name='composetest',
  866. config_data=config_data, client=self.client
  867. )
  868. project.volumes.initialize()
  869. volume_data = self.client.inspect_volume(full_vol_name)
  870. self.assertEqual(volume_data['Name'], full_vol_name)
  871. self.assertEqual(volume_data['Driver'], 'local')
  872. @v2_only()
  873. def test_project_up_implicit_volume_driver(self):
  874. vol_name = '{0:x}'.format(random.getrandbits(32))
  875. full_vol_name = 'composetest_{0}'.format(vol_name)
  876. config_data = config.Config(
  877. version=V2_0,
  878. services=[{
  879. 'name': 'web',
  880. 'image': 'busybox:latest',
  881. 'command': 'top'
  882. }],
  883. volumes={vol_name: {}},
  884. networks={},
  885. )
  886. project = Project.from_config(
  887. name='composetest',
  888. config_data=config_data, client=self.client
  889. )
  890. project.up()
  891. volume_data = self.client.inspect_volume(full_vol_name)
  892. self.assertEqual(volume_data['Name'], full_vol_name)
  893. self.assertEqual(volume_data['Driver'], 'local')
  894. @v2_only()
  895. def test_initialize_volumes_invalid_volume_driver(self):
  896. vol_name = '{0:x}'.format(random.getrandbits(32))
  897. config_data = config.Config(
  898. version=V2_0,
  899. services=[{
  900. 'name': 'web',
  901. 'image': 'busybox:latest',
  902. 'command': 'top'
  903. }],
  904. volumes={vol_name: {'driver': 'foobar'}},
  905. networks={},
  906. )
  907. project = Project.from_config(
  908. name='composetest',
  909. config_data=config_data, client=self.client
  910. )
  911. with self.assertRaises(config.ConfigurationError):
  912. project.volumes.initialize()
  913. @v2_only()
  914. def test_initialize_volumes_updated_driver(self):
  915. vol_name = '{0:x}'.format(random.getrandbits(32))
  916. full_vol_name = 'composetest_{0}'.format(vol_name)
  917. config_data = config.Config(
  918. version=V2_0,
  919. services=[{
  920. 'name': 'web',
  921. 'image': 'busybox:latest',
  922. 'command': 'top'
  923. }],
  924. volumes={vol_name: {'driver': 'local'}},
  925. networks={},
  926. )
  927. project = Project.from_config(
  928. name='composetest',
  929. config_data=config_data, client=self.client
  930. )
  931. project.volumes.initialize()
  932. volume_data = self.client.inspect_volume(full_vol_name)
  933. self.assertEqual(volume_data['Name'], full_vol_name)
  934. self.assertEqual(volume_data['Driver'], 'local')
  935. config_data = config_data._replace(
  936. volumes={vol_name: {'driver': 'smb'}}
  937. )
  938. project = Project.from_config(
  939. name='composetest',
  940. config_data=config_data,
  941. client=self.client
  942. )
  943. with self.assertRaises(config.ConfigurationError) as e:
  944. project.volumes.initialize()
  945. assert 'Configuration for volume {0} specifies driver smb'.format(
  946. vol_name
  947. ) in str(e.exception)
  948. @v2_only()
  949. def test_initialize_volumes_updated_blank_driver(self):
  950. vol_name = '{0:x}'.format(random.getrandbits(32))
  951. full_vol_name = 'composetest_{0}'.format(vol_name)
  952. config_data = config.Config(
  953. version=V2_0,
  954. services=[{
  955. 'name': 'web',
  956. 'image': 'busybox:latest',
  957. 'command': 'top'
  958. }],
  959. volumes={vol_name: {'driver': 'local'}},
  960. networks={},
  961. )
  962. project = Project.from_config(
  963. name='composetest',
  964. config_data=config_data, client=self.client
  965. )
  966. project.volumes.initialize()
  967. volume_data = self.client.inspect_volume(full_vol_name)
  968. self.assertEqual(volume_data['Name'], full_vol_name)
  969. self.assertEqual(volume_data['Driver'], 'local')
  970. config_data = config_data._replace(
  971. volumes={vol_name: {}}
  972. )
  973. project = Project.from_config(
  974. name='composetest',
  975. config_data=config_data,
  976. client=self.client
  977. )
  978. project.volumes.initialize()
  979. volume_data = self.client.inspect_volume(full_vol_name)
  980. self.assertEqual(volume_data['Name'], full_vol_name)
  981. self.assertEqual(volume_data['Driver'], 'local')
  982. @v2_only()
  983. def test_initialize_volumes_external_volumes(self):
  984. # Use composetest_ prefix so it gets garbage-collected in tearDown()
  985. vol_name = 'composetest_{0:x}'.format(random.getrandbits(32))
  986. full_vol_name = 'composetest_{0}'.format(vol_name)
  987. self.client.create_volume(vol_name)
  988. config_data = config.Config(
  989. version=V2_0,
  990. services=[{
  991. 'name': 'web',
  992. 'image': 'busybox:latest',
  993. 'command': 'top'
  994. }],
  995. volumes={
  996. vol_name: {'external': True, 'external_name': vol_name}
  997. },
  998. networks=None,
  999. )
  1000. project = Project.from_config(
  1001. name='composetest',
  1002. config_data=config_data, client=self.client
  1003. )
  1004. project.volumes.initialize()
  1005. with self.assertRaises(NotFound):
  1006. self.client.inspect_volume(full_vol_name)
  1007. @v2_only()
  1008. def test_initialize_volumes_inexistent_external_volume(self):
  1009. vol_name = '{0:x}'.format(random.getrandbits(32))
  1010. config_data = config.Config(
  1011. version=V2_0,
  1012. services=[{
  1013. 'name': 'web',
  1014. 'image': 'busybox:latest',
  1015. 'command': 'top'
  1016. }],
  1017. volumes={
  1018. vol_name: {'external': True, 'external_name': vol_name}
  1019. },
  1020. networks=None,
  1021. )
  1022. project = Project.from_config(
  1023. name='composetest',
  1024. config_data=config_data, client=self.client
  1025. )
  1026. with self.assertRaises(config.ConfigurationError) as e:
  1027. project.volumes.initialize()
  1028. assert 'Volume {0} declared as external'.format(
  1029. vol_name
  1030. ) in str(e.exception)
  1031. @v2_only()
  1032. def test_project_up_named_volumes_in_binds(self):
  1033. vol_name = '{0:x}'.format(random.getrandbits(32))
  1034. full_vol_name = 'composetest_{0}'.format(vol_name)
  1035. base_file = config.ConfigFile(
  1036. 'base.yml',
  1037. {
  1038. 'version': V2_0,
  1039. 'services': {
  1040. 'simple': {
  1041. 'image': 'busybox:latest',
  1042. 'command': 'top',
  1043. 'volumes': ['{0}:/data'.format(vol_name)]
  1044. },
  1045. },
  1046. 'volumes': {
  1047. vol_name: {'driver': 'local'}
  1048. }
  1049. })
  1050. config_details = config.ConfigDetails('.', [base_file])
  1051. config_data = config.load(config_details)
  1052. project = Project.from_config(
  1053. name='composetest', config_data=config_data, client=self.client
  1054. )
  1055. service = project.services[0]
  1056. self.assertEqual(service.name, 'simple')
  1057. volumes = service.options.get('volumes')
  1058. self.assertEqual(len(volumes), 1)
  1059. self.assertEqual(volumes[0].external, full_vol_name)
  1060. project.up()
  1061. engine_volumes = self.client.volumes()['Volumes']
  1062. container = service.get_container()
  1063. assert [mount['Name'] for mount in container.get('Mounts')] == [full_vol_name]
  1064. assert next((v for v in engine_volumes if v['Name'] == vol_name), None) is None
  1065. def test_project_up_orphans(self):
  1066. config_dict = {
  1067. 'service1': {
  1068. 'image': 'busybox:latest',
  1069. 'command': 'top',
  1070. }
  1071. }
  1072. config_data = build_config(config_dict)
  1073. project = Project.from_config(
  1074. name='composetest', config_data=config_data, client=self.client
  1075. )
  1076. project.up()
  1077. config_dict['service2'] = config_dict['service1']
  1078. del config_dict['service1']
  1079. config_data = build_config(config_dict)
  1080. project = Project.from_config(
  1081. name='composetest', config_data=config_data, client=self.client
  1082. )
  1083. with mock.patch('compose.project.log') as mock_log:
  1084. project.up()
  1085. mock_log.warning.assert_called_once_with(mock.ANY)
  1086. assert len([
  1087. ctnr for ctnr in project._labeled_containers()
  1088. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1089. ]) == 1
  1090. project.up(remove_orphans=True)
  1091. assert len([
  1092. ctnr for ctnr in project._labeled_containers()
  1093. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1094. ]) == 0