project_test.py 67 KB

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