config_test.py 144 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441
  1. # encoding: utf-8
  2. from __future__ import absolute_import
  3. from __future__ import print_function
  4. from __future__ import unicode_literals
  5. import os
  6. import shutil
  7. import tempfile
  8. from operator import itemgetter
  9. import py
  10. import pytest
  11. import yaml
  12. from ...helpers import build_config_details
  13. from compose.config import config
  14. from compose.config import types
  15. from compose.config.config import resolve_build_args
  16. from compose.config.config import resolve_environment
  17. from compose.config.environment import Environment
  18. from compose.config.errors import ConfigurationError
  19. from compose.config.errors import VERSION_EXPLANATION
  20. from compose.config.serialize import denormalize_service_dict
  21. from compose.config.serialize import serialize_config
  22. from compose.config.serialize import serialize_ns_time_value
  23. from compose.config.types import VolumeSpec
  24. from compose.const import COMPOSEFILE_V1 as V1
  25. from compose.const import COMPOSEFILE_V2_0 as V2_0
  26. from compose.const import COMPOSEFILE_V2_1 as V2_1
  27. from compose.const import COMPOSEFILE_V2_2 as V2_2
  28. from compose.const import COMPOSEFILE_V2_3 as V2_3
  29. from compose.const import COMPOSEFILE_V3_0 as V3_0
  30. from compose.const import COMPOSEFILE_V3_1 as V3_1
  31. from compose.const import COMPOSEFILE_V3_2 as V3_2
  32. from compose.const import COMPOSEFILE_V3_3 as V3_3
  33. from compose.const import IS_WINDOWS_PLATFORM
  34. from compose.utils import nanoseconds_from_time_seconds
  35. from tests import mock
  36. from tests import unittest
  37. DEFAULT_VERSION = V2_0
  38. def make_service_dict(name, service_dict, working_dir, filename=None):
  39. """Test helper function to construct a ServiceExtendsResolver
  40. """
  41. resolver = config.ServiceExtendsResolver(
  42. config.ServiceConfig(
  43. working_dir=working_dir,
  44. filename=filename,
  45. name=name,
  46. config=service_dict),
  47. config.ConfigFile(filename=filename, config={}),
  48. environment=Environment.from_env_file(working_dir)
  49. )
  50. return config.process_service(resolver.run())
  51. def service_sort(services):
  52. return sorted(services, key=itemgetter('name'))
  53. def secret_sort(secrets):
  54. return sorted(secrets, key=itemgetter('source'))
  55. class ConfigTest(unittest.TestCase):
  56. def test_load(self):
  57. service_dicts = config.load(
  58. build_config_details(
  59. {
  60. 'foo': {'image': 'busybox'},
  61. 'bar': {'image': 'busybox', 'environment': ['FOO=1']},
  62. },
  63. 'tests/fixtures/extends',
  64. 'common.yml'
  65. )
  66. ).services
  67. self.assertEqual(
  68. service_sort(service_dicts),
  69. service_sort([
  70. {
  71. 'name': 'bar',
  72. 'image': 'busybox',
  73. 'environment': {'FOO': '1'},
  74. },
  75. {
  76. 'name': 'foo',
  77. 'image': 'busybox',
  78. }
  79. ])
  80. )
  81. def test_load_v2(self):
  82. config_data = config.load(
  83. build_config_details({
  84. 'version': '2',
  85. 'services': {
  86. 'foo': {'image': 'busybox'},
  87. 'bar': {'image': 'busybox', 'environment': ['FOO=1']},
  88. },
  89. 'volumes': {
  90. 'hello': {
  91. 'driver': 'default',
  92. 'driver_opts': {'beep': 'boop'}
  93. }
  94. },
  95. 'networks': {
  96. 'default': {
  97. 'driver': 'bridge',
  98. 'driver_opts': {'beep': 'boop'}
  99. },
  100. 'with_ipam': {
  101. 'ipam': {
  102. 'driver': 'default',
  103. 'config': [
  104. {'subnet': '172.28.0.0/16'}
  105. ]
  106. }
  107. },
  108. 'internal': {
  109. 'driver': 'bridge',
  110. 'internal': True
  111. }
  112. }
  113. }, 'working_dir', 'filename.yml')
  114. )
  115. service_dicts = config_data.services
  116. volume_dict = config_data.volumes
  117. networks_dict = config_data.networks
  118. self.assertEqual(
  119. service_sort(service_dicts),
  120. service_sort([
  121. {
  122. 'name': 'bar',
  123. 'image': 'busybox',
  124. 'environment': {'FOO': '1'},
  125. },
  126. {
  127. 'name': 'foo',
  128. 'image': 'busybox',
  129. }
  130. ])
  131. )
  132. self.assertEqual(volume_dict, {
  133. 'hello': {
  134. 'driver': 'default',
  135. 'driver_opts': {'beep': 'boop'}
  136. }
  137. })
  138. self.assertEqual(networks_dict, {
  139. 'default': {
  140. 'driver': 'bridge',
  141. 'driver_opts': {'beep': 'boop'}
  142. },
  143. 'with_ipam': {
  144. 'ipam': {
  145. 'driver': 'default',
  146. 'config': [
  147. {'subnet': '172.28.0.0/16'}
  148. ]
  149. }
  150. },
  151. 'internal': {
  152. 'driver': 'bridge',
  153. 'internal': True
  154. }
  155. })
  156. def test_valid_versions(self):
  157. for version in ['2', '2.0']:
  158. cfg = config.load(build_config_details({'version': version}))
  159. assert cfg.version == V2_0
  160. cfg = config.load(build_config_details({'version': '2.1'}))
  161. assert cfg.version == V2_1
  162. cfg = config.load(build_config_details({'version': '2.2'}))
  163. assert cfg.version == V2_2
  164. cfg = config.load(build_config_details({'version': '2.3'}))
  165. assert cfg.version == V2_3
  166. for version in ['3', '3.0']:
  167. cfg = config.load(build_config_details({'version': version}))
  168. assert cfg.version == V3_0
  169. cfg = config.load(build_config_details({'version': '3.1'}))
  170. assert cfg.version == V3_1
  171. def test_v1_file_version(self):
  172. cfg = config.load(build_config_details({'web': {'image': 'busybox'}}))
  173. assert cfg.version == V1
  174. assert list(s['name'] for s in cfg.services) == ['web']
  175. cfg = config.load(build_config_details({'version': {'image': 'busybox'}}))
  176. assert cfg.version == V1
  177. assert list(s['name'] for s in cfg.services) == ['version']
  178. def test_wrong_version_type(self):
  179. for version in [None, 1, 2, 2.0]:
  180. with pytest.raises(ConfigurationError) as excinfo:
  181. config.load(
  182. build_config_details(
  183. {'version': version},
  184. filename='filename.yml',
  185. )
  186. )
  187. assert 'Version in "filename.yml" is invalid - it should be a string.' \
  188. in excinfo.exconly()
  189. def test_unsupported_version(self):
  190. with pytest.raises(ConfigurationError) as excinfo:
  191. config.load(
  192. build_config_details(
  193. {'version': '2.18'},
  194. filename='filename.yml',
  195. )
  196. )
  197. assert 'Version in "filename.yml" is unsupported' in excinfo.exconly()
  198. assert VERSION_EXPLANATION in excinfo.exconly()
  199. def test_version_1_is_invalid(self):
  200. with pytest.raises(ConfigurationError) as excinfo:
  201. config.load(
  202. build_config_details(
  203. {
  204. 'version': '1',
  205. 'web': {'image': 'busybox'},
  206. },
  207. filename='filename.yml',
  208. )
  209. )
  210. assert 'Version in "filename.yml" is invalid' in excinfo.exconly()
  211. assert VERSION_EXPLANATION in excinfo.exconly()
  212. def test_v1_file_with_version_is_invalid(self):
  213. with pytest.raises(ConfigurationError) as excinfo:
  214. config.load(
  215. build_config_details(
  216. {
  217. 'version': '2',
  218. 'web': {'image': 'busybox'},
  219. },
  220. filename='filename.yml',
  221. )
  222. )
  223. assert 'Invalid top-level property "web"' in excinfo.exconly()
  224. assert VERSION_EXPLANATION in excinfo.exconly()
  225. def test_named_volume_config_empty(self):
  226. config_details = build_config_details({
  227. 'version': '2',
  228. 'services': {
  229. 'simple': {'image': 'busybox'}
  230. },
  231. 'volumes': {
  232. 'simple': None,
  233. 'other': {},
  234. }
  235. })
  236. config_result = config.load(config_details)
  237. volumes = config_result.volumes
  238. assert 'simple' in volumes
  239. assert volumes['simple'] == {}
  240. assert volumes['other'] == {}
  241. def test_named_volume_numeric_driver_opt(self):
  242. config_details = build_config_details({
  243. 'version': '2',
  244. 'services': {
  245. 'simple': {'image': 'busybox'}
  246. },
  247. 'volumes': {
  248. 'simple': {'driver_opts': {'size': 42}},
  249. }
  250. })
  251. cfg = config.load(config_details)
  252. assert cfg.volumes['simple']['driver_opts']['size'] == '42'
  253. def test_volume_invalid_driver_opt(self):
  254. config_details = build_config_details({
  255. 'version': '2',
  256. 'services': {
  257. 'simple': {'image': 'busybox'}
  258. },
  259. 'volumes': {
  260. 'simple': {'driver_opts': {'size': True}},
  261. }
  262. })
  263. with pytest.raises(ConfigurationError) as exc:
  264. config.load(config_details)
  265. assert 'driver_opts.size contains an invalid type' in exc.exconly()
  266. def test_named_volume_invalid_type_list(self):
  267. config_details = build_config_details({
  268. 'version': '2',
  269. 'services': {
  270. 'simple': {'image': 'busybox'}
  271. },
  272. 'volumes': []
  273. })
  274. with pytest.raises(ConfigurationError) as exc:
  275. config.load(config_details)
  276. assert "volume must be a mapping, not an array" in exc.exconly()
  277. def test_networks_invalid_type_list(self):
  278. config_details = build_config_details({
  279. 'version': '2',
  280. 'services': {
  281. 'simple': {'image': 'busybox'}
  282. },
  283. 'networks': []
  284. })
  285. with pytest.raises(ConfigurationError) as exc:
  286. config.load(config_details)
  287. assert "network must be a mapping, not an array" in exc.exconly()
  288. def test_load_service_with_name_version(self):
  289. with mock.patch('compose.config.config.log') as mock_logging:
  290. config_data = config.load(
  291. build_config_details({
  292. 'version': {
  293. 'image': 'busybox'
  294. }
  295. }, 'working_dir', 'filename.yml')
  296. )
  297. assert 'Unexpected type for "version" key in "filename.yml"' \
  298. in mock_logging.warn.call_args[0][0]
  299. service_dicts = config_data.services
  300. self.assertEqual(
  301. service_sort(service_dicts),
  302. service_sort([
  303. {
  304. 'name': 'version',
  305. 'image': 'busybox',
  306. }
  307. ])
  308. )
  309. def test_load_throws_error_when_not_dict(self):
  310. with self.assertRaises(ConfigurationError):
  311. config.load(
  312. build_config_details(
  313. {'web': 'busybox:latest'},
  314. 'working_dir',
  315. 'filename.yml'
  316. )
  317. )
  318. def test_load_throws_error_when_not_dict_v2(self):
  319. with self.assertRaises(ConfigurationError):
  320. config.load(
  321. build_config_details(
  322. {'version': '2', 'services': {'web': 'busybox:latest'}},
  323. 'working_dir',
  324. 'filename.yml'
  325. )
  326. )
  327. def test_load_throws_error_with_invalid_network_fields(self):
  328. with self.assertRaises(ConfigurationError):
  329. config.load(
  330. build_config_details({
  331. 'version': '2',
  332. 'services': {'web': 'busybox:latest'},
  333. 'networks': {
  334. 'invalid': {'foo', 'bar'}
  335. }
  336. }, 'working_dir', 'filename.yml')
  337. )
  338. def test_load_config_link_local_ips_network(self):
  339. base_file = config.ConfigFile(
  340. 'base.yaml',
  341. {
  342. 'version': str(V2_1),
  343. 'services': {
  344. 'web': {
  345. 'image': 'example/web',
  346. 'networks': {
  347. 'foobar': {
  348. 'aliases': ['foo', 'bar'],
  349. 'link_local_ips': ['169.254.8.8']
  350. }
  351. }
  352. }
  353. },
  354. 'networks': {'foobar': {}}
  355. }
  356. )
  357. details = config.ConfigDetails('.', [base_file])
  358. web_service = config.load(details).services[0]
  359. assert web_service['networks'] == {
  360. 'foobar': {
  361. 'aliases': ['foo', 'bar'],
  362. 'link_local_ips': ['169.254.8.8']
  363. }
  364. }
  365. def test_load_config_volume_and_network_labels(self):
  366. base_file = config.ConfigFile(
  367. 'base.yaml',
  368. {
  369. 'version': '2.1',
  370. 'services': {
  371. 'web': {
  372. 'image': 'example/web',
  373. },
  374. },
  375. 'networks': {
  376. 'with_label': {
  377. 'labels': {
  378. 'label_key': 'label_val'
  379. }
  380. }
  381. },
  382. 'volumes': {
  383. 'with_label': {
  384. 'labels': {
  385. 'label_key': 'label_val'
  386. }
  387. }
  388. }
  389. }
  390. )
  391. details = config.ConfigDetails('.', [base_file])
  392. network_dict = config.load(details).networks
  393. volume_dict = config.load(details).volumes
  394. self.assertEqual(
  395. network_dict,
  396. {
  397. 'with_label': {
  398. 'labels': {
  399. 'label_key': 'label_val'
  400. }
  401. }
  402. }
  403. )
  404. self.assertEqual(
  405. volume_dict,
  406. {
  407. 'with_label': {
  408. 'labels': {
  409. 'label_key': 'label_val'
  410. }
  411. }
  412. }
  413. )
  414. def test_load_config_invalid_service_names(self):
  415. for invalid_name in ['?not?allowed', ' ', '', '!', '/', '\xe2']:
  416. with pytest.raises(ConfigurationError) as exc:
  417. config.load(build_config_details(
  418. {invalid_name: {'image': 'busybox'}}))
  419. assert 'Invalid service name \'%s\'' % invalid_name in exc.exconly()
  420. def test_load_config_invalid_service_names_v2(self):
  421. for invalid_name in ['?not?allowed', ' ', '', '!', '/', '\xe2']:
  422. with pytest.raises(ConfigurationError) as exc:
  423. config.load(build_config_details(
  424. {
  425. 'version': '2',
  426. 'services': {invalid_name: {'image': 'busybox'}},
  427. }))
  428. assert 'Invalid service name \'%s\'' % invalid_name in exc.exconly()
  429. def test_load_with_invalid_field_name(self):
  430. with pytest.raises(ConfigurationError) as exc:
  431. config.load(build_config_details(
  432. {
  433. 'version': '2',
  434. 'services': {
  435. 'web': {'image': 'busybox', 'name': 'bogus'},
  436. }
  437. },
  438. 'working_dir',
  439. 'filename.yml',
  440. ))
  441. assert "Unsupported config option for services.web: 'name'" in exc.exconly()
  442. def test_load_with_invalid_field_name_v1(self):
  443. with pytest.raises(ConfigurationError) as exc:
  444. config.load(build_config_details(
  445. {
  446. 'web': {'image': 'busybox', 'name': 'bogus'},
  447. },
  448. 'working_dir',
  449. 'filename.yml',
  450. ))
  451. assert "Unsupported config option for web: 'name'" in exc.exconly()
  452. def test_load_invalid_service_definition(self):
  453. config_details = build_config_details(
  454. {'web': 'wrong'},
  455. 'working_dir',
  456. 'filename.yml')
  457. with pytest.raises(ConfigurationError) as exc:
  458. config.load(config_details)
  459. assert "service 'web' must be a mapping not a string." in exc.exconly()
  460. def test_load_with_empty_build_args(self):
  461. config_details = build_config_details(
  462. {
  463. 'version': '2',
  464. 'services': {
  465. 'web': {
  466. 'build': {
  467. 'context': '.',
  468. 'args': None,
  469. },
  470. },
  471. },
  472. }
  473. )
  474. with pytest.raises(ConfigurationError) as exc:
  475. config.load(config_details)
  476. assert (
  477. "services.web.build.args contains an invalid type, it should be an "
  478. "object, or an array" in exc.exconly()
  479. )
  480. def test_config_integer_service_name_raise_validation_error(self):
  481. with pytest.raises(ConfigurationError) as excinfo:
  482. config.load(
  483. build_config_details(
  484. {1: {'image': 'busybox'}},
  485. 'working_dir',
  486. 'filename.yml'
  487. )
  488. )
  489. assert (
  490. "In file 'filename.yml', the service name 1 must be a quoted string, i.e. '1'" in
  491. excinfo.exconly()
  492. )
  493. def test_config_integer_service_name_raise_validation_error_v2(self):
  494. with pytest.raises(ConfigurationError) as excinfo:
  495. config.load(
  496. build_config_details(
  497. {
  498. 'version': '2',
  499. 'services': {1: {'image': 'busybox'}}
  500. },
  501. 'working_dir',
  502. 'filename.yml'
  503. )
  504. )
  505. assert (
  506. "In file 'filename.yml', the service name 1 must be a quoted string, i.e. '1'." in
  507. excinfo.exconly()
  508. )
  509. def test_config_invalid_service_name_raise_validation_error(self):
  510. with pytest.raises(ConfigurationError) as excinfo:
  511. config.load(
  512. build_config_details({
  513. 'version': '2',
  514. 'services': {
  515. 'test_app': {'build': '.'},
  516. 'mong\\o': {'image': 'mongo'},
  517. }
  518. })
  519. )
  520. assert 'Invalid service name \'mong\\o\'' in excinfo.exconly()
  521. def test_config_duplicate_cache_from_values_validation_error(self):
  522. with pytest.raises(ConfigurationError) as exc:
  523. config.load(
  524. build_config_details({
  525. 'version': '2.3',
  526. 'services': {
  527. 'test': {'build': {'context': '.', 'cache_from': ['a', 'b', 'a']}}
  528. }
  529. })
  530. )
  531. assert 'build.cache_from contains non-unique items' in exc.exconly()
  532. def test_load_with_multiple_files_v1(self):
  533. base_file = config.ConfigFile(
  534. 'base.yaml',
  535. {
  536. 'web': {
  537. 'image': 'example/web',
  538. 'links': ['db'],
  539. },
  540. 'db': {
  541. 'image': 'example/db',
  542. },
  543. })
  544. override_file = config.ConfigFile(
  545. 'override.yaml',
  546. {
  547. 'web': {
  548. 'build': '/',
  549. 'volumes': ['/home/user/project:/code'],
  550. },
  551. })
  552. details = config.ConfigDetails('.', [base_file, override_file])
  553. service_dicts = config.load(details).services
  554. expected = [
  555. {
  556. 'name': 'web',
  557. 'build': {'context': os.path.abspath('/')},
  558. 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
  559. 'links': ['db'],
  560. },
  561. {
  562. 'name': 'db',
  563. 'image': 'example/db',
  564. },
  565. ]
  566. assert service_sort(service_dicts) == service_sort(expected)
  567. def test_load_with_multiple_files_and_empty_override(self):
  568. base_file = config.ConfigFile(
  569. 'base.yml',
  570. {'web': {'image': 'example/web'}})
  571. override_file = config.ConfigFile('override.yml', None)
  572. details = config.ConfigDetails('.', [base_file, override_file])
  573. with pytest.raises(ConfigurationError) as exc:
  574. config.load(details)
  575. error_msg = "Top level object in 'override.yml' needs to be an object"
  576. assert error_msg in exc.exconly()
  577. def test_load_with_multiple_files_and_empty_override_v2(self):
  578. base_file = config.ConfigFile(
  579. 'base.yml',
  580. {'version': '2', 'services': {'web': {'image': 'example/web'}}})
  581. override_file = config.ConfigFile('override.yml', None)
  582. details = config.ConfigDetails('.', [base_file, override_file])
  583. with pytest.raises(ConfigurationError) as exc:
  584. config.load(details)
  585. error_msg = "Top level object in 'override.yml' needs to be an object"
  586. assert error_msg in exc.exconly()
  587. def test_load_with_multiple_files_and_empty_base(self):
  588. base_file = config.ConfigFile('base.yml', None)
  589. override_file = config.ConfigFile(
  590. 'override.yml',
  591. {'web': {'image': 'example/web'}})
  592. details = config.ConfigDetails('.', [base_file, override_file])
  593. with pytest.raises(ConfigurationError) as exc:
  594. config.load(details)
  595. assert "Top level object in 'base.yml' needs to be an object" in exc.exconly()
  596. def test_load_with_multiple_files_and_empty_base_v2(self):
  597. base_file = config.ConfigFile('base.yml', None)
  598. override_file = config.ConfigFile(
  599. 'override.tml',
  600. {'version': '2', 'services': {'web': {'image': 'example/web'}}}
  601. )
  602. details = config.ConfigDetails('.', [base_file, override_file])
  603. with pytest.raises(ConfigurationError) as exc:
  604. config.load(details)
  605. assert "Top level object in 'base.yml' needs to be an object" in exc.exconly()
  606. def test_load_with_multiple_files_and_extends_in_override_file(self):
  607. base_file = config.ConfigFile(
  608. 'base.yaml',
  609. {
  610. 'web': {'image': 'example/web'},
  611. })
  612. override_file = config.ConfigFile(
  613. 'override.yaml',
  614. {
  615. 'web': {
  616. 'extends': {
  617. 'file': 'common.yml',
  618. 'service': 'base',
  619. },
  620. 'volumes': ['/home/user/project:/code'],
  621. },
  622. })
  623. details = config.ConfigDetails('.', [base_file, override_file])
  624. tmpdir = py.test.ensuretemp('config_test')
  625. self.addCleanup(tmpdir.remove)
  626. tmpdir.join('common.yml').write("""
  627. base:
  628. labels: ['label=one']
  629. """)
  630. with tmpdir.as_cwd():
  631. service_dicts = config.load(details).services
  632. expected = [
  633. {
  634. 'name': 'web',
  635. 'image': 'example/web',
  636. 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
  637. 'labels': {'label': 'one'},
  638. },
  639. ]
  640. self.assertEqual(service_sort(service_dicts), service_sort(expected))
  641. def test_load_mixed_extends_resolution(self):
  642. main_file = config.ConfigFile(
  643. 'main.yml', {
  644. 'version': '2.2',
  645. 'services': {
  646. 'prodweb': {
  647. 'extends': {
  648. 'service': 'web',
  649. 'file': 'base.yml'
  650. },
  651. 'environment': {'PROD': 'true'},
  652. },
  653. },
  654. }
  655. )
  656. tmpdir = pytest.ensuretemp('config_test')
  657. self.addCleanup(tmpdir.remove)
  658. tmpdir.join('base.yml').write("""
  659. version: '2.2'
  660. services:
  661. base:
  662. image: base
  663. web:
  664. extends: base
  665. """)
  666. details = config.ConfigDetails('.', [main_file])
  667. with tmpdir.as_cwd():
  668. service_dicts = config.load(details).services
  669. assert service_dicts[0] == {
  670. 'name': 'prodweb',
  671. 'image': 'base',
  672. 'environment': {'PROD': 'true'},
  673. }
  674. def test_load_with_multiple_files_and_invalid_override(self):
  675. base_file = config.ConfigFile(
  676. 'base.yaml',
  677. {'web': {'image': 'example/web'}})
  678. override_file = config.ConfigFile(
  679. 'override.yaml',
  680. {'bogus': 'thing'})
  681. details = config.ConfigDetails('.', [base_file, override_file])
  682. with pytest.raises(ConfigurationError) as exc:
  683. config.load(details)
  684. assert "service 'bogus' must be a mapping not a string." in exc.exconly()
  685. assert "In file 'override.yaml'" in exc.exconly()
  686. def test_load_sorts_in_dependency_order(self):
  687. config_details = build_config_details({
  688. 'web': {
  689. 'image': 'busybox:latest',
  690. 'links': ['db'],
  691. },
  692. 'db': {
  693. 'image': 'busybox:latest',
  694. 'volumes_from': ['volume:ro']
  695. },
  696. 'volume': {
  697. 'image': 'busybox:latest',
  698. 'volumes': ['/tmp'],
  699. }
  700. })
  701. services = config.load(config_details).services
  702. assert services[0]['name'] == 'volume'
  703. assert services[1]['name'] == 'db'
  704. assert services[2]['name'] == 'web'
  705. def test_load_with_extensions(self):
  706. config_details = build_config_details({
  707. 'version': '2.3',
  708. 'x-data': {
  709. 'lambda': 3,
  710. 'excess': [True, {}]
  711. }
  712. })
  713. config_data = config.load(config_details)
  714. assert config_data.services == []
  715. def test_config_build_configuration(self):
  716. service = config.load(
  717. build_config_details(
  718. {'web': {
  719. 'build': '.',
  720. 'dockerfile': 'Dockerfile-alt'
  721. }},
  722. 'tests/fixtures/extends',
  723. 'filename.yml'
  724. )
  725. ).services
  726. self.assertTrue('context' in service[0]['build'])
  727. self.assertEqual(service[0]['build']['dockerfile'], 'Dockerfile-alt')
  728. def test_config_build_configuration_v2(self):
  729. # service.dockerfile is invalid in v2
  730. with self.assertRaises(ConfigurationError):
  731. config.load(
  732. build_config_details(
  733. {
  734. 'version': '2',
  735. 'services': {
  736. 'web': {
  737. 'build': '.',
  738. 'dockerfile': 'Dockerfile-alt'
  739. }
  740. }
  741. },
  742. 'tests/fixtures/extends',
  743. 'filename.yml'
  744. )
  745. )
  746. service = config.load(
  747. build_config_details({
  748. 'version': '2',
  749. 'services': {
  750. 'web': {
  751. 'build': '.'
  752. }
  753. }
  754. }, 'tests/fixtures/extends', 'filename.yml')
  755. ).services[0]
  756. self.assertTrue('context' in service['build'])
  757. service = config.load(
  758. build_config_details(
  759. {
  760. 'version': '2',
  761. 'services': {
  762. 'web': {
  763. 'build': {
  764. 'context': '.',
  765. 'dockerfile': 'Dockerfile-alt'
  766. }
  767. }
  768. }
  769. },
  770. 'tests/fixtures/extends',
  771. 'filename.yml'
  772. )
  773. ).services
  774. self.assertTrue('context' in service[0]['build'])
  775. self.assertEqual(service[0]['build']['dockerfile'], 'Dockerfile-alt')
  776. def test_load_with_buildargs(self):
  777. service = config.load(
  778. build_config_details(
  779. {
  780. 'version': '2',
  781. 'services': {
  782. 'web': {
  783. 'build': {
  784. 'context': '.',
  785. 'dockerfile': 'Dockerfile-alt',
  786. 'args': {
  787. 'opt1': 42,
  788. 'opt2': 'foobar'
  789. }
  790. }
  791. }
  792. }
  793. },
  794. 'tests/fixtures/extends',
  795. 'filename.yml'
  796. )
  797. ).services[0]
  798. assert 'args' in service['build']
  799. assert 'opt1' in service['build']['args']
  800. assert isinstance(service['build']['args']['opt1'], str)
  801. assert service['build']['args']['opt1'] == '42'
  802. assert service['build']['args']['opt2'] == 'foobar'
  803. def test_load_with_build_labels(self):
  804. service = config.load(
  805. build_config_details(
  806. {
  807. 'version': str(V3_3),
  808. 'services': {
  809. 'web': {
  810. 'build': {
  811. 'context': '.',
  812. 'dockerfile': 'Dockerfile-alt',
  813. 'labels': {
  814. 'label1': 42,
  815. 'label2': 'foobar'
  816. }
  817. }
  818. }
  819. }
  820. },
  821. 'tests/fixtures/extends',
  822. 'filename.yml'
  823. )
  824. ).services[0]
  825. assert 'labels' in service['build']
  826. assert 'label1' in service['build']['labels']
  827. assert service['build']['labels']['label1'] == 42
  828. assert service['build']['labels']['label2'] == 'foobar'
  829. def test_build_args_allow_empty_properties(self):
  830. service = config.load(
  831. build_config_details(
  832. {
  833. 'version': '2',
  834. 'services': {
  835. 'web': {
  836. 'build': {
  837. 'context': '.',
  838. 'dockerfile': 'Dockerfile-alt',
  839. 'args': {
  840. 'foo': None
  841. }
  842. }
  843. }
  844. }
  845. },
  846. 'tests/fixtures/extends',
  847. 'filename.yml'
  848. )
  849. ).services[0]
  850. assert 'args' in service['build']
  851. assert 'foo' in service['build']['args']
  852. assert service['build']['args']['foo'] == ''
  853. # If build argument is None then it will be converted to the empty
  854. # string. Make sure that int zero kept as it is, i.e. not converted to
  855. # the empty string
  856. def test_build_args_check_zero_preserved(self):
  857. service = config.load(
  858. build_config_details(
  859. {
  860. 'version': '2',
  861. 'services': {
  862. 'web': {
  863. 'build': {
  864. 'context': '.',
  865. 'dockerfile': 'Dockerfile-alt',
  866. 'args': {
  867. 'foo': 0
  868. }
  869. }
  870. }
  871. }
  872. },
  873. 'tests/fixtures/extends',
  874. 'filename.yml'
  875. )
  876. ).services[0]
  877. assert 'args' in service['build']
  878. assert 'foo' in service['build']['args']
  879. assert service['build']['args']['foo'] == '0'
  880. def test_load_with_multiple_files_mismatched_networks_format(self):
  881. base_file = config.ConfigFile(
  882. 'base.yaml',
  883. {
  884. 'version': '2',
  885. 'services': {
  886. 'web': {
  887. 'image': 'example/web',
  888. 'networks': {
  889. 'foobar': {'aliases': ['foo', 'bar']}
  890. }
  891. }
  892. },
  893. 'networks': {'foobar': {}, 'baz': {}}
  894. }
  895. )
  896. override_file = config.ConfigFile(
  897. 'override.yaml',
  898. {
  899. 'version': '2',
  900. 'services': {
  901. 'web': {
  902. 'networks': ['baz']
  903. }
  904. }
  905. }
  906. )
  907. details = config.ConfigDetails('.', [base_file, override_file])
  908. web_service = config.load(details).services[0]
  909. assert web_service['networks'] == {
  910. 'foobar': {'aliases': ['foo', 'bar']},
  911. 'baz': None
  912. }
  913. def test_load_with_multiple_files_v2(self):
  914. base_file = config.ConfigFile(
  915. 'base.yaml',
  916. {
  917. 'version': '2',
  918. 'services': {
  919. 'web': {
  920. 'image': 'example/web',
  921. 'depends_on': ['db'],
  922. },
  923. 'db': {
  924. 'image': 'example/db',
  925. }
  926. },
  927. })
  928. override_file = config.ConfigFile(
  929. 'override.yaml',
  930. {
  931. 'version': '2',
  932. 'services': {
  933. 'web': {
  934. 'build': '/',
  935. 'volumes': ['/home/user/project:/code'],
  936. 'depends_on': ['other'],
  937. },
  938. 'other': {
  939. 'image': 'example/other',
  940. }
  941. }
  942. })
  943. details = config.ConfigDetails('.', [base_file, override_file])
  944. service_dicts = config.load(details).services
  945. expected = [
  946. {
  947. 'name': 'web',
  948. 'build': {'context': os.path.abspath('/')},
  949. 'image': 'example/web',
  950. 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
  951. 'depends_on': {
  952. 'db': {'condition': 'service_started'},
  953. 'other': {'condition': 'service_started'},
  954. },
  955. },
  956. {
  957. 'name': 'db',
  958. 'image': 'example/db',
  959. },
  960. {
  961. 'name': 'other',
  962. 'image': 'example/other',
  963. },
  964. ]
  965. assert service_sort(service_dicts) == service_sort(expected)
  966. @mock.patch.dict(os.environ)
  967. def test_load_with_multiple_files_v3_2(self):
  968. os.environ['COMPOSE_CONVERT_WINDOWS_PATHS'] = 'true'
  969. base_file = config.ConfigFile(
  970. 'base.yaml',
  971. {
  972. 'version': '3.2',
  973. 'services': {
  974. 'web': {
  975. 'image': 'example/web',
  976. 'volumes': [
  977. {'source': '/a', 'target': '/b', 'type': 'bind'},
  978. {'source': 'vol', 'target': '/x', 'type': 'volume', 'read_only': True}
  979. ]
  980. }
  981. },
  982. 'volumes': {'vol': {}}
  983. }
  984. )
  985. override_file = config.ConfigFile(
  986. 'override.yaml',
  987. {
  988. 'version': '3.2',
  989. 'services': {
  990. 'web': {
  991. 'volumes': ['/c:/b', '/anonymous']
  992. }
  993. }
  994. }
  995. )
  996. details = config.ConfigDetails('.', [base_file, override_file])
  997. service_dicts = config.load(details).services
  998. svc_volumes = map(lambda v: v.repr(), service_dicts[0]['volumes'])
  999. assert sorted(svc_volumes) == sorted(
  1000. ['/anonymous', '/c:/b:rw', 'vol:/x:ro']
  1001. )
  1002. @mock.patch.dict(os.environ)
  1003. def test_volume_mode_override(self):
  1004. os.environ['COMPOSE_CONVERT_WINDOWS_PATHS'] = 'true'
  1005. base_file = config.ConfigFile(
  1006. 'base.yaml',
  1007. {
  1008. 'version': '2.3',
  1009. 'services': {
  1010. 'web': {
  1011. 'image': 'example/web',
  1012. 'volumes': ['/c:/b:rw']
  1013. }
  1014. },
  1015. }
  1016. )
  1017. override_file = config.ConfigFile(
  1018. 'override.yaml',
  1019. {
  1020. 'version': '2.3',
  1021. 'services': {
  1022. 'web': {
  1023. 'volumes': ['/c:/b:ro']
  1024. }
  1025. }
  1026. }
  1027. )
  1028. details = config.ConfigDetails('.', [base_file, override_file])
  1029. service_dicts = config.load(details).services
  1030. svc_volumes = list(map(lambda v: v.repr(), service_dicts[0]['volumes']))
  1031. assert svc_volumes == ['/c:/b:ro']
  1032. def test_undeclared_volume_v2(self):
  1033. base_file = config.ConfigFile(
  1034. 'base.yaml',
  1035. {
  1036. 'version': '2',
  1037. 'services': {
  1038. 'web': {
  1039. 'image': 'busybox:latest',
  1040. 'volumes': ['data0028:/data:ro'],
  1041. },
  1042. },
  1043. }
  1044. )
  1045. details = config.ConfigDetails('.', [base_file])
  1046. with self.assertRaises(ConfigurationError):
  1047. config.load(details)
  1048. base_file = config.ConfigFile(
  1049. 'base.yaml',
  1050. {
  1051. 'version': '2',
  1052. 'services': {
  1053. 'web': {
  1054. 'image': 'busybox:latest',
  1055. 'volumes': ['./data0028:/data:ro'],
  1056. },
  1057. },
  1058. }
  1059. )
  1060. details = config.ConfigDetails('.', [base_file])
  1061. config_data = config.load(details)
  1062. volume = config_data.services[0].get('volumes')[0]
  1063. assert not volume.is_named_volume
  1064. def test_undeclared_volume_v1(self):
  1065. base_file = config.ConfigFile(
  1066. 'base.yaml',
  1067. {
  1068. 'web': {
  1069. 'image': 'busybox:latest',
  1070. 'volumes': ['data0028:/data:ro'],
  1071. },
  1072. }
  1073. )
  1074. details = config.ConfigDetails('.', [base_file])
  1075. config_data = config.load(details)
  1076. volume = config_data.services[0].get('volumes')[0]
  1077. assert volume.external == 'data0028'
  1078. assert volume.is_named_volume
  1079. def test_config_valid_service_names(self):
  1080. for valid_name in ['_', '-', '.__.', '_what-up.', 'what_.up----', 'whatup']:
  1081. services = config.load(
  1082. build_config_details(
  1083. {valid_name: {'image': 'busybox'}},
  1084. 'tests/fixtures/extends',
  1085. 'common.yml')).services
  1086. assert services[0]['name'] == valid_name
  1087. def test_config_hint(self):
  1088. with pytest.raises(ConfigurationError) as excinfo:
  1089. config.load(
  1090. build_config_details(
  1091. {
  1092. 'foo': {'image': 'busybox', 'privilige': 'something'},
  1093. },
  1094. 'tests/fixtures/extends',
  1095. 'filename.yml'
  1096. )
  1097. )
  1098. assert "(did you mean 'privileged'?)" in excinfo.exconly()
  1099. def test_load_errors_on_uppercase_with_no_image(self):
  1100. with pytest.raises(ConfigurationError) as exc:
  1101. config.load(build_config_details({
  1102. 'Foo': {'build': '.'},
  1103. }, 'tests/fixtures/build-ctx'))
  1104. assert "Service 'Foo' contains uppercase characters" in exc.exconly()
  1105. def test_invalid_config_v1(self):
  1106. with pytest.raises(ConfigurationError) as excinfo:
  1107. config.load(
  1108. build_config_details(
  1109. {
  1110. 'foo': {'image': 1},
  1111. },
  1112. 'tests/fixtures/extends',
  1113. 'filename.yml'
  1114. )
  1115. )
  1116. assert "foo.image contains an invalid type, it should be a string" \
  1117. in excinfo.exconly()
  1118. def test_invalid_config_v2(self):
  1119. with pytest.raises(ConfigurationError) as excinfo:
  1120. config.load(
  1121. build_config_details(
  1122. {
  1123. 'version': '2',
  1124. 'services': {
  1125. 'foo': {'image': 1},
  1126. },
  1127. },
  1128. 'tests/fixtures/extends',
  1129. 'filename.yml'
  1130. )
  1131. )
  1132. assert "services.foo.image contains an invalid type, it should be a string" \
  1133. in excinfo.exconly()
  1134. def test_invalid_config_build_and_image_specified_v1(self):
  1135. with pytest.raises(ConfigurationError) as excinfo:
  1136. config.load(
  1137. build_config_details(
  1138. {
  1139. 'foo': {'image': 'busybox', 'build': '.'},
  1140. },
  1141. 'tests/fixtures/extends',
  1142. 'filename.yml'
  1143. )
  1144. )
  1145. assert "foo has both an image and build path specified." in excinfo.exconly()
  1146. def test_invalid_config_type_should_be_an_array(self):
  1147. with pytest.raises(ConfigurationError) as excinfo:
  1148. config.load(
  1149. build_config_details(
  1150. {
  1151. 'foo': {'image': 'busybox', 'links': 'an_link'},
  1152. },
  1153. 'tests/fixtures/extends',
  1154. 'filename.yml'
  1155. )
  1156. )
  1157. assert "foo.links contains an invalid type, it should be an array" \
  1158. in excinfo.exconly()
  1159. def test_invalid_config_not_a_dictionary(self):
  1160. with pytest.raises(ConfigurationError) as excinfo:
  1161. config.load(
  1162. build_config_details(
  1163. ['foo', 'lol'],
  1164. 'tests/fixtures/extends',
  1165. 'filename.yml'
  1166. )
  1167. )
  1168. assert "Top level object in 'filename.yml' needs to be an object" \
  1169. in excinfo.exconly()
  1170. def test_invalid_config_not_unique_items(self):
  1171. with pytest.raises(ConfigurationError) as excinfo:
  1172. config.load(
  1173. build_config_details(
  1174. {
  1175. 'web': {'build': '.', 'devices': ['/dev/foo:/dev/foo', '/dev/foo:/dev/foo']}
  1176. },
  1177. 'tests/fixtures/extends',
  1178. 'filename.yml'
  1179. )
  1180. )
  1181. assert "has non-unique elements" in excinfo.exconly()
  1182. def test_invalid_list_of_strings_format(self):
  1183. with pytest.raises(ConfigurationError) as excinfo:
  1184. config.load(
  1185. build_config_details(
  1186. {
  1187. 'web': {'build': '.', 'command': [1]}
  1188. },
  1189. 'tests/fixtures/extends',
  1190. 'filename.yml'
  1191. )
  1192. )
  1193. assert "web.command contains 1, which is an invalid type, it should be a string" \
  1194. in excinfo.exconly()
  1195. def test_load_config_dockerfile_without_build_raises_error_v1(self):
  1196. with pytest.raises(ConfigurationError) as exc:
  1197. config.load(build_config_details({
  1198. 'web': {
  1199. 'image': 'busybox',
  1200. 'dockerfile': 'Dockerfile.alt'
  1201. }
  1202. }))
  1203. assert "web has both an image and alternate Dockerfile." in exc.exconly()
  1204. def test_config_extra_hosts_string_raises_validation_error(self):
  1205. with pytest.raises(ConfigurationError) as excinfo:
  1206. config.load(
  1207. build_config_details(
  1208. {'web': {
  1209. 'image': 'busybox',
  1210. 'extra_hosts': 'somehost:162.242.195.82'
  1211. }},
  1212. 'working_dir',
  1213. 'filename.yml'
  1214. )
  1215. )
  1216. assert "web.extra_hosts contains an invalid type" \
  1217. in excinfo.exconly()
  1218. def test_config_extra_hosts_list_of_dicts_validation_error(self):
  1219. with pytest.raises(ConfigurationError) as excinfo:
  1220. config.load(
  1221. build_config_details(
  1222. {'web': {
  1223. 'image': 'busybox',
  1224. 'extra_hosts': [
  1225. {'somehost': '162.242.195.82'},
  1226. {'otherhost': '50.31.209.229'}
  1227. ]
  1228. }},
  1229. 'working_dir',
  1230. 'filename.yml'
  1231. )
  1232. )
  1233. assert "web.extra_hosts contains {\"somehost\": \"162.242.195.82\"}, " \
  1234. "which is an invalid type, it should be a string" \
  1235. in excinfo.exconly()
  1236. def test_config_ulimits_invalid_keys_validation_error(self):
  1237. with pytest.raises(ConfigurationError) as exc:
  1238. config.load(build_config_details(
  1239. {
  1240. 'web': {
  1241. 'image': 'busybox',
  1242. 'ulimits': {
  1243. 'nofile': {
  1244. "not_soft_or_hard": 100,
  1245. "soft": 10000,
  1246. "hard": 20000,
  1247. }
  1248. }
  1249. }
  1250. },
  1251. 'working_dir',
  1252. 'filename.yml'))
  1253. assert "web.ulimits.nofile contains unsupported option: 'not_soft_or_hard'" \
  1254. in exc.exconly()
  1255. def test_config_ulimits_required_keys_validation_error(self):
  1256. with pytest.raises(ConfigurationError) as exc:
  1257. config.load(build_config_details(
  1258. {
  1259. 'web': {
  1260. 'image': 'busybox',
  1261. 'ulimits': {'nofile': {"soft": 10000}}
  1262. }
  1263. },
  1264. 'working_dir',
  1265. 'filename.yml'))
  1266. assert "web.ulimits.nofile" in exc.exconly()
  1267. assert "'hard' is a required property" in exc.exconly()
  1268. def test_config_ulimits_soft_greater_than_hard_error(self):
  1269. expected = "'soft' value can not be greater than 'hard' value"
  1270. with pytest.raises(ConfigurationError) as exc:
  1271. config.load(build_config_details(
  1272. {
  1273. 'web': {
  1274. 'image': 'busybox',
  1275. 'ulimits': {
  1276. 'nofile': {"soft": 10000, "hard": 1000}
  1277. }
  1278. }
  1279. },
  1280. 'working_dir',
  1281. 'filename.yml'))
  1282. assert expected in exc.exconly()
  1283. def test_valid_config_which_allows_two_type_definitions(self):
  1284. expose_values = [["8000"], [8000]]
  1285. for expose in expose_values:
  1286. service = config.load(
  1287. build_config_details(
  1288. {'web': {
  1289. 'image': 'busybox',
  1290. 'expose': expose
  1291. }},
  1292. 'working_dir',
  1293. 'filename.yml'
  1294. )
  1295. ).services
  1296. self.assertEqual(service[0]['expose'], expose)
  1297. def test_valid_config_oneof_string_or_list(self):
  1298. entrypoint_values = [["sh"], "sh"]
  1299. for entrypoint in entrypoint_values:
  1300. service = config.load(
  1301. build_config_details(
  1302. {'web': {
  1303. 'image': 'busybox',
  1304. 'entrypoint': entrypoint
  1305. }},
  1306. 'working_dir',
  1307. 'filename.yml'
  1308. )
  1309. ).services
  1310. self.assertEqual(service[0]['entrypoint'], entrypoint)
  1311. def test_logs_warning_for_boolean_in_environment(self):
  1312. config_details = build_config_details({
  1313. 'web': {
  1314. 'image': 'busybox',
  1315. 'environment': {'SHOW_STUFF': True}
  1316. }
  1317. })
  1318. with pytest.raises(ConfigurationError) as exc:
  1319. config.load(config_details)
  1320. assert "contains true, which is an invalid type" in exc.exconly()
  1321. def test_config_valid_environment_dict_key_contains_dashes(self):
  1322. services = config.load(
  1323. build_config_details(
  1324. {'web': {
  1325. 'image': 'busybox',
  1326. 'environment': {'SPRING_JPA_HIBERNATE_DDL-AUTO': 'none'}
  1327. }},
  1328. 'working_dir',
  1329. 'filename.yml'
  1330. )
  1331. ).services
  1332. self.assertEqual(services[0]['environment']['SPRING_JPA_HIBERNATE_DDL-AUTO'], 'none')
  1333. def test_load_yaml_with_yaml_error(self):
  1334. tmpdir = py.test.ensuretemp('invalid_yaml_test')
  1335. self.addCleanup(tmpdir.remove)
  1336. invalid_yaml_file = tmpdir.join('docker-compose.yml')
  1337. invalid_yaml_file.write("""
  1338. web:
  1339. this is bogus: ok: what
  1340. """)
  1341. with pytest.raises(ConfigurationError) as exc:
  1342. config.load_yaml(str(invalid_yaml_file))
  1343. assert 'line 3, column 32' in exc.exconly()
  1344. def test_validate_extra_hosts_invalid(self):
  1345. with pytest.raises(ConfigurationError) as exc:
  1346. config.load(build_config_details({
  1347. 'web': {
  1348. 'image': 'alpine',
  1349. 'extra_hosts': "www.example.com: 192.168.0.17",
  1350. }
  1351. }))
  1352. assert "web.extra_hosts contains an invalid type" in exc.exconly()
  1353. def test_validate_extra_hosts_invalid_list(self):
  1354. with pytest.raises(ConfigurationError) as exc:
  1355. config.load(build_config_details({
  1356. 'web': {
  1357. 'image': 'alpine',
  1358. 'extra_hosts': [
  1359. {'www.example.com': '192.168.0.17'},
  1360. {'api.example.com': '192.168.0.18'}
  1361. ],
  1362. }
  1363. }))
  1364. assert "which is an invalid type" in exc.exconly()
  1365. def test_normalize_dns_options(self):
  1366. actual = config.load(build_config_details({
  1367. 'web': {
  1368. 'image': 'alpine',
  1369. 'dns': '8.8.8.8',
  1370. 'dns_search': 'domain.local',
  1371. }
  1372. }))
  1373. assert actual.services == [
  1374. {
  1375. 'name': 'web',
  1376. 'image': 'alpine',
  1377. 'dns': ['8.8.8.8'],
  1378. 'dns_search': ['domain.local'],
  1379. }
  1380. ]
  1381. def test_tmpfs_option(self):
  1382. actual = config.load(build_config_details({
  1383. 'version': '2',
  1384. 'services': {
  1385. 'web': {
  1386. 'image': 'alpine',
  1387. 'tmpfs': '/run',
  1388. }
  1389. }
  1390. }))
  1391. assert actual.services == [
  1392. {
  1393. 'name': 'web',
  1394. 'image': 'alpine',
  1395. 'tmpfs': ['/run'],
  1396. }
  1397. ]
  1398. def test_oom_score_adj_option(self):
  1399. actual = config.load(build_config_details({
  1400. 'version': '2',
  1401. 'services': {
  1402. 'web': {
  1403. 'image': 'alpine',
  1404. 'oom_score_adj': 500
  1405. }
  1406. }
  1407. }))
  1408. assert actual.services == [
  1409. {
  1410. 'name': 'web',
  1411. 'image': 'alpine',
  1412. 'oom_score_adj': 500
  1413. }
  1414. ]
  1415. def test_swappiness_option(self):
  1416. actual = config.load(build_config_details({
  1417. 'version': '2',
  1418. 'services': {
  1419. 'web': {
  1420. 'image': 'alpine',
  1421. 'mem_swappiness': 10,
  1422. }
  1423. }
  1424. }))
  1425. assert actual.services == [
  1426. {
  1427. 'name': 'web',
  1428. 'image': 'alpine',
  1429. 'mem_swappiness': 10,
  1430. }
  1431. ]
  1432. def test_group_add_option(self):
  1433. actual = config.load(build_config_details({
  1434. 'version': '2',
  1435. 'services': {
  1436. 'web': {
  1437. 'image': 'alpine',
  1438. 'group_add': ["docker", 777]
  1439. }
  1440. }
  1441. }))
  1442. assert actual.services == [
  1443. {
  1444. 'name': 'web',
  1445. 'image': 'alpine',
  1446. 'group_add': ["docker", 777]
  1447. }
  1448. ]
  1449. def test_dns_opt_option(self):
  1450. actual = config.load(build_config_details({
  1451. 'version': '2',
  1452. 'services': {
  1453. 'web': {
  1454. 'image': 'alpine',
  1455. 'dns_opt': ["use-vc", "no-tld-query"]
  1456. }
  1457. }
  1458. }))
  1459. assert actual.services == [
  1460. {
  1461. 'name': 'web',
  1462. 'image': 'alpine',
  1463. 'dns_opt': ["use-vc", "no-tld-query"]
  1464. }
  1465. ]
  1466. def test_isolation_option(self):
  1467. actual = config.load(build_config_details({
  1468. 'version': str(V2_1),
  1469. 'services': {
  1470. 'web': {
  1471. 'image': 'win10',
  1472. 'isolation': 'hyperv'
  1473. }
  1474. }
  1475. }))
  1476. assert actual.services == [
  1477. {
  1478. 'name': 'web',
  1479. 'image': 'win10',
  1480. 'isolation': 'hyperv',
  1481. }
  1482. ]
  1483. def test_merge_service_dicts_from_files_with_extends_in_base(self):
  1484. base = {
  1485. 'volumes': ['.:/app'],
  1486. 'extends': {'service': 'app'}
  1487. }
  1488. override = {
  1489. 'image': 'alpine:edge',
  1490. }
  1491. actual = config.merge_service_dicts_from_files(
  1492. base,
  1493. override,
  1494. DEFAULT_VERSION)
  1495. assert actual == {
  1496. 'image': 'alpine:edge',
  1497. 'volumes': ['.:/app'],
  1498. 'extends': {'service': 'app'}
  1499. }
  1500. def test_merge_service_dicts_from_files_with_extends_in_override(self):
  1501. base = {
  1502. 'volumes': ['.:/app'],
  1503. 'extends': {'service': 'app'}
  1504. }
  1505. override = {
  1506. 'image': 'alpine:edge',
  1507. 'extends': {'service': 'foo'}
  1508. }
  1509. actual = config.merge_service_dicts_from_files(
  1510. base,
  1511. override,
  1512. DEFAULT_VERSION)
  1513. assert actual == {
  1514. 'image': 'alpine:edge',
  1515. 'volumes': ['.:/app'],
  1516. 'extends': {'service': 'foo'}
  1517. }
  1518. def test_merge_service_dicts_heterogeneous(self):
  1519. base = {
  1520. 'volumes': ['.:/app'],
  1521. 'ports': ['5432']
  1522. }
  1523. override = {
  1524. 'image': 'alpine:edge',
  1525. 'ports': [5432]
  1526. }
  1527. actual = config.merge_service_dicts_from_files(
  1528. base,
  1529. override,
  1530. DEFAULT_VERSION)
  1531. assert actual == {
  1532. 'image': 'alpine:edge',
  1533. 'volumes': ['.:/app'],
  1534. 'ports': types.ServicePort.parse('5432')
  1535. }
  1536. def test_merge_service_dicts_heterogeneous_2(self):
  1537. base = {
  1538. 'volumes': ['.:/app'],
  1539. 'ports': [5432]
  1540. }
  1541. override = {
  1542. 'image': 'alpine:edge',
  1543. 'ports': ['5432']
  1544. }
  1545. actual = config.merge_service_dicts_from_files(
  1546. base,
  1547. override,
  1548. DEFAULT_VERSION)
  1549. assert actual == {
  1550. 'image': 'alpine:edge',
  1551. 'volumes': ['.:/app'],
  1552. 'ports': types.ServicePort.parse('5432')
  1553. }
  1554. def test_merge_service_dicts_ports_sorting(self):
  1555. base = {
  1556. 'ports': [5432]
  1557. }
  1558. override = {
  1559. 'image': 'alpine:edge',
  1560. 'ports': ['5432/udp']
  1561. }
  1562. actual = config.merge_service_dicts_from_files(
  1563. base,
  1564. override,
  1565. DEFAULT_VERSION)
  1566. assert len(actual['ports']) == 2
  1567. assert types.ServicePort.parse('5432')[0] in actual['ports']
  1568. assert types.ServicePort.parse('5432/udp')[0] in actual['ports']
  1569. def test_merge_service_dicts_heterogeneous_volumes(self):
  1570. base = {
  1571. 'volumes': ['/a:/b', '/x:/z'],
  1572. }
  1573. override = {
  1574. 'image': 'alpine:edge',
  1575. 'volumes': [
  1576. {'source': '/e', 'target': '/b', 'type': 'bind'},
  1577. {'source': '/c', 'target': '/d', 'type': 'bind'}
  1578. ]
  1579. }
  1580. actual = config.merge_service_dicts_from_files(
  1581. base, override, V3_2
  1582. )
  1583. assert actual['volumes'] == [
  1584. {'source': '/e', 'target': '/b', 'type': 'bind'},
  1585. {'source': '/c', 'target': '/d', 'type': 'bind'},
  1586. '/x:/z'
  1587. ]
  1588. def test_merge_logging_v1(self):
  1589. base = {
  1590. 'image': 'alpine:edge',
  1591. 'log_driver': 'something',
  1592. 'log_opt': {'foo': 'three'},
  1593. }
  1594. override = {
  1595. 'image': 'alpine:edge',
  1596. 'command': 'true',
  1597. }
  1598. actual = config.merge_service_dicts(base, override, V1)
  1599. assert actual == {
  1600. 'image': 'alpine:edge',
  1601. 'log_driver': 'something',
  1602. 'log_opt': {'foo': 'three'},
  1603. 'command': 'true',
  1604. }
  1605. def test_merge_logging_v2(self):
  1606. base = {
  1607. 'image': 'alpine:edge',
  1608. 'logging': {
  1609. 'driver': 'json-file',
  1610. 'options': {
  1611. 'frequency': '2000',
  1612. 'timeout': '23'
  1613. }
  1614. }
  1615. }
  1616. override = {
  1617. 'logging': {
  1618. 'options': {
  1619. 'timeout': '360',
  1620. 'pretty-print': 'on'
  1621. }
  1622. }
  1623. }
  1624. actual = config.merge_service_dicts(base, override, V2_0)
  1625. assert actual == {
  1626. 'image': 'alpine:edge',
  1627. 'logging': {
  1628. 'driver': 'json-file',
  1629. 'options': {
  1630. 'frequency': '2000',
  1631. 'timeout': '360',
  1632. 'pretty-print': 'on'
  1633. }
  1634. }
  1635. }
  1636. def test_merge_logging_v2_override_driver(self):
  1637. base = {
  1638. 'image': 'alpine:edge',
  1639. 'logging': {
  1640. 'driver': 'json-file',
  1641. 'options': {
  1642. 'frequency': '2000',
  1643. 'timeout': '23'
  1644. }
  1645. }
  1646. }
  1647. override = {
  1648. 'logging': {
  1649. 'driver': 'syslog',
  1650. 'options': {
  1651. 'timeout': '360',
  1652. 'pretty-print': 'on'
  1653. }
  1654. }
  1655. }
  1656. actual = config.merge_service_dicts(base, override, V2_0)
  1657. assert actual == {
  1658. 'image': 'alpine:edge',
  1659. 'logging': {
  1660. 'driver': 'syslog',
  1661. 'options': {
  1662. 'timeout': '360',
  1663. 'pretty-print': 'on'
  1664. }
  1665. }
  1666. }
  1667. def test_merge_logging_v2_no_base_driver(self):
  1668. base = {
  1669. 'image': 'alpine:edge',
  1670. 'logging': {
  1671. 'options': {
  1672. 'frequency': '2000',
  1673. 'timeout': '23'
  1674. }
  1675. }
  1676. }
  1677. override = {
  1678. 'logging': {
  1679. 'driver': 'json-file',
  1680. 'options': {
  1681. 'timeout': '360',
  1682. 'pretty-print': 'on'
  1683. }
  1684. }
  1685. }
  1686. actual = config.merge_service_dicts(base, override, V2_0)
  1687. assert actual == {
  1688. 'image': 'alpine:edge',
  1689. 'logging': {
  1690. 'driver': 'json-file',
  1691. 'options': {
  1692. 'frequency': '2000',
  1693. 'timeout': '360',
  1694. 'pretty-print': 'on'
  1695. }
  1696. }
  1697. }
  1698. def test_merge_logging_v2_no_drivers(self):
  1699. base = {
  1700. 'image': 'alpine:edge',
  1701. 'logging': {
  1702. 'options': {
  1703. 'frequency': '2000',
  1704. 'timeout': '23'
  1705. }
  1706. }
  1707. }
  1708. override = {
  1709. 'logging': {
  1710. 'options': {
  1711. 'timeout': '360',
  1712. 'pretty-print': 'on'
  1713. }
  1714. }
  1715. }
  1716. actual = config.merge_service_dicts(base, override, V2_0)
  1717. assert actual == {
  1718. 'image': 'alpine:edge',
  1719. 'logging': {
  1720. 'options': {
  1721. 'frequency': '2000',
  1722. 'timeout': '360',
  1723. 'pretty-print': 'on'
  1724. }
  1725. }
  1726. }
  1727. def test_merge_logging_v2_no_override_options(self):
  1728. base = {
  1729. 'image': 'alpine:edge',
  1730. 'logging': {
  1731. 'driver': 'json-file',
  1732. 'options': {
  1733. 'frequency': '2000',
  1734. 'timeout': '23'
  1735. }
  1736. }
  1737. }
  1738. override = {
  1739. 'logging': {
  1740. 'driver': 'syslog'
  1741. }
  1742. }
  1743. actual = config.merge_service_dicts(base, override, V2_0)
  1744. assert actual == {
  1745. 'image': 'alpine:edge',
  1746. 'logging': {
  1747. 'driver': 'syslog',
  1748. }
  1749. }
  1750. def test_merge_logging_v2_no_base(self):
  1751. base = {
  1752. 'image': 'alpine:edge'
  1753. }
  1754. override = {
  1755. 'logging': {
  1756. 'driver': 'json-file',
  1757. 'options': {
  1758. 'frequency': '2000'
  1759. }
  1760. }
  1761. }
  1762. actual = config.merge_service_dicts(base, override, V2_0)
  1763. assert actual == {
  1764. 'image': 'alpine:edge',
  1765. 'logging': {
  1766. 'driver': 'json-file',
  1767. 'options': {
  1768. 'frequency': '2000'
  1769. }
  1770. }
  1771. }
  1772. def test_merge_logging_v2_no_override(self):
  1773. base = {
  1774. 'image': 'alpine:edge',
  1775. 'logging': {
  1776. 'driver': 'syslog',
  1777. 'options': {
  1778. 'frequency': '2000'
  1779. }
  1780. }
  1781. }
  1782. override = {}
  1783. actual = config.merge_service_dicts(base, override, V2_0)
  1784. assert actual == {
  1785. 'image': 'alpine:edge',
  1786. 'logging': {
  1787. 'driver': 'syslog',
  1788. 'options': {
  1789. 'frequency': '2000'
  1790. }
  1791. }
  1792. }
  1793. def test_merge_mixed_ports(self):
  1794. base = {
  1795. 'image': 'busybox:latest',
  1796. 'command': 'top',
  1797. 'ports': [
  1798. {
  1799. 'target': '1245',
  1800. 'published': '1245',
  1801. 'protocol': 'udp',
  1802. }
  1803. ]
  1804. }
  1805. override = {
  1806. 'ports': ['1245:1245/udp']
  1807. }
  1808. actual = config.merge_service_dicts(base, override, V3_1)
  1809. assert actual == {
  1810. 'image': 'busybox:latest',
  1811. 'command': 'top',
  1812. 'ports': [types.ServicePort('1245', '1245', 'udp', None, None)]
  1813. }
  1814. def test_merge_depends_on_no_override(self):
  1815. base = {
  1816. 'image': 'busybox',
  1817. 'depends_on': {
  1818. 'app1': {'condition': 'service_started'},
  1819. 'app2': {'condition': 'service_healthy'}
  1820. }
  1821. }
  1822. override = {}
  1823. actual = config.merge_service_dicts(base, override, V2_1)
  1824. assert actual == base
  1825. def test_merge_depends_on_mixed_syntax(self):
  1826. base = {
  1827. 'image': 'busybox',
  1828. 'depends_on': {
  1829. 'app1': {'condition': 'service_started'},
  1830. 'app2': {'condition': 'service_healthy'}
  1831. }
  1832. }
  1833. override = {
  1834. 'depends_on': ['app3']
  1835. }
  1836. actual = config.merge_service_dicts(base, override, V2_1)
  1837. assert actual == {
  1838. 'image': 'busybox',
  1839. 'depends_on': {
  1840. 'app1': {'condition': 'service_started'},
  1841. 'app2': {'condition': 'service_healthy'},
  1842. 'app3': {'condition': 'service_started'}
  1843. }
  1844. }
  1845. def test_empty_environment_key_allowed(self):
  1846. service_dict = config.load(
  1847. build_config_details(
  1848. {
  1849. 'web': {
  1850. 'build': '.',
  1851. 'environment': {
  1852. 'POSTGRES_PASSWORD': ''
  1853. },
  1854. },
  1855. },
  1856. '.',
  1857. None,
  1858. )
  1859. ).services[0]
  1860. self.assertEqual(service_dict['environment']['POSTGRES_PASSWORD'], '')
  1861. def test_merge_pid(self):
  1862. # Regression: https://github.com/docker/compose/issues/4184
  1863. base = {
  1864. 'image': 'busybox',
  1865. 'pid': 'host'
  1866. }
  1867. override = {
  1868. 'labels': {'com.docker.compose.test': 'yes'}
  1869. }
  1870. actual = config.merge_service_dicts(base, override, V2_0)
  1871. assert actual == {
  1872. 'image': 'busybox',
  1873. 'pid': 'host',
  1874. 'labels': {'com.docker.compose.test': 'yes'}
  1875. }
  1876. def test_merge_different_secrets(self):
  1877. base = {
  1878. 'image': 'busybox',
  1879. 'secrets': [
  1880. {'source': 'src.txt'}
  1881. ]
  1882. }
  1883. override = {'secrets': ['other-src.txt']}
  1884. actual = config.merge_service_dicts(base, override, V3_1)
  1885. assert secret_sort(actual['secrets']) == secret_sort([
  1886. {'source': 'src.txt'},
  1887. {'source': 'other-src.txt'}
  1888. ])
  1889. def test_merge_secrets_override(self):
  1890. base = {
  1891. 'image': 'busybox',
  1892. 'secrets': ['src.txt'],
  1893. }
  1894. override = {
  1895. 'secrets': [
  1896. {
  1897. 'source': 'src.txt',
  1898. 'target': 'data.txt',
  1899. 'mode': 0o400
  1900. }
  1901. ]
  1902. }
  1903. actual = config.merge_service_dicts(base, override, V3_1)
  1904. assert actual['secrets'] == override['secrets']
  1905. def test_merge_different_configs(self):
  1906. base = {
  1907. 'image': 'busybox',
  1908. 'configs': [
  1909. {'source': 'src.txt'}
  1910. ]
  1911. }
  1912. override = {'configs': ['other-src.txt']}
  1913. actual = config.merge_service_dicts(base, override, V3_3)
  1914. assert secret_sort(actual['configs']) == secret_sort([
  1915. {'source': 'src.txt'},
  1916. {'source': 'other-src.txt'}
  1917. ])
  1918. def test_merge_configs_override(self):
  1919. base = {
  1920. 'image': 'busybox',
  1921. 'configs': ['src.txt'],
  1922. }
  1923. override = {
  1924. 'configs': [
  1925. {
  1926. 'source': 'src.txt',
  1927. 'target': 'data.txt',
  1928. 'mode': 0o400
  1929. }
  1930. ]
  1931. }
  1932. actual = config.merge_service_dicts(base, override, V3_3)
  1933. assert actual['configs'] == override['configs']
  1934. def test_merge_deploy(self):
  1935. base = {
  1936. 'image': 'busybox',
  1937. }
  1938. override = {
  1939. 'deploy': {
  1940. 'mode': 'global',
  1941. 'restart_policy': {
  1942. 'condition': 'on-failure'
  1943. }
  1944. }
  1945. }
  1946. actual = config.merge_service_dicts(base, override, V3_0)
  1947. assert actual['deploy'] == override['deploy']
  1948. def test_merge_deploy_override(self):
  1949. base = {
  1950. 'image': 'busybox',
  1951. 'deploy': {
  1952. 'mode': 'global',
  1953. 'restart_policy': {
  1954. 'condition': 'on-failure'
  1955. },
  1956. 'placement': {
  1957. 'constraints': [
  1958. 'node.role == manager'
  1959. ]
  1960. }
  1961. }
  1962. }
  1963. override = {
  1964. 'deploy': {
  1965. 'mode': 'replicated',
  1966. 'restart_policy': {
  1967. 'condition': 'any'
  1968. }
  1969. }
  1970. }
  1971. actual = config.merge_service_dicts(base, override, V3_0)
  1972. assert actual['deploy'] == {
  1973. 'mode': 'replicated',
  1974. 'restart_policy': {
  1975. 'condition': 'any'
  1976. },
  1977. 'placement': {
  1978. 'constraints': [
  1979. 'node.role == manager'
  1980. ]
  1981. }
  1982. }
  1983. def test_merge_credential_spec(self):
  1984. base = {
  1985. 'image': 'bb',
  1986. 'credential_spec': {
  1987. 'file': '/hello-world',
  1988. }
  1989. }
  1990. override = {
  1991. 'credential_spec': {
  1992. 'registry': 'revolution.com',
  1993. }
  1994. }
  1995. actual = config.merge_service_dicts(base, override, V3_3)
  1996. assert actual['credential_spec'] == override['credential_spec']
  1997. def test_merge_scale(self):
  1998. base = {
  1999. 'image': 'bar',
  2000. 'scale': 2,
  2001. }
  2002. override = {
  2003. 'scale': 4,
  2004. }
  2005. actual = config.merge_service_dicts(base, override, V2_2)
  2006. assert actual == {'image': 'bar', 'scale': 4}
  2007. def test_merge_blkio_config(self):
  2008. base = {
  2009. 'image': 'bar',
  2010. 'blkio_config': {
  2011. 'weight': 300,
  2012. 'weight_device': [
  2013. {'path': '/dev/sda1', 'weight': 200}
  2014. ],
  2015. 'device_read_iops': [
  2016. {'path': '/dev/sda1', 'rate': 300}
  2017. ],
  2018. 'device_write_iops': [
  2019. {'path': '/dev/sda1', 'rate': 1000}
  2020. ]
  2021. }
  2022. }
  2023. override = {
  2024. 'blkio_config': {
  2025. 'weight': 450,
  2026. 'weight_device': [
  2027. {'path': '/dev/sda2', 'weight': 400}
  2028. ],
  2029. 'device_read_iops': [
  2030. {'path': '/dev/sda1', 'rate': 2000}
  2031. ],
  2032. 'device_read_bps': [
  2033. {'path': '/dev/sda1', 'rate': 1024}
  2034. ]
  2035. }
  2036. }
  2037. actual = config.merge_service_dicts(base, override, V2_2)
  2038. assert actual == {
  2039. 'image': 'bar',
  2040. 'blkio_config': {
  2041. 'weight': override['blkio_config']['weight'],
  2042. 'weight_device': (
  2043. base['blkio_config']['weight_device'] +
  2044. override['blkio_config']['weight_device']
  2045. ),
  2046. 'device_read_iops': override['blkio_config']['device_read_iops'],
  2047. 'device_read_bps': override['blkio_config']['device_read_bps'],
  2048. 'device_write_iops': base['blkio_config']['device_write_iops']
  2049. }
  2050. }
  2051. def test_merge_extra_hosts(self):
  2052. base = {
  2053. 'image': 'bar',
  2054. 'extra_hosts': {
  2055. 'foo': '1.2.3.4',
  2056. }
  2057. }
  2058. override = {
  2059. 'extra_hosts': ['bar:5.6.7.8', 'foo:127.0.0.1']
  2060. }
  2061. actual = config.merge_service_dicts(base, override, V2_0)
  2062. assert actual['extra_hosts'] == {
  2063. 'foo': '127.0.0.1',
  2064. 'bar': '5.6.7.8',
  2065. }
  2066. def test_merge_healthcheck_config(self):
  2067. base = {
  2068. 'image': 'bar',
  2069. 'healthcheck': {
  2070. 'start_period': 1000,
  2071. 'interval': 3000,
  2072. 'test': ['true']
  2073. }
  2074. }
  2075. override = {
  2076. 'healthcheck': {
  2077. 'interval': 5000,
  2078. 'timeout': 10000,
  2079. 'test': ['echo', 'OK'],
  2080. }
  2081. }
  2082. actual = config.merge_service_dicts(base, override, V2_3)
  2083. assert actual['healthcheck'] == {
  2084. 'start_period': base['healthcheck']['start_period'],
  2085. 'test': override['healthcheck']['test'],
  2086. 'interval': override['healthcheck']['interval'],
  2087. 'timeout': override['healthcheck']['timeout'],
  2088. }
  2089. def test_merge_healthcheck_override_disables(self):
  2090. base = {
  2091. 'image': 'bar',
  2092. 'healthcheck': {
  2093. 'start_period': 1000,
  2094. 'interval': 3000,
  2095. 'timeout': 2000,
  2096. 'retries': 3,
  2097. 'test': ['true']
  2098. }
  2099. }
  2100. override = {
  2101. 'healthcheck': {
  2102. 'disabled': True
  2103. }
  2104. }
  2105. actual = config.merge_service_dicts(base, override, V2_3)
  2106. assert actual['healthcheck'] == {'disabled': True}
  2107. def test_merge_healthcheck_override_enables(self):
  2108. base = {
  2109. 'image': 'bar',
  2110. 'healthcheck': {
  2111. 'disabled': True
  2112. }
  2113. }
  2114. override = {
  2115. 'healthcheck': {
  2116. 'disabled': False,
  2117. 'start_period': 1000,
  2118. 'interval': 3000,
  2119. 'timeout': 2000,
  2120. 'retries': 3,
  2121. 'test': ['true']
  2122. }
  2123. }
  2124. actual = config.merge_service_dicts(base, override, V2_3)
  2125. assert actual['healthcheck'] == override['healthcheck']
  2126. def test_external_volume_config(self):
  2127. config_details = build_config_details({
  2128. 'version': '2',
  2129. 'services': {
  2130. 'bogus': {'image': 'busybox'}
  2131. },
  2132. 'volumes': {
  2133. 'ext': {'external': True},
  2134. 'ext2': {'external': {'name': 'aliased'}}
  2135. }
  2136. })
  2137. config_result = config.load(config_details)
  2138. volumes = config_result.volumes
  2139. assert 'ext' in volumes
  2140. assert volumes['ext']['external'] is True
  2141. assert 'ext2' in volumes
  2142. assert volumes['ext2']['external']['name'] == 'aliased'
  2143. def test_external_volume_invalid_config(self):
  2144. config_details = build_config_details({
  2145. 'version': '2',
  2146. 'services': {
  2147. 'bogus': {'image': 'busybox'}
  2148. },
  2149. 'volumes': {
  2150. 'ext': {'external': True, 'driver': 'foo'}
  2151. }
  2152. })
  2153. with pytest.raises(ConfigurationError):
  2154. config.load(config_details)
  2155. def test_depends_on_orders_services(self):
  2156. config_details = build_config_details({
  2157. 'version': '2',
  2158. 'services': {
  2159. 'one': {'image': 'busybox', 'depends_on': ['three', 'two']},
  2160. 'two': {'image': 'busybox', 'depends_on': ['three']},
  2161. 'three': {'image': 'busybox'},
  2162. },
  2163. })
  2164. actual = config.load(config_details)
  2165. assert (
  2166. [service['name'] for service in actual.services] ==
  2167. ['three', 'two', 'one']
  2168. )
  2169. def test_depends_on_unknown_service_errors(self):
  2170. config_details = build_config_details({
  2171. 'version': '2',
  2172. 'services': {
  2173. 'one': {'image': 'busybox', 'depends_on': ['three']},
  2174. },
  2175. })
  2176. with pytest.raises(ConfigurationError) as exc:
  2177. config.load(config_details)
  2178. assert "Service 'one' depends on service 'three'" in exc.exconly()
  2179. def test_linked_service_is_undefined(self):
  2180. with self.assertRaises(ConfigurationError):
  2181. config.load(
  2182. build_config_details({
  2183. 'version': '2',
  2184. 'services': {
  2185. 'web': {'image': 'busybox', 'links': ['db:db']},
  2186. },
  2187. })
  2188. )
  2189. def test_load_dockerfile_without_context(self):
  2190. config_details = build_config_details({
  2191. 'version': '2',
  2192. 'services': {
  2193. 'one': {'build': {'dockerfile': 'Dockerfile.foo'}},
  2194. },
  2195. })
  2196. with pytest.raises(ConfigurationError) as exc:
  2197. config.load(config_details)
  2198. assert 'has neither an image nor a build context' in exc.exconly()
  2199. def test_load_secrets(self):
  2200. base_file = config.ConfigFile(
  2201. 'base.yaml',
  2202. {
  2203. 'version': '3.1',
  2204. 'services': {
  2205. 'web': {
  2206. 'image': 'example/web',
  2207. 'secrets': [
  2208. 'one',
  2209. {
  2210. 'source': 'source',
  2211. 'target': 'target',
  2212. 'uid': '100',
  2213. 'gid': '200',
  2214. 'mode': 0o777,
  2215. },
  2216. ],
  2217. },
  2218. },
  2219. 'secrets': {
  2220. 'one': {'file': 'secret.txt'},
  2221. },
  2222. })
  2223. details = config.ConfigDetails('.', [base_file])
  2224. service_dicts = config.load(details).services
  2225. expected = [
  2226. {
  2227. 'name': 'web',
  2228. 'image': 'example/web',
  2229. 'secrets': [
  2230. types.ServiceSecret('one', None, None, None, None),
  2231. types.ServiceSecret('source', 'target', '100', '200', 0o777),
  2232. ],
  2233. },
  2234. ]
  2235. assert service_sort(service_dicts) == service_sort(expected)
  2236. def test_load_secrets_multi_file(self):
  2237. base_file = config.ConfigFile(
  2238. 'base.yaml',
  2239. {
  2240. 'version': '3.1',
  2241. 'services': {
  2242. 'web': {
  2243. 'image': 'example/web',
  2244. 'secrets': ['one'],
  2245. },
  2246. },
  2247. 'secrets': {
  2248. 'one': {'file': 'secret.txt'},
  2249. },
  2250. })
  2251. override_file = config.ConfigFile(
  2252. 'base.yaml',
  2253. {
  2254. 'version': '3.1',
  2255. 'services': {
  2256. 'web': {
  2257. 'secrets': [
  2258. {
  2259. 'source': 'source',
  2260. 'target': 'target',
  2261. 'uid': '100',
  2262. 'gid': '200',
  2263. 'mode': 0o777,
  2264. },
  2265. ],
  2266. },
  2267. },
  2268. })
  2269. details = config.ConfigDetails('.', [base_file, override_file])
  2270. service_dicts = config.load(details).services
  2271. expected = [
  2272. {
  2273. 'name': 'web',
  2274. 'image': 'example/web',
  2275. 'secrets': [
  2276. types.ServiceSecret('one', None, None, None, None),
  2277. types.ServiceSecret('source', 'target', '100', '200', 0o777),
  2278. ],
  2279. },
  2280. ]
  2281. assert service_sort(service_dicts) == service_sort(expected)
  2282. def test_load_configs(self):
  2283. base_file = config.ConfigFile(
  2284. 'base.yaml',
  2285. {
  2286. 'version': '3.3',
  2287. 'services': {
  2288. 'web': {
  2289. 'image': 'example/web',
  2290. 'configs': [
  2291. 'one',
  2292. {
  2293. 'source': 'source',
  2294. 'target': 'target',
  2295. 'uid': '100',
  2296. 'gid': '200',
  2297. 'mode': 0o777,
  2298. },
  2299. ],
  2300. },
  2301. },
  2302. 'configs': {
  2303. 'one': {'file': 'secret.txt'},
  2304. },
  2305. })
  2306. details = config.ConfigDetails('.', [base_file])
  2307. service_dicts = config.load(details).services
  2308. expected = [
  2309. {
  2310. 'name': 'web',
  2311. 'image': 'example/web',
  2312. 'configs': [
  2313. types.ServiceConfig('one', None, None, None, None),
  2314. types.ServiceConfig('source', 'target', '100', '200', 0o777),
  2315. ],
  2316. },
  2317. ]
  2318. assert service_sort(service_dicts) == service_sort(expected)
  2319. def test_load_configs_multi_file(self):
  2320. base_file = config.ConfigFile(
  2321. 'base.yaml',
  2322. {
  2323. 'version': '3.3',
  2324. 'services': {
  2325. 'web': {
  2326. 'image': 'example/web',
  2327. 'configs': ['one'],
  2328. },
  2329. },
  2330. 'configs': {
  2331. 'one': {'file': 'secret.txt'},
  2332. },
  2333. })
  2334. override_file = config.ConfigFile(
  2335. 'base.yaml',
  2336. {
  2337. 'version': '3.3',
  2338. 'services': {
  2339. 'web': {
  2340. 'configs': [
  2341. {
  2342. 'source': 'source',
  2343. 'target': 'target',
  2344. 'uid': '100',
  2345. 'gid': '200',
  2346. 'mode': 0o777,
  2347. },
  2348. ],
  2349. },
  2350. },
  2351. })
  2352. details = config.ConfigDetails('.', [base_file, override_file])
  2353. service_dicts = config.load(details).services
  2354. expected = [
  2355. {
  2356. 'name': 'web',
  2357. 'image': 'example/web',
  2358. 'configs': [
  2359. types.ServiceConfig('one', None, None, None, None),
  2360. types.ServiceConfig('source', 'target', '100', '200', 0o777),
  2361. ],
  2362. },
  2363. ]
  2364. assert service_sort(service_dicts) == service_sort(expected)
  2365. class NetworkModeTest(unittest.TestCase):
  2366. def test_network_mode_standard(self):
  2367. config_data = config.load(build_config_details({
  2368. 'version': '2',
  2369. 'services': {
  2370. 'web': {
  2371. 'image': 'busybox',
  2372. 'command': "top",
  2373. 'network_mode': 'bridge',
  2374. },
  2375. },
  2376. }))
  2377. assert config_data.services[0]['network_mode'] == 'bridge'
  2378. def test_network_mode_standard_v1(self):
  2379. config_data = config.load(build_config_details({
  2380. 'web': {
  2381. 'image': 'busybox',
  2382. 'command': "top",
  2383. 'net': 'bridge',
  2384. },
  2385. }))
  2386. assert config_data.services[0]['network_mode'] == 'bridge'
  2387. assert 'net' not in config_data.services[0]
  2388. def test_network_mode_container(self):
  2389. config_data = config.load(build_config_details({
  2390. 'version': '2',
  2391. 'services': {
  2392. 'web': {
  2393. 'image': 'busybox',
  2394. 'command': "top",
  2395. 'network_mode': 'container:foo',
  2396. },
  2397. },
  2398. }))
  2399. assert config_data.services[0]['network_mode'] == 'container:foo'
  2400. def test_network_mode_container_v1(self):
  2401. config_data = config.load(build_config_details({
  2402. 'web': {
  2403. 'image': 'busybox',
  2404. 'command': "top",
  2405. 'net': 'container:foo',
  2406. },
  2407. }))
  2408. assert config_data.services[0]['network_mode'] == 'container:foo'
  2409. def test_network_mode_service(self):
  2410. config_data = config.load(build_config_details({
  2411. 'version': '2',
  2412. 'services': {
  2413. 'web': {
  2414. 'image': 'busybox',
  2415. 'command': "top",
  2416. 'network_mode': 'service:foo',
  2417. },
  2418. 'foo': {
  2419. 'image': 'busybox',
  2420. 'command': "top",
  2421. },
  2422. },
  2423. }))
  2424. assert config_data.services[1]['network_mode'] == 'service:foo'
  2425. def test_network_mode_service_v1(self):
  2426. config_data = config.load(build_config_details({
  2427. 'web': {
  2428. 'image': 'busybox',
  2429. 'command': "top",
  2430. 'net': 'container:foo',
  2431. },
  2432. 'foo': {
  2433. 'image': 'busybox',
  2434. 'command': "top",
  2435. },
  2436. }))
  2437. assert config_data.services[1]['network_mode'] == 'service:foo'
  2438. def test_network_mode_service_nonexistent(self):
  2439. with pytest.raises(ConfigurationError) as excinfo:
  2440. config.load(build_config_details({
  2441. 'version': '2',
  2442. 'services': {
  2443. 'web': {
  2444. 'image': 'busybox',
  2445. 'command': "top",
  2446. 'network_mode': 'service:foo',
  2447. },
  2448. },
  2449. }))
  2450. assert "service 'foo' which is undefined" in excinfo.exconly()
  2451. def test_network_mode_plus_networks_is_invalid(self):
  2452. with pytest.raises(ConfigurationError) as excinfo:
  2453. config.load(build_config_details({
  2454. 'version': '2',
  2455. 'services': {
  2456. 'web': {
  2457. 'image': 'busybox',
  2458. 'command': "top",
  2459. 'network_mode': 'bridge',
  2460. 'networks': ['front'],
  2461. },
  2462. },
  2463. 'networks': {
  2464. 'front': None,
  2465. }
  2466. }))
  2467. assert "'network_mode' and 'networks' cannot be combined" in excinfo.exconly()
  2468. class PortsTest(unittest.TestCase):
  2469. INVALID_PORTS_TYPES = [
  2470. {"1": "8000"},
  2471. False,
  2472. "8000",
  2473. 8000,
  2474. ]
  2475. NON_UNIQUE_SINGLE_PORTS = [
  2476. ["8000", "8000"],
  2477. ]
  2478. INVALID_PORT_MAPPINGS = [
  2479. ["8000-8004:8000-8002"],
  2480. ["4242:4242-4244"],
  2481. ]
  2482. VALID_SINGLE_PORTS = [
  2483. ["8000"],
  2484. ["8000/tcp"],
  2485. ["8000", "9000"],
  2486. [8000],
  2487. [8000, 9000],
  2488. ]
  2489. VALID_PORT_MAPPINGS = [
  2490. ["8000:8050"],
  2491. ["49153-49154:3002-3003"],
  2492. ]
  2493. def test_config_invalid_ports_type_validation(self):
  2494. for invalid_ports in self.INVALID_PORTS_TYPES:
  2495. with pytest.raises(ConfigurationError) as exc:
  2496. self.check_config({'ports': invalid_ports})
  2497. assert "contains an invalid type" in exc.value.msg
  2498. def test_config_non_unique_ports_validation(self):
  2499. for invalid_ports in self.NON_UNIQUE_SINGLE_PORTS:
  2500. with pytest.raises(ConfigurationError) as exc:
  2501. self.check_config({'ports': invalid_ports})
  2502. assert "non-unique" in exc.value.msg
  2503. def test_config_invalid_ports_format_validation(self):
  2504. for invalid_ports in self.INVALID_PORT_MAPPINGS:
  2505. with pytest.raises(ConfigurationError) as exc:
  2506. self.check_config({'ports': invalid_ports})
  2507. assert "Port ranges don't match in length" in exc.value.msg
  2508. def test_config_valid_ports_format_validation(self):
  2509. for valid_ports in self.VALID_SINGLE_PORTS + self.VALID_PORT_MAPPINGS:
  2510. self.check_config({'ports': valid_ports})
  2511. def test_config_invalid_expose_type_validation(self):
  2512. for invalid_expose in self.INVALID_PORTS_TYPES:
  2513. with pytest.raises(ConfigurationError) as exc:
  2514. self.check_config({'expose': invalid_expose})
  2515. assert "contains an invalid type" in exc.value.msg
  2516. def test_config_non_unique_expose_validation(self):
  2517. for invalid_expose in self.NON_UNIQUE_SINGLE_PORTS:
  2518. with pytest.raises(ConfigurationError) as exc:
  2519. self.check_config({'expose': invalid_expose})
  2520. assert "non-unique" in exc.value.msg
  2521. def test_config_invalid_expose_format_validation(self):
  2522. # Valid port mappings ARE NOT valid 'expose' entries
  2523. for invalid_expose in self.INVALID_PORT_MAPPINGS + self.VALID_PORT_MAPPINGS:
  2524. with pytest.raises(ConfigurationError) as exc:
  2525. self.check_config({'expose': invalid_expose})
  2526. assert "should be of the format" in exc.value.msg
  2527. def test_config_valid_expose_format_validation(self):
  2528. # Valid single ports ARE valid 'expose' entries
  2529. for valid_expose in self.VALID_SINGLE_PORTS:
  2530. self.check_config({'expose': valid_expose})
  2531. def check_config(self, cfg):
  2532. config.load(
  2533. build_config_details({
  2534. 'version': '2.3',
  2535. 'services': {
  2536. 'web': dict(image='busybox', **cfg)
  2537. },
  2538. }, 'working_dir', 'filename.yml')
  2539. )
  2540. class InterpolationTest(unittest.TestCase):
  2541. @mock.patch.dict(os.environ)
  2542. def test_config_file_with_environment_file(self):
  2543. project_dir = 'tests/fixtures/default-env-file'
  2544. service_dicts = config.load(
  2545. config.find(
  2546. project_dir, None, Environment.from_env_file(project_dir)
  2547. )
  2548. ).services
  2549. self.assertEqual(service_dicts[0], {
  2550. 'name': 'web',
  2551. 'image': 'alpine:latest',
  2552. 'ports': [
  2553. types.ServicePort.parse('5643')[0],
  2554. types.ServicePort.parse('9999')[0]
  2555. ],
  2556. 'command': 'true'
  2557. })
  2558. @mock.patch.dict(os.environ)
  2559. def test_config_file_with_environment_variable(self):
  2560. project_dir = 'tests/fixtures/environment-interpolation'
  2561. os.environ.update(
  2562. IMAGE="busybox",
  2563. HOST_PORT="80",
  2564. LABEL_VALUE="myvalue",
  2565. )
  2566. service_dicts = config.load(
  2567. config.find(
  2568. project_dir, None, Environment.from_env_file(project_dir)
  2569. )
  2570. ).services
  2571. self.assertEqual(service_dicts, [
  2572. {
  2573. 'name': 'web',
  2574. 'image': 'busybox',
  2575. 'ports': types.ServicePort.parse('80:8000'),
  2576. 'labels': {'mylabel': 'myvalue'},
  2577. 'hostname': 'host-',
  2578. 'command': '${ESCAPED}',
  2579. }
  2580. ])
  2581. @mock.patch.dict(os.environ)
  2582. def test_unset_variable_produces_warning(self):
  2583. os.environ.pop('FOO', None)
  2584. os.environ.pop('BAR', None)
  2585. config_details = build_config_details(
  2586. {
  2587. 'web': {
  2588. 'image': '${FOO}',
  2589. 'command': '${BAR}',
  2590. 'container_name': '${BAR}',
  2591. },
  2592. },
  2593. '.',
  2594. None,
  2595. )
  2596. with mock.patch('compose.config.environment.log') as log:
  2597. config.load(config_details)
  2598. self.assertEqual(2, log.warn.call_count)
  2599. warnings = sorted(args[0][0] for args in log.warn.call_args_list)
  2600. self.assertIn('BAR', warnings[0])
  2601. self.assertIn('FOO', warnings[1])
  2602. @mock.patch.dict(os.environ)
  2603. def test_invalid_interpolation(self):
  2604. with self.assertRaises(config.ConfigurationError) as cm:
  2605. config.load(
  2606. build_config_details(
  2607. {'web': {'image': '${'}},
  2608. 'working_dir',
  2609. 'filename.yml'
  2610. )
  2611. )
  2612. self.assertIn('Invalid', cm.exception.msg)
  2613. self.assertIn('for "image" option', cm.exception.msg)
  2614. self.assertIn('in service "web"', cm.exception.msg)
  2615. self.assertIn('"${"', cm.exception.msg)
  2616. @mock.patch.dict(os.environ)
  2617. def test_interpolation_secrets_section(self):
  2618. os.environ['FOO'] = 'baz.bar'
  2619. config_dict = config.load(build_config_details({
  2620. 'version': '3.1',
  2621. 'secrets': {
  2622. 'secretdata': {
  2623. 'external': {'name': '$FOO'}
  2624. }
  2625. }
  2626. }))
  2627. assert config_dict.secrets == {
  2628. 'secretdata': {
  2629. 'external': {'name': 'baz.bar'},
  2630. 'external_name': 'baz.bar'
  2631. }
  2632. }
  2633. @mock.patch.dict(os.environ)
  2634. def test_interpolation_configs_section(self):
  2635. os.environ['FOO'] = 'baz.bar'
  2636. config_dict = config.load(build_config_details({
  2637. 'version': '3.3',
  2638. 'configs': {
  2639. 'configdata': {
  2640. 'external': {'name': '$FOO'}
  2641. }
  2642. }
  2643. }))
  2644. assert config_dict.configs == {
  2645. 'configdata': {
  2646. 'external': {'name': 'baz.bar'},
  2647. 'external_name': 'baz.bar'
  2648. }
  2649. }
  2650. class VolumeConfigTest(unittest.TestCase):
  2651. def test_no_binding(self):
  2652. d = make_service_dict('foo', {'build': '.', 'volumes': ['/data']}, working_dir='.')
  2653. self.assertEqual(d['volumes'], ['/data'])
  2654. @mock.patch.dict(os.environ)
  2655. def test_volume_binding_with_environment_variable(self):
  2656. os.environ['VOLUME_PATH'] = '/host/path'
  2657. d = config.load(
  2658. build_config_details(
  2659. {'foo': {'build': '.', 'volumes': ['${VOLUME_PATH}:/container/path']}},
  2660. '.',
  2661. None,
  2662. )
  2663. ).services[0]
  2664. self.assertEqual(d['volumes'], [VolumeSpec.parse('/host/path:/container/path')])
  2665. @pytest.mark.skipif(IS_WINDOWS_PLATFORM, reason='posix paths')
  2666. @mock.patch.dict(os.environ)
  2667. def test_volume_binding_with_home(self):
  2668. os.environ['HOME'] = '/home/user'
  2669. d = make_service_dict('foo', {'build': '.', 'volumes': ['~:/container/path']}, working_dir='.')
  2670. self.assertEqual(d['volumes'], ['/home/user:/container/path'])
  2671. def test_name_does_not_expand(self):
  2672. d = make_service_dict('foo', {'build': '.', 'volumes': ['mydatavolume:/data']}, working_dir='.')
  2673. self.assertEqual(d['volumes'], ['mydatavolume:/data'])
  2674. def test_absolute_posix_path_does_not_expand(self):
  2675. d = make_service_dict('foo', {'build': '.', 'volumes': ['/var/lib/data:/data']}, working_dir='.')
  2676. self.assertEqual(d['volumes'], ['/var/lib/data:/data'])
  2677. def test_absolute_windows_path_does_not_expand(self):
  2678. d = make_service_dict('foo', {'build': '.', 'volumes': ['c:\\data:/data']}, working_dir='.')
  2679. self.assertEqual(d['volumes'], ['c:\\data:/data'])
  2680. @pytest.mark.skipif(IS_WINDOWS_PLATFORM, reason='posix paths')
  2681. def test_relative_path_does_expand_posix(self):
  2682. d = make_service_dict(
  2683. 'foo',
  2684. {'build': '.', 'volumes': ['./data:/data']},
  2685. working_dir='/home/me/myproject')
  2686. self.assertEqual(d['volumes'], ['/home/me/myproject/data:/data'])
  2687. d = make_service_dict(
  2688. 'foo',
  2689. {'build': '.', 'volumes': ['.:/data']},
  2690. working_dir='/home/me/myproject')
  2691. self.assertEqual(d['volumes'], ['/home/me/myproject:/data'])
  2692. d = make_service_dict(
  2693. 'foo',
  2694. {'build': '.', 'volumes': ['../otherproject:/data']},
  2695. working_dir='/home/me/myproject')
  2696. self.assertEqual(d['volumes'], ['/home/me/otherproject:/data'])
  2697. @pytest.mark.skipif(not IS_WINDOWS_PLATFORM, reason='windows paths')
  2698. def test_relative_path_does_expand_windows(self):
  2699. d = make_service_dict(
  2700. 'foo',
  2701. {'build': '.', 'volumes': ['./data:/data']},
  2702. working_dir='c:\\Users\\me\\myproject')
  2703. self.assertEqual(d['volumes'], ['c:\\Users\\me\\myproject\\data:/data'])
  2704. d = make_service_dict(
  2705. 'foo',
  2706. {'build': '.', 'volumes': ['.:/data']},
  2707. working_dir='c:\\Users\\me\\myproject')
  2708. self.assertEqual(d['volumes'], ['c:\\Users\\me\\myproject:/data'])
  2709. d = make_service_dict(
  2710. 'foo',
  2711. {'build': '.', 'volumes': ['../otherproject:/data']},
  2712. working_dir='c:\\Users\\me\\myproject')
  2713. self.assertEqual(d['volumes'], ['c:\\Users\\me\\otherproject:/data'])
  2714. @mock.patch.dict(os.environ)
  2715. def test_home_directory_with_driver_does_not_expand(self):
  2716. os.environ['NAME'] = 'surprise!'
  2717. d = make_service_dict('foo', {
  2718. 'build': '.',
  2719. 'volumes': ['~:/data'],
  2720. 'volume_driver': 'foodriver',
  2721. }, working_dir='.')
  2722. self.assertEqual(d['volumes'], ['~:/data'])
  2723. def test_volume_path_with_non_ascii_directory(self):
  2724. volume = u'/Füü/data:/data'
  2725. container_path = config.resolve_volume_path(".", volume)
  2726. self.assertEqual(container_path, volume)
  2727. class MergePathMappingTest(object):
  2728. config_name = ""
  2729. def test_empty(self):
  2730. service_dict = config.merge_service_dicts({}, {}, DEFAULT_VERSION)
  2731. assert self.config_name not in service_dict
  2732. def test_no_override(self):
  2733. service_dict = config.merge_service_dicts(
  2734. {self.config_name: ['/foo:/code', '/data']},
  2735. {},
  2736. DEFAULT_VERSION)
  2737. assert set(service_dict[self.config_name]) == set(['/foo:/code', '/data'])
  2738. def test_no_base(self):
  2739. service_dict = config.merge_service_dicts(
  2740. {},
  2741. {self.config_name: ['/bar:/code']},
  2742. DEFAULT_VERSION)
  2743. assert set(service_dict[self.config_name]) == set(['/bar:/code'])
  2744. def test_override_explicit_path(self):
  2745. service_dict = config.merge_service_dicts(
  2746. {self.config_name: ['/foo:/code', '/data']},
  2747. {self.config_name: ['/bar:/code']},
  2748. DEFAULT_VERSION)
  2749. assert set(service_dict[self.config_name]) == set(['/bar:/code', '/data'])
  2750. def test_add_explicit_path(self):
  2751. service_dict = config.merge_service_dicts(
  2752. {self.config_name: ['/foo:/code', '/data']},
  2753. {self.config_name: ['/bar:/code', '/quux:/data']},
  2754. DEFAULT_VERSION)
  2755. assert set(service_dict[self.config_name]) == set(['/bar:/code', '/quux:/data'])
  2756. def test_remove_explicit_path(self):
  2757. service_dict = config.merge_service_dicts(
  2758. {self.config_name: ['/foo:/code', '/quux:/data']},
  2759. {self.config_name: ['/bar:/code', '/data']},
  2760. DEFAULT_VERSION)
  2761. assert set(service_dict[self.config_name]) == set(['/bar:/code', '/data'])
  2762. class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
  2763. config_name = 'volumes'
  2764. class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
  2765. config_name = 'devices'
  2766. class BuildOrImageMergeTest(unittest.TestCase):
  2767. def test_merge_build_or_image_no_override(self):
  2768. self.assertEqual(
  2769. config.merge_service_dicts({'build': '.'}, {}, V1),
  2770. {'build': '.'},
  2771. )
  2772. self.assertEqual(
  2773. config.merge_service_dicts({'image': 'redis'}, {}, V1),
  2774. {'image': 'redis'},
  2775. )
  2776. def test_merge_build_or_image_override_with_same(self):
  2777. self.assertEqual(
  2778. config.merge_service_dicts({'build': '.'}, {'build': './web'}, V1),
  2779. {'build': './web'},
  2780. )
  2781. self.assertEqual(
  2782. config.merge_service_dicts({'image': 'redis'}, {'image': 'postgres'}, V1),
  2783. {'image': 'postgres'},
  2784. )
  2785. def test_merge_build_or_image_override_with_other(self):
  2786. self.assertEqual(
  2787. config.merge_service_dicts({'build': '.'}, {'image': 'redis'}, V1),
  2788. {'image': 'redis'},
  2789. )
  2790. self.assertEqual(
  2791. config.merge_service_dicts({'image': 'redis'}, {'build': '.'}, V1),
  2792. {'build': '.'}
  2793. )
  2794. class MergeListsTest(object):
  2795. config_name = ""
  2796. base_config = []
  2797. override_config = []
  2798. def merged_config(self):
  2799. return set(self.base_config) | set(self.override_config)
  2800. def test_empty(self):
  2801. assert self.config_name not in config.merge_service_dicts({}, {}, DEFAULT_VERSION)
  2802. def test_no_override(self):
  2803. service_dict = config.merge_service_dicts(
  2804. {self.config_name: self.base_config},
  2805. {},
  2806. DEFAULT_VERSION)
  2807. assert set(service_dict[self.config_name]) == set(self.base_config)
  2808. def test_no_base(self):
  2809. service_dict = config.merge_service_dicts(
  2810. {},
  2811. {self.config_name: self.base_config},
  2812. DEFAULT_VERSION)
  2813. assert set(service_dict[self.config_name]) == set(self.base_config)
  2814. def test_add_item(self):
  2815. service_dict = config.merge_service_dicts(
  2816. {self.config_name: self.base_config},
  2817. {self.config_name: self.override_config},
  2818. DEFAULT_VERSION)
  2819. assert set(service_dict[self.config_name]) == set(self.merged_config())
  2820. class MergePortsTest(unittest.TestCase, MergeListsTest):
  2821. config_name = 'ports'
  2822. base_config = ['10:8000', '9000']
  2823. override_config = ['20:8000']
  2824. def merged_config(self):
  2825. return self.convert(self.base_config) | self.convert(self.override_config)
  2826. def convert(self, port_config):
  2827. return set(config.merge_service_dicts(
  2828. {self.config_name: port_config},
  2829. {self.config_name: []},
  2830. DEFAULT_VERSION
  2831. )[self.config_name])
  2832. def test_duplicate_port_mappings(self):
  2833. service_dict = config.merge_service_dicts(
  2834. {self.config_name: self.base_config},
  2835. {self.config_name: self.base_config},
  2836. DEFAULT_VERSION
  2837. )
  2838. assert set(service_dict[self.config_name]) == self.convert(self.base_config)
  2839. def test_no_override(self):
  2840. service_dict = config.merge_service_dicts(
  2841. {self.config_name: self.base_config},
  2842. {},
  2843. DEFAULT_VERSION)
  2844. assert set(service_dict[self.config_name]) == self.convert(self.base_config)
  2845. def test_no_base(self):
  2846. service_dict = config.merge_service_dicts(
  2847. {},
  2848. {self.config_name: self.base_config},
  2849. DEFAULT_VERSION)
  2850. assert set(service_dict[self.config_name]) == self.convert(self.base_config)
  2851. class MergeNetworksTest(unittest.TestCase, MergeListsTest):
  2852. config_name = 'networks'
  2853. base_config = ['frontend', 'backend']
  2854. override_config = ['monitoring']
  2855. class MergeStringsOrListsTest(unittest.TestCase):
  2856. def test_no_override(self):
  2857. service_dict = config.merge_service_dicts(
  2858. {'dns': '8.8.8.8'},
  2859. {},
  2860. DEFAULT_VERSION)
  2861. assert set(service_dict['dns']) == set(['8.8.8.8'])
  2862. def test_no_base(self):
  2863. service_dict = config.merge_service_dicts(
  2864. {},
  2865. {'dns': '8.8.8.8'},
  2866. DEFAULT_VERSION)
  2867. assert set(service_dict['dns']) == set(['8.8.8.8'])
  2868. def test_add_string(self):
  2869. service_dict = config.merge_service_dicts(
  2870. {'dns': ['8.8.8.8']},
  2871. {'dns': '9.9.9.9'},
  2872. DEFAULT_VERSION)
  2873. assert set(service_dict['dns']) == set(['8.8.8.8', '9.9.9.9'])
  2874. def test_add_list(self):
  2875. service_dict = config.merge_service_dicts(
  2876. {'dns': '8.8.8.8'},
  2877. {'dns': ['9.9.9.9']},
  2878. DEFAULT_VERSION)
  2879. assert set(service_dict['dns']) == set(['8.8.8.8', '9.9.9.9'])
  2880. class MergeLabelsTest(unittest.TestCase):
  2881. def test_empty(self):
  2882. assert 'labels' not in config.merge_service_dicts({}, {}, DEFAULT_VERSION)
  2883. def test_no_override(self):
  2884. service_dict = config.merge_service_dicts(
  2885. make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
  2886. make_service_dict('foo', {'build': '.'}, 'tests/'),
  2887. DEFAULT_VERSION)
  2888. assert service_dict['labels'] == {'foo': '1', 'bar': ''}
  2889. def test_no_base(self):
  2890. service_dict = config.merge_service_dicts(
  2891. make_service_dict('foo', {'build': '.'}, 'tests/'),
  2892. make_service_dict('foo', {'build': '.', 'labels': ['foo=2']}, 'tests/'),
  2893. DEFAULT_VERSION)
  2894. assert service_dict['labels'] == {'foo': '2'}
  2895. def test_override_explicit_value(self):
  2896. service_dict = config.merge_service_dicts(
  2897. make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
  2898. make_service_dict('foo', {'build': '.', 'labels': ['foo=2']}, 'tests/'),
  2899. DEFAULT_VERSION)
  2900. assert service_dict['labels'] == {'foo': '2', 'bar': ''}
  2901. def test_add_explicit_value(self):
  2902. service_dict = config.merge_service_dicts(
  2903. make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
  2904. make_service_dict('foo', {'build': '.', 'labels': ['bar=2']}, 'tests/'),
  2905. DEFAULT_VERSION)
  2906. assert service_dict['labels'] == {'foo': '1', 'bar': '2'}
  2907. def test_remove_explicit_value(self):
  2908. service_dict = config.merge_service_dicts(
  2909. make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar=2']}, 'tests/'),
  2910. make_service_dict('foo', {'build': '.', 'labels': ['bar']}, 'tests/'),
  2911. DEFAULT_VERSION)
  2912. assert service_dict['labels'] == {'foo': '1', 'bar': ''}
  2913. class MergeBuildTest(unittest.TestCase):
  2914. def test_full(self):
  2915. base = {
  2916. 'context': '.',
  2917. 'dockerfile': 'Dockerfile',
  2918. 'args': {
  2919. 'x': '1',
  2920. 'y': '2',
  2921. },
  2922. 'cache_from': ['ubuntu'],
  2923. 'labels': ['com.docker.compose.test=true']
  2924. }
  2925. override = {
  2926. 'context': './prod',
  2927. 'dockerfile': 'Dockerfile.prod',
  2928. 'args': ['x=12'],
  2929. 'cache_from': ['debian'],
  2930. 'labels': {
  2931. 'com.docker.compose.test': 'false',
  2932. 'com.docker.compose.prod': 'true',
  2933. }
  2934. }
  2935. result = config.merge_build(None, {'build': base}, {'build': override})
  2936. assert result['context'] == override['context']
  2937. assert result['dockerfile'] == override['dockerfile']
  2938. assert result['args'] == {'x': '12', 'y': '2'}
  2939. assert set(result['cache_from']) == set(['ubuntu', 'debian'])
  2940. assert result['labels'] == override['labels']
  2941. def test_empty_override(self):
  2942. base = {
  2943. 'context': '.',
  2944. 'dockerfile': 'Dockerfile',
  2945. 'args': {
  2946. 'x': '1',
  2947. 'y': '2',
  2948. },
  2949. 'cache_from': ['ubuntu'],
  2950. 'labels': {
  2951. 'com.docker.compose.test': 'true'
  2952. }
  2953. }
  2954. override = {}
  2955. result = config.merge_build(None, {'build': base}, {'build': override})
  2956. assert result == base
  2957. def test_empty_base(self):
  2958. base = {}
  2959. override = {
  2960. 'context': './prod',
  2961. 'dockerfile': 'Dockerfile.prod',
  2962. 'args': {'x': '12'},
  2963. 'cache_from': ['debian'],
  2964. 'labels': {
  2965. 'com.docker.compose.test': 'false',
  2966. 'com.docker.compose.prod': 'true',
  2967. }
  2968. }
  2969. result = config.merge_build(None, {'build': base}, {'build': override})
  2970. assert result == override
  2971. class MemoryOptionsTest(unittest.TestCase):
  2972. def test_validation_fails_with_just_memswap_limit(self):
  2973. """
  2974. When you set a 'memswap_limit' it is invalid config unless you also set
  2975. a mem_limit
  2976. """
  2977. with pytest.raises(ConfigurationError) as excinfo:
  2978. config.load(
  2979. build_config_details(
  2980. {
  2981. 'foo': {'image': 'busybox', 'memswap_limit': 2000000},
  2982. },
  2983. 'tests/fixtures/extends',
  2984. 'filename.yml'
  2985. )
  2986. )
  2987. assert "foo.memswap_limit is invalid: when defining " \
  2988. "'memswap_limit' you must set 'mem_limit' as well" \
  2989. in excinfo.exconly()
  2990. def test_validation_with_correct_memswap_values(self):
  2991. service_dict = config.load(
  2992. build_config_details(
  2993. {'foo': {'image': 'busybox', 'mem_limit': 1000000, 'memswap_limit': 2000000}},
  2994. 'tests/fixtures/extends',
  2995. 'common.yml'
  2996. )
  2997. ).services
  2998. self.assertEqual(service_dict[0]['memswap_limit'], 2000000)
  2999. def test_memswap_can_be_a_string(self):
  3000. service_dict = config.load(
  3001. build_config_details(
  3002. {'foo': {'image': 'busybox', 'mem_limit': "1G", 'memswap_limit': "512M"}},
  3003. 'tests/fixtures/extends',
  3004. 'common.yml'
  3005. )
  3006. ).services
  3007. self.assertEqual(service_dict[0]['memswap_limit'], "512M")
  3008. class EnvTest(unittest.TestCase):
  3009. def test_parse_environment_as_list(self):
  3010. environment = [
  3011. 'NORMAL=F1',
  3012. 'CONTAINS_EQUALS=F=2',
  3013. 'TRAILING_EQUALS=',
  3014. ]
  3015. self.assertEqual(
  3016. config.parse_environment(environment),
  3017. {'NORMAL': 'F1', 'CONTAINS_EQUALS': 'F=2', 'TRAILING_EQUALS': ''},
  3018. )
  3019. def test_parse_environment_as_dict(self):
  3020. environment = {
  3021. 'NORMAL': 'F1',
  3022. 'CONTAINS_EQUALS': 'F=2',
  3023. 'TRAILING_EQUALS': None,
  3024. }
  3025. self.assertEqual(config.parse_environment(environment), environment)
  3026. def test_parse_environment_invalid(self):
  3027. with self.assertRaises(ConfigurationError):
  3028. config.parse_environment('a=b')
  3029. def test_parse_environment_empty(self):
  3030. self.assertEqual(config.parse_environment(None), {})
  3031. @mock.patch.dict(os.environ)
  3032. def test_resolve_environment(self):
  3033. os.environ['FILE_DEF'] = 'E1'
  3034. os.environ['FILE_DEF_EMPTY'] = 'E2'
  3035. os.environ['ENV_DEF'] = 'E3'
  3036. service_dict = {
  3037. 'build': '.',
  3038. 'environment': {
  3039. 'FILE_DEF': 'F1',
  3040. 'FILE_DEF_EMPTY': '',
  3041. 'ENV_DEF': None,
  3042. 'NO_DEF': None
  3043. },
  3044. }
  3045. self.assertEqual(
  3046. resolve_environment(
  3047. service_dict, Environment.from_env_file(None)
  3048. ),
  3049. {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': None},
  3050. )
  3051. def test_resolve_environment_from_env_file(self):
  3052. self.assertEqual(
  3053. resolve_environment({'env_file': ['tests/fixtures/env/one.env']}),
  3054. {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'bar'},
  3055. )
  3056. def test_environment_overrides_env_file(self):
  3057. self.assertEqual(
  3058. resolve_environment({
  3059. 'environment': {'FOO': 'baz'},
  3060. 'env_file': ['tests/fixtures/env/one.env'],
  3061. }),
  3062. {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'baz'},
  3063. )
  3064. def test_resolve_environment_with_multiple_env_files(self):
  3065. service_dict = {
  3066. 'env_file': [
  3067. 'tests/fixtures/env/one.env',
  3068. 'tests/fixtures/env/two.env'
  3069. ]
  3070. }
  3071. self.assertEqual(
  3072. resolve_environment(service_dict),
  3073. {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'baz', 'DOO': 'dah'},
  3074. )
  3075. def test_resolve_environment_nonexistent_file(self):
  3076. with pytest.raises(ConfigurationError) as exc:
  3077. config.load(build_config_details(
  3078. {'foo': {'image': 'example', 'env_file': 'nonexistent.env'}},
  3079. working_dir='tests/fixtures/env'))
  3080. assert 'Couldn\'t find env file' in exc.exconly()
  3081. assert 'nonexistent.env' in exc.exconly()
  3082. @mock.patch.dict(os.environ)
  3083. def test_resolve_environment_from_env_file_with_empty_values(self):
  3084. os.environ['FILE_DEF'] = 'E1'
  3085. os.environ['FILE_DEF_EMPTY'] = 'E2'
  3086. os.environ['ENV_DEF'] = 'E3'
  3087. self.assertEqual(
  3088. resolve_environment(
  3089. {'env_file': ['tests/fixtures/env/resolve.env']},
  3090. Environment.from_env_file(None)
  3091. ),
  3092. {
  3093. 'FILE_DEF': u'bär',
  3094. 'FILE_DEF_EMPTY': '',
  3095. 'ENV_DEF': 'E3',
  3096. 'NO_DEF': None
  3097. },
  3098. )
  3099. @mock.patch.dict(os.environ)
  3100. def test_resolve_build_args(self):
  3101. os.environ['env_arg'] = 'value2'
  3102. build = {
  3103. 'context': '.',
  3104. 'args': {
  3105. 'arg1': 'value1',
  3106. 'empty_arg': '',
  3107. 'env_arg': None,
  3108. 'no_env': None
  3109. }
  3110. }
  3111. self.assertEqual(
  3112. resolve_build_args(build['args'], Environment.from_env_file(build['context'])),
  3113. {'arg1': 'value1', 'empty_arg': '', 'env_arg': 'value2', 'no_env': None},
  3114. )
  3115. @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
  3116. @mock.patch.dict(os.environ)
  3117. def test_resolve_path(self):
  3118. os.environ['HOSTENV'] = '/tmp'
  3119. os.environ['CONTAINERENV'] = '/host/tmp'
  3120. service_dict = config.load(
  3121. build_config_details(
  3122. {'foo': {'build': '.', 'volumes': ['$HOSTENV:$CONTAINERENV']}},
  3123. "tests/fixtures/env",
  3124. )
  3125. ).services[0]
  3126. self.assertEqual(
  3127. set(service_dict['volumes']),
  3128. set([VolumeSpec.parse('/tmp:/host/tmp')]))
  3129. service_dict = config.load(
  3130. build_config_details(
  3131. {'foo': {'build': '.', 'volumes': ['/opt${HOSTENV}:/opt${CONTAINERENV}']}},
  3132. "tests/fixtures/env",
  3133. )
  3134. ).services[0]
  3135. self.assertEqual(
  3136. set(service_dict['volumes']),
  3137. set([VolumeSpec.parse('/opt/tmp:/opt/host/tmp')]))
  3138. def load_from_filename(filename, override_dir=None):
  3139. return config.load(
  3140. config.find('.', [filename], Environment.from_env_file('.'), override_dir=override_dir)
  3141. ).services
  3142. class ExtendsTest(unittest.TestCase):
  3143. def test_extends(self):
  3144. service_dicts = load_from_filename('tests/fixtures/extends/docker-compose.yml')
  3145. self.assertEqual(service_sort(service_dicts), service_sort([
  3146. {
  3147. 'name': 'mydb',
  3148. 'image': 'busybox',
  3149. 'command': 'top',
  3150. },
  3151. {
  3152. 'name': 'myweb',
  3153. 'image': 'busybox',
  3154. 'command': 'top',
  3155. 'network_mode': 'bridge',
  3156. 'links': ['mydb:db'],
  3157. 'environment': {
  3158. "FOO": "1",
  3159. "BAR": "2",
  3160. "BAZ": "2",
  3161. },
  3162. }
  3163. ]))
  3164. def test_merging_env_labels_ulimits(self):
  3165. service_dicts = load_from_filename('tests/fixtures/extends/common-env-labels-ulimits.yml')
  3166. self.assertEqual(service_sort(service_dicts), service_sort([
  3167. {
  3168. 'name': 'web',
  3169. 'image': 'busybox',
  3170. 'command': '/bin/true',
  3171. 'network_mode': 'host',
  3172. 'environment': {
  3173. "FOO": "2",
  3174. "BAR": "1",
  3175. "BAZ": "3",
  3176. },
  3177. 'labels': {'label': 'one'},
  3178. 'ulimits': {'nproc': 65535, 'memlock': {'soft': 1024, 'hard': 2048}}
  3179. }
  3180. ]))
  3181. def test_nested(self):
  3182. service_dicts = load_from_filename('tests/fixtures/extends/nested.yml')
  3183. self.assertEqual(service_dicts, [
  3184. {
  3185. 'name': 'myweb',
  3186. 'image': 'busybox',
  3187. 'command': '/bin/true',
  3188. 'network_mode': 'host',
  3189. 'environment': {
  3190. "FOO": "2",
  3191. "BAR": "2",
  3192. },
  3193. },
  3194. ])
  3195. def test_self_referencing_file(self):
  3196. """
  3197. We specify a 'file' key that is the filename we're already in.
  3198. """
  3199. service_dicts = load_from_filename('tests/fixtures/extends/specify-file-as-self.yml')
  3200. self.assertEqual(service_sort(service_dicts), service_sort([
  3201. {
  3202. 'environment':
  3203. {
  3204. 'YEP': '1', 'BAR': '1', 'BAZ': '3'
  3205. },
  3206. 'image': 'busybox',
  3207. 'name': 'myweb'
  3208. },
  3209. {
  3210. 'environment':
  3211. {'YEP': '1'},
  3212. 'image': 'busybox',
  3213. 'name': 'otherweb'
  3214. },
  3215. {
  3216. 'environment':
  3217. {'YEP': '1', 'BAZ': '3'},
  3218. 'image': 'busybox',
  3219. 'name': 'web'
  3220. }
  3221. ]))
  3222. def test_circular(self):
  3223. with pytest.raises(config.CircularReference) as exc:
  3224. load_from_filename('tests/fixtures/extends/circle-1.yml')
  3225. path = [
  3226. (os.path.basename(filename), service_name)
  3227. for (filename, service_name) in exc.value.trail
  3228. ]
  3229. expected = [
  3230. ('circle-1.yml', 'web'),
  3231. ('circle-2.yml', 'other'),
  3232. ('circle-1.yml', 'web'),
  3233. ]
  3234. self.assertEqual(path, expected)
  3235. def test_extends_validation_empty_dictionary(self):
  3236. with pytest.raises(ConfigurationError) as excinfo:
  3237. config.load(
  3238. build_config_details(
  3239. {
  3240. 'web': {'image': 'busybox', 'extends': {}},
  3241. },
  3242. 'tests/fixtures/extends',
  3243. 'filename.yml'
  3244. )
  3245. )
  3246. assert 'service' in excinfo.exconly()
  3247. def test_extends_validation_missing_service_key(self):
  3248. with pytest.raises(ConfigurationError) as excinfo:
  3249. config.load(
  3250. build_config_details(
  3251. {
  3252. 'web': {'image': 'busybox', 'extends': {'file': 'common.yml'}},
  3253. },
  3254. 'tests/fixtures/extends',
  3255. 'filename.yml'
  3256. )
  3257. )
  3258. assert "'service' is a required property" in excinfo.exconly()
  3259. def test_extends_validation_invalid_key(self):
  3260. with pytest.raises(ConfigurationError) as excinfo:
  3261. config.load(
  3262. build_config_details(
  3263. {
  3264. 'web': {
  3265. 'image': 'busybox',
  3266. 'extends': {
  3267. 'file': 'common.yml',
  3268. 'service': 'web',
  3269. 'rogue_key': 'is not allowed'
  3270. }
  3271. },
  3272. },
  3273. 'tests/fixtures/extends',
  3274. 'filename.yml'
  3275. )
  3276. )
  3277. assert "web.extends contains unsupported option: 'rogue_key'" \
  3278. in excinfo.exconly()
  3279. def test_extends_validation_sub_property_key(self):
  3280. with pytest.raises(ConfigurationError) as excinfo:
  3281. config.load(
  3282. build_config_details(
  3283. {
  3284. 'web': {
  3285. 'image': 'busybox',
  3286. 'extends': {
  3287. 'file': 1,
  3288. 'service': 'web',
  3289. }
  3290. },
  3291. },
  3292. 'tests/fixtures/extends',
  3293. 'filename.yml'
  3294. )
  3295. )
  3296. assert "web.extends.file contains 1, which is an invalid type, it should be a string" \
  3297. in excinfo.exconly()
  3298. def test_extends_validation_no_file_key_no_filename_set(self):
  3299. dictionary = {'extends': {'service': 'web'}}
  3300. with pytest.raises(ConfigurationError) as excinfo:
  3301. make_service_dict('myweb', dictionary, working_dir='tests/fixtures/extends')
  3302. assert 'file' in excinfo.exconly()
  3303. def test_extends_validation_valid_config(self):
  3304. service = config.load(
  3305. build_config_details(
  3306. {
  3307. 'web': {'image': 'busybox', 'extends': {'service': 'web', 'file': 'common.yml'}},
  3308. },
  3309. 'tests/fixtures/extends',
  3310. 'common.yml'
  3311. )
  3312. ).services
  3313. self.assertEqual(len(service), 1)
  3314. self.assertIsInstance(service[0], dict)
  3315. self.assertEqual(service[0]['command'], "/bin/true")
  3316. def test_extended_service_with_invalid_config(self):
  3317. with pytest.raises(ConfigurationError) as exc:
  3318. load_from_filename('tests/fixtures/extends/service-with-invalid-schema.yml')
  3319. assert (
  3320. "myweb has neither an image nor a build context specified" in
  3321. exc.exconly()
  3322. )
  3323. def test_extended_service_with_valid_config(self):
  3324. service = load_from_filename('tests/fixtures/extends/service-with-valid-composite-extends.yml')
  3325. self.assertEqual(service[0]['command'], "top")
  3326. def test_extends_file_defaults_to_self(self):
  3327. """
  3328. Test not specifying a file in our extends options that the
  3329. config is valid and correctly extends from itself.
  3330. """
  3331. service_dicts = load_from_filename('tests/fixtures/extends/no-file-specified.yml')
  3332. self.assertEqual(service_sort(service_dicts), service_sort([
  3333. {
  3334. 'name': 'myweb',
  3335. 'image': 'busybox',
  3336. 'environment': {
  3337. "BAR": "1",
  3338. "BAZ": "3",
  3339. }
  3340. },
  3341. {
  3342. 'name': 'web',
  3343. 'image': 'busybox',
  3344. 'environment': {
  3345. "BAZ": "3",
  3346. }
  3347. }
  3348. ]))
  3349. def test_invalid_links_in_extended_service(self):
  3350. with pytest.raises(ConfigurationError) as excinfo:
  3351. load_from_filename('tests/fixtures/extends/invalid-links.yml')
  3352. assert "services with 'links' cannot be extended" in excinfo.exconly()
  3353. def test_invalid_volumes_from_in_extended_service(self):
  3354. with pytest.raises(ConfigurationError) as excinfo:
  3355. load_from_filename('tests/fixtures/extends/invalid-volumes.yml')
  3356. assert "services with 'volumes_from' cannot be extended" in excinfo.exconly()
  3357. def test_invalid_net_in_extended_service(self):
  3358. with pytest.raises(ConfigurationError) as excinfo:
  3359. load_from_filename('tests/fixtures/extends/invalid-net-v2.yml')
  3360. assert 'network_mode: service' in excinfo.exconly()
  3361. assert 'cannot be extended' in excinfo.exconly()
  3362. with pytest.raises(ConfigurationError) as excinfo:
  3363. load_from_filename('tests/fixtures/extends/invalid-net.yml')
  3364. assert 'net: container' in excinfo.exconly()
  3365. assert 'cannot be extended' in excinfo.exconly()
  3366. @mock.patch.dict(os.environ)
  3367. def test_load_config_runs_interpolation_in_extended_service(self):
  3368. os.environ.update(HOSTNAME_VALUE="penguin")
  3369. expected_interpolated_value = "host-penguin"
  3370. service_dicts = load_from_filename(
  3371. 'tests/fixtures/extends/valid-interpolation.yml')
  3372. for service in service_dicts:
  3373. assert service['hostname'] == expected_interpolated_value
  3374. @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
  3375. def test_volume_path(self):
  3376. dicts = load_from_filename('tests/fixtures/volume-path/docker-compose.yml')
  3377. paths = [
  3378. VolumeSpec(
  3379. os.path.abspath('tests/fixtures/volume-path/common/foo'),
  3380. '/foo',
  3381. 'rw'),
  3382. VolumeSpec(
  3383. os.path.abspath('tests/fixtures/volume-path/bar'),
  3384. '/bar',
  3385. 'rw')
  3386. ]
  3387. self.assertEqual(set(dicts[0]['volumes']), set(paths))
  3388. def test_parent_build_path_dne(self):
  3389. child = load_from_filename('tests/fixtures/extends/nonexistent-path-child.yml')
  3390. self.assertEqual(child, [
  3391. {
  3392. 'name': 'dnechild',
  3393. 'image': 'busybox',
  3394. 'command': '/bin/true',
  3395. 'environment': {
  3396. "FOO": "1",
  3397. "BAR": "2",
  3398. },
  3399. },
  3400. ])
  3401. def test_load_throws_error_when_base_service_does_not_exist(self):
  3402. with pytest.raises(ConfigurationError) as excinfo:
  3403. load_from_filename('tests/fixtures/extends/nonexistent-service.yml')
  3404. assert "Cannot extend service 'foo'" in excinfo.exconly()
  3405. assert "Service not found" in excinfo.exconly()
  3406. def test_partial_service_config_in_extends_is_still_valid(self):
  3407. dicts = load_from_filename('tests/fixtures/extends/valid-common-config.yml')
  3408. self.assertEqual(dicts[0]['environment'], {'FOO': '1'})
  3409. def test_extended_service_with_verbose_and_shorthand_way(self):
  3410. services = load_from_filename('tests/fixtures/extends/verbose-and-shorthand.yml')
  3411. self.assertEqual(service_sort(services), service_sort([
  3412. {
  3413. 'name': 'base',
  3414. 'image': 'busybox',
  3415. 'environment': {'BAR': '1'},
  3416. },
  3417. {
  3418. 'name': 'verbose',
  3419. 'image': 'busybox',
  3420. 'environment': {'BAR': '1', 'FOO': '1'},
  3421. },
  3422. {
  3423. 'name': 'shorthand',
  3424. 'image': 'busybox',
  3425. 'environment': {'BAR': '1', 'FOO': '2'},
  3426. },
  3427. ]))
  3428. @mock.patch.dict(os.environ)
  3429. def test_extends_with_environment_and_env_files(self):
  3430. tmpdir = py.test.ensuretemp('test_extends_with_environment')
  3431. self.addCleanup(tmpdir.remove)
  3432. commondir = tmpdir.mkdir('common')
  3433. commondir.join('base.yml').write("""
  3434. app:
  3435. image: 'example/app'
  3436. env_file:
  3437. - 'envs'
  3438. environment:
  3439. - SECRET
  3440. - TEST_ONE=common
  3441. - TEST_TWO=common
  3442. """)
  3443. tmpdir.join('docker-compose.yml').write("""
  3444. ext:
  3445. extends:
  3446. file: common/base.yml
  3447. service: app
  3448. env_file:
  3449. - 'envs'
  3450. environment:
  3451. - THING
  3452. - TEST_ONE=top
  3453. """)
  3454. commondir.join('envs').write("""
  3455. COMMON_ENV_FILE
  3456. TEST_ONE=common-env-file
  3457. TEST_TWO=common-env-file
  3458. TEST_THREE=common-env-file
  3459. TEST_FOUR=common-env-file
  3460. """)
  3461. tmpdir.join('envs').write("""
  3462. TOP_ENV_FILE
  3463. TEST_ONE=top-env-file
  3464. TEST_TWO=top-env-file
  3465. TEST_THREE=top-env-file
  3466. """)
  3467. expected = [
  3468. {
  3469. 'name': 'ext',
  3470. 'image': 'example/app',
  3471. 'environment': {
  3472. 'SECRET': 'secret',
  3473. 'TOP_ENV_FILE': 'secret',
  3474. 'COMMON_ENV_FILE': 'secret',
  3475. 'THING': 'thing',
  3476. 'TEST_ONE': 'top',
  3477. 'TEST_TWO': 'common',
  3478. 'TEST_THREE': 'top-env-file',
  3479. 'TEST_FOUR': 'common-env-file',
  3480. },
  3481. },
  3482. ]
  3483. os.environ['SECRET'] = 'secret'
  3484. os.environ['THING'] = 'thing'
  3485. os.environ['COMMON_ENV_FILE'] = 'secret'
  3486. os.environ['TOP_ENV_FILE'] = 'secret'
  3487. config = load_from_filename(str(tmpdir.join('docker-compose.yml')))
  3488. assert config == expected
  3489. def test_extends_with_mixed_versions_is_error(self):
  3490. tmpdir = py.test.ensuretemp('test_extends_with_mixed_version')
  3491. self.addCleanup(tmpdir.remove)
  3492. tmpdir.join('docker-compose.yml').write("""
  3493. version: "2"
  3494. services:
  3495. web:
  3496. extends:
  3497. file: base.yml
  3498. service: base
  3499. image: busybox
  3500. """)
  3501. tmpdir.join('base.yml').write("""
  3502. base:
  3503. volumes: ['/foo']
  3504. ports: ['3000:3000']
  3505. """)
  3506. with pytest.raises(ConfigurationError) as exc:
  3507. load_from_filename(str(tmpdir.join('docker-compose.yml')))
  3508. assert 'Version mismatch' in exc.exconly()
  3509. def test_extends_with_defined_version_passes(self):
  3510. tmpdir = py.test.ensuretemp('test_extends_with_defined_version')
  3511. self.addCleanup(tmpdir.remove)
  3512. tmpdir.join('docker-compose.yml').write("""
  3513. version: "2"
  3514. services:
  3515. web:
  3516. extends:
  3517. file: base.yml
  3518. service: base
  3519. image: busybox
  3520. """)
  3521. tmpdir.join('base.yml').write("""
  3522. version: "2"
  3523. services:
  3524. base:
  3525. volumes: ['/foo']
  3526. ports: ['3000:3000']
  3527. command: top
  3528. """)
  3529. service = load_from_filename(str(tmpdir.join('docker-compose.yml')))
  3530. self.assertEqual(service[0]['command'], "top")
  3531. def test_extends_with_depends_on(self):
  3532. tmpdir = py.test.ensuretemp('test_extends_with_depends_on')
  3533. self.addCleanup(tmpdir.remove)
  3534. tmpdir.join('docker-compose.yml').write("""
  3535. version: "2"
  3536. services:
  3537. base:
  3538. image: example
  3539. web:
  3540. extends: base
  3541. image: busybox
  3542. depends_on: ['other']
  3543. other:
  3544. image: example
  3545. """)
  3546. services = load_from_filename(str(tmpdir.join('docker-compose.yml')))
  3547. assert service_sort(services)[2]['depends_on'] == {
  3548. 'other': {'condition': 'service_started'}
  3549. }
  3550. def test_extends_with_healthcheck(self):
  3551. service_dicts = load_from_filename('tests/fixtures/extends/healthcheck-2.yml')
  3552. assert service_sort(service_dicts) == [{
  3553. 'name': 'demo',
  3554. 'image': 'foobar:latest',
  3555. 'healthcheck': {
  3556. 'test': ['CMD', '/health.sh'],
  3557. 'interval': 10000000000,
  3558. 'timeout': 5000000000,
  3559. 'retries': 36,
  3560. }
  3561. }]
  3562. def test_extends_with_ports(self):
  3563. tmpdir = py.test.ensuretemp('test_extends_with_ports')
  3564. self.addCleanup(tmpdir.remove)
  3565. tmpdir.join('docker-compose.yml').write("""
  3566. version: '2'
  3567. services:
  3568. a:
  3569. image: nginx
  3570. ports:
  3571. - 80
  3572. b:
  3573. extends:
  3574. service: a
  3575. """)
  3576. services = load_from_filename(str(tmpdir.join('docker-compose.yml')))
  3577. assert len(services) == 2
  3578. for svc in services:
  3579. assert svc['ports'] == [types.ServicePort('80', None, None, None, None)]
  3580. @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
  3581. class ExpandPathTest(unittest.TestCase):
  3582. working_dir = '/home/user/somedir'
  3583. def test_expand_path_normal(self):
  3584. result = config.expand_path(self.working_dir, 'myfile')
  3585. self.assertEqual(result, self.working_dir + '/' + 'myfile')
  3586. def test_expand_path_absolute(self):
  3587. abs_path = '/home/user/otherdir/somefile'
  3588. result = config.expand_path(self.working_dir, abs_path)
  3589. self.assertEqual(result, abs_path)
  3590. def test_expand_path_with_tilde(self):
  3591. test_path = '~/otherdir/somefile'
  3592. with mock.patch.dict(os.environ):
  3593. os.environ['HOME'] = user_path = '/home/user/'
  3594. result = config.expand_path(self.working_dir, test_path)
  3595. self.assertEqual(result, user_path + 'otherdir/somefile')
  3596. class VolumePathTest(unittest.TestCase):
  3597. def test_split_path_mapping_with_windows_path(self):
  3598. host_path = "c:\\Users\\msamblanet\\Documents\\anvil\\connect\\config"
  3599. windows_volume_path = host_path + ":/opt/connect/config:ro"
  3600. expected_mapping = ("/opt/connect/config", (host_path, 'ro'))
  3601. mapping = config.split_path_mapping(windows_volume_path)
  3602. assert mapping == expected_mapping
  3603. def test_split_path_mapping_with_windows_path_in_container(self):
  3604. host_path = 'c:\\Users\\remilia\\data'
  3605. container_path = 'c:\\scarletdevil\\data'
  3606. expected_mapping = (container_path, (host_path, None))
  3607. mapping = config.split_path_mapping('{0}:{1}'.format(host_path, container_path))
  3608. assert mapping == expected_mapping
  3609. def test_split_path_mapping_with_root_mount(self):
  3610. host_path = '/'
  3611. container_path = '/var/hostroot'
  3612. expected_mapping = (container_path, (host_path, None))
  3613. mapping = config.split_path_mapping('{0}:{1}'.format(host_path, container_path))
  3614. assert mapping == expected_mapping
  3615. @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
  3616. class BuildPathTest(unittest.TestCase):
  3617. def setUp(self):
  3618. self.abs_context_path = os.path.join(os.getcwd(), 'tests/fixtures/build-ctx')
  3619. def test_nonexistent_path(self):
  3620. with self.assertRaises(ConfigurationError):
  3621. config.load(
  3622. build_config_details(
  3623. {
  3624. 'foo': {'build': 'nonexistent.path'},
  3625. },
  3626. 'working_dir',
  3627. 'filename.yml'
  3628. )
  3629. )
  3630. def test_relative_path(self):
  3631. relative_build_path = '../build-ctx/'
  3632. service_dict = make_service_dict(
  3633. 'relpath',
  3634. {'build': relative_build_path},
  3635. working_dir='tests/fixtures/build-path'
  3636. )
  3637. self.assertEqual(service_dict['build'], self.abs_context_path)
  3638. def test_absolute_path(self):
  3639. service_dict = make_service_dict(
  3640. 'abspath',
  3641. {'build': self.abs_context_path},
  3642. working_dir='tests/fixtures/build-path'
  3643. )
  3644. self.assertEqual(service_dict['build'], self.abs_context_path)
  3645. def test_from_file(self):
  3646. service_dict = load_from_filename('tests/fixtures/build-path/docker-compose.yml')
  3647. self.assertEqual(service_dict, [{'name': 'foo', 'build': {'context': self.abs_context_path}}])
  3648. def test_from_file_override_dir(self):
  3649. override_dir = os.path.join(os.getcwd(), 'tests/fixtures/')
  3650. service_dict = load_from_filename(
  3651. 'tests/fixtures/build-path-override-dir/docker-compose.yml', override_dir=override_dir)
  3652. self.assertEquals(service_dict, [{'name': 'foo', 'build': {'context': self.abs_context_path}}])
  3653. def test_valid_url_in_build_path(self):
  3654. valid_urls = [
  3655. 'git://github.com/docker/docker',
  3656. '[email protected]:docker/docker.git',
  3657. '[email protected]:atlassianlabs/atlassian-docker.git',
  3658. 'https://github.com/docker/docker.git',
  3659. 'http://github.com/docker/docker.git',
  3660. 'github.com/docker/docker.git',
  3661. ]
  3662. for valid_url in valid_urls:
  3663. service_dict = config.load(build_config_details({
  3664. 'validurl': {'build': valid_url},
  3665. }, '.', None)).services
  3666. assert service_dict[0]['build'] == {'context': valid_url}
  3667. def test_invalid_url_in_build_path(self):
  3668. invalid_urls = [
  3669. 'example.com/bogus',
  3670. 'ftp://example.com/',
  3671. '/path/does/not/exist',
  3672. ]
  3673. for invalid_url in invalid_urls:
  3674. with pytest.raises(ConfigurationError) as exc:
  3675. config.load(build_config_details({
  3676. 'invalidurl': {'build': invalid_url},
  3677. }, '.', None))
  3678. assert 'build path' in exc.exconly()
  3679. class HealthcheckTest(unittest.TestCase):
  3680. def test_healthcheck(self):
  3681. service_dict = make_service_dict(
  3682. 'test',
  3683. {'healthcheck': {
  3684. 'test': ['CMD', 'true'],
  3685. 'interval': '1s',
  3686. 'timeout': '1m',
  3687. 'retries': 3,
  3688. 'start_period': '10s'
  3689. }},
  3690. '.',
  3691. )
  3692. assert service_dict['healthcheck'] == {
  3693. 'test': ['CMD', 'true'],
  3694. 'interval': nanoseconds_from_time_seconds(1),
  3695. 'timeout': nanoseconds_from_time_seconds(60),
  3696. 'retries': 3,
  3697. 'start_period': nanoseconds_from_time_seconds(10)
  3698. }
  3699. def test_disable(self):
  3700. service_dict = make_service_dict(
  3701. 'test',
  3702. {'healthcheck': {
  3703. 'disable': True,
  3704. }},
  3705. '.',
  3706. )
  3707. assert service_dict['healthcheck'] == {
  3708. 'test': ['NONE'],
  3709. }
  3710. def test_disable_with_other_config_is_invalid(self):
  3711. with pytest.raises(ConfigurationError) as excinfo:
  3712. make_service_dict(
  3713. 'invalid-healthcheck',
  3714. {'healthcheck': {
  3715. 'disable': True,
  3716. 'interval': '1s',
  3717. }},
  3718. '.',
  3719. )
  3720. assert 'invalid-healthcheck' in excinfo.exconly()
  3721. assert 'disable' in excinfo.exconly()
  3722. class GetDefaultConfigFilesTestCase(unittest.TestCase):
  3723. files = [
  3724. 'docker-compose.yml',
  3725. 'docker-compose.yaml',
  3726. ]
  3727. def test_get_config_path_default_file_in_basedir(self):
  3728. for index, filename in enumerate(self.files):
  3729. self.assertEqual(
  3730. filename,
  3731. get_config_filename_for_files(self.files[index:]))
  3732. with self.assertRaises(config.ComposeFileNotFound):
  3733. get_config_filename_for_files([])
  3734. def test_get_config_path_default_file_in_parent_dir(self):
  3735. """Test with files placed in the subdir"""
  3736. def get_config_in_subdir(files):
  3737. return get_config_filename_for_files(files, subdir=True)
  3738. for index, filename in enumerate(self.files):
  3739. self.assertEqual(filename, get_config_in_subdir(self.files[index:]))
  3740. with self.assertRaises(config.ComposeFileNotFound):
  3741. get_config_in_subdir([])
  3742. def get_config_filename_for_files(filenames, subdir=None):
  3743. def make_files(dirname, filenames):
  3744. for fname in filenames:
  3745. with open(os.path.join(dirname, fname), 'w') as f:
  3746. f.write('')
  3747. project_dir = tempfile.mkdtemp()
  3748. try:
  3749. make_files(project_dir, filenames)
  3750. if subdir:
  3751. base_dir = tempfile.mkdtemp(dir=project_dir)
  3752. else:
  3753. base_dir = project_dir
  3754. filename, = config.get_default_config_files(base_dir)
  3755. return os.path.basename(filename)
  3756. finally:
  3757. shutil.rmtree(project_dir)
  3758. class SerializeTest(unittest.TestCase):
  3759. def test_denormalize_depends_on_v3(self):
  3760. service_dict = {
  3761. 'image': 'busybox',
  3762. 'command': 'true',
  3763. 'depends_on': {
  3764. 'service2': {'condition': 'service_started'},
  3765. 'service3': {'condition': 'service_started'},
  3766. }
  3767. }
  3768. assert denormalize_service_dict(service_dict, V3_0) == {
  3769. 'image': 'busybox',
  3770. 'command': 'true',
  3771. 'depends_on': ['service2', 'service3']
  3772. }
  3773. def test_denormalize_depends_on_v2_1(self):
  3774. service_dict = {
  3775. 'image': 'busybox',
  3776. 'command': 'true',
  3777. 'depends_on': {
  3778. 'service2': {'condition': 'service_started'},
  3779. 'service3': {'condition': 'service_started'},
  3780. }
  3781. }
  3782. assert denormalize_service_dict(service_dict, V2_1) == service_dict
  3783. def test_serialize_time(self):
  3784. data = {
  3785. 9: '9ns',
  3786. 9000: '9us',
  3787. 9000000: '9ms',
  3788. 90000000: '90ms',
  3789. 900000000: '900ms',
  3790. 999999999: '999999999ns',
  3791. 1000000000: '1s',
  3792. 60000000000: '1m',
  3793. 60000000001: '60000000001ns',
  3794. 9000000000000: '150m',
  3795. 90000000000000: '25h',
  3796. }
  3797. for k, v in data.items():
  3798. assert serialize_ns_time_value(k) == v
  3799. def test_denormalize_healthcheck(self):
  3800. service_dict = {
  3801. 'image': 'test',
  3802. 'healthcheck': {
  3803. 'test': 'exit 1',
  3804. 'interval': '1m40s',
  3805. 'timeout': '30s',
  3806. 'retries': 5,
  3807. 'start_period': '2s90ms'
  3808. }
  3809. }
  3810. processed_service = config.process_service(config.ServiceConfig(
  3811. '.', 'test', 'test', service_dict
  3812. ))
  3813. denormalized_service = denormalize_service_dict(processed_service, V2_3)
  3814. assert denormalized_service['healthcheck']['interval'] == '100s'
  3815. assert denormalized_service['healthcheck']['timeout'] == '30s'
  3816. assert denormalized_service['healthcheck']['start_period'] == '2090ms'
  3817. def test_denormalize_image_has_digest(self):
  3818. service_dict = {
  3819. 'image': 'busybox'
  3820. }
  3821. image_digest = 'busybox@sha256:abcde'
  3822. assert denormalize_service_dict(service_dict, V3_0, image_digest) == {
  3823. 'image': 'busybox@sha256:abcde'
  3824. }
  3825. def test_denormalize_image_no_digest(self):
  3826. service_dict = {
  3827. 'image': 'busybox'
  3828. }
  3829. assert denormalize_service_dict(service_dict, V3_0) == {
  3830. 'image': 'busybox'
  3831. }
  3832. def test_serialize_secrets(self):
  3833. service_dict = {
  3834. 'image': 'example/web',
  3835. 'secrets': [
  3836. {'source': 'one'},
  3837. {
  3838. 'source': 'source',
  3839. 'target': 'target',
  3840. 'uid': '100',
  3841. 'gid': '200',
  3842. 'mode': 0o777,
  3843. }
  3844. ]
  3845. }
  3846. secrets_dict = {
  3847. 'one': {'file': '/one.txt'},
  3848. 'source': {'file': '/source.pem'},
  3849. 'two': {'external': True},
  3850. }
  3851. config_dict = config.load(build_config_details({
  3852. 'version': '3.1',
  3853. 'services': {'web': service_dict},
  3854. 'secrets': secrets_dict
  3855. }))
  3856. serialized_config = yaml.load(serialize_config(config_dict))
  3857. serialized_service = serialized_config['services']['web']
  3858. assert secret_sort(serialized_service['secrets']) == secret_sort(service_dict['secrets'])
  3859. assert 'secrets' in serialized_config
  3860. assert serialized_config['secrets']['two'] == secrets_dict['two']
  3861. def test_serialize_ports(self):
  3862. config_dict = config.Config(version=V2_0, services=[
  3863. {
  3864. 'ports': [types.ServicePort('80', '8080', None, None, None)],
  3865. 'image': 'alpine',
  3866. 'name': 'web'
  3867. }
  3868. ], volumes={}, networks={}, secrets={}, configs={})
  3869. serialized_config = yaml.load(serialize_config(config_dict))
  3870. assert '8080:80/tcp' in serialized_config['services']['web']['ports']
  3871. def test_serialize_configs(self):
  3872. service_dict = {
  3873. 'image': 'example/web',
  3874. 'configs': [
  3875. {'source': 'one'},
  3876. {
  3877. 'source': 'source',
  3878. 'target': 'target',
  3879. 'uid': '100',
  3880. 'gid': '200',
  3881. 'mode': 0o777,
  3882. }
  3883. ]
  3884. }
  3885. configs_dict = {
  3886. 'one': {'file': '/one.txt'},
  3887. 'source': {'file': '/source.pem'},
  3888. 'two': {'external': True},
  3889. }
  3890. config_dict = config.load(build_config_details({
  3891. 'version': '3.3',
  3892. 'services': {'web': service_dict},
  3893. 'configs': configs_dict
  3894. }))
  3895. serialized_config = yaml.load(serialize_config(config_dict))
  3896. serialized_service = serialized_config['services']['web']
  3897. assert secret_sort(serialized_service['configs']) == secret_sort(service_dict['configs'])
  3898. assert 'configs' in serialized_config
  3899. assert serialized_config['configs']['two'] == configs_dict['two']
  3900. def test_serialize_bool_string(self):
  3901. cfg = {
  3902. 'version': '2.2',
  3903. 'services': {
  3904. 'web': {
  3905. 'image': 'example/web',
  3906. 'command': 'true',
  3907. 'environment': {'FOO': 'Y', 'BAR': 'on'}
  3908. }
  3909. }
  3910. }
  3911. config_dict = config.load(build_config_details(cfg))
  3912. serialized_config = serialize_config(config_dict)
  3913. assert 'command: "true"\n' in serialized_config
  3914. assert 'FOO: "Y"\n' in serialized_config
  3915. assert 'BAR: "on"\n' in serialized_config
  3916. def test_serialize_escape_dollar_sign(self):
  3917. cfg = {
  3918. 'version': '2.2',
  3919. 'services': {
  3920. 'web': {
  3921. 'image': 'busybox',
  3922. 'command': 'echo $$FOO',
  3923. 'environment': {
  3924. 'CURRENCY': '$$'
  3925. },
  3926. 'entrypoint': ['$$SHELL', '-c'],
  3927. }
  3928. }
  3929. }
  3930. config_dict = config.load(build_config_details(cfg))
  3931. serialized_config = yaml.load(serialize_config(config_dict))
  3932. serialized_service = serialized_config['services']['web']
  3933. assert serialized_service['environment']['CURRENCY'] == '$$'
  3934. assert serialized_service['command'] == 'echo $$FOO'
  3935. assert serialized_service['entrypoint'][0] == '$$SHELL'