project_test.py 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870
  1. from __future__ import absolute_import
  2. from __future__ import unicode_literals
  3. import json
  4. import os
  5. import random
  6. import tempfile
  7. import py
  8. import pytest
  9. from docker.errors import APIError
  10. from docker.errors import NotFound
  11. from .. import mock
  12. from ..helpers import build_config as load_config
  13. from ..helpers import create_host_file
  14. from .testcases import DockerClientTestCase
  15. from .testcases import SWARM_SKIP_CONTAINERS_ALL
  16. from compose.config import config
  17. from compose.config import ConfigurationError
  18. from compose.config import types
  19. from compose.config.types import VolumeFromSpec
  20. from compose.config.types import VolumeSpec
  21. from compose.const import COMPOSEFILE_V2_0 as V2_0
  22. from compose.const import COMPOSEFILE_V2_1 as V2_1
  23. from compose.const import COMPOSEFILE_V2_2 as V2_2
  24. from compose.const import COMPOSEFILE_V2_3 as V2_3
  25. from compose.const import COMPOSEFILE_V3_1 as V3_1
  26. from compose.const import LABEL_PROJECT
  27. from compose.const import LABEL_SERVICE
  28. from compose.container import Container
  29. from compose.errors import HealthCheckFailed
  30. from compose.errors import NoHealthCheckConfigured
  31. from compose.project import Project
  32. from compose.project import ProjectError
  33. from compose.service import ConvergenceStrategy
  34. from tests.integration.testcases import if_runtime_available
  35. from tests.integration.testcases import is_cluster
  36. from tests.integration.testcases import no_cluster
  37. from tests.integration.testcases import v2_1_only
  38. from tests.integration.testcases import v2_2_only
  39. from tests.integration.testcases import v2_3_only
  40. from tests.integration.testcases import v2_only
  41. from tests.integration.testcases import v3_only
  42. def build_config(**kwargs):
  43. return config.Config(
  44. version=kwargs.get('version'),
  45. services=kwargs.get('services'),
  46. volumes=kwargs.get('volumes'),
  47. networks=kwargs.get('networks'),
  48. secrets=kwargs.get('secrets'),
  49. configs=kwargs.get('configs'),
  50. )
  51. class ProjectTest(DockerClientTestCase):
  52. def test_containers(self):
  53. web = self.create_service('web')
  54. db = self.create_service('db')
  55. project = Project('composetest', [web, db], self.client)
  56. project.up()
  57. containers = project.containers()
  58. assert len(containers) == 2
  59. @pytest.mark.skipif(SWARM_SKIP_CONTAINERS_ALL, reason='Swarm /containers/json bug')
  60. def test_containers_stopped(self):
  61. web = self.create_service('web')
  62. db = self.create_service('db')
  63. project = Project('composetest', [web, db], self.client)
  64. project.up()
  65. assert len(project.containers()) == 2
  66. assert len(project.containers(stopped=True)) == 2
  67. project.stop()
  68. assert len(project.containers()) == 0
  69. assert len(project.containers(stopped=True)) == 2
  70. def test_containers_with_service_names(self):
  71. web = self.create_service('web')
  72. db = self.create_service('db')
  73. project = Project('composetest', [web, db], self.client)
  74. project.up()
  75. containers = project.containers(['web'])
  76. assert [c.name for c in containers] == ['composetest_web_1']
  77. def test_containers_with_extra_service(self):
  78. web = self.create_service('web')
  79. web_1 = web.create_container()
  80. db = self.create_service('db')
  81. db_1 = db.create_container()
  82. self.create_service('extra').create_container()
  83. project = Project('composetest', [web, db], self.client)
  84. assert set(project.containers(stopped=True)) == set([web_1, db_1])
  85. def test_volumes_from_service(self):
  86. project = Project.from_config(
  87. name='composetest',
  88. config_data=load_config({
  89. 'data': {
  90. 'image': 'busybox:latest',
  91. 'volumes': ['/var/data'],
  92. },
  93. 'db': {
  94. 'image': 'busybox:latest',
  95. 'volumes_from': ['data'],
  96. },
  97. }),
  98. client=self.client,
  99. )
  100. db = project.get_service('db')
  101. data = project.get_service('data')
  102. assert db.volumes_from == [VolumeFromSpec(data, 'rw', 'service')]
  103. def test_volumes_from_container(self):
  104. data_container = Container.create(
  105. self.client,
  106. image='busybox:latest',
  107. volumes=['/var/data'],
  108. name='composetest_data_container',
  109. labels={LABEL_PROJECT: 'composetest'},
  110. host_config={},
  111. )
  112. project = Project.from_config(
  113. name='composetest',
  114. config_data=load_config({
  115. 'db': {
  116. 'image': 'busybox:latest',
  117. 'volumes_from': ['composetest_data_container'],
  118. },
  119. }),
  120. client=self.client,
  121. )
  122. db = project.get_service('db')
  123. assert db._get_volumes_from() == [data_container.id + ':rw']
  124. @v2_only()
  125. @no_cluster('container networks not supported in Swarm')
  126. def test_network_mode_from_service(self):
  127. project = Project.from_config(
  128. name='composetest',
  129. client=self.client,
  130. config_data=load_config({
  131. 'version': str(V2_0),
  132. 'services': {
  133. 'net': {
  134. 'image': 'busybox:latest',
  135. 'command': ["top"]
  136. },
  137. 'web': {
  138. 'image': 'busybox:latest',
  139. 'network_mode': 'service:net',
  140. 'command': ["top"]
  141. },
  142. },
  143. }),
  144. )
  145. project.up()
  146. web = project.get_service('web')
  147. net = project.get_service('net')
  148. assert web.network_mode.mode == 'container:' + net.containers()[0].id
  149. @v2_only()
  150. @no_cluster('container networks not supported in Swarm')
  151. def test_network_mode_from_container(self):
  152. def get_project():
  153. return Project.from_config(
  154. name='composetest',
  155. config_data=load_config({
  156. 'version': str(V2_0),
  157. 'services': {
  158. 'web': {
  159. 'image': 'busybox:latest',
  160. 'network_mode': 'container:composetest_net_container'
  161. },
  162. },
  163. }),
  164. client=self.client,
  165. )
  166. with pytest.raises(ConfigurationError) as excinfo:
  167. get_project()
  168. assert "container 'composetest_net_container' which does not exist" in excinfo.exconly()
  169. net_container = Container.create(
  170. self.client,
  171. image='busybox:latest',
  172. name='composetest_net_container',
  173. command='top',
  174. labels={LABEL_PROJECT: 'composetest'},
  175. host_config={},
  176. )
  177. net_container.start()
  178. project = get_project()
  179. project.up()
  180. web = project.get_service('web')
  181. assert web.network_mode.mode == 'container:' + net_container.id
  182. @no_cluster('container networks not supported in Swarm')
  183. def test_net_from_service_v1(self):
  184. project = Project.from_config(
  185. name='composetest',
  186. config_data=load_config({
  187. 'net': {
  188. 'image': 'busybox:latest',
  189. 'command': ["top"]
  190. },
  191. 'web': {
  192. 'image': 'busybox:latest',
  193. 'net': 'container:net',
  194. 'command': ["top"]
  195. },
  196. }),
  197. client=self.client,
  198. )
  199. project.up()
  200. web = project.get_service('web')
  201. net = project.get_service('net')
  202. assert web.network_mode.mode == 'container:' + net.containers()[0].id
  203. @no_cluster('container networks not supported in Swarm')
  204. def test_net_from_container_v1(self):
  205. def get_project():
  206. return Project.from_config(
  207. name='composetest',
  208. config_data=load_config({
  209. 'web': {
  210. 'image': 'busybox:latest',
  211. 'net': 'container:composetest_net_container'
  212. },
  213. }),
  214. client=self.client,
  215. )
  216. with pytest.raises(ConfigurationError) as excinfo:
  217. get_project()
  218. assert "container 'composetest_net_container' which does not exist" in excinfo.exconly()
  219. net_container = Container.create(
  220. self.client,
  221. image='busybox:latest',
  222. name='composetest_net_container',
  223. command='top',
  224. labels={LABEL_PROJECT: 'composetest'},
  225. host_config={},
  226. )
  227. net_container.start()
  228. project = get_project()
  229. project.up()
  230. web = project.get_service('web')
  231. assert web.network_mode.mode == 'container:' + net_container.id
  232. def test_start_pause_unpause_stop_kill_remove(self):
  233. web = self.create_service('web')
  234. db = self.create_service('db')
  235. project = Project('composetest', [web, db], self.client)
  236. project.start()
  237. assert len(web.containers()) == 0
  238. assert len(db.containers()) == 0
  239. web_container_1 = web.create_container()
  240. web_container_2 = web.create_container()
  241. db_container = db.create_container()
  242. project.start(service_names=['web'])
  243. assert set(c.name for c in project.containers() if c.is_running) == set(
  244. [web_container_1.name, web_container_2.name]
  245. )
  246. project.start()
  247. assert set(c.name for c in project.containers() if c.is_running) == set(
  248. [web_container_1.name, web_container_2.name, db_container.name]
  249. )
  250. project.pause(service_names=['web'])
  251. assert set([c.name for c in project.containers() if c.is_paused]) == set(
  252. [web_container_1.name, web_container_2.name]
  253. )
  254. project.pause()
  255. assert set([c.name for c in project.containers() if c.is_paused]) == set(
  256. [web_container_1.name, web_container_2.name, db_container.name]
  257. )
  258. project.unpause(service_names=['db'])
  259. assert len([c.name for c in project.containers() if c.is_paused]) == 2
  260. project.unpause()
  261. assert len([c.name for c in project.containers() if c.is_paused]) == 0
  262. project.stop(service_names=['web'], timeout=1)
  263. assert set(c.name for c in project.containers() if c.is_running) == set([db_container.name])
  264. project.kill(service_names=['db'])
  265. assert len([c for c in project.containers() if c.is_running]) == 0
  266. assert len(project.containers(stopped=True)) == 3
  267. project.remove_stopped(service_names=['web'])
  268. assert len(project.containers(stopped=True)) == 1
  269. project.remove_stopped()
  270. assert len(project.containers(stopped=True)) == 0
  271. def test_create(self):
  272. web = self.create_service('web')
  273. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  274. project = Project('composetest', [web, db], self.client)
  275. project.create(['db'])
  276. containers = project.containers(stopped=True)
  277. assert len(containers) == 1
  278. assert not containers[0].is_running
  279. db_containers = db.containers(stopped=True)
  280. assert len(db_containers) == 1
  281. assert not db_containers[0].is_running
  282. assert len(web.containers(stopped=True)) == 0
  283. def test_create_twice(self):
  284. web = self.create_service('web')
  285. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  286. project = Project('composetest', [web, db], self.client)
  287. project.create(['db', 'web'])
  288. project.create(['db', 'web'])
  289. containers = project.containers(stopped=True)
  290. assert len(containers) == 2
  291. db_containers = db.containers(stopped=True)
  292. assert len(db_containers) == 1
  293. assert not db_containers[0].is_running
  294. web_containers = web.containers(stopped=True)
  295. assert len(web_containers) == 1
  296. assert not web_containers[0].is_running
  297. def test_create_with_links(self):
  298. db = self.create_service('db')
  299. web = self.create_service('web', links=[(db, 'db')])
  300. project = Project('composetest', [db, web], self.client)
  301. project.create(['web'])
  302. # self.assertEqual(len(project.containers()), 0)
  303. assert len(project.containers(stopped=True)) == 2
  304. assert not [c for c in project.containers(stopped=True) if c.is_running]
  305. assert len(db.containers(stopped=True)) == 1
  306. assert len(web.containers(stopped=True)) == 1
  307. def test_create_strategy_always(self):
  308. db = self.create_service('db')
  309. project = Project('composetest', [db], self.client)
  310. project.create(['db'])
  311. old_id = project.containers(stopped=True)[0].id
  312. project.create(['db'], strategy=ConvergenceStrategy.always)
  313. assert len(project.containers(stopped=True)) == 1
  314. db_container = project.containers(stopped=True)[0]
  315. assert not db_container.is_running
  316. assert db_container.id != old_id
  317. def test_create_strategy_never(self):
  318. db = self.create_service('db')
  319. project = Project('composetest', [db], self.client)
  320. project.create(['db'])
  321. old_id = project.containers(stopped=True)[0].id
  322. project.create(['db'], strategy=ConvergenceStrategy.never)
  323. assert len(project.containers(stopped=True)) == 1
  324. db_container = project.containers(stopped=True)[0]
  325. assert not db_container.is_running
  326. assert db_container.id == old_id
  327. def test_project_up(self):
  328. web = self.create_service('web')
  329. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  330. project = Project('composetest', [web, db], self.client)
  331. project.start()
  332. assert len(project.containers()) == 0
  333. project.up(['db'])
  334. assert len(project.containers()) == 1
  335. assert len(db.containers()) == 1
  336. assert len(web.containers()) == 0
  337. def test_project_up_starts_uncreated_services(self):
  338. db = self.create_service('db')
  339. web = self.create_service('web', links=[(db, 'db')])
  340. project = Project('composetest', [db, web], self.client)
  341. project.up(['db'])
  342. assert len(project.containers()) == 1
  343. project.up()
  344. assert len(project.containers()) == 2
  345. assert len(db.containers()) == 1
  346. assert len(web.containers()) == 1
  347. def test_recreate_preserves_volumes(self):
  348. web = self.create_service('web')
  349. db = self.create_service('db', volumes=[VolumeSpec.parse('/etc')])
  350. project = Project('composetest', [web, db], self.client)
  351. project.start()
  352. assert len(project.containers()) == 0
  353. project.up(['db'])
  354. assert len(project.containers()) == 1
  355. old_db_id = project.containers()[0].id
  356. db_volume_path = project.containers()[0].get('Volumes./etc')
  357. project.up(strategy=ConvergenceStrategy.always)
  358. assert len(project.containers()) == 2
  359. db_container = [c for c in project.containers() if 'db' in c.name][0]
  360. assert db_container.id != old_db_id
  361. assert db_container.get('Volumes./etc') == db_volume_path
  362. @v2_3_only()
  363. def test_recreate_preserves_mounts(self):
  364. web = self.create_service('web')
  365. db = self.create_service('db', volumes=[types.MountSpec(type='volume', target='/etc')])
  366. project = Project('composetest', [web, db], self.client)
  367. project.start()
  368. assert len(project.containers()) == 0
  369. project.up(['db'])
  370. assert len(project.containers()) == 1
  371. old_db_id = project.containers()[0].id
  372. db_volume_path = project.containers()[0].get_mount('/etc')['Source']
  373. project.up(strategy=ConvergenceStrategy.always)
  374. assert len(project.containers()) == 2
  375. db_container = [c for c in project.containers() if 'db' in c.name][0]
  376. assert db_container.id != old_db_id
  377. assert db_container.get_mount('/etc')['Source'] == db_volume_path
  378. def test_project_up_with_no_recreate_running(self):
  379. web = self.create_service('web')
  380. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  381. project = Project('composetest', [web, db], self.client)
  382. project.start()
  383. assert len(project.containers()) == 0
  384. project.up(['db'])
  385. assert len(project.containers()) == 1
  386. old_db_id = project.containers()[0].id
  387. container, = project.containers()
  388. db_volume_path = container.get_mount('/var/db')['Source']
  389. project.up(strategy=ConvergenceStrategy.never)
  390. assert len(project.containers()) == 2
  391. db_container = [c for c in project.containers() if 'db' in c.name][0]
  392. assert db_container.id == old_db_id
  393. assert db_container.get_mount('/var/db')['Source'] == db_volume_path
  394. def test_project_up_with_no_recreate_stopped(self):
  395. web = self.create_service('web')
  396. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  397. project = Project('composetest', [web, db], self.client)
  398. project.start()
  399. assert len(project.containers()) == 0
  400. project.up(['db'])
  401. project.kill()
  402. old_containers = project.containers(stopped=True)
  403. assert len(old_containers) == 1
  404. old_container, = old_containers
  405. old_db_id = old_container.id
  406. db_volume_path = old_container.get_mount('/var/db')['Source']
  407. project.up(strategy=ConvergenceStrategy.never)
  408. new_containers = project.containers(stopped=True)
  409. assert len(new_containers) == 2
  410. assert [c.is_running for c in new_containers] == [True, True]
  411. db_container = [c for c in new_containers if 'db' in c.name][0]
  412. assert db_container.id == old_db_id
  413. assert db_container.get_mount('/var/db')['Source'] == db_volume_path
  414. def test_project_up_without_all_services(self):
  415. console = self.create_service('console')
  416. db = self.create_service('db')
  417. project = Project('composetest', [console, db], self.client)
  418. project.start()
  419. assert len(project.containers()) == 0
  420. project.up()
  421. assert len(project.containers()) == 2
  422. assert len(db.containers()) == 1
  423. assert len(console.containers()) == 1
  424. def test_project_up_starts_links(self):
  425. console = self.create_service('console')
  426. db = self.create_service('db', volumes=[VolumeSpec.parse('/var/db')])
  427. web = self.create_service('web', links=[(db, 'db')])
  428. project = Project('composetest', [web, db, console], self.client)
  429. project.start()
  430. assert len(project.containers()) == 0
  431. project.up(['web'])
  432. assert len(project.containers()) == 2
  433. assert len(web.containers()) == 1
  434. assert len(db.containers()) == 1
  435. assert len(console.containers()) == 0
  436. def test_project_up_starts_depends(self):
  437. project = Project.from_config(
  438. name='composetest',
  439. config_data=load_config({
  440. 'console': {
  441. 'image': 'busybox:latest',
  442. 'command': ["top"],
  443. },
  444. 'data': {
  445. 'image': 'busybox:latest',
  446. 'command': ["top"]
  447. },
  448. 'db': {
  449. 'image': 'busybox:latest',
  450. 'command': ["top"],
  451. 'volumes_from': ['data'],
  452. },
  453. 'web': {
  454. 'image': 'busybox:latest',
  455. 'command': ["top"],
  456. 'links': ['db'],
  457. },
  458. }),
  459. client=self.client,
  460. )
  461. project.start()
  462. assert len(project.containers()) == 0
  463. project.up(['web'])
  464. assert len(project.containers()) == 3
  465. assert len(project.get_service('web').containers()) == 1
  466. assert len(project.get_service('db').containers()) == 1
  467. assert len(project.get_service('data').containers()) == 1
  468. assert len(project.get_service('console').containers()) == 0
  469. def test_project_up_with_no_deps(self):
  470. project = Project.from_config(
  471. name='composetest',
  472. config_data=load_config({
  473. 'console': {
  474. 'image': 'busybox:latest',
  475. 'command': ["top"],
  476. },
  477. 'data': {
  478. 'image': 'busybox:latest',
  479. 'command': ["top"]
  480. },
  481. 'db': {
  482. 'image': 'busybox:latest',
  483. 'command': ["top"],
  484. 'volumes_from': ['data'],
  485. },
  486. 'web': {
  487. 'image': 'busybox:latest',
  488. 'command': ["top"],
  489. 'links': ['db'],
  490. },
  491. }),
  492. client=self.client,
  493. )
  494. project.start()
  495. assert len(project.containers()) == 0
  496. project.up(['db'], start_deps=False)
  497. assert len(project.containers(stopped=True)) == 2
  498. assert len(project.get_service('web').containers()) == 0
  499. assert len(project.get_service('db').containers()) == 1
  500. assert len(project.get_service('data').containers(stopped=True)) == 1
  501. assert not project.get_service('data').containers(stopped=True)[0].is_running
  502. assert len(project.get_service('console').containers()) == 0
  503. def test_project_up_recreate_with_tmpfs_volume(self):
  504. # https://github.com/docker/compose/issues/4751
  505. project = Project.from_config(
  506. name='composetest',
  507. config_data=load_config({
  508. 'version': '2.1',
  509. 'services': {
  510. 'foo': {
  511. 'image': 'busybox:latest',
  512. 'tmpfs': ['/dev/shm'],
  513. 'volumes': ['/dev/shm']
  514. }
  515. }
  516. }), client=self.client
  517. )
  518. project.up()
  519. project.up(strategy=ConvergenceStrategy.always)
  520. def test_unscale_after_restart(self):
  521. web = self.create_service('web')
  522. project = Project('composetest', [web], self.client)
  523. project.start()
  524. service = project.get_service('web')
  525. service.scale(1)
  526. assert len(service.containers()) == 1
  527. service.scale(3)
  528. assert len(service.containers()) == 3
  529. project.up()
  530. service = project.get_service('web')
  531. assert len(service.containers()) == 1
  532. service.scale(1)
  533. assert len(service.containers()) == 1
  534. project.up(scale_override={'web': 3})
  535. service = project.get_service('web')
  536. assert len(service.containers()) == 3
  537. # does scale=0 ,makes any sense? after recreating at least 1 container is running
  538. service.scale(0)
  539. project.up()
  540. service = project.get_service('web')
  541. assert len(service.containers()) == 1
  542. @v2_only()
  543. def test_project_up_networks(self):
  544. config_data = build_config(
  545. version=V2_0,
  546. services=[{
  547. 'name': 'web',
  548. 'image': 'busybox:latest',
  549. 'command': 'top',
  550. 'networks': {
  551. 'foo': None,
  552. 'bar': None,
  553. 'baz': {'aliases': ['extra']},
  554. },
  555. }],
  556. networks={
  557. 'foo': {'driver': 'bridge'},
  558. 'bar': {'driver': None},
  559. 'baz': {},
  560. },
  561. )
  562. project = Project.from_config(
  563. client=self.client,
  564. name='composetest',
  565. config_data=config_data,
  566. )
  567. project.up()
  568. containers = project.containers()
  569. assert len(containers) == 1
  570. container, = containers
  571. for net_name in ['foo', 'bar', 'baz']:
  572. full_net_name = 'composetest_{}'.format(net_name)
  573. network_data = self.client.inspect_network(full_net_name)
  574. assert network_data['Name'] == full_net_name
  575. aliases_key = 'NetworkSettings.Networks.{net}.Aliases'
  576. assert 'web' in container.get(aliases_key.format(net='composetest_foo'))
  577. assert 'web' in container.get(aliases_key.format(net='composetest_baz'))
  578. assert 'extra' in container.get(aliases_key.format(net='composetest_baz'))
  579. foo_data = self.client.inspect_network('composetest_foo')
  580. assert foo_data['Driver'] == 'bridge'
  581. @v2_only()
  582. def test_up_with_ipam_config(self):
  583. config_data = build_config(
  584. version=V2_0,
  585. services=[{
  586. 'name': 'web',
  587. 'image': 'busybox:latest',
  588. 'networks': {'front': None},
  589. }],
  590. networks={
  591. 'front': {
  592. 'driver': 'bridge',
  593. 'driver_opts': {
  594. "com.docker.network.bridge.enable_icc": "false",
  595. },
  596. 'ipam': {
  597. 'driver': 'default',
  598. 'config': [{
  599. "subnet": "172.28.0.0/16",
  600. "ip_range": "172.28.5.0/24",
  601. "gateway": "172.28.5.254",
  602. "aux_addresses": {
  603. "a": "172.28.1.5",
  604. "b": "172.28.1.6",
  605. "c": "172.28.1.7",
  606. },
  607. }],
  608. },
  609. },
  610. },
  611. )
  612. project = Project.from_config(
  613. client=self.client,
  614. name='composetest',
  615. config_data=config_data,
  616. )
  617. project.up()
  618. network = self.client.networks(names=['composetest_front'])[0]
  619. assert network['Options'] == {
  620. "com.docker.network.bridge.enable_icc": "false"
  621. }
  622. assert network['IPAM'] == {
  623. 'Driver': 'default',
  624. 'Options': None,
  625. 'Config': [{
  626. 'Subnet': "172.28.0.0/16",
  627. 'IPRange': "172.28.5.0/24",
  628. 'Gateway': "172.28.5.254",
  629. 'AuxiliaryAddresses': {
  630. 'a': '172.28.1.5',
  631. 'b': '172.28.1.6',
  632. 'c': '172.28.1.7',
  633. },
  634. }],
  635. }
  636. @v2_only()
  637. def test_up_with_ipam_options(self):
  638. config_data = build_config(
  639. version=V2_0,
  640. services=[{
  641. 'name': 'web',
  642. 'image': 'busybox:latest',
  643. 'networks': {'front': None},
  644. }],
  645. networks={
  646. 'front': {
  647. 'driver': 'bridge',
  648. 'ipam': {
  649. 'driver': 'default',
  650. 'options': {
  651. "com.docker.compose.network.test": "9-29-045"
  652. }
  653. },
  654. },
  655. },
  656. )
  657. project = Project.from_config(
  658. client=self.client,
  659. name='composetest',
  660. config_data=config_data,
  661. )
  662. project.up()
  663. network = self.client.networks(names=['composetest_front'])[0]
  664. assert network['IPAM']['Options'] == {
  665. "com.docker.compose.network.test": "9-29-045"
  666. }
  667. @v2_1_only()
  668. def test_up_with_network_static_addresses(self):
  669. config_data = build_config(
  670. version=V2_1,
  671. services=[{
  672. 'name': 'web',
  673. 'image': 'busybox:latest',
  674. 'command': 'top',
  675. 'networks': {
  676. 'static_test': {
  677. 'ipv4_address': '172.16.100.100',
  678. 'ipv6_address': 'fe80::1001:102'
  679. }
  680. },
  681. }],
  682. networks={
  683. 'static_test': {
  684. 'driver': 'bridge',
  685. 'driver_opts': {
  686. "com.docker.network.enable_ipv6": "true",
  687. },
  688. 'ipam': {
  689. 'driver': 'default',
  690. 'config': [
  691. {"subnet": "172.16.100.0/24",
  692. "gateway": "172.16.100.1"},
  693. {"subnet": "fe80::/64",
  694. "gateway": "fe80::1001:1"}
  695. ]
  696. },
  697. 'enable_ipv6': True,
  698. }
  699. }
  700. )
  701. project = Project.from_config(
  702. client=self.client,
  703. name='composetest',
  704. config_data=config_data,
  705. )
  706. project.up(detached=True)
  707. service_container = project.get_service('web').containers()[0]
  708. ipam_config = (service_container.inspect().get('NetworkSettings', {}).
  709. get('Networks', {}).get('composetest_static_test', {}).
  710. get('IPAMConfig', {}))
  711. assert ipam_config.get('IPv4Address') == '172.16.100.100'
  712. assert ipam_config.get('IPv6Address') == 'fe80::1001:102'
  713. @v2_3_only()
  714. def test_up_with_network_priorities(self):
  715. mac_address = '74:6f:75:68:6f:75'
  716. def get_config_data(p1, p2, p3):
  717. return build_config(
  718. version=V2_3,
  719. services=[{
  720. 'name': 'web',
  721. 'image': 'busybox:latest',
  722. 'networks': {
  723. 'n1': {
  724. 'priority': p1,
  725. },
  726. 'n2': {
  727. 'priority': p2,
  728. },
  729. 'n3': {
  730. 'priority': p3,
  731. }
  732. },
  733. 'command': 'top',
  734. 'mac_address': mac_address
  735. }],
  736. networks={
  737. 'n1': {},
  738. 'n2': {},
  739. 'n3': {}
  740. }
  741. )
  742. config1 = get_config_data(1000, 1, 1)
  743. config2 = get_config_data(2, 3, 1)
  744. config3 = get_config_data(5, 40, 100)
  745. project = Project.from_config(
  746. client=self.client,
  747. name='composetest',
  748. config_data=config1
  749. )
  750. project.up(detached=True)
  751. service_container = project.get_service('web').containers()[0]
  752. net_config = service_container.inspect()['NetworkSettings']['Networks']['composetest_n1']
  753. assert net_config['MacAddress'] == mac_address
  754. project = Project.from_config(
  755. client=self.client,
  756. name='composetest',
  757. config_data=config2
  758. )
  759. project.up(detached=True)
  760. service_container = project.get_service('web').containers()[0]
  761. net_config = service_container.inspect()['NetworkSettings']['Networks']['composetest_n2']
  762. assert net_config['MacAddress'] == mac_address
  763. project = Project.from_config(
  764. client=self.client,
  765. name='composetest',
  766. config_data=config3
  767. )
  768. project.up(detached=True)
  769. service_container = project.get_service('web').containers()[0]
  770. net_config = service_container.inspect()['NetworkSettings']['Networks']['composetest_n3']
  771. assert net_config['MacAddress'] == mac_address
  772. @v2_1_only()
  773. def test_up_with_enable_ipv6(self):
  774. self.require_api_version('1.23')
  775. config_data = build_config(
  776. version=V2_1,
  777. services=[{
  778. 'name': 'web',
  779. 'image': 'busybox:latest',
  780. 'command': 'top',
  781. 'networks': {
  782. 'static_test': {
  783. 'ipv6_address': 'fe80::1001:102'
  784. }
  785. },
  786. }],
  787. networks={
  788. 'static_test': {
  789. 'driver': 'bridge',
  790. 'enable_ipv6': True,
  791. 'ipam': {
  792. 'driver': 'default',
  793. 'config': [
  794. {"subnet": "fe80::/64",
  795. "gateway": "fe80::1001:1"}
  796. ]
  797. }
  798. }
  799. }
  800. )
  801. project = Project.from_config(
  802. client=self.client,
  803. name='composetest',
  804. config_data=config_data,
  805. )
  806. project.up(detached=True)
  807. network = [n for n in self.client.networks() if 'static_test' in n['Name']][0]
  808. service_container = project.get_service('web').containers()[0]
  809. assert network['EnableIPv6'] is True
  810. ipam_config = (service_container.inspect().get('NetworkSettings', {}).
  811. get('Networks', {}).get('composetest_static_test', {}).
  812. get('IPAMConfig', {}))
  813. assert ipam_config.get('IPv6Address') == 'fe80::1001:102'
  814. @v2_only()
  815. def test_up_with_network_static_addresses_missing_subnet(self):
  816. config_data = build_config(
  817. version=V2_0,
  818. services=[{
  819. 'name': 'web',
  820. 'image': 'busybox:latest',
  821. 'networks': {
  822. 'static_test': {
  823. 'ipv4_address': '172.16.100.100',
  824. 'ipv6_address': 'fe80::1001:101'
  825. }
  826. },
  827. }],
  828. networks={
  829. 'static_test': {
  830. 'driver': 'bridge',
  831. 'driver_opts': {
  832. "com.docker.network.enable_ipv6": "true",
  833. },
  834. 'ipam': {
  835. 'driver': 'default',
  836. },
  837. },
  838. },
  839. )
  840. project = Project.from_config(
  841. client=self.client,
  842. name='composetest',
  843. config_data=config_data,
  844. )
  845. with pytest.raises(ProjectError):
  846. project.up()
  847. @v2_1_only()
  848. def test_up_with_network_link_local_ips(self):
  849. config_data = build_config(
  850. version=V2_1,
  851. services=[{
  852. 'name': 'web',
  853. 'image': 'busybox:latest',
  854. 'networks': {
  855. 'linklocaltest': {
  856. 'link_local_ips': ['169.254.8.8']
  857. }
  858. }
  859. }],
  860. networks={
  861. 'linklocaltest': {'driver': 'bridge'}
  862. }
  863. )
  864. project = Project.from_config(
  865. client=self.client,
  866. name='composetest',
  867. config_data=config_data
  868. )
  869. project.up(detached=True)
  870. service_container = project.get_service('web').containers(stopped=True)[0]
  871. ipam_config = service_container.inspect().get(
  872. 'NetworkSettings', {}
  873. ).get(
  874. 'Networks', {}
  875. ).get(
  876. 'composetest_linklocaltest', {}
  877. ).get('IPAMConfig', {})
  878. assert 'LinkLocalIPs' in ipam_config
  879. assert ipam_config['LinkLocalIPs'] == ['169.254.8.8']
  880. @v2_1_only()
  881. def test_up_with_custom_name_resources(self):
  882. config_data = build_config(
  883. version=V2_2,
  884. services=[{
  885. 'name': 'web',
  886. 'volumes': [VolumeSpec.parse('foo:/container-path')],
  887. 'networks': {'foo': {}},
  888. 'image': 'busybox:latest'
  889. }],
  890. networks={
  891. 'foo': {
  892. 'name': 'zztop',
  893. 'labels': {'com.docker.compose.test_value': 'sharpdressedman'}
  894. }
  895. },
  896. volumes={
  897. 'foo': {
  898. 'name': 'acdc',
  899. 'labels': {'com.docker.compose.test_value': 'thefuror'}
  900. }
  901. }
  902. )
  903. project = Project.from_config(
  904. client=self.client,
  905. name='composetest',
  906. config_data=config_data
  907. )
  908. project.up(detached=True)
  909. network = [n for n in self.client.networks() if n['Name'] == 'zztop'][0]
  910. volume = [v for v in self.client.volumes()['Volumes'] if v['Name'] == 'acdc'][0]
  911. assert network['Labels']['com.docker.compose.test_value'] == 'sharpdressedman'
  912. assert volume['Labels']['com.docker.compose.test_value'] == 'thefuror'
  913. @v2_1_only()
  914. def test_up_with_isolation(self):
  915. self.require_api_version('1.24')
  916. config_data = build_config(
  917. version=V2_1,
  918. services=[{
  919. 'name': 'web',
  920. 'image': 'busybox:latest',
  921. 'isolation': 'default'
  922. }],
  923. )
  924. project = Project.from_config(
  925. client=self.client,
  926. name='composetest',
  927. config_data=config_data
  928. )
  929. project.up(detached=True)
  930. service_container = project.get_service('web').containers(stopped=True)[0]
  931. assert service_container.inspect()['HostConfig']['Isolation'] == 'default'
  932. @v2_1_only()
  933. def test_up_with_invalid_isolation(self):
  934. self.require_api_version('1.24')
  935. config_data = build_config(
  936. version=V2_1,
  937. services=[{
  938. 'name': 'web',
  939. 'image': 'busybox:latest',
  940. 'isolation': 'foobar'
  941. }],
  942. )
  943. project = Project.from_config(
  944. client=self.client,
  945. name='composetest',
  946. config_data=config_data
  947. )
  948. with pytest.raises(ProjectError):
  949. project.up()
  950. @v2_3_only()
  951. @if_runtime_available('runc')
  952. def test_up_with_runtime(self):
  953. self.require_api_version('1.30')
  954. config_data = build_config(
  955. version=V2_3,
  956. services=[{
  957. 'name': 'web',
  958. 'image': 'busybox:latest',
  959. 'runtime': 'runc'
  960. }],
  961. )
  962. project = Project.from_config(
  963. client=self.client,
  964. name='composetest',
  965. config_data=config_data
  966. )
  967. project.up(detached=True)
  968. service_container = project.get_service('web').containers(stopped=True)[0]
  969. assert service_container.inspect()['HostConfig']['Runtime'] == 'runc'
  970. @v2_3_only()
  971. def test_up_with_invalid_runtime(self):
  972. self.require_api_version('1.30')
  973. config_data = build_config(
  974. version=V2_3,
  975. services=[{
  976. 'name': 'web',
  977. 'image': 'busybox:latest',
  978. 'runtime': 'foobar'
  979. }],
  980. )
  981. project = Project.from_config(
  982. client=self.client,
  983. name='composetest',
  984. config_data=config_data
  985. )
  986. with pytest.raises(ProjectError):
  987. project.up()
  988. @v2_3_only()
  989. @if_runtime_available('nvidia')
  990. def test_up_with_nvidia_runtime(self):
  991. self.require_api_version('1.30')
  992. config_data = build_config(
  993. version=V2_3,
  994. services=[{
  995. 'name': 'web',
  996. 'image': 'busybox:latest',
  997. 'runtime': 'nvidia'
  998. }],
  999. )
  1000. project = Project.from_config(
  1001. client=self.client,
  1002. name='composetest',
  1003. config_data=config_data
  1004. )
  1005. project.up(detached=True)
  1006. service_container = project.get_service('web').containers(stopped=True)[0]
  1007. assert service_container.inspect()['HostConfig']['Runtime'] == 'nvidia'
  1008. @v2_only()
  1009. def test_project_up_with_network_internal(self):
  1010. self.require_api_version('1.23')
  1011. config_data = build_config(
  1012. version=V2_0,
  1013. services=[{
  1014. 'name': 'web',
  1015. 'image': 'busybox:latest',
  1016. 'networks': {'internal': None},
  1017. }],
  1018. networks={
  1019. 'internal': {'driver': 'bridge', 'internal': True},
  1020. },
  1021. )
  1022. project = Project.from_config(
  1023. client=self.client,
  1024. name='composetest',
  1025. config_data=config_data,
  1026. )
  1027. project.up()
  1028. network = self.client.networks(names=['composetest_internal'])[0]
  1029. assert network['Internal'] is True
  1030. @v2_1_only()
  1031. def test_project_up_with_network_label(self):
  1032. self.require_api_version('1.23')
  1033. network_name = 'network_with_label'
  1034. config_data = build_config(
  1035. version=V2_1,
  1036. services=[{
  1037. 'name': 'web',
  1038. 'image': 'busybox:latest',
  1039. 'networks': {network_name: None}
  1040. }],
  1041. networks={
  1042. network_name: {'labels': {'label_key': 'label_val'}}
  1043. }
  1044. )
  1045. project = Project.from_config(
  1046. client=self.client,
  1047. name='composetest',
  1048. config_data=config_data
  1049. )
  1050. project.up()
  1051. networks = [
  1052. n for n in self.client.networks()
  1053. if n['Name'].startswith('composetest_')
  1054. ]
  1055. assert [n['Name'] for n in networks] == ['composetest_{}'.format(network_name)]
  1056. assert 'label_key' in networks[0]['Labels']
  1057. assert networks[0]['Labels']['label_key'] == 'label_val'
  1058. @v2_only()
  1059. def test_project_up_volumes(self):
  1060. vol_name = '{0:x}'.format(random.getrandbits(32))
  1061. full_vol_name = 'composetest_{0}'.format(vol_name)
  1062. config_data = build_config(
  1063. version=V2_0,
  1064. services=[{
  1065. 'name': 'web',
  1066. 'image': 'busybox:latest',
  1067. 'command': 'top'
  1068. }],
  1069. volumes={vol_name: {'driver': 'local'}},
  1070. )
  1071. project = Project.from_config(
  1072. name='composetest',
  1073. config_data=config_data, client=self.client
  1074. )
  1075. project.up()
  1076. assert len(project.containers()) == 1
  1077. volume_data = self.get_volume_data(full_vol_name)
  1078. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1079. assert volume_data['Driver'] == 'local'
  1080. @v2_1_only()
  1081. def test_project_up_with_volume_labels(self):
  1082. self.require_api_version('1.23')
  1083. volume_name = 'volume_with_label'
  1084. config_data = build_config(
  1085. version=V2_1,
  1086. services=[{
  1087. 'name': 'web',
  1088. 'image': 'busybox:latest',
  1089. 'volumes': [VolumeSpec.parse('{}:/data'.format(volume_name))]
  1090. }],
  1091. volumes={
  1092. volume_name: {
  1093. 'labels': {
  1094. 'label_key': 'label_val'
  1095. }
  1096. }
  1097. },
  1098. )
  1099. project = Project.from_config(
  1100. client=self.client,
  1101. name='composetest',
  1102. config_data=config_data,
  1103. )
  1104. project.up()
  1105. volumes = [
  1106. v for v in self.client.volumes().get('Volumes', [])
  1107. if v['Name'].split('/')[-1].startswith('composetest_')
  1108. ]
  1109. assert set([v['Name'].split('/')[-1] for v in volumes]) == set(
  1110. ['composetest_{}'.format(volume_name)]
  1111. )
  1112. assert 'label_key' in volumes[0]['Labels']
  1113. assert volumes[0]['Labels']['label_key'] == 'label_val'
  1114. @v2_only()
  1115. def test_project_up_logging_with_multiple_files(self):
  1116. base_file = config.ConfigFile(
  1117. 'base.yml',
  1118. {
  1119. 'version': str(V2_0),
  1120. 'services': {
  1121. 'simple': {'image': 'busybox:latest', 'command': 'top'},
  1122. 'another': {
  1123. 'image': 'busybox:latest',
  1124. 'command': 'top',
  1125. 'logging': {
  1126. 'driver': "json-file",
  1127. 'options': {
  1128. 'max-size': "10m"
  1129. }
  1130. }
  1131. }
  1132. }
  1133. })
  1134. override_file = config.ConfigFile(
  1135. 'override.yml',
  1136. {
  1137. 'version': str(V2_0),
  1138. 'services': {
  1139. 'another': {
  1140. 'logging': {
  1141. 'driver': "none"
  1142. }
  1143. }
  1144. }
  1145. })
  1146. details = config.ConfigDetails('.', [base_file, override_file])
  1147. tmpdir = py.test.ensuretemp('logging_test')
  1148. self.addCleanup(tmpdir.remove)
  1149. with tmpdir.as_cwd():
  1150. config_data = config.load(details)
  1151. project = Project.from_config(
  1152. name='composetest', config_data=config_data, client=self.client
  1153. )
  1154. project.up()
  1155. containers = project.containers()
  1156. assert len(containers) == 2
  1157. another = project.get_service('another').containers()[0]
  1158. log_config = another.get('HostConfig.LogConfig')
  1159. assert log_config
  1160. assert log_config.get('Type') == 'none'
  1161. @v2_only()
  1162. def test_project_up_port_mappings_with_multiple_files(self):
  1163. base_file = config.ConfigFile(
  1164. 'base.yml',
  1165. {
  1166. 'version': str(V2_0),
  1167. 'services': {
  1168. 'simple': {
  1169. 'image': 'busybox:latest',
  1170. 'command': 'top',
  1171. 'ports': ['1234:1234']
  1172. },
  1173. },
  1174. })
  1175. override_file = config.ConfigFile(
  1176. 'override.yml',
  1177. {
  1178. 'version': str(V2_0),
  1179. 'services': {
  1180. 'simple': {
  1181. 'ports': ['1234:1234']
  1182. }
  1183. }
  1184. })
  1185. details = config.ConfigDetails('.', [base_file, override_file])
  1186. config_data = config.load(details)
  1187. project = Project.from_config(
  1188. name='composetest', config_data=config_data, client=self.client
  1189. )
  1190. project.up()
  1191. containers = project.containers()
  1192. assert len(containers) == 1
  1193. @v2_2_only()
  1194. def test_project_up_config_scale(self):
  1195. config_data = build_config(
  1196. version=V2_2,
  1197. services=[{
  1198. 'name': 'web',
  1199. 'image': 'busybox:latest',
  1200. 'command': 'top',
  1201. 'scale': 3
  1202. }]
  1203. )
  1204. project = Project.from_config(
  1205. name='composetest', config_data=config_data, client=self.client
  1206. )
  1207. project.up()
  1208. assert len(project.containers()) == 3
  1209. project.up(scale_override={'web': 2})
  1210. assert len(project.containers()) == 2
  1211. project.up(scale_override={'web': 4})
  1212. assert len(project.containers()) == 4
  1213. project.stop()
  1214. project.up()
  1215. assert len(project.containers()) == 3
  1216. @v2_only()
  1217. def test_initialize_volumes(self):
  1218. vol_name = '{0:x}'.format(random.getrandbits(32))
  1219. full_vol_name = 'composetest_{0}'.format(vol_name)
  1220. config_data = build_config(
  1221. version=V2_0,
  1222. services=[{
  1223. 'name': 'web',
  1224. 'image': 'busybox:latest',
  1225. 'command': 'top'
  1226. }],
  1227. volumes={vol_name: {}},
  1228. )
  1229. project = Project.from_config(
  1230. name='composetest',
  1231. config_data=config_data, client=self.client
  1232. )
  1233. project.volumes.initialize()
  1234. volume_data = self.get_volume_data(full_vol_name)
  1235. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1236. assert volume_data['Driver'] == 'local'
  1237. @v2_only()
  1238. def test_project_up_implicit_volume_driver(self):
  1239. vol_name = '{0:x}'.format(random.getrandbits(32))
  1240. full_vol_name = 'composetest_{0}'.format(vol_name)
  1241. config_data = build_config(
  1242. version=V2_0,
  1243. services=[{
  1244. 'name': 'web',
  1245. 'image': 'busybox:latest',
  1246. 'command': 'top'
  1247. }],
  1248. volumes={vol_name: {}},
  1249. )
  1250. project = Project.from_config(
  1251. name='composetest',
  1252. config_data=config_data, client=self.client
  1253. )
  1254. project.up()
  1255. volume_data = self.get_volume_data(full_vol_name)
  1256. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1257. assert volume_data['Driver'] == 'local'
  1258. @v3_only()
  1259. def test_project_up_with_secrets(self):
  1260. node = create_host_file(self.client, os.path.abspath('tests/fixtures/secrets/default'))
  1261. config_data = build_config(
  1262. version=V3_1,
  1263. services=[{
  1264. 'name': 'web',
  1265. 'image': 'busybox:latest',
  1266. 'command': 'cat /run/secrets/special',
  1267. 'secrets': [
  1268. types.ServiceSecret.parse({'source': 'super', 'target': 'special'}),
  1269. ],
  1270. 'environment': ['constraint:node=={}'.format(node if node is not None else '*')]
  1271. }],
  1272. secrets={
  1273. 'super': {
  1274. 'file': os.path.abspath('tests/fixtures/secrets/default'),
  1275. },
  1276. },
  1277. )
  1278. project = Project.from_config(
  1279. client=self.client,
  1280. name='composetest',
  1281. config_data=config_data,
  1282. )
  1283. project.up()
  1284. project.stop()
  1285. containers = project.containers(stopped=True)
  1286. assert len(containers) == 1
  1287. container, = containers
  1288. output = container.logs()
  1289. assert output == b"This is the secret\n"
  1290. @v2_only()
  1291. def test_initialize_volumes_invalid_volume_driver(self):
  1292. vol_name = '{0:x}'.format(random.getrandbits(32))
  1293. config_data = build_config(
  1294. version=V2_0,
  1295. services=[{
  1296. 'name': 'web',
  1297. 'image': 'busybox:latest',
  1298. 'command': 'top'
  1299. }],
  1300. volumes={vol_name: {'driver': 'foobar'}},
  1301. )
  1302. project = Project.from_config(
  1303. name='composetest',
  1304. config_data=config_data, client=self.client
  1305. )
  1306. with pytest.raises(APIError if is_cluster(self.client) else config.ConfigurationError):
  1307. project.volumes.initialize()
  1308. @v2_only()
  1309. @no_cluster('inspect volume by name defect on Swarm Classic')
  1310. def test_initialize_volumes_updated_driver(self):
  1311. vol_name = '{0:x}'.format(random.getrandbits(32))
  1312. full_vol_name = 'composetest_{0}'.format(vol_name)
  1313. config_data = build_config(
  1314. version=V2_0,
  1315. services=[{
  1316. 'name': 'web',
  1317. 'image': 'busybox:latest',
  1318. 'command': 'top'
  1319. }],
  1320. volumes={vol_name: {'driver': 'local'}},
  1321. )
  1322. project = Project.from_config(
  1323. name='composetest',
  1324. config_data=config_data, client=self.client
  1325. )
  1326. project.volumes.initialize()
  1327. volume_data = self.get_volume_data(full_vol_name)
  1328. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1329. assert volume_data['Driver'] == 'local'
  1330. config_data = config_data._replace(
  1331. volumes={vol_name: {'driver': 'smb'}}
  1332. )
  1333. project = Project.from_config(
  1334. name='composetest',
  1335. config_data=config_data,
  1336. client=self.client
  1337. )
  1338. with pytest.raises(config.ConfigurationError) as e:
  1339. project.volumes.initialize()
  1340. assert 'Configuration for volume {0} specifies driver smb'.format(
  1341. vol_name
  1342. ) in str(e.value)
  1343. @v2_only()
  1344. def test_initialize_volumes_updated_blank_driver(self):
  1345. vol_name = '{0:x}'.format(random.getrandbits(32))
  1346. full_vol_name = 'composetest_{0}'.format(vol_name)
  1347. config_data = build_config(
  1348. version=V2_0,
  1349. services=[{
  1350. 'name': 'web',
  1351. 'image': 'busybox:latest',
  1352. 'command': 'top'
  1353. }],
  1354. volumes={vol_name: {'driver': 'local'}},
  1355. )
  1356. project = Project.from_config(
  1357. name='composetest',
  1358. config_data=config_data, client=self.client
  1359. )
  1360. project.volumes.initialize()
  1361. volume_data = self.get_volume_data(full_vol_name)
  1362. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1363. assert volume_data['Driver'] == 'local'
  1364. config_data = config_data._replace(
  1365. volumes={vol_name: {}}
  1366. )
  1367. project = Project.from_config(
  1368. name='composetest',
  1369. config_data=config_data,
  1370. client=self.client
  1371. )
  1372. project.volumes.initialize()
  1373. volume_data = self.get_volume_data(full_vol_name)
  1374. assert volume_data['Name'].split('/')[-1] == full_vol_name
  1375. assert volume_data['Driver'] == 'local'
  1376. @v2_only()
  1377. @no_cluster('inspect volume by name defect on Swarm Classic')
  1378. def test_initialize_volumes_external_volumes(self):
  1379. # Use composetest_ prefix so it gets garbage-collected in tearDown()
  1380. vol_name = 'composetest_{0:x}'.format(random.getrandbits(32))
  1381. full_vol_name = 'composetest_{0}'.format(vol_name)
  1382. self.client.create_volume(vol_name)
  1383. config_data = build_config(
  1384. version=V2_0,
  1385. services=[{
  1386. 'name': 'web',
  1387. 'image': 'busybox:latest',
  1388. 'command': 'top'
  1389. }],
  1390. volumes={
  1391. vol_name: {'external': True, 'name': vol_name}
  1392. },
  1393. )
  1394. project = Project.from_config(
  1395. name='composetest',
  1396. config_data=config_data, client=self.client
  1397. )
  1398. project.volumes.initialize()
  1399. with pytest.raises(NotFound):
  1400. self.client.inspect_volume(full_vol_name)
  1401. @v2_only()
  1402. def test_initialize_volumes_inexistent_external_volume(self):
  1403. vol_name = '{0:x}'.format(random.getrandbits(32))
  1404. config_data = build_config(
  1405. version=V2_0,
  1406. services=[{
  1407. 'name': 'web',
  1408. 'image': 'busybox:latest',
  1409. 'command': 'top'
  1410. }],
  1411. volumes={
  1412. vol_name: {'external': True, 'name': vol_name}
  1413. },
  1414. )
  1415. project = Project.from_config(
  1416. name='composetest',
  1417. config_data=config_data, client=self.client
  1418. )
  1419. with pytest.raises(config.ConfigurationError) as e:
  1420. project.volumes.initialize()
  1421. assert 'Volume {0} declared as external'.format(
  1422. vol_name
  1423. ) in str(e.value)
  1424. @v2_only()
  1425. def test_project_up_named_volumes_in_binds(self):
  1426. vol_name = '{0:x}'.format(random.getrandbits(32))
  1427. full_vol_name = 'composetest_{0}'.format(vol_name)
  1428. base_file = config.ConfigFile(
  1429. 'base.yml',
  1430. {
  1431. 'version': str(V2_0),
  1432. 'services': {
  1433. 'simple': {
  1434. 'image': 'busybox:latest',
  1435. 'command': 'top',
  1436. 'volumes': ['{0}:/data'.format(vol_name)]
  1437. },
  1438. },
  1439. 'volumes': {
  1440. vol_name: {'driver': 'local'}
  1441. }
  1442. })
  1443. config_details = config.ConfigDetails('.', [base_file])
  1444. config_data = config.load(config_details)
  1445. project = Project.from_config(
  1446. name='composetest', config_data=config_data, client=self.client
  1447. )
  1448. service = project.services[0]
  1449. assert service.name == 'simple'
  1450. volumes = service.options.get('volumes')
  1451. assert len(volumes) == 1
  1452. assert volumes[0].external == full_vol_name
  1453. project.up()
  1454. engine_volumes = self.client.volumes()['Volumes']
  1455. container = service.get_container()
  1456. assert [mount['Name'] for mount in container.get('Mounts')] == [full_vol_name]
  1457. assert next((v for v in engine_volumes if v['Name'] == vol_name), None) is None
  1458. def test_project_up_orphans(self):
  1459. config_dict = {
  1460. 'service1': {
  1461. 'image': 'busybox:latest',
  1462. 'command': 'top',
  1463. }
  1464. }
  1465. config_data = load_config(config_dict)
  1466. project = Project.from_config(
  1467. name='composetest', config_data=config_data, client=self.client
  1468. )
  1469. project.up()
  1470. config_dict['service2'] = config_dict['service1']
  1471. del config_dict['service1']
  1472. config_data = load_config(config_dict)
  1473. project = Project.from_config(
  1474. name='composetest', config_data=config_data, client=self.client
  1475. )
  1476. with mock.patch('compose.project.log') as mock_log:
  1477. project.up()
  1478. mock_log.warning.assert_called_once_with(mock.ANY)
  1479. assert len([
  1480. ctnr for ctnr in project._labeled_containers()
  1481. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1482. ]) == 1
  1483. project.up(remove_orphans=True)
  1484. assert len([
  1485. ctnr for ctnr in project._labeled_containers()
  1486. if ctnr.labels.get(LABEL_SERVICE) == 'service1'
  1487. ]) == 0
  1488. def test_project_up_ignore_orphans(self):
  1489. config_dict = {
  1490. 'service1': {
  1491. 'image': 'busybox:latest',
  1492. 'command': 'top',
  1493. }
  1494. }
  1495. config_data = load_config(config_dict)
  1496. project = Project.from_config(
  1497. name='composetest', config_data=config_data, client=self.client
  1498. )
  1499. project.up()
  1500. config_dict['service2'] = config_dict['service1']
  1501. del config_dict['service1']
  1502. config_data = load_config(config_dict)
  1503. project = Project.from_config(
  1504. name='composetest', config_data=config_data, client=self.client
  1505. )
  1506. with mock.patch('compose.project.log') as mock_log:
  1507. project.up(ignore_orphans=True)
  1508. mock_log.warning.assert_not_called()
  1509. @v2_1_only()
  1510. def test_project_up_healthy_dependency(self):
  1511. config_dict = {
  1512. 'version': '2.1',
  1513. 'services': {
  1514. 'svc1': {
  1515. 'image': 'busybox:latest',
  1516. 'command': 'top',
  1517. 'healthcheck': {
  1518. 'test': 'exit 0',
  1519. 'retries': 1,
  1520. 'timeout': '10s',
  1521. 'interval': '1s'
  1522. },
  1523. },
  1524. 'svc2': {
  1525. 'image': 'busybox:latest',
  1526. 'command': 'top',
  1527. 'depends_on': {
  1528. 'svc1': {'condition': 'service_healthy'},
  1529. }
  1530. }
  1531. }
  1532. }
  1533. config_data = load_config(config_dict)
  1534. project = Project.from_config(
  1535. name='composetest', config_data=config_data, client=self.client
  1536. )
  1537. project.up()
  1538. containers = project.containers()
  1539. assert len(containers) == 2
  1540. svc1 = project.get_service('svc1')
  1541. svc2 = project.get_service('svc2')
  1542. assert 'svc1' in svc2.get_dependency_names()
  1543. assert svc1.is_healthy()
  1544. @v2_1_only()
  1545. def test_project_up_unhealthy_dependency(self):
  1546. config_dict = {
  1547. 'version': '2.1',
  1548. 'services': {
  1549. 'svc1': {
  1550. 'image': 'busybox:latest',
  1551. 'command': 'top',
  1552. 'healthcheck': {
  1553. 'test': 'exit 1',
  1554. 'retries': 1,
  1555. 'timeout': '10s',
  1556. 'interval': '1s'
  1557. },
  1558. },
  1559. 'svc2': {
  1560. 'image': 'busybox:latest',
  1561. 'command': 'top',
  1562. 'depends_on': {
  1563. 'svc1': {'condition': 'service_healthy'},
  1564. }
  1565. }
  1566. }
  1567. }
  1568. config_data = load_config(config_dict)
  1569. project = Project.from_config(
  1570. name='composetest', config_data=config_data, client=self.client
  1571. )
  1572. with pytest.raises(ProjectError):
  1573. project.up()
  1574. containers = project.containers()
  1575. assert len(containers) == 1
  1576. svc1 = project.get_service('svc1')
  1577. svc2 = project.get_service('svc2')
  1578. assert 'svc1' in svc2.get_dependency_names()
  1579. with pytest.raises(HealthCheckFailed):
  1580. svc1.is_healthy()
  1581. @v2_1_only()
  1582. def test_project_up_no_healthcheck_dependency(self):
  1583. config_dict = {
  1584. 'version': '2.1',
  1585. 'services': {
  1586. 'svc1': {
  1587. 'image': 'busybox:latest',
  1588. 'command': 'top',
  1589. 'healthcheck': {
  1590. 'disable': True
  1591. },
  1592. },
  1593. 'svc2': {
  1594. 'image': 'busybox:latest',
  1595. 'command': 'top',
  1596. 'depends_on': {
  1597. 'svc1': {'condition': 'service_healthy'},
  1598. }
  1599. }
  1600. }
  1601. }
  1602. config_data = load_config(config_dict)
  1603. project = Project.from_config(
  1604. name='composetest', config_data=config_data, client=self.client
  1605. )
  1606. with pytest.raises(ProjectError):
  1607. project.up()
  1608. containers = project.containers()
  1609. assert len(containers) == 1
  1610. svc1 = project.get_service('svc1')
  1611. svc2 = project.get_service('svc2')
  1612. assert 'svc1' in svc2.get_dependency_names()
  1613. with pytest.raises(NoHealthCheckConfigured):
  1614. svc1.is_healthy()
  1615. def test_project_up_seccomp_profile(self):
  1616. seccomp_data = {
  1617. 'defaultAction': 'SCMP_ACT_ALLOW',
  1618. 'syscalls': []
  1619. }
  1620. fd, profile_path = tempfile.mkstemp('_seccomp.json')
  1621. self.addCleanup(os.remove, profile_path)
  1622. with os.fdopen(fd, 'w') as f:
  1623. json.dump(seccomp_data, f)
  1624. config_dict = {
  1625. 'version': '2.3',
  1626. 'services': {
  1627. 'svc1': {
  1628. 'image': 'busybox:latest',
  1629. 'command': 'top',
  1630. 'security_opt': ['seccomp:"{}"'.format(profile_path)]
  1631. }
  1632. }
  1633. }
  1634. config_data = load_config(config_dict)
  1635. project = Project.from_config(name='composetest', config_data=config_data, client=self.client)
  1636. project.up()
  1637. containers = project.containers()
  1638. assert len(containers) == 1
  1639. remote_secopts = containers[0].get('HostConfig.SecurityOpt')
  1640. assert len(remote_secopts) == 1
  1641. assert remote_secopts[0].startswith('seccomp=')
  1642. assert json.loads(remote_secopts[0].lstrip('seccomp=')) == seccomp_data