config_test.py 139 KB

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