project_test.py 68 KB

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