project_test.py 66 KB

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