config_test.py 144 KB

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