project_test.py 68 KB

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