project_test.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import random
  4. import py
  5. from docker.errors import NotFound
  6. from .testcases import DockerClientTestCase
  7. from compose.config import config
  8. from compose.config.types import VolumeFromSpec
  9. from compose.config.types import VolumeSpec
  10. from compose.const import LABEL_PROJECT
  11. from compose.container import Container
  12. from compose.project import Project
  13. from compose.service import ConvergenceStrategy
  14. from tests.integration.testcases import v2_only
  15. def build_service_dicts(service_config):
  16. return config.load(
  17. config.ConfigDetails(
  18. 'working_dir',
  19. [config.ConfigFile(None, service_config)]))
  20. class ProjectTest(DockerClientTestCase):
  21. def test_containers(self):
  22. web = self.create_service('web')
  23. db = self.create_service('db')
  24. project = Project('composetest', [web, db], self.client)
  25. project.up()
  26. containers = project.containers()
  27. self.assertEqual(len(containers), 2)
  28. def test_containers_with_service_names(self):
  29. web = self.create_service('web')
  30. db = self.create_service('db')
  31. project = Project('composetest', [web, db], self.client)
  32. project.up()
  33. containers = project.containers(['web'])
  34. self.assertEqual(
  35. [c.name for c in containers],
  36. ['composetest_web_1'])
  37. def test_containers_with_extra_service(self):
  38. web = self.create_service('web')
  39. web_1 = web.create_container()
  40. db = self.create_service('db')
  41. db_1 = db.create_container()
  42. self.create_service('extra').create_container()
  43. project = Project('composetest', [web, db], self.client)
  44. self.assertEqual(
  45. set(project.containers(stopped=True)),
  46. set([web_1, db_1]),
  47. )
  48. def test_volumes_from_service(self):
  49. service_dicts = build_service_dicts({
  50. 'data': {
  51. 'image': 'busybox:latest',
  52. 'volumes': ['/var/data'],
  53. },
  54. 'db': {
  55. 'image': 'busybox:latest',
  56. 'volumes_from': ['data'],
  57. },
  58. })
  59. project = Project.from_config(
  60. name='composetest',
  61. config_data=service_dicts,
  62. client=self.client,
  63. )
  64. db = project.get_service('db')
  65. data = project.get_service('data')
  66. self.assertEqual(db.volumes_from, [VolumeFromSpec(data, 'rw', 'service')])
  67. def test_volumes_from_container(self):
  68. data_container = Container.create(
  69. self.client,
  70. image='busybox:latest',
  71. volumes=['/var/data'],
  72. name='composetest_data_container',
  73. labels={LABEL_PROJECT: 'composetest'},
  74. )
  75. project = Project.from_config(
  76. name='composetest',
  77. config_data=build_service_dicts({
  78. 'db': {
  79. 'image': 'busybox:latest',
  80. 'volumes_from': ['composetest_data_container'],
  81. },
  82. }),
  83. client=self.client,
  84. )
  85. db = project.get_service('db')
  86. self.assertEqual(db._get_volumes_from(), [data_container.id + ':rw'])
  87. def test_net_from_service(self):
  88. project = Project.from_config(
  89. name='composetest',
  90. config_data=build_service_dicts({
  91. 'net': {
  92. 'image': 'busybox:latest',
  93. 'command': ["top"]
  94. },
  95. 'web': {
  96. 'image': 'busybox:latest',
  97. 'net': 'container:net',
  98. 'command': ["top"]
  99. },
  100. }),
  101. client=self.client,
  102. )
  103. project.up()
  104. web = project.get_service('web')
  105. net = project.get_service('net')
  106. self.assertEqual(web.net.mode, 'container:' + net.containers()[0].id)
  107. def test_net_from_container(self):
  108. net_container = Container.create(
  109. self.client,
  110. image='busybox:latest',
  111. name='composetest_net_container',
  112. command='top',
  113. labels={LABEL_PROJECT: 'composetest'},
  114. )
  115. net_container.start()
  116. project = Project.from_config(
  117. name='composetest',
  118. config_data=build_service_dicts({
  119. 'web': {
  120. 'image': 'busybox:latest',
  121. 'net': 'container:composetest_net_container'
  122. },
  123. }),
  124. client=self.client,
  125. )
  126. project.up()
  127. web = project.get_service('web')
  128. self.assertEqual(web.net.mode, 'container:' + net_container.id)
  129. def test_start_pause_unpause_stop_kill_remove(self):
  130. web = self.create_service('web')
  131. db = self.create_service('db')
  132. project = Project('composetest', [web, db], self.client)
  133. project.start()
  134. self.assertEqual(len(web.containers()), 0)
  135. self.assertEqual(len(db.containers()), 0)
  136. web_container_1 = web.create_container()
  137. web_container_2 = web.create_container()
  138. db_container = db.create_container()
  139. project.start(service_names=['web'])
  140. self.assertEqual(set(c.name for c in project.containers()), set([web_container_1.name, web_container_2.name]))
  141. project.start()
  142. self.assertEqual(set(c.name for c in project.containers()),
  143. set([web_container_1.name, web_container_2.name, db_container.name]))
  144. project.pause(service_names=['web'])
  145. self.assertEqual(set([c.name for c in project.containers() if c.is_paused]),
  146. set([web_container_1.name, web_container_2.name]))
  147. project.pause()
  148. self.assertEqual(set([c.name for c in project.containers() if c.is_paused]),
  149. set([web_container_1.name, web_container_2.name, db_container.name]))
  150. project.unpause(service_names=['db'])
  151. self.assertEqual(len([c.name for c in project.containers() if c.is_paused]), 2)
  152. project.unpause()
  153. self.assertEqual(len([c.name for c in project.containers() if c.is_paused]), 0)
  154. project.stop(service_names=['web'], timeout=1)
  155. self.assertEqual(set(c.name for c in project.containers()), set([db_container.name]))
  156. project.kill(service_names=['db'])
  157. self.assertEqual(len(project.containers()), 0)
  158. self.assertEqual(len(project.containers(stopped=True)), 3)
  159. project.remove_stopped(service_names=['web'])
  160. self.assertEqual(len(project.containers(stopped=True)), 1)
  161. project.remove_stopped()
  162. self.assertEqual(len(project.containers(stopped=True)), 0)
  163. def test_create(self):
  164. web = self.create_service('web')
  165. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  166. project = Project('composetest', [web, db], self.client)
  167. project.create(['db'])
  168. self.assertEqual(len(project.containers()), 0)
  169. self.assertEqual(len(project.containers(stopped=True)), 1)
  170. self.assertEqual(len(db.containers()), 0)
  171. self.assertEqual(len(db.containers(stopped=True)), 1)
  172. self.assertEqual(len(web.containers(stopped=True)), 0)
  173. def test_create_twice(self):
  174. web = self.create_service('web')
  175. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  176. project = Project('composetest', [web, db], self.client)
  177. project.create(['db', 'web'])
  178. project.create(['db', 'web'])
  179. self.assertEqual(len(project.containers()), 0)
  180. self.assertEqual(len(project.containers(stopped=True)), 2)
  181. self.assertEqual(len(db.containers()), 0)
  182. self.assertEqual(len(db.containers(stopped=True)), 1)
  183. self.assertEqual(len(web.containers()), 0)
  184. self.assertEqual(len(web.containers(stopped=True)), 1)
  185. def test_create_with_links(self):
  186. db = self.create_service('db')
  187. web = self.create_service('web', links=[(db, 'db')])
  188. project = Project('composetest', [db, web], self.client)
  189. project.create(['web'])
  190. self.assertEqual(len(project.containers()), 0)
  191. self.assertEqual(len(project.containers(stopped=True)), 2)
  192. self.assertEqual(len(db.containers()), 0)
  193. self.assertEqual(len(db.containers(stopped=True)), 1)
  194. self.assertEqual(len(web.containers()), 0)
  195. self.assertEqual(len(web.containers(stopped=True)), 1)
  196. def test_create_strategy_always(self):
  197. db = self.create_service('db')
  198. project = Project('composetest', [db], self.client)
  199. project.create(['db'])
  200. old_id = project.containers(stopped=True)[0].id
  201. project.create(['db'], strategy=ConvergenceStrategy.always)
  202. self.assertEqual(len(project.containers()), 0)
  203. self.assertEqual(len(project.containers(stopped=True)), 1)
  204. db_container = project.containers(stopped=True)[0]
  205. self.assertNotEqual(db_container.id, old_id)
  206. def test_create_strategy_never(self):
  207. db = self.create_service('db')
  208. project = Project('composetest', [db], self.client)
  209. project.create(['db'])
  210. old_id = project.containers(stopped=True)[0].id
  211. project.create(['db'], strategy=ConvergenceStrategy.never)
  212. self.assertEqual(len(project.containers()), 0)
  213. self.assertEqual(len(project.containers(stopped=True)), 1)
  214. db_container = project.containers(stopped=True)[0]
  215. self.assertEqual(db_container.id, old_id)
  216. def test_project_up(self):
  217. web = self.create_service('web')
  218. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  219. project = Project('composetest', [web, db], self.client)
  220. project.start()
  221. self.assertEqual(len(project.containers()), 0)
  222. project.up(['db'])
  223. self.assertEqual(len(project.containers()), 1)
  224. self.assertEqual(len(db.containers()), 1)
  225. self.assertEqual(len(web.containers()), 0)
  226. def test_project_up_starts_uncreated_services(self):
  227. db = self.create_service('db')
  228. web = self.create_service('web', links=[(db, 'db')])
  229. project = Project('composetest', [db, web], self.client)
  230. project.up(['db'])
  231. self.assertEqual(len(project.containers()), 1)
  232. project.up()
  233. self.assertEqual(len(project.containers()), 2)
  234. self.assertEqual(len(db.containers()), 1)
  235. self.assertEqual(len(web.containers()), 1)
  236. def test_recreate_preserves_volumes(self):
  237. web = self.create_service('web')
  238. db = self.create_service('db', volumes=[VolumeSpec.parse('/etc')])
  239. project = Project('composetest', [web, db], self.client)
  240. project.start()
  241. self.assertEqual(len(project.containers()), 0)
  242. project.up(['db'])
  243. self.assertEqual(len(project.containers()), 1)
  244. old_db_id = project.containers()[0].id
  245. db_volume_path = project.containers()[0].get('Volumes./etc')
  246. project.up(strategy=ConvergenceStrategy.always)
  247. self.assertEqual(len(project.containers()), 2)
  248. db_container = [c for c in project.containers() if 'db' in c.name][0]
  249. self.assertNotEqual(db_container.id, old_db_id)
  250. self.assertEqual(db_container.get('Volumes./etc'), db_volume_path)
  251. def test_project_up_with_no_recreate_running(self):
  252. web = self.create_service('web')
  253. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  254. project = Project('composetest', [web, db], self.client)
  255. project.start()
  256. self.assertEqual(len(project.containers()), 0)
  257. project.up(['db'])
  258. self.assertEqual(len(project.containers()), 1)
  259. old_db_id = project.containers()[0].id
  260. container, = project.containers()
  261. db_volume_path = container.get_mount('/var/db')['Source']
  262. project.up(strategy=ConvergenceStrategy.never)
  263. self.assertEqual(len(project.containers()), 2)
  264. db_container = [c for c in project.containers() if 'db' in c.name][0]
  265. self.assertEqual(db_container.id, old_db_id)
  266. self.assertEqual(
  267. db_container.get_mount('/var/db')['Source'],
  268. db_volume_path)
  269. def test_project_up_with_no_recreate_stopped(self):
  270. web = self.create_service('web')
  271. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  272. project = Project('composetest', [web, db], self.client)
  273. project.start()
  274. self.assertEqual(len(project.containers()), 0)
  275. project.up(['db'])
  276. project.kill()
  277. old_containers = project.containers(stopped=True)
  278. self.assertEqual(len(old_containers), 1)
  279. old_container, = old_containers
  280. old_db_id = old_container.id
  281. db_volume_path = old_container.get_mount('/var/db')['Source']
  282. project.up(strategy=ConvergenceStrategy.never)
  283. new_containers = project.containers(stopped=True)
  284. self.assertEqual(len(new_containers), 2)
  285. self.assertEqual([c.is_running for c in new_containers], [True, True])
  286. db_container = [c for c in new_containers if 'db' in c.name][0]
  287. self.assertEqual(db_container.id, old_db_id)
  288. self.assertEqual(
  289. db_container.get_mount('/var/db')['Source'],
  290. db_volume_path)
  291. def test_project_up_without_all_services(self):
  292. console = self.create_service('console')
  293. db = self.create_service('db')
  294. project = Project('composetest', [console, db], self.client)
  295. project.start()
  296. self.assertEqual(len(project.containers()), 0)
  297. project.up()
  298. self.assertEqual(len(project.containers()), 2)
  299. self.assertEqual(len(db.containers()), 1)
  300. self.assertEqual(len(console.containers()), 1)
  301. def test_project_up_starts_links(self):
  302. console = self.create_service('console')
  303. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  304. web = self.create_service('web', links=[(db, 'db')])
  305. project = Project('composetest', [web, db, console], self.client)
  306. project.start()
  307. self.assertEqual(len(project.containers()), 0)
  308. project.up(['web'])
  309. self.assertEqual(len(project.containers()), 2)
  310. self.assertEqual(len(web.containers()), 1)
  311. self.assertEqual(len(db.containers()), 1)
  312. self.assertEqual(len(console.containers()), 0)
  313. def test_project_up_starts_depends(self):
  314. project = Project.from_config(
  315. name='composetest',
  316. config_data=build_service_dicts({
  317. 'console': {
  318. 'image': 'busybox:latest',
  319. 'command': ["top"],
  320. },
  321. 'data': {
  322. 'image': 'busybox:latest',
  323. 'command': ["top"]
  324. },
  325. 'db': {
  326. 'image': 'busybox:latest',
  327. 'command': ["top"],
  328. 'volumes_from': ['data'],
  329. },
  330. 'web': {
  331. 'image': 'busybox:latest',
  332. 'command': ["top"],
  333. 'links': ['db'],
  334. },
  335. }),
  336. client=self.client,
  337. )
  338. project.start()
  339. self.assertEqual(len(project.containers()), 0)
  340. project.up(['web'])
  341. self.assertEqual(len(project.containers()), 3)
  342. self.assertEqual(len(project.get_service('web').containers()), 1)
  343. self.assertEqual(len(project.get_service('db').containers()), 1)
  344. self.assertEqual(len(project.get_service('data').containers()), 1)
  345. self.assertEqual(len(project.get_service('console').containers()), 0)
  346. def test_project_up_with_no_deps(self):
  347. project = Project.from_config(
  348. name='composetest',
  349. config_data=build_service_dicts({
  350. 'console': {
  351. 'image': 'busybox:latest',
  352. 'command': ["top"],
  353. },
  354. 'data': {
  355. 'image': 'busybox:latest',
  356. 'command': ["top"]
  357. },
  358. 'db': {
  359. 'image': 'busybox:latest',
  360. 'command': ["top"],
  361. 'volumes_from': ['data'],
  362. },
  363. 'web': {
  364. 'image': 'busybox:latest',
  365. 'command': ["top"],
  366. 'links': ['db'],
  367. },
  368. }),
  369. client=self.client,
  370. )
  371. project.start()
  372. self.assertEqual(len(project.containers()), 0)
  373. project.up(['db'], start_deps=False)
  374. self.assertEqual(len(project.containers(stopped=True)), 2)
  375. self.assertEqual(len(project.get_service('web').containers()), 0)
  376. self.assertEqual(len(project.get_service('db').containers()), 1)
  377. self.assertEqual(len(project.get_service('data').containers()), 0)
  378. self.assertEqual(len(project.get_service('data').containers(stopped=True)), 1)
  379. self.assertEqual(len(project.get_service('console').containers()), 0)
  380. def test_unscale_after_restart(self):
  381. web = self.create_service('web')
  382. project = Project('composetest', [web], self.client)
  383. project.start()
  384. service = project.get_service('web')
  385. service.scale(1)
  386. self.assertEqual(len(service.containers()), 1)
  387. service.scale(3)
  388. self.assertEqual(len(service.containers()), 3)
  389. project.up()
  390. service = project.get_service('web')
  391. self.assertEqual(len(service.containers()), 3)
  392. service.scale(1)
  393. self.assertEqual(len(service.containers()), 1)
  394. project.up()
  395. service = project.get_service('web')
  396. self.assertEqual(len(service.containers()), 1)
  397. # does scale=0 ,makes any sense? after recreating at least 1 container is running
  398. service.scale(0)
  399. project.up()
  400. service = project.get_service('web')
  401. self.assertEqual(len(service.containers()), 1)
  402. @v2_only()
  403. def test_project_up_networks(self):
  404. config_data = config.Config(
  405. version=2,
  406. services=[{
  407. 'name': 'web',
  408. 'image': 'busybox:latest',
  409. 'command': 'top',
  410. }],
  411. volumes={},
  412. networks={
  413. 'foo': {'driver': 'bridge'},
  414. 'bar': {'driver': None},
  415. 'baz': {},
  416. },
  417. )
  418. project = Project.from_config(
  419. client=self.client,
  420. name='composetest',
  421. config_data=config_data,
  422. )
  423. project.up()
  424. self.assertEqual(len(project.containers()), 1)
  425. for net_name in ['foo', 'bar', 'baz']:
  426. full_net_name = 'composetest_{}'.format(net_name)
  427. network_data = self.client.inspect_network(full_net_name)
  428. self.assertEqual(network_data['Name'], full_net_name)
  429. foo_data = self.client.inspect_network('composetest_foo')
  430. self.assertEqual(foo_data['Driver'], 'bridge')
  431. @v2_only()
  432. def test_up_with_ipam_config(self):
  433. config_data = config.Config(
  434. version=2,
  435. services=[],
  436. volumes={},
  437. networks={
  438. 'front': {
  439. 'driver': 'bridge',
  440. 'driver_opts': {
  441. "com.docker.network.bridge.enable_icc": "false",
  442. },
  443. 'ipam': {
  444. 'driver': 'default',
  445. 'config': [{
  446. "subnet": "172.28.0.0/16",
  447. "ip_range": "172.28.5.0/24",
  448. "gateway": "172.28.5.254",
  449. "aux_addresses": {
  450. "a": "172.28.1.5",
  451. "b": "172.28.1.6",
  452. "c": "172.28.1.7",
  453. },
  454. }],
  455. },
  456. },
  457. },
  458. )
  459. project = Project.from_config(
  460. client=self.client,
  461. name='composetest',
  462. config_data=config_data,
  463. )
  464. project.up()
  465. network = self.client.networks(names=['composetest_front'])[0]
  466. assert network['Options'] == {
  467. "com.docker.network.bridge.enable_icc": "false"
  468. }
  469. assert network['IPAM'] == {
  470. 'Driver': 'default',
  471. 'Options': None,
  472. 'Config': [{
  473. 'Subnet': "172.28.0.0/16",
  474. 'IPRange': "172.28.5.0/24",
  475. 'Gateway': "172.28.5.254",
  476. 'AuxiliaryAddresses': {
  477. 'a': '172.28.1.5',
  478. 'b': '172.28.1.6',
  479. 'c': '172.28.1.7',
  480. },
  481. }],
  482. }
  483. @v2_only()
  484. def test_project_up_volumes(self):
  485. vol_name = '{0:x}'.format(random.getrandbits(32))
  486. full_vol_name = 'composetest_{0}'.format(vol_name)
  487. config_data = config.Config(
  488. version=2,
  489. services=[{
  490. 'name': 'web',
  491. 'image': 'busybox:latest',
  492. 'command': 'top'
  493. }],
  494. volumes={vol_name: {'driver': 'local'}},
  495. networks={},
  496. )
  497. project = Project.from_config(
  498. name='composetest',
  499. config_data=config_data, client=self.client
  500. )
  501. project.up()
  502. self.assertEqual(len(project.containers()), 1)
  503. volume_data = self.client.inspect_volume(full_vol_name)
  504. self.assertEqual(volume_data['Name'], full_vol_name)
  505. self.assertEqual(volume_data['Driver'], 'local')
  506. @v2_only()
  507. def test_project_up_logging_with_multiple_files(self):
  508. base_file = config.ConfigFile(
  509. 'base.yml',
  510. {
  511. 'version': 2,
  512. 'services': {
  513. 'simple': {'image': 'busybox:latest', 'command': 'top'},
  514. 'another': {
  515. 'image': 'busybox:latest',
  516. 'command': 'top',
  517. 'logging': {
  518. 'driver': "json-file",
  519. 'options': {
  520. 'max-size': "10m"
  521. }
  522. }
  523. }
  524. }
  525. })
  526. override_file = config.ConfigFile(
  527. 'override.yml',
  528. {
  529. 'version': 2,
  530. 'services': {
  531. 'another': {
  532. 'logging': {
  533. 'driver': "none"
  534. }
  535. }
  536. }
  537. })
  538. details = config.ConfigDetails('.', [base_file, override_file])
  539. tmpdir = py.test.ensuretemp('logging_test')
  540. self.addCleanup(tmpdir.remove)
  541. with tmpdir.as_cwd():
  542. config_data = config.load(details)
  543. project = Project.from_config(
  544. name='composetest', config_data=config_data, client=self.client
  545. )
  546. project.up()
  547. containers = project.containers()
  548. self.assertEqual(len(containers), 2)
  549. another = project.get_service('another').containers()[0]
  550. log_config = another.get('HostConfig.LogConfig')
  551. self.assertTrue(log_config)
  552. self.assertEqual(log_config.get('Type'), 'none')
  553. @v2_only()
  554. def test_initialize_volumes(self):
  555. vol_name = '{0:x}'.format(random.getrandbits(32))
  556. full_vol_name = 'composetest_{0}'.format(vol_name)
  557. config_data = config.Config(
  558. version=2,
  559. services=[{
  560. 'name': 'web',
  561. 'image': 'busybox:latest',
  562. 'command': 'top'
  563. }],
  564. volumes={vol_name: {}},
  565. networks={},
  566. )
  567. project = Project.from_config(
  568. name='composetest',
  569. config_data=config_data, client=self.client
  570. )
  571. project.initialize_volumes()
  572. volume_data = self.client.inspect_volume(full_vol_name)
  573. self.assertEqual(volume_data['Name'], full_vol_name)
  574. self.assertEqual(volume_data['Driver'], 'local')
  575. @v2_only()
  576. def test_project_up_implicit_volume_driver(self):
  577. vol_name = '{0:x}'.format(random.getrandbits(32))
  578. full_vol_name = 'composetest_{0}'.format(vol_name)
  579. config_data = config.Config(
  580. version=2,
  581. services=[{
  582. 'name': 'web',
  583. 'image': 'busybox:latest',
  584. 'command': 'top'
  585. }],
  586. volumes={vol_name: {}},
  587. networks={},
  588. )
  589. project = Project.from_config(
  590. name='composetest',
  591. config_data=config_data, client=self.client
  592. )
  593. project.up()
  594. volume_data = self.client.inspect_volume(full_vol_name)
  595. self.assertEqual(volume_data['Name'], full_vol_name)
  596. self.assertEqual(volume_data['Driver'], 'local')
  597. @v2_only()
  598. def test_initialize_volumes_invalid_volume_driver(self):
  599. vol_name = '{0:x}'.format(random.getrandbits(32))
  600. config_data = config.Config(
  601. version=2,
  602. services=[{
  603. 'name': 'web',
  604. 'image': 'busybox:latest',
  605. 'command': 'top'
  606. }],
  607. volumes={vol_name: {'driver': 'foobar'}},
  608. networks={},
  609. )
  610. project = Project.from_config(
  611. name='composetest',
  612. config_data=config_data, client=self.client
  613. )
  614. with self.assertRaises(config.ConfigurationError):
  615. project.initialize_volumes()
  616. @v2_only()
  617. def test_initialize_volumes_updated_driver(self):
  618. vol_name = '{0:x}'.format(random.getrandbits(32))
  619. full_vol_name = 'composetest_{0}'.format(vol_name)
  620. config_data = config.Config(
  621. version=2,
  622. services=[{
  623. 'name': 'web',
  624. 'image': 'busybox:latest',
  625. 'command': 'top'
  626. }],
  627. volumes={vol_name: {'driver': 'local'}},
  628. networks={},
  629. )
  630. project = Project.from_config(
  631. name='composetest',
  632. config_data=config_data, client=self.client
  633. )
  634. project.initialize_volumes()
  635. volume_data = self.client.inspect_volume(full_vol_name)
  636. self.assertEqual(volume_data['Name'], full_vol_name)
  637. self.assertEqual(volume_data['Driver'], 'local')
  638. config_data = config_data._replace(
  639. volumes={vol_name: {'driver': 'smb'}}
  640. )
  641. project = Project.from_config(
  642. name='composetest',
  643. config_data=config_data, client=self.client
  644. )
  645. with self.assertRaises(config.ConfigurationError) as e:
  646. project.initialize_volumes()
  647. assert 'Configuration for volume {0} specifies driver smb'.format(
  648. vol_name
  649. ) in str(e.exception)
  650. @v2_only()
  651. def test_initialize_volumes_external_volumes(self):
  652. # Use composetest_ prefix so it gets garbage-collected in tearDown()
  653. vol_name = 'composetest_{0:x}'.format(random.getrandbits(32))
  654. full_vol_name = 'composetest_{0}'.format(vol_name)
  655. self.client.create_volume(vol_name)
  656. config_data = config.Config(
  657. version=2,
  658. services=[{
  659. 'name': 'web',
  660. 'image': 'busybox:latest',
  661. 'command': 'top'
  662. }],
  663. volumes={
  664. vol_name: {'external': True, 'external_name': vol_name}
  665. },
  666. networks=None,
  667. )
  668. project = Project.from_config(
  669. name='composetest',
  670. config_data=config_data, client=self.client
  671. )
  672. project.initialize_volumes()
  673. with self.assertRaises(NotFound):
  674. self.client.inspect_volume(full_vol_name)
  675. @v2_only()
  676. def test_initialize_volumes_inexistent_external_volume(self):
  677. vol_name = '{0:x}'.format(random.getrandbits(32))
  678. config_data = config.Config(
  679. version=2,
  680. services=[{
  681. 'name': 'web',
  682. 'image': 'busybox:latest',
  683. 'command': 'top'
  684. }],
  685. volumes={
  686. vol_name: {'external': True, 'external_name': vol_name}
  687. },
  688. networks=None,
  689. )
  690. project = Project.from_config(
  691. name='composetest',
  692. config_data=config_data, client=self.client
  693. )
  694. with self.assertRaises(config.ConfigurationError) as e:
  695. project.initialize_volumes()
  696. assert 'Volume {0} declared as external'.format(
  697. vol_name
  698. ) in str(e.exception)
  699. @v2_only()
  700. def test_project_up_named_volumes_in_binds(self):
  701. vol_name = '{0:x}'.format(random.getrandbits(32))
  702. full_vol_name = 'composetest_{0}'.format(vol_name)
  703. base_file = config.ConfigFile(
  704. 'base.yml',
  705. {
  706. 'version': 2,
  707. 'services': {
  708. 'simple': {
  709. 'image': 'busybox:latest',
  710. 'command': 'top',
  711. 'volumes': ['{0}:/data'.format(vol_name)]
  712. },
  713. },
  714. 'volumes': {
  715. vol_name: {'driver': 'local'}
  716. }
  717. })
  718. config_details = config.ConfigDetails('.', [base_file])
  719. config_data = config.load(config_details)
  720. project = Project.from_config(
  721. name='composetest', config_data=config_data, client=self.client
  722. )
  723. service = project.services[0]
  724. self.assertEqual(service.name, 'simple')
  725. volumes = service.options.get('volumes')
  726. self.assertEqual(len(volumes), 1)
  727. self.assertEqual(volumes[0].external, full_vol_name)
  728. project.up()
  729. engine_volumes = self.client.volumes()['Volumes']
  730. container = service.get_container()
  731. assert [mount['Name'] for mount in container.get('Mounts')] == [full_vol_name]
  732. assert next((v for v in engine_volumes if v['Name'] == vol_name), None) is None