project_test.py 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212
  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_only()
  685. def test_project_up_with_network_internal(self):
  686. self.require_api_version('1.23')
  687. config_data = config.Config(
  688. version=V2_0,
  689. services=[{
  690. 'name': 'web',
  691. 'image': 'busybox:latest',
  692. 'networks': {'internal': None},
  693. }],
  694. volumes={},
  695. networks={
  696. 'internal': {'driver': 'bridge', 'internal': True},
  697. },
  698. )
  699. project = Project.from_config(
  700. client=self.client,
  701. name='composetest',
  702. config_data=config_data,
  703. )
  704. project.up()
  705. network = self.client.networks(names=['composetest_internal'])[0]
  706. assert network['Internal'] is True
  707. @v2_only()
  708. def test_project_up_volumes(self):
  709. vol_name = '{0:x}'.format(random.getrandbits(32))
  710. full_vol_name = 'composetest_{0}'.format(vol_name)
  711. config_data = config.Config(
  712. version=V2_0,
  713. services=[{
  714. 'name': 'web',
  715. 'image': 'busybox:latest',
  716. 'command': 'top'
  717. }],
  718. volumes={vol_name: {'driver': 'local'}},
  719. networks={},
  720. )
  721. project = Project.from_config(
  722. name='composetest',
  723. config_data=config_data, client=self.client
  724. )
  725. project.up()
  726. self.assertEqual(len(project.containers()), 1)
  727. volume_data = self.client.inspect_volume(full_vol_name)
  728. self.assertEqual(volume_data['Name'], full_vol_name)
  729. self.assertEqual(volume_data['Driver'], 'local')
  730. @v2_only()
  731. def test_project_up_logging_with_multiple_files(self):
  732. base_file = config.ConfigFile(
  733. 'base.yml',
  734. {
  735. 'version': V2_0,
  736. 'services': {
  737. 'simple': {'image': 'busybox:latest', 'command': 'top'},
  738. 'another': {
  739. 'image': 'busybox:latest',
  740. 'command': 'top',
  741. 'logging': {
  742. 'driver': "json-file",
  743. 'options': {
  744. 'max-size': "10m"
  745. }
  746. }
  747. }
  748. }
  749. })
  750. override_file = config.ConfigFile(
  751. 'override.yml',
  752. {
  753. 'version': V2_0,
  754. 'services': {
  755. 'another': {
  756. 'logging': {
  757. 'driver': "none"
  758. }
  759. }
  760. }
  761. })
  762. details = config.ConfigDetails('.', [base_file, override_file])
  763. tmpdir = py.test.ensuretemp('logging_test')
  764. self.addCleanup(tmpdir.remove)
  765. with tmpdir.as_cwd():
  766. config_data = config.load(details)
  767. project = Project.from_config(
  768. name='composetest', config_data=config_data, client=self.client
  769. )
  770. project.up()
  771. containers = project.containers()
  772. self.assertEqual(len(containers), 2)
  773. another = project.get_service('another').containers()[0]
  774. log_config = another.get('HostConfig.LogConfig')
  775. self.assertTrue(log_config)
  776. self.assertEqual(log_config.get('Type'), 'none')
  777. @v2_only()
  778. def test_project_up_port_mappings_with_multiple_files(self):
  779. base_file = config.ConfigFile(
  780. 'base.yml',
  781. {
  782. 'version': V2_0,
  783. 'services': {
  784. 'simple': {
  785. 'image': 'busybox:latest',
  786. 'command': 'top',
  787. 'ports': ['1234:1234']
  788. },
  789. },
  790. })
  791. override_file = config.ConfigFile(
  792. 'override.yml',
  793. {
  794. 'version': V2_0,
  795. 'services': {
  796. 'simple': {
  797. 'ports': ['1234:1234']
  798. }
  799. }
  800. })
  801. details = config.ConfigDetails('.', [base_file, override_file])
  802. config_data = config.load(details)
  803. project = Project.from_config(
  804. name='composetest', config_data=config_data, client=self.client
  805. )
  806. project.up()
  807. containers = project.containers()
  808. self.assertEqual(len(containers), 1)
  809. @v2_only()
  810. def test_initialize_volumes(self):
  811. vol_name = '{0:x}'.format(random.getrandbits(32))
  812. full_vol_name = 'composetest_{0}'.format(vol_name)
  813. config_data = config.Config(
  814. version=V2_0,
  815. services=[{
  816. 'name': 'web',
  817. 'image': 'busybox:latest',
  818. 'command': 'top'
  819. }],
  820. volumes={vol_name: {}},
  821. networks={},
  822. )
  823. project = Project.from_config(
  824. name='composetest',
  825. config_data=config_data, client=self.client
  826. )
  827. project.volumes.initialize()
  828. volume_data = self.client.inspect_volume(full_vol_name)
  829. self.assertEqual(volume_data['Name'], full_vol_name)
  830. self.assertEqual(volume_data['Driver'], 'local')
  831. @v2_only()
  832. def test_project_up_implicit_volume_driver(self):
  833. vol_name = '{0:x}'.format(random.getrandbits(32))
  834. full_vol_name = 'composetest_{0}'.format(vol_name)
  835. config_data = config.Config(
  836. version=V2_0,
  837. services=[{
  838. 'name': 'web',
  839. 'image': 'busybox:latest',
  840. 'command': 'top'
  841. }],
  842. volumes={vol_name: {}},
  843. networks={},
  844. )
  845. project = Project.from_config(
  846. name='composetest',
  847. config_data=config_data, client=self.client
  848. )
  849. project.up()
  850. volume_data = self.client.inspect_volume(full_vol_name)
  851. self.assertEqual(volume_data['Name'], full_vol_name)
  852. self.assertEqual(volume_data['Driver'], 'local')
  853. @v2_only()
  854. def test_initialize_volumes_invalid_volume_driver(self):
  855. vol_name = '{0:x}'.format(random.getrandbits(32))
  856. config_data = config.Config(
  857. version=V2_0,
  858. services=[{
  859. 'name': 'web',
  860. 'image': 'busybox:latest',
  861. 'command': 'top'
  862. }],
  863. volumes={vol_name: {'driver': 'foobar'}},
  864. networks={},
  865. )
  866. project = Project.from_config(
  867. name='composetest',
  868. config_data=config_data, client=self.client
  869. )
  870. with self.assertRaises(config.ConfigurationError):
  871. project.volumes.initialize()
  872. @v2_only()
  873. def test_initialize_volumes_updated_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: {'driver': 'local'}},
  884. networks={},
  885. )
  886. project = Project.from_config(
  887. name='composetest',
  888. config_data=config_data, client=self.client
  889. )
  890. project.volumes.initialize()
  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. config_data = config_data._replace(
  895. volumes={vol_name: {'driver': 'smb'}}
  896. )
  897. project = Project.from_config(
  898. name='composetest',
  899. config_data=config_data,
  900. client=self.client
  901. )
  902. with self.assertRaises(config.ConfigurationError) as e:
  903. project.volumes.initialize()
  904. assert 'Configuration for volume {0} specifies driver smb'.format(
  905. vol_name
  906. ) in str(e.exception)
  907. @v2_only()
  908. def test_initialize_volumes_updated_blank_driver(self):
  909. vol_name = '{0:x}'.format(random.getrandbits(32))
  910. full_vol_name = 'composetest_{0}'.format(vol_name)
  911. config_data = config.Config(
  912. version=V2_0,
  913. services=[{
  914. 'name': 'web',
  915. 'image': 'busybox:latest',
  916. 'command': 'top'
  917. }],
  918. volumes={vol_name: {'driver': 'local'}},
  919. networks={},
  920. )
  921. project = Project.from_config(
  922. name='composetest',
  923. config_data=config_data, client=self.client
  924. )
  925. project.volumes.initialize()
  926. volume_data = self.client.inspect_volume(full_vol_name)
  927. self.assertEqual(volume_data['Name'], full_vol_name)
  928. self.assertEqual(volume_data['Driver'], 'local')
  929. config_data = config_data._replace(
  930. volumes={vol_name: {}}
  931. )
  932. project = Project.from_config(
  933. name='composetest',
  934. config_data=config_data,
  935. client=self.client
  936. )
  937. project.volumes.initialize()
  938. volume_data = self.client.inspect_volume(full_vol_name)
  939. self.assertEqual(volume_data['Name'], full_vol_name)
  940. self.assertEqual(volume_data['Driver'], 'local')
  941. @v2_only()
  942. def test_initialize_volumes_external_volumes(self):
  943. # Use composetest_ prefix so it gets garbage-collected in tearDown()
  944. vol_name = 'composetest_{0:x}'.format(random.getrandbits(32))
  945. full_vol_name = 'composetest_{0}'.format(vol_name)
  946. self.client.create_volume(vol_name)
  947. config_data = config.Config(
  948. version=V2_0,
  949. services=[{
  950. 'name': 'web',
  951. 'image': 'busybox:latest',
  952. 'command': 'top'
  953. }],
  954. volumes={
  955. vol_name: {'external': True, 'external_name': vol_name}
  956. },
  957. networks=None,
  958. )
  959. project = Project.from_config(
  960. name='composetest',
  961. config_data=config_data, client=self.client
  962. )
  963. project.volumes.initialize()
  964. with self.assertRaises(NotFound):
  965. self.client.inspect_volume(full_vol_name)
  966. @v2_only()
  967. def test_initialize_volumes_inexistent_external_volume(self):
  968. vol_name = '{0:x}'.format(random.getrandbits(32))
  969. config_data = config.Config(
  970. version=V2_0,
  971. services=[{
  972. 'name': 'web',
  973. 'image': 'busybox:latest',
  974. 'command': 'top'
  975. }],
  976. volumes={
  977. vol_name: {'external': True, 'external_name': vol_name}
  978. },
  979. networks=None,
  980. )
  981. project = Project.from_config(
  982. name='composetest',
  983. config_data=config_data, client=self.client
  984. )
  985. with self.assertRaises(config.ConfigurationError) as e:
  986. project.volumes.initialize()
  987. assert 'Volume {0} declared as external'.format(
  988. vol_name
  989. ) in str(e.exception)
  990. @v2_only()
  991. def test_project_up_named_volumes_in_binds(self):
  992. vol_name = '{0:x}'.format(random.getrandbits(32))
  993. full_vol_name = 'composetest_{0}'.format(vol_name)
  994. base_file = config.ConfigFile(
  995. 'base.yml',
  996. {
  997. 'version': V2_0,
  998. 'services': {
  999. 'simple': {
  1000. 'image': 'busybox:latest',
  1001. 'command': 'top',
  1002. 'volumes': ['{0}:/data'.format(vol_name)]
  1003. },
  1004. },
  1005. 'volumes': {
  1006. vol_name: {'driver': 'local'}
  1007. }
  1008. })
  1009. config_details = config.ConfigDetails('.', [base_file])
  1010. config_data = config.load(config_details)
  1011. project = Project.from_config(
  1012. name='composetest', config_data=config_data, client=self.client
  1013. )
  1014. service = project.services[0]
  1015. self.assertEqual(service.name, 'simple')
  1016. volumes = service.options.get('volumes')
  1017. self.assertEqual(len(volumes), 1)
  1018. self.assertEqual(volumes[0].external, full_vol_name)
  1019. project.up()
  1020. engine_volumes = self.client.volumes()['Volumes']
  1021. container = service.get_container()
  1022. assert [mount['Name'] for mount in container.get('Mounts')] == [full_vol_name]
  1023. assert next((v for v in engine_volumes if v['Name'] == vol_name), None) is None
  1024. def test_project_up_orphans(self):
  1025. config_dict = {
  1026. 'service1': {
  1027. 'image': 'busybox:latest',
  1028. 'command': 'top',
  1029. }
  1030. }
  1031. config_data = build_config(config_dict)
  1032. project = Project.from_config(
  1033. name='composetest', config_data=config_data, client=self.client
  1034. )
  1035. project.up()
  1036. config_dict['service2'] = config_dict['service1']
  1037. del config_dict['service1']
  1038. config_data = build_config(config_dict)
  1039. project = Project.from_config(
  1040. name='composetest', config_data=config_data, client=self.client
  1041. )
  1042. with mock.patch('compose.project.log') as mock_log:
  1043. project.up()
  1044. mock_log.warning.assert_called_once_with(mock.ANY)
  1045. assert len([
  1046. ctnr for ctnr in project._labeled_containers()
  1047. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1048. ]) == 1
  1049. project.up(remove_orphans=True)
  1050. assert len([
  1051. ctnr for ctnr in project._labeled_containers()
  1052. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1053. ]) == 0