project_test.py 68 KB

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