project_test.py 68 KB

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