123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902 |
- # encoding: utf-8
- from __future__ import absolute_import
- from __future__ import print_function
- from __future__ import unicode_literals
- import os
- import shutil
- import tempfile
- from operator import itemgetter
- import py
- import pytest
- import yaml
- from ...helpers import build_config_details
- from compose.config import config
- from compose.config import types
- from compose.config.config import resolve_build_args
- from compose.config.config import resolve_environment
- from compose.config.environment import Environment
- from compose.config.errors import ConfigurationError
- from compose.config.errors import VERSION_EXPLANATION
- from compose.config.serialize import denormalize_service_dict
- from compose.config.serialize import serialize_config
- from compose.config.serialize import serialize_ns_time_value
- from compose.config.types import VolumeSpec
- from compose.const import COMPOSEFILE_V1 as V1
- from compose.const import COMPOSEFILE_V2_0 as V2_0
- from compose.const import COMPOSEFILE_V2_1 as V2_1
- from compose.const import COMPOSEFILE_V2_2 as V2_2
- from compose.const import COMPOSEFILE_V2_3 as V2_3
- from compose.const import COMPOSEFILE_V3_0 as V3_0
- from compose.const import COMPOSEFILE_V3_1 as V3_1
- from compose.const import COMPOSEFILE_V3_2 as V3_2
- from compose.const import COMPOSEFILE_V3_3 as V3_3
- from compose.const import COMPOSEFILE_V3_5 as V3_5
- from compose.const import IS_WINDOWS_PLATFORM
- from tests import mock
- from tests import unittest
- DEFAULT_VERSION = V2_0
- def make_service_dict(name, service_dict, working_dir, filename=None):
- """Test helper function to construct a ServiceExtendsResolver
- """
- resolver = config.ServiceExtendsResolver(
- config.ServiceConfig(
- working_dir=working_dir,
- filename=filename,
- name=name,
- config=service_dict),
- config.ConfigFile(filename=filename, config={}),
- environment=Environment.from_env_file(working_dir)
- )
- return config.process_service(resolver.run())
- def service_sort(services):
- return sorted(services, key=itemgetter('name'))
- def secret_sort(secrets):
- return sorted(secrets, key=itemgetter('source'))
- class ConfigTest(unittest.TestCase):
- def test_load(self):
- service_dicts = config.load(
- build_config_details(
- {
- 'foo': {'image': 'busybox'},
- 'bar': {'image': 'busybox', 'environment': ['FOO=1']},
- },
- 'tests/fixtures/extends',
- 'common.yml'
- )
- ).services
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'bar',
- 'image': 'busybox',
- 'environment': {'FOO': '1'},
- },
- {
- 'name': 'foo',
- 'image': 'busybox',
- }
- ])
- def test_load_v2(self):
- config_data = config.load(
- build_config_details({
- 'version': '2',
- 'services': {
- 'foo': {'image': 'busybox'},
- 'bar': {'image': 'busybox', 'environment': ['FOO=1']},
- },
- 'volumes': {
- 'hello': {
- 'driver': 'default',
- 'driver_opts': {'beep': 'boop'}
- }
- },
- 'networks': {
- 'default': {
- 'driver': 'bridge',
- 'driver_opts': {'beep': 'boop'}
- },
- 'with_ipam': {
- 'ipam': {
- 'driver': 'default',
- 'config': [
- {'subnet': '172.28.0.0/16'}
- ]
- }
- },
- 'internal': {
- 'driver': 'bridge',
- 'internal': True
- }
- }
- }, 'working_dir', 'filename.yml')
- )
- service_dicts = config_data.services
- volume_dict = config_data.volumes
- networks_dict = config_data.networks
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'bar',
- 'image': 'busybox',
- 'environment': {'FOO': '1'},
- },
- {
- 'name': 'foo',
- 'image': 'busybox',
- }
- ])
- assert volume_dict == {
- 'hello': {
- 'driver': 'default',
- 'driver_opts': {'beep': 'boop'}
- }
- }
- assert networks_dict == {
- 'default': {
- 'driver': 'bridge',
- 'driver_opts': {'beep': 'boop'}
- },
- 'with_ipam': {
- 'ipam': {
- 'driver': 'default',
- 'config': [
- {'subnet': '172.28.0.0/16'}
- ]
- }
- },
- 'internal': {
- 'driver': 'bridge',
- 'internal': True
- }
- }
- def test_valid_versions(self):
- for version in ['2', '2.0']:
- cfg = config.load(build_config_details({'version': version}))
- assert cfg.version == V2_0
- cfg = config.load(build_config_details({'version': '2.1'}))
- assert cfg.version == V2_1
- cfg = config.load(build_config_details({'version': '2.2'}))
- assert cfg.version == V2_2
- cfg = config.load(build_config_details({'version': '2.3'}))
- assert cfg.version == V2_3
- for version in ['3', '3.0']:
- cfg = config.load(build_config_details({'version': version}))
- assert cfg.version == V3_0
- cfg = config.load(build_config_details({'version': '3.1'}))
- assert cfg.version == V3_1
- def test_v1_file_version(self):
- cfg = config.load(build_config_details({'web': {'image': 'busybox'}}))
- assert cfg.version == V1
- assert list(s['name'] for s in cfg.services) == ['web']
- cfg = config.load(build_config_details({'version': {'image': 'busybox'}}))
- assert cfg.version == V1
- assert list(s['name'] for s in cfg.services) == ['version']
- def test_wrong_version_type(self):
- for version in [None, 1, 2, 2.0]:
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {'version': version},
- filename='filename.yml',
- )
- )
- assert 'Version in "filename.yml" is invalid - it should be a string.' \
- in excinfo.exconly()
- def test_unsupported_version(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {'version': '2.18'},
- filename='filename.yml',
- )
- )
- assert 'Version in "filename.yml" is unsupported' in excinfo.exconly()
- assert VERSION_EXPLANATION in excinfo.exconly()
- def test_version_1_is_invalid(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'version': '1',
- 'web': {'image': 'busybox'},
- },
- filename='filename.yml',
- )
- )
- assert 'Version in "filename.yml" is invalid' in excinfo.exconly()
- assert VERSION_EXPLANATION in excinfo.exconly()
- def test_v1_file_with_version_is_invalid(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'version': '2',
- 'web': {'image': 'busybox'},
- },
- filename='filename.yml',
- )
- )
- assert 'Invalid top-level property "web"' in excinfo.exconly()
- assert VERSION_EXPLANATION in excinfo.exconly()
- def test_named_volume_config_empty(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'simple': {'image': 'busybox'}
- },
- 'volumes': {
- 'simple': None,
- 'other': {},
- }
- })
- config_result = config.load(config_details)
- volumes = config_result.volumes
- assert 'simple' in volumes
- assert volumes['simple'] == {}
- assert volumes['other'] == {}
- def test_named_volume_numeric_driver_opt(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'simple': {'image': 'busybox'}
- },
- 'volumes': {
- 'simple': {'driver_opts': {'size': 42}},
- }
- })
- cfg = config.load(config_details)
- assert cfg.volumes['simple']['driver_opts']['size'] == '42'
- def test_volume_invalid_driver_opt(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'simple': {'image': 'busybox'}
- },
- 'volumes': {
- 'simple': {'driver_opts': {'size': True}},
- }
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert 'driver_opts.size contains an invalid type' in exc.exconly()
- def test_named_volume_invalid_type_list(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'simple': {'image': 'busybox'}
- },
- 'volumes': []
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "volume must be a mapping, not an array" in exc.exconly()
- def test_networks_invalid_type_list(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'simple': {'image': 'busybox'}
- },
- 'networks': []
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "network must be a mapping, not an array" in exc.exconly()
- def test_load_service_with_name_version(self):
- with mock.patch('compose.config.config.log') as mock_logging:
- config_data = config.load(
- build_config_details({
- 'version': {
- 'image': 'busybox'
- }
- }, 'working_dir', 'filename.yml')
- )
- assert 'Unexpected type for "version" key in "filename.yml"' \
- in mock_logging.warn.call_args[0][0]
- service_dicts = config_data.services
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'version',
- 'image': 'busybox',
- }
- ])
- def test_load_throws_error_when_not_dict(self):
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details(
- {'web': 'busybox:latest'},
- 'working_dir',
- 'filename.yml'
- )
- )
- def test_load_throws_error_when_not_dict_v2(self):
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details(
- {'version': '2', 'services': {'web': 'busybox:latest'}},
- 'working_dir',
- 'filename.yml'
- )
- )
- def test_load_throws_error_with_invalid_network_fields(self):
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details({
- 'version': '2',
- 'services': {'web': 'busybox:latest'},
- 'networks': {
- 'invalid': {'foo', 'bar'}
- }
- }, 'working_dir', 'filename.yml')
- )
- def test_load_config_link_local_ips_network(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': str(V2_1),
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'networks': {
- 'foobar': {
- 'aliases': ['foo', 'bar'],
- 'link_local_ips': ['169.254.8.8']
- }
- }
- }
- },
- 'networks': {'foobar': {}}
- }
- )
- details = config.ConfigDetails('.', [base_file])
- web_service = config.load(details).services[0]
- assert web_service['networks'] == {
- 'foobar': {
- 'aliases': ['foo', 'bar'],
- 'link_local_ips': ['169.254.8.8']
- }
- }
- def test_load_config_service_labels(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2.1',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'labels': ['label_key=label_val']
- },
- 'db': {
- 'image': 'example/db',
- 'labels': {
- 'label_key': 'label_val'
- }
- }
- },
- }
- )
- details = config.ConfigDetails('.', [base_file])
- service_dicts = config.load(details).services
- for service in service_dicts:
- assert service['labels'] == {
- 'label_key': 'label_val'
- }
- def test_load_config_custom_resource_names(self):
- base_file = config.ConfigFile(
- 'base.yaml', {
- 'version': '3.5',
- 'volumes': {
- 'abc': {
- 'name': 'xyz'
- }
- },
- 'networks': {
- 'abc': {
- 'name': 'xyz'
- }
- },
- 'secrets': {
- 'abc': {
- 'name': 'xyz'
- }
- },
- 'configs': {
- 'abc': {
- 'name': 'xyz'
- }
- }
- }
- )
- details = config.ConfigDetails('.', [base_file])
- loaded_config = config.load(details)
- assert loaded_config.networks['abc'] == {'name': 'xyz'}
- assert loaded_config.volumes['abc'] == {'name': 'xyz'}
- assert loaded_config.secrets['abc']['name'] == 'xyz'
- assert loaded_config.configs['abc']['name'] == 'xyz'
- def test_load_config_volume_and_network_labels(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2.1',
- 'services': {
- 'web': {
- 'image': 'example/web',
- },
- },
- 'networks': {
- 'with_label': {
- 'labels': {
- 'label_key': 'label_val'
- }
- }
- },
- 'volumes': {
- 'with_label': {
- 'labels': {
- 'label_key': 'label_val'
- }
- }
- }
- }
- )
- details = config.ConfigDetails('.', [base_file])
- loaded_config = config.load(details)
- assert loaded_config.networks == {
- 'with_label': {
- 'labels': {
- 'label_key': 'label_val'
- }
- }
- }
- assert loaded_config.volumes == {
- 'with_label': {
- 'labels': {
- 'label_key': 'label_val'
- }
- }
- }
- def test_load_config_invalid_service_names(self):
- for invalid_name in ['?not?allowed', ' ', '', '!', '/', '\xe2']:
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {invalid_name: {'image': 'busybox'}}))
- assert 'Invalid service name \'%s\'' % invalid_name in exc.exconly()
- def test_load_config_invalid_service_names_v2(self):
- for invalid_name in ['?not?allowed', ' ', '', '!', '/', '\xe2']:
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'version': '2',
- 'services': {invalid_name: {'image': 'busybox'}},
- }))
- assert 'Invalid service name \'%s\'' % invalid_name in exc.exconly()
- def test_load_with_invalid_field_name(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {'image': 'busybox', 'name': 'bogus'},
- }
- },
- 'working_dir',
- 'filename.yml',
- ))
- assert "Unsupported config option for services.web: 'name'" in exc.exconly()
- def test_load_with_invalid_field_name_v1(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'web': {'image': 'busybox', 'name': 'bogus'},
- },
- 'working_dir',
- 'filename.yml',
- ))
- assert "Unsupported config option for web: 'name'" in exc.exconly()
- def test_load_invalid_service_definition(self):
- config_details = build_config_details(
- {'web': 'wrong'},
- 'working_dir',
- 'filename.yml')
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "service 'web' must be a mapping not a string." in exc.exconly()
- def test_load_with_empty_build_args(self):
- config_details = build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': {
- 'context': os.getcwd(),
- 'args': None,
- },
- },
- },
- }
- )
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert (
- "services.web.build.args contains an invalid type, it should be an "
- "object, or an array" in exc.exconly()
- )
- def test_config_integer_service_name_raise_validation_error(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {1: {'image': 'busybox'}},
- 'working_dir',
- 'filename.yml'
- )
- )
- assert (
- "In file 'filename.yml', the service name 1 must be a quoted string, i.e. '1'" in
- excinfo.exconly()
- )
- def test_config_integer_service_name_raise_validation_error_v2(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {1: {'image': 'busybox'}}
- },
- 'working_dir',
- 'filename.yml'
- )
- )
- assert (
- "In file 'filename.yml', the service name 1 must be a quoted string, i.e. '1'." in
- excinfo.exconly()
- )
- def test_config_invalid_service_name_raise_validation_error(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details({
- 'version': '2',
- 'services': {
- 'test_app': {'build': '.'},
- 'mong\\o': {'image': 'mongo'},
- }
- })
- )
- assert 'Invalid service name \'mong\\o\'' in excinfo.exconly()
- def test_config_duplicate_cache_from_values_validation_error(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'test': {'build': {'context': '.', 'cache_from': ['a', 'b', 'a']}}
- }
- })
- )
- assert 'build.cache_from contains non-unique items' in exc.exconly()
- def test_load_with_multiple_files_v1(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'web': {
- 'image': 'example/web',
- 'links': ['db'],
- },
- 'db': {
- 'image': 'example/db',
- },
- })
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'web': {
- 'build': '/',
- 'volumes': ['/home/user/project:/code'],
- },
- })
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'build': {'context': os.path.abspath('/')},
- 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
- 'links': ['db'],
- },
- {
- 'name': 'db',
- 'image': 'example/db',
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_load_with_multiple_files_and_empty_override(self):
- base_file = config.ConfigFile(
- 'base.yml',
- {'web': {'image': 'example/web'}})
- override_file = config.ConfigFile('override.yml', None)
- details = config.ConfigDetails('.', [base_file, override_file])
- with pytest.raises(ConfigurationError) as exc:
- config.load(details)
- error_msg = "Top level object in 'override.yml' needs to be an object"
- assert error_msg in exc.exconly()
- def test_load_with_multiple_files_and_empty_override_v2(self):
- base_file = config.ConfigFile(
- 'base.yml',
- {'version': '2', 'services': {'web': {'image': 'example/web'}}})
- override_file = config.ConfigFile('override.yml', None)
- details = config.ConfigDetails('.', [base_file, override_file])
- with pytest.raises(ConfigurationError) as exc:
- config.load(details)
- error_msg = "Top level object in 'override.yml' needs to be an object"
- assert error_msg in exc.exconly()
- def test_load_with_multiple_files_and_empty_base(self):
- base_file = config.ConfigFile('base.yml', None)
- override_file = config.ConfigFile(
- 'override.yml',
- {'web': {'image': 'example/web'}})
- details = config.ConfigDetails('.', [base_file, override_file])
- with pytest.raises(ConfigurationError) as exc:
- config.load(details)
- assert "Top level object in 'base.yml' needs to be an object" in exc.exconly()
- def test_load_with_multiple_files_and_empty_base_v2(self):
- base_file = config.ConfigFile('base.yml', None)
- override_file = config.ConfigFile(
- 'override.tml',
- {'version': '2', 'services': {'web': {'image': 'example/web'}}}
- )
- details = config.ConfigDetails('.', [base_file, override_file])
- with pytest.raises(ConfigurationError) as exc:
- config.load(details)
- assert "Top level object in 'base.yml' needs to be an object" in exc.exconly()
- def test_load_with_multiple_files_and_extends_in_override_file(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'web': {'image': 'example/web'},
- })
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'web': {
- 'extends': {
- 'file': 'common.yml',
- 'service': 'base',
- },
- 'volumes': ['/home/user/project:/code'],
- },
- })
- details = config.ConfigDetails('.', [base_file, override_file])
- tmpdir = py.test.ensuretemp('config_test')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('common.yml').write("""
- base:
- labels: ['label=one']
- """)
- with tmpdir.as_cwd():
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'image': 'example/web',
- 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
- 'labels': {'label': 'one'},
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_load_mixed_extends_resolution(self):
- main_file = config.ConfigFile(
- 'main.yml', {
- 'version': '2.2',
- 'services': {
- 'prodweb': {
- 'extends': {
- 'service': 'web',
- 'file': 'base.yml'
- },
- 'environment': {'PROD': 'true'},
- },
- },
- }
- )
- tmpdir = pytest.ensuretemp('config_test')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('base.yml').write("""
- version: '2.2'
- services:
- base:
- image: base
- web:
- extends: base
- """)
- details = config.ConfigDetails('.', [main_file])
- with tmpdir.as_cwd():
- service_dicts = config.load(details).services
- assert service_dicts[0] == {
- 'name': 'prodweb',
- 'image': 'base',
- 'environment': {'PROD': 'true'},
- }
- def test_load_with_multiple_files_and_invalid_override(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {'web': {'image': 'example/web'}})
- override_file = config.ConfigFile(
- 'override.yaml',
- {'bogus': 'thing'})
- details = config.ConfigDetails('.', [base_file, override_file])
- with pytest.raises(ConfigurationError) as exc:
- config.load(details)
- assert "service 'bogus' must be a mapping not a string." in exc.exconly()
- assert "In file 'override.yaml'" in exc.exconly()
- def test_load_sorts_in_dependency_order(self):
- config_details = build_config_details({
- 'web': {
- 'image': 'busybox:latest',
- 'links': ['db'],
- },
- 'db': {
- 'image': 'busybox:latest',
- 'volumes_from': ['volume:ro']
- },
- 'volume': {
- 'image': 'busybox:latest',
- 'volumes': ['/tmp'],
- }
- })
- services = config.load(config_details).services
- assert services[0]['name'] == 'volume'
- assert services[1]['name'] == 'db'
- assert services[2]['name'] == 'web'
- def test_load_with_extensions(self):
- config_details = build_config_details({
- 'version': '2.3',
- 'x-data': {
- 'lambda': 3,
- 'excess': [True, {}]
- }
- })
- config_data = config.load(config_details)
- assert config_data.services == []
- def test_config_build_configuration(self):
- service = config.load(
- build_config_details(
- {'web': {
- 'build': '.',
- 'dockerfile': 'Dockerfile-alt'
- }},
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services
- assert 'context' in service[0]['build']
- assert service[0]['build']['dockerfile'] == 'Dockerfile-alt'
- def test_config_build_configuration_v2(self):
- # service.dockerfile is invalid in v2
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': '.',
- 'dockerfile': 'Dockerfile-alt'
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- service = config.load(
- build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'build': '.'
- }
- }
- }, 'tests/fixtures/extends', 'filename.yml')
- ).services[0]
- assert 'context' in service['build']
- service = config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'dockerfile': 'Dockerfile-alt'
- }
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services
- assert 'context' in service[0]['build']
- assert service[0]['build']['dockerfile'] == 'Dockerfile-alt'
- def test_load_with_buildargs(self):
- service = config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'dockerfile': 'Dockerfile-alt',
- 'args': {
- 'opt1': 42,
- 'opt2': 'foobar'
- }
- }
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services[0]
- assert 'args' in service['build']
- assert 'opt1' in service['build']['args']
- assert isinstance(service['build']['args']['opt1'], str)
- assert service['build']['args']['opt1'] == '42'
- assert service['build']['args']['opt2'] == 'foobar'
- def test_load_build_labels_dict(self):
- service = config.load(
- build_config_details(
- {
- 'version': str(V3_3),
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'dockerfile': 'Dockerfile-alt',
- 'labels': {
- 'label1': 42,
- 'label2': 'foobar'
- }
- }
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services[0]
- assert 'labels' in service['build']
- assert 'label1' in service['build']['labels']
- assert service['build']['labels']['label1'] == '42'
- assert service['build']['labels']['label2'] == 'foobar'
- def test_load_build_labels_list(self):
- base_file = config.ConfigFile(
- 'base.yml',
- {
- 'version': '2.3',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'labels': ['foo=bar', 'baz=true', 'foobar=1']
- },
- },
- },
- }
- )
- details = config.ConfigDetails('.', [base_file])
- service = config.load(details).services[0]
- assert service['build']['labels'] == {
- 'foo': 'bar', 'baz': 'true', 'foobar': '1'
- }
- def test_build_args_allow_empty_properties(self):
- service = config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'dockerfile': 'Dockerfile-alt',
- 'args': {
- 'foo': None
- }
- }
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services[0]
- assert 'args' in service['build']
- assert 'foo' in service['build']['args']
- assert service['build']['args']['foo'] == ''
- # If build argument is None then it will be converted to the empty
- # string. Make sure that int zero kept as it is, i.e. not converted to
- # the empty string
- def test_build_args_check_zero_preserved(self):
- service = config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'dockerfile': 'Dockerfile-alt',
- 'args': {
- 'foo': 0
- }
- }
- }
- }
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- ).services[0]
- assert 'args' in service['build']
- assert 'foo' in service['build']['args']
- assert service['build']['args']['foo'] == '0'
- def test_load_with_multiple_files_mismatched_networks_format(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'networks': {
- 'foobar': {'aliases': ['foo', 'bar']}
- }
- }
- },
- 'networks': {'foobar': {}, 'baz': {}}
- }
- )
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'networks': ['baz']
- }
- }
- }
- )
- details = config.ConfigDetails('.', [base_file, override_file])
- web_service = config.load(details).services[0]
- assert web_service['networks'] == {
- 'foobar': {'aliases': ['foo', 'bar']},
- 'baz': None
- }
- def test_load_with_multiple_files_v2(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'depends_on': ['db'],
- },
- 'db': {
- 'image': 'example/db',
- }
- },
- })
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'build': '/',
- 'volumes': ['/home/user/project:/code'],
- 'depends_on': ['other'],
- },
- 'other': {
- 'image': 'example/other',
- }
- }
- })
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'build': {'context': os.path.abspath('/')},
- 'image': 'example/web',
- 'volumes': [VolumeSpec.parse('/home/user/project:/code')],
- 'depends_on': {
- 'db': {'condition': 'service_started'},
- 'other': {'condition': 'service_started'},
- },
- },
- {
- 'name': 'db',
- 'image': 'example/db',
- },
- {
- 'name': 'other',
- 'image': 'example/other',
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- @mock.patch.dict(os.environ)
- def test_load_with_multiple_files_v3_2(self):
- os.environ['COMPOSE_CONVERT_WINDOWS_PATHS'] = 'true'
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.2',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'volumes': [
- {'source': '/a', 'target': '/b', 'type': 'bind'},
- {'source': 'vol', 'target': '/x', 'type': 'volume', 'read_only': True}
- ],
- 'stop_grace_period': '30s',
- }
- },
- 'volumes': {'vol': {}}
- }
- )
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'version': '3.2',
- 'services': {
- 'web': {
- 'volumes': ['/c:/b', '/anonymous']
- }
- }
- }
- )
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- svc_volumes = map(lambda v: v.repr(), service_dicts[0]['volumes'])
- for vol in svc_volumes:
- assert vol in [
- '/anonymous',
- '/c:/b:rw',
- {'source': 'vol', 'target': '/x', 'type': 'volume', 'read_only': True}
- ]
- assert service_dicts[0]['stop_grace_period'] == '30s'
- @mock.patch.dict(os.environ)
- def test_volume_mode_override(self):
- os.environ['COMPOSE_CONVERT_WINDOWS_PATHS'] = 'true'
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2.3',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'volumes': ['/c:/b:rw']
- }
- },
- }
- )
- override_file = config.ConfigFile(
- 'override.yaml',
- {
- 'version': '2.3',
- 'services': {
- 'web': {
- 'volumes': ['/c:/b:ro']
- }
- }
- }
- )
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- svc_volumes = list(map(lambda v: v.repr(), service_dicts[0]['volumes']))
- assert svc_volumes == ['/c:/b:ro']
- def test_undeclared_volume_v2(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox:latest',
- 'volumes': ['data0028:/data:ro'],
- },
- },
- }
- )
- details = config.ConfigDetails('.', [base_file])
- with pytest.raises(ConfigurationError):
- config.load(details)
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox:latest',
- 'volumes': ['./data0028:/data:ro'],
- },
- },
- }
- )
- details = config.ConfigDetails('.', [base_file])
- config_data = config.load(details)
- volume = config_data.services[0].get('volumes')[0]
- assert not volume.is_named_volume
- def test_undeclared_volume_v1(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'web': {
- 'image': 'busybox:latest',
- 'volumes': ['data0028:/data:ro'],
- },
- }
- )
- details = config.ConfigDetails('.', [base_file])
- config_data = config.load(details)
- volume = config_data.services[0].get('volumes')[0]
- assert volume.external == 'data0028'
- assert volume.is_named_volume
- def test_volumes_long_syntax(self):
- base_file = config.ConfigFile(
- 'base.yaml', {
- 'version': '2.3',
- 'services': {
- 'web': {
- 'image': 'busybox:latest',
- 'volumes': [
- {
- 'target': '/anonymous', 'type': 'volume'
- }, {
- 'source': '/abc', 'target': '/xyz', 'type': 'bind'
- }, {
- 'source': '\\\\.\\pipe\\abcd', 'target': '/named_pipe', 'type': 'npipe'
- }, {
- 'type': 'tmpfs', 'target': '/tmpfs'
- }
- ]
- },
- },
- },
- )
- details = config.ConfigDetails('.', [base_file])
- config_data = config.load(details)
- volumes = config_data.services[0].get('volumes')
- anon_volume = [v for v in volumes if v.target == '/anonymous'][0]
- tmpfs_mount = [v for v in volumes if v.type == 'tmpfs'][0]
- host_mount = [v for v in volumes if v.type == 'bind'][0]
- npipe_mount = [v for v in volumes if v.type == 'npipe'][0]
- assert anon_volume.type == 'volume'
- assert not anon_volume.is_named_volume
- assert tmpfs_mount.target == '/tmpfs'
- assert not tmpfs_mount.is_named_volume
- assert host_mount.source == os.path.normpath('/abc')
- assert host_mount.target == '/xyz'
- assert not host_mount.is_named_volume
- assert npipe_mount.source == '\\\\.\\pipe\\abcd'
- assert npipe_mount.target == '/named_pipe'
- assert not npipe_mount.is_named_volume
- def test_load_bind_mount_relative_path(self):
- expected_source = 'C:\\tmp\\web' if IS_WINDOWS_PLATFORM else '/tmp/web'
- base_file = config.ConfigFile(
- 'base.yaml', {
- 'version': '3.4',
- 'services': {
- 'web': {
- 'image': 'busybox:latest',
- 'volumes': [
- {'type': 'bind', 'source': './web', 'target': '/web'},
- ],
- },
- },
- },
- )
- details = config.ConfigDetails('/tmp', [base_file])
- config_data = config.load(details)
- mount = config_data.services[0].get('volumes')[0]
- assert mount.target == '/web'
- assert mount.type == 'bind'
- assert mount.source == expected_source
- def test_config_valid_service_names(self):
- for valid_name in ['_', '-', '.__.', '_what-up.', 'what_.up----', 'whatup']:
- services = config.load(
- build_config_details(
- {valid_name: {'image': 'busybox'}},
- 'tests/fixtures/extends',
- 'common.yml')).services
- assert services[0]['name'] == valid_name
- def test_config_hint(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'foo': {'image': 'busybox', 'privilige': 'something'},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "(did you mean 'privileged'?)" in excinfo.exconly()
- def test_load_errors_on_uppercase_with_no_image(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details({
- 'Foo': {'build': '.'},
- }, 'tests/fixtures/build-ctx'))
- assert "Service 'Foo' contains uppercase characters" in exc.exconly()
- def test_invalid_config_v1(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'foo': {'image': 1},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "foo.image contains an invalid type, it should be a string" \
- in excinfo.exconly()
- def test_invalid_config_v2(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'version': '2',
- 'services': {
- 'foo': {'image': 1},
- },
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "services.foo.image contains an invalid type, it should be a string" \
- in excinfo.exconly()
- def test_invalid_config_build_and_image_specified_v1(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'foo': {'image': 'busybox', 'build': '.'},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "foo has both an image and build path specified." in excinfo.exconly()
- def test_invalid_config_type_should_be_an_array(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'foo': {'image': 'busybox', 'links': 'an_link'},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "foo.links contains an invalid type, it should be an array" \
- in excinfo.exconly()
- def test_invalid_config_not_a_dictionary(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- ['foo', 'lol'],
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "Top level object in 'filename.yml' needs to be an object" \
- in excinfo.exconly()
- def test_invalid_config_not_unique_items(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {'build': '.', 'devices': ['/dev/foo:/dev/foo', '/dev/foo:/dev/foo']}
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "has non-unique elements" in excinfo.exconly()
- def test_invalid_list_of_strings_format(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {'build': '.', 'command': [1]}
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "web.command contains 1, which is an invalid type, it should be a string" \
- in excinfo.exconly()
- def test_load_config_dockerfile_without_build_raises_error_v1(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details({
- 'web': {
- 'image': 'busybox',
- 'dockerfile': 'Dockerfile.alt'
- }
- }))
- assert "web has both an image and alternate Dockerfile." in exc.exconly()
- def test_config_extra_hosts_string_raises_validation_error(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {'web': {
- 'image': 'busybox',
- 'extra_hosts': 'somehost:162.242.195.82'
- }},
- 'working_dir',
- 'filename.yml'
- )
- )
- assert "web.extra_hosts contains an invalid type" \
- in excinfo.exconly()
- def test_config_extra_hosts_list_of_dicts_validation_error(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {'web': {
- 'image': 'busybox',
- 'extra_hosts': [
- {'somehost': '162.242.195.82'},
- {'otherhost': '50.31.209.229'}
- ]
- }},
- 'working_dir',
- 'filename.yml'
- )
- )
- assert "web.extra_hosts contains {\"somehost\": \"162.242.195.82\"}, " \
- "which is an invalid type, it should be a string" \
- in excinfo.exconly()
- def test_config_ulimits_invalid_keys_validation_error(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'web': {
- 'image': 'busybox',
- 'ulimits': {
- 'nofile': {
- "not_soft_or_hard": 100,
- "soft": 10000,
- "hard": 20000,
- }
- }
- }
- },
- 'working_dir',
- 'filename.yml'))
- assert "web.ulimits.nofile contains unsupported option: 'not_soft_or_hard'" \
- in exc.exconly()
- def test_config_ulimits_required_keys_validation_error(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'web': {
- 'image': 'busybox',
- 'ulimits': {'nofile': {"soft": 10000}}
- }
- },
- 'working_dir',
- 'filename.yml'))
- assert "web.ulimits.nofile" in exc.exconly()
- assert "'hard' is a required property" in exc.exconly()
- def test_config_ulimits_soft_greater_than_hard_error(self):
- expected = "'soft' value can not be greater than 'hard' value"
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {
- 'web': {
- 'image': 'busybox',
- 'ulimits': {
- 'nofile': {"soft": 10000, "hard": 1000}
- }
- }
- },
- 'working_dir',
- 'filename.yml'))
- assert expected in exc.exconly()
- def test_valid_config_which_allows_two_type_definitions(self):
- expose_values = [["8000"], [8000]]
- for expose in expose_values:
- service = config.load(
- build_config_details(
- {'web': {
- 'image': 'busybox',
- 'expose': expose
- }},
- 'working_dir',
- 'filename.yml'
- )
- ).services
- assert service[0]['expose'] == expose
- def test_valid_config_oneof_string_or_list(self):
- entrypoint_values = [["sh"], "sh"]
- for entrypoint in entrypoint_values:
- service = config.load(
- build_config_details(
- {'web': {
- 'image': 'busybox',
- 'entrypoint': entrypoint
- }},
- 'working_dir',
- 'filename.yml'
- )
- ).services
- assert service[0]['entrypoint'] == entrypoint
- def test_logs_warning_for_boolean_in_environment(self):
- config_details = build_config_details({
- 'web': {
- 'image': 'busybox',
- 'environment': {'SHOW_STUFF': True}
- }
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "contains true, which is an invalid type" in exc.exconly()
- def test_config_valid_environment_dict_key_contains_dashes(self):
- services = config.load(
- build_config_details(
- {'web': {
- 'image': 'busybox',
- 'environment': {'SPRING_JPA_HIBERNATE_DDL-AUTO': 'none'}
- }},
- 'working_dir',
- 'filename.yml'
- )
- ).services
- assert services[0]['environment']['SPRING_JPA_HIBERNATE_DDL-AUTO'] == 'none'
- def test_load_yaml_with_yaml_error(self):
- tmpdir = py.test.ensuretemp('invalid_yaml_test')
- self.addCleanup(tmpdir.remove)
- invalid_yaml_file = tmpdir.join('docker-compose.yml')
- invalid_yaml_file.write("""
- web:
- this is bogus: ok: what
- """)
- with pytest.raises(ConfigurationError) as exc:
- config.load_yaml(str(invalid_yaml_file))
- assert 'line 3, column 32' in exc.exconly()
- def test_validate_extra_hosts_invalid(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details({
- 'web': {
- 'image': 'alpine',
- 'extra_hosts': "www.example.com: 192.168.0.17",
- }
- }))
- assert "web.extra_hosts contains an invalid type" in exc.exconly()
- def test_validate_extra_hosts_invalid_list(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details({
- 'web': {
- 'image': 'alpine',
- 'extra_hosts': [
- {'www.example.com': '192.168.0.17'},
- {'api.example.com': '192.168.0.18'}
- ],
- }
- }))
- assert "which is an invalid type" in exc.exconly()
- def test_normalize_dns_options(self):
- actual = config.load(build_config_details({
- 'web': {
- 'image': 'alpine',
- 'dns': '8.8.8.8',
- 'dns_search': 'domain.local',
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'dns': ['8.8.8.8'],
- 'dns_search': ['domain.local'],
- }
- ]
- def test_tmpfs_option(self):
- actual = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'alpine',
- 'tmpfs': '/run',
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'tmpfs': ['/run'],
- }
- ]
- def test_oom_score_adj_option(self):
- actual = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'alpine',
- 'oom_score_adj': 500
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'oom_score_adj': 500
- }
- ]
- def test_swappiness_option(self):
- actual = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'alpine',
- 'mem_swappiness': 10,
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'mem_swappiness': 10,
- }
- ]
- def test_group_add_option(self):
- actual = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'alpine',
- 'group_add': ["docker", 777]
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'group_add': ["docker", 777]
- }
- ]
- def test_dns_opt_option(self):
- actual = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'alpine',
- 'dns_opt': ["use-vc", "no-tld-query"]
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'alpine',
- 'dns_opt': ["use-vc", "no-tld-query"]
- }
- ]
- def test_isolation_option(self):
- actual = config.load(build_config_details({
- 'version': str(V2_1),
- 'services': {
- 'web': {
- 'image': 'win10',
- 'isolation': 'hyperv'
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'win10',
- 'isolation': 'hyperv',
- }
- ]
- def test_runtime_option(self):
- actual = config.load(build_config_details({
- 'version': str(V2_3),
- 'services': {
- 'web': {
- 'image': 'nvidia/cuda',
- 'runtime': 'nvidia'
- }
- }
- }))
- assert actual.services == [
- {
- 'name': 'web',
- 'image': 'nvidia/cuda',
- 'runtime': 'nvidia',
- }
- ]
- def test_merge_service_dicts_from_files_with_extends_in_base(self):
- base = {
- 'volumes': ['.:/app'],
- 'extends': {'service': 'app'}
- }
- override = {
- 'image': 'alpine:edge',
- }
- actual = config.merge_service_dicts_from_files(
- base,
- override,
- DEFAULT_VERSION)
- assert actual == {
- 'image': 'alpine:edge',
- 'volumes': ['.:/app'],
- 'extends': {'service': 'app'}
- }
- def test_merge_service_dicts_from_files_with_extends_in_override(self):
- base = {
- 'volumes': ['.:/app'],
- 'extends': {'service': 'app'}
- }
- override = {
- 'image': 'alpine:edge',
- 'extends': {'service': 'foo'}
- }
- actual = config.merge_service_dicts_from_files(
- base,
- override,
- DEFAULT_VERSION)
- assert actual == {
- 'image': 'alpine:edge',
- 'volumes': ['.:/app'],
- 'extends': {'service': 'foo'}
- }
- def test_merge_service_dicts_heterogeneous(self):
- base = {
- 'volumes': ['.:/app'],
- 'ports': ['5432']
- }
- override = {
- 'image': 'alpine:edge',
- 'ports': [5432]
- }
- actual = config.merge_service_dicts_from_files(
- base,
- override,
- DEFAULT_VERSION)
- assert actual == {
- 'image': 'alpine:edge',
- 'volumes': ['.:/app'],
- 'ports': types.ServicePort.parse('5432')
- }
- def test_merge_service_dicts_heterogeneous_2(self):
- base = {
- 'volumes': ['.:/app'],
- 'ports': [5432]
- }
- override = {
- 'image': 'alpine:edge',
- 'ports': ['5432']
- }
- actual = config.merge_service_dicts_from_files(
- base,
- override,
- DEFAULT_VERSION)
- assert actual == {
- 'image': 'alpine:edge',
- 'volumes': ['.:/app'],
- 'ports': types.ServicePort.parse('5432')
- }
- def test_merge_service_dicts_ports_sorting(self):
- base = {
- 'ports': [5432]
- }
- override = {
- 'image': 'alpine:edge',
- 'ports': ['5432/udp']
- }
- actual = config.merge_service_dicts_from_files(
- base,
- override,
- DEFAULT_VERSION)
- assert len(actual['ports']) == 2
- assert types.ServicePort.parse('5432')[0] in actual['ports']
- assert types.ServicePort.parse('5432/udp')[0] in actual['ports']
- def test_merge_service_dicts_heterogeneous_volumes(self):
- base = {
- 'volumes': ['/a:/b', '/x:/z'],
- }
- override = {
- 'image': 'alpine:edge',
- 'volumes': [
- {'source': '/e', 'target': '/b', 'type': 'bind'},
- {'source': '/c', 'target': '/d', 'type': 'bind'}
- ]
- }
- actual = config.merge_service_dicts_from_files(
- base, override, V3_2
- )
- assert actual['volumes'] == [
- {'source': '/e', 'target': '/b', 'type': 'bind'},
- {'source': '/c', 'target': '/d', 'type': 'bind'},
- '/x:/z'
- ]
- def test_merge_logging_v1(self):
- base = {
- 'image': 'alpine:edge',
- 'log_driver': 'something',
- 'log_opt': {'foo': 'three'},
- }
- override = {
- 'image': 'alpine:edge',
- 'command': 'true',
- }
- actual = config.merge_service_dicts(base, override, V1)
- assert actual == {
- 'image': 'alpine:edge',
- 'log_driver': 'something',
- 'log_opt': {'foo': 'three'},
- 'command': 'true',
- }
- def test_merge_logging_v2(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000',
- 'timeout': '23'
- }
- }
- }
- override = {
- 'logging': {
- 'options': {
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000',
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- def test_merge_logging_v2_override_driver(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000',
- 'timeout': '23'
- }
- }
- }
- override = {
- 'logging': {
- 'driver': 'syslog',
- 'options': {
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'syslog',
- 'options': {
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- def test_merge_logging_v2_no_base_driver(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'options': {
- 'frequency': '2000',
- 'timeout': '23'
- }
- }
- }
- override = {
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000',
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- def test_merge_logging_v2_no_drivers(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'options': {
- 'frequency': '2000',
- 'timeout': '23'
- }
- }
- }
- override = {
- 'logging': {
- 'options': {
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'options': {
- 'frequency': '2000',
- 'timeout': '360',
- 'pretty-print': 'on'
- }
- }
- }
- def test_merge_logging_v2_no_override_options(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000',
- 'timeout': '23'
- }
- }
- }
- override = {
- 'logging': {
- 'driver': 'syslog'
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'syslog',
- }
- }
- def test_merge_logging_v2_no_base(self):
- base = {
- 'image': 'alpine:edge'
- }
- override = {
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'json-file',
- 'options': {
- 'frequency': '2000'
- }
- }
- }
- def test_merge_logging_v2_no_override(self):
- base = {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'syslog',
- 'options': {
- 'frequency': '2000'
- }
- }
- }
- override = {}
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'alpine:edge',
- 'logging': {
- 'driver': 'syslog',
- 'options': {
- 'frequency': '2000'
- }
- }
- }
- def test_merge_mixed_ports(self):
- base = {
- 'image': 'busybox:latest',
- 'command': 'top',
- 'ports': [
- {
- 'target': '1245',
- 'published': '1245',
- 'protocol': 'udp',
- }
- ]
- }
- override = {
- 'ports': ['1245:1245/udp']
- }
- actual = config.merge_service_dicts(base, override, V3_1)
- assert actual == {
- 'image': 'busybox:latest',
- 'command': 'top',
- 'ports': [types.ServicePort('1245', '1245', 'udp', None, None)]
- }
- def test_merge_depends_on_no_override(self):
- base = {
- 'image': 'busybox',
- 'depends_on': {
- 'app1': {'condition': 'service_started'},
- 'app2': {'condition': 'service_healthy'}
- }
- }
- override = {}
- actual = config.merge_service_dicts(base, override, V2_1)
- assert actual == base
- def test_merge_depends_on_mixed_syntax(self):
- base = {
- 'image': 'busybox',
- 'depends_on': {
- 'app1': {'condition': 'service_started'},
- 'app2': {'condition': 'service_healthy'}
- }
- }
- override = {
- 'depends_on': ['app3']
- }
- actual = config.merge_service_dicts(base, override, V2_1)
- assert actual == {
- 'image': 'busybox',
- 'depends_on': {
- 'app1': {'condition': 'service_started'},
- 'app2': {'condition': 'service_healthy'},
- 'app3': {'condition': 'service_started'}
- }
- }
- def test_empty_environment_key_allowed(self):
- service_dict = config.load(
- build_config_details(
- {
- 'web': {
- 'build': '.',
- 'environment': {
- 'POSTGRES_PASSWORD': ''
- },
- },
- },
- '.',
- None,
- )
- ).services[0]
- assert service_dict['environment']['POSTGRES_PASSWORD'] == ''
- def test_merge_pid(self):
- # Regression: https://github.com/docker/compose/issues/4184
- base = {
- 'image': 'busybox',
- 'pid': 'host'
- }
- override = {
- 'labels': {'com.docker.compose.test': 'yes'}
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual == {
- 'image': 'busybox',
- 'pid': 'host',
- 'labels': {'com.docker.compose.test': 'yes'}
- }
- def test_merge_different_secrets(self):
- base = {
- 'image': 'busybox',
- 'secrets': [
- {'source': 'src.txt'}
- ]
- }
- override = {'secrets': ['other-src.txt']}
- actual = config.merge_service_dicts(base, override, V3_1)
- assert secret_sort(actual['secrets']) == secret_sort([
- {'source': 'src.txt'},
- {'source': 'other-src.txt'}
- ])
- def test_merge_secrets_override(self):
- base = {
- 'image': 'busybox',
- 'secrets': ['src.txt'],
- }
- override = {
- 'secrets': [
- {
- 'source': 'src.txt',
- 'target': 'data.txt',
- 'mode': 0o400
- }
- ]
- }
- actual = config.merge_service_dicts(base, override, V3_1)
- assert actual['secrets'] == override['secrets']
- def test_merge_different_configs(self):
- base = {
- 'image': 'busybox',
- 'configs': [
- {'source': 'src.txt'}
- ]
- }
- override = {'configs': ['other-src.txt']}
- actual = config.merge_service_dicts(base, override, V3_3)
- assert secret_sort(actual['configs']) == secret_sort([
- {'source': 'src.txt'},
- {'source': 'other-src.txt'}
- ])
- def test_merge_configs_override(self):
- base = {
- 'image': 'busybox',
- 'configs': ['src.txt'],
- }
- override = {
- 'configs': [
- {
- 'source': 'src.txt',
- 'target': 'data.txt',
- 'mode': 0o400
- }
- ]
- }
- actual = config.merge_service_dicts(base, override, V3_3)
- assert actual['configs'] == override['configs']
- def test_merge_deploy(self):
- base = {
- 'image': 'busybox',
- }
- override = {
- 'deploy': {
- 'mode': 'global',
- 'restart_policy': {
- 'condition': 'on-failure'
- }
- }
- }
- actual = config.merge_service_dicts(base, override, V3_0)
- assert actual['deploy'] == override['deploy']
- def test_merge_deploy_override(self):
- base = {
- 'deploy': {
- 'endpoint_mode': 'vip',
- 'labels': ['com.docker.compose.a=1', 'com.docker.compose.b=2'],
- 'mode': 'replicated',
- 'placement': {
- 'constraints': [
- 'node.role == manager', 'engine.labels.aws == true'
- ],
- 'preferences': [
- {'spread': 'node.labels.zone'}, {'spread': 'x.d.z'}
- ]
- },
- 'replicas': 3,
- 'resources': {
- 'limits': {'cpus': '0.50', 'memory': '50m'},
- 'reservations': {
- 'cpus': '0.1',
- 'generic_resources': [
- {'discrete_resource_spec': {'kind': 'abc', 'value': 123}}
- ],
- 'memory': '15m'
- }
- },
- 'restart_policy': {'condition': 'any', 'delay': '10s'},
- 'update_config': {'delay': '10s', 'max_failure_ratio': 0.3}
- },
- 'image': 'hello-world'
- }
- override = {
- 'deploy': {
- 'labels': {
- 'com.docker.compose.b': '21', 'com.docker.compose.c': '3'
- },
- 'placement': {
- 'constraints': ['node.role == worker', 'engine.labels.dev == true'],
- 'preferences': [{'spread': 'node.labels.zone'}, {'spread': 'x.d.s'}]
- },
- 'resources': {
- 'limits': {'memory': '200m'},
- 'reservations': {
- 'cpus': '0.78',
- 'generic_resources': [
- {'discrete_resource_spec': {'kind': 'abc', 'value': 134}},
- {'discrete_resource_spec': {'kind': 'xyz', 'value': 0.1}}
- ]
- }
- },
- 'restart_policy': {'condition': 'on-failure', 'max_attempts': 42},
- 'update_config': {'max_failure_ratio': 0.712, 'parallelism': 4}
- }
- }
- actual = config.merge_service_dicts(base, override, V3_5)
- assert actual['deploy'] == {
- 'mode': 'replicated',
- 'endpoint_mode': 'vip',
- 'labels': {
- 'com.docker.compose.a': '1',
- 'com.docker.compose.b': '21',
- 'com.docker.compose.c': '3'
- },
- 'placement': {
- 'constraints': [
- 'engine.labels.aws == true', 'engine.labels.dev == true',
- 'node.role == manager', 'node.role == worker'
- ],
- 'preferences': [
- {'spread': 'node.labels.zone'}, {'spread': 'x.d.s'}, {'spread': 'x.d.z'}
- ]
- },
- 'replicas': 3,
- 'resources': {
- 'limits': {'cpus': '0.50', 'memory': '200m'},
- 'reservations': {
- 'cpus': '0.78',
- 'memory': '15m',
- 'generic_resources': [
- {'discrete_resource_spec': {'kind': 'abc', 'value': 134}},
- {'discrete_resource_spec': {'kind': 'xyz', 'value': 0.1}},
- ]
- }
- },
- 'restart_policy': {
- 'condition': 'on-failure',
- 'delay': '10s',
- 'max_attempts': 42,
- },
- 'update_config': {
- 'max_failure_ratio': 0.712,
- 'delay': '10s',
- 'parallelism': 4
- }
- }
- def test_merge_credential_spec(self):
- base = {
- 'image': 'bb',
- 'credential_spec': {
- 'file': '/hello-world',
- }
- }
- override = {
- 'credential_spec': {
- 'registry': 'revolution.com',
- }
- }
- actual = config.merge_service_dicts(base, override, V3_3)
- assert actual['credential_spec'] == override['credential_spec']
- def test_merge_scale(self):
- base = {
- 'image': 'bar',
- 'scale': 2,
- }
- override = {
- 'scale': 4,
- }
- actual = config.merge_service_dicts(base, override, V2_2)
- assert actual == {'image': 'bar', 'scale': 4}
- def test_merge_blkio_config(self):
- base = {
- 'image': 'bar',
- 'blkio_config': {
- 'weight': 300,
- 'weight_device': [
- {'path': '/dev/sda1', 'weight': 200}
- ],
- 'device_read_iops': [
- {'path': '/dev/sda1', 'rate': 300}
- ],
- 'device_write_iops': [
- {'path': '/dev/sda1', 'rate': 1000}
- ]
- }
- }
- override = {
- 'blkio_config': {
- 'weight': 450,
- 'weight_device': [
- {'path': '/dev/sda2', 'weight': 400}
- ],
- 'device_read_iops': [
- {'path': '/dev/sda1', 'rate': 2000}
- ],
- 'device_read_bps': [
- {'path': '/dev/sda1', 'rate': 1024}
- ]
- }
- }
- actual = config.merge_service_dicts(base, override, V2_2)
- assert actual == {
- 'image': 'bar',
- 'blkio_config': {
- 'weight': override['blkio_config']['weight'],
- 'weight_device': (
- base['blkio_config']['weight_device'] +
- override['blkio_config']['weight_device']
- ),
- 'device_read_iops': override['blkio_config']['device_read_iops'],
- 'device_read_bps': override['blkio_config']['device_read_bps'],
- 'device_write_iops': base['blkio_config']['device_write_iops']
- }
- }
- def test_merge_extra_hosts(self):
- base = {
- 'image': 'bar',
- 'extra_hosts': {
- 'foo': '1.2.3.4',
- }
- }
- override = {
- 'extra_hosts': ['bar:5.6.7.8', 'foo:127.0.0.1']
- }
- actual = config.merge_service_dicts(base, override, V2_0)
- assert actual['extra_hosts'] == {
- 'foo': '127.0.0.1',
- 'bar': '5.6.7.8',
- }
- def test_merge_healthcheck_config(self):
- base = {
- 'image': 'bar',
- 'healthcheck': {
- 'start_period': 1000,
- 'interval': 3000,
- 'test': ['true']
- }
- }
- override = {
- 'healthcheck': {
- 'interval': 5000,
- 'timeout': 10000,
- 'test': ['echo', 'OK'],
- }
- }
- actual = config.merge_service_dicts(base, override, V2_3)
- assert actual['healthcheck'] == {
- 'start_period': base['healthcheck']['start_period'],
- 'test': override['healthcheck']['test'],
- 'interval': override['healthcheck']['interval'],
- 'timeout': override['healthcheck']['timeout'],
- }
- def test_merge_healthcheck_override_disables(self):
- base = {
- 'image': 'bar',
- 'healthcheck': {
- 'start_period': 1000,
- 'interval': 3000,
- 'timeout': 2000,
- 'retries': 3,
- 'test': ['true']
- }
- }
- override = {
- 'healthcheck': {
- 'disabled': True
- }
- }
- actual = config.merge_service_dicts(base, override, V2_3)
- assert actual['healthcheck'] == {'disabled': True}
- def test_merge_healthcheck_override_enables(self):
- base = {
- 'image': 'bar',
- 'healthcheck': {
- 'disabled': True
- }
- }
- override = {
- 'healthcheck': {
- 'disabled': False,
- 'start_period': 1000,
- 'interval': 3000,
- 'timeout': 2000,
- 'retries': 3,
- 'test': ['true']
- }
- }
- actual = config.merge_service_dicts(base, override, V2_3)
- assert actual['healthcheck'] == override['healthcheck']
- def test_external_volume_config(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'bogus': {'image': 'busybox'}
- },
- 'volumes': {
- 'ext': {'external': True},
- 'ext2': {'external': {'name': 'aliased'}}
- }
- })
- config_result = config.load(config_details)
- volumes = config_result.volumes
- assert 'ext' in volumes
- assert volumes['ext']['external'] is True
- assert 'ext2' in volumes
- assert volumes['ext2']['external']['name'] == 'aliased'
- def test_external_volume_invalid_config(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'bogus': {'image': 'busybox'}
- },
- 'volumes': {
- 'ext': {'external': True, 'driver': 'foo'}
- }
- })
- with pytest.raises(ConfigurationError):
- config.load(config_details)
- def test_depends_on_orders_services(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'one': {'image': 'busybox', 'depends_on': ['three', 'two']},
- 'two': {'image': 'busybox', 'depends_on': ['three']},
- 'three': {'image': 'busybox'},
- },
- })
- actual = config.load(config_details)
- assert (
- [service['name'] for service in actual.services] ==
- ['three', 'two', 'one']
- )
- def test_depends_on_unknown_service_errors(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'one': {'image': 'busybox', 'depends_on': ['three']},
- },
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "Service 'one' depends on service 'three'" in exc.exconly()
- def test_linked_service_is_undefined(self):
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details({
- 'version': '2',
- 'services': {
- 'web': {'image': 'busybox', 'links': ['db:db']},
- },
- })
- )
- def test_load_dockerfile_without_context(self):
- config_details = build_config_details({
- 'version': '2',
- 'services': {
- 'one': {'build': {'dockerfile': 'Dockerfile.foo'}},
- },
- })
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert 'has neither an image nor a build context' in exc.exconly()
- def test_load_secrets(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.1',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'secrets': [
- 'one',
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- },
- ],
- },
- },
- 'secrets': {
- 'one': {'file': 'secret.txt'},
- },
- })
- details = config.ConfigDetails('.', [base_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'image': 'example/web',
- 'secrets': [
- types.ServiceSecret('one', None, None, None, None, None),
- types.ServiceSecret('source', 'target', '100', '200', 0o777, None),
- ],
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_load_secrets_multi_file(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.1',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'secrets': ['one'],
- },
- },
- 'secrets': {
- 'one': {'file': 'secret.txt'},
- },
- })
- override_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.1',
- 'services': {
- 'web': {
- 'secrets': [
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- },
- ],
- },
- },
- })
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'image': 'example/web',
- 'secrets': [
- types.ServiceSecret('one', None, None, None, None, None),
- types.ServiceSecret('source', 'target', '100', '200', 0o777, None),
- ],
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_load_configs(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.3',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'configs': [
- 'one',
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- },
- ],
- },
- },
- 'configs': {
- 'one': {'file': 'secret.txt'},
- },
- })
- details = config.ConfigDetails('.', [base_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'image': 'example/web',
- 'configs': [
- types.ServiceConfig('one', None, None, None, None, None),
- types.ServiceConfig('source', 'target', '100', '200', 0o777, None),
- ],
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_load_configs_multi_file(self):
- base_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.3',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'configs': ['one'],
- },
- },
- 'configs': {
- 'one': {'file': 'secret.txt'},
- },
- })
- override_file = config.ConfigFile(
- 'base.yaml',
- {
- 'version': '3.3',
- 'services': {
- 'web': {
- 'configs': [
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- },
- ],
- },
- },
- })
- details = config.ConfigDetails('.', [base_file, override_file])
- service_dicts = config.load(details).services
- expected = [
- {
- 'name': 'web',
- 'image': 'example/web',
- 'configs': [
- types.ServiceConfig('one', None, None, None, None, None),
- types.ServiceConfig('source', 'target', '100', '200', 0o777, None),
- ],
- },
- ]
- assert service_sort(service_dicts) == service_sort(expected)
- def test_config_convertible_label_types(self):
- config_details = build_config_details(
- {
- 'version': '3.5',
- 'services': {
- 'web': {
- 'build': {
- 'labels': {'testbuild': True},
- 'context': os.getcwd()
- },
- 'labels': {
- "key": 12345
- }
- },
- },
- 'networks': {
- 'foo': {
- 'labels': {'network.ips.max': 1023}
- }
- },
- 'volumes': {
- 'foo': {
- 'labels': {'volume.is_readonly': False}
- }
- },
- 'secrets': {
- 'foo': {
- 'labels': {'secret.data.expires': 1546282120}
- }
- },
- 'configs': {
- 'foo': {
- 'labels': {'config.data.correction.value': -0.1412}
- }
- }
- }
- )
- loaded_config = config.load(config_details)
- assert loaded_config.services[0]['build']['labels'] == {'testbuild': 'True'}
- assert loaded_config.services[0]['labels'] == {'key': '12345'}
- assert loaded_config.networks['foo']['labels']['network.ips.max'] == '1023'
- assert loaded_config.volumes['foo']['labels']['volume.is_readonly'] == 'False'
- assert loaded_config.secrets['foo']['labels']['secret.data.expires'] == '1546282120'
- assert loaded_config.configs['foo']['labels']['config.data.correction.value'] == '-0.1412'
- def test_config_invalid_label_types(self):
- config_details = build_config_details({
- 'version': '2.3',
- 'volumes': {
- 'foo': {'labels': [1, 2, 3]}
- }
- })
- with pytest.raises(ConfigurationError):
- config.load(config_details)
- def test_service_volume_invalid_config(self):
- config_details = build_config_details(
- {
- 'version': '3.2',
- 'services': {
- 'web': {
- 'build': {
- 'context': '.',
- 'args': None,
- },
- 'volumes': [
- {
- "type": "volume",
- "source": "/data",
- "garbage": {
- "and": "error"
- }
- }
- ]
- }
- }
- }
- )
- with pytest.raises(ConfigurationError) as exc:
- config.load(config_details)
- assert "services.web.volumes contains unsupported option: 'garbage'" in exc.exconly()
- def test_config_valid_service_label_validation(self):
- config_details = build_config_details(
- {
- 'version': '3.5',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'labels': {
- "key": "string"
- }
- },
- },
- }
- )
- config.load(config_details)
- class NetworkModeTest(unittest.TestCase):
- def test_network_mode_standard(self):
- config_data = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'network_mode': 'bridge',
- },
- },
- }))
- assert config_data.services[0]['network_mode'] == 'bridge'
- def test_network_mode_standard_v1(self):
- config_data = config.load(build_config_details({
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'net': 'bridge',
- },
- }))
- assert config_data.services[0]['network_mode'] == 'bridge'
- assert 'net' not in config_data.services[0]
- def test_network_mode_container(self):
- config_data = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'network_mode': 'container:foo',
- },
- },
- }))
- assert config_data.services[0]['network_mode'] == 'container:foo'
- def test_network_mode_container_v1(self):
- config_data = config.load(build_config_details({
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'net': 'container:foo',
- },
- }))
- assert config_data.services[0]['network_mode'] == 'container:foo'
- def test_network_mode_service(self):
- config_data = config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'network_mode': 'service:foo',
- },
- 'foo': {
- 'image': 'busybox',
- 'command': "top",
- },
- },
- }))
- assert config_data.services[1]['network_mode'] == 'service:foo'
- def test_network_mode_service_v1(self):
- config_data = config.load(build_config_details({
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'net': 'container:foo',
- },
- 'foo': {
- 'image': 'busybox',
- 'command': "top",
- },
- }))
- assert config_data.services[1]['network_mode'] == 'service:foo'
- def test_network_mode_service_nonexistent(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'network_mode': 'service:foo',
- },
- },
- }))
- assert "service 'foo' which is undefined" in excinfo.exconly()
- def test_network_mode_plus_networks_is_invalid(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(build_config_details({
- 'version': '2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': "top",
- 'network_mode': 'bridge',
- 'networks': ['front'],
- },
- },
- 'networks': {
- 'front': None,
- }
- }))
- assert "'network_mode' and 'networks' cannot be combined" in excinfo.exconly()
- class PortsTest(unittest.TestCase):
- INVALID_PORTS_TYPES = [
- {"1": "8000"},
- False,
- "8000",
- 8000,
- ]
- NON_UNIQUE_SINGLE_PORTS = [
- ["8000", "8000"],
- ]
- INVALID_PORT_MAPPINGS = [
- ["8000-8004:8000-8002"],
- ["4242:4242-4244"],
- ]
- VALID_SINGLE_PORTS = [
- ["8000"],
- ["8000/tcp"],
- ["8000", "9000"],
- [8000],
- [8000, 9000],
- ]
- VALID_PORT_MAPPINGS = [
- ["8000:8050"],
- ["49153-49154:3002-3003"],
- ]
- def test_config_invalid_ports_type_validation(self):
- for invalid_ports in self.INVALID_PORTS_TYPES:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'ports': invalid_ports})
- assert "contains an invalid type" in exc.value.msg
- def test_config_non_unique_ports_validation(self):
- for invalid_ports in self.NON_UNIQUE_SINGLE_PORTS:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'ports': invalid_ports})
- assert "non-unique" in exc.value.msg
- def test_config_invalid_ports_format_validation(self):
- for invalid_ports in self.INVALID_PORT_MAPPINGS:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'ports': invalid_ports})
- assert "Port ranges don't match in length" in exc.value.msg
- def test_config_valid_ports_format_validation(self):
- for valid_ports in self.VALID_SINGLE_PORTS + self.VALID_PORT_MAPPINGS:
- self.check_config({'ports': valid_ports})
- def test_config_invalid_expose_type_validation(self):
- for invalid_expose in self.INVALID_PORTS_TYPES:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'expose': invalid_expose})
- assert "contains an invalid type" in exc.value.msg
- def test_config_non_unique_expose_validation(self):
- for invalid_expose in self.NON_UNIQUE_SINGLE_PORTS:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'expose': invalid_expose})
- assert "non-unique" in exc.value.msg
- def test_config_invalid_expose_format_validation(self):
- # Valid port mappings ARE NOT valid 'expose' entries
- for invalid_expose in self.INVALID_PORT_MAPPINGS + self.VALID_PORT_MAPPINGS:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config({'expose': invalid_expose})
- assert "should be of the format" in exc.value.msg
- def test_config_valid_expose_format_validation(self):
- # Valid single ports ARE valid 'expose' entries
- for valid_expose in self.VALID_SINGLE_PORTS:
- self.check_config({'expose': valid_expose})
- def check_config(self, cfg):
- config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'web': dict(image='busybox', **cfg)
- },
- }, 'working_dir', 'filename.yml')
- )
- class SubnetTest(unittest.TestCase):
- INVALID_SUBNET_TYPES = [
- None,
- False,
- 10,
- ]
- INVALID_SUBNET_MAPPINGS = [
- "",
- "192.168.0.1/sdfsdfs",
- "192.168.0.1/",
- "192.168.0.1/33",
- "192.168.0.1/01",
- "192.168.0.1",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/sdfsdfs",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/129",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/01",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156",
- "ge80:0000:0000:0000:0204:61ff:fe9d:f156/128",
- "192.168.0.1/31/31",
- ]
- VALID_SUBNET_MAPPINGS = [
- "192.168.0.1/0",
- "192.168.0.1/32",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/0",
- "fe80:0000:0000:0000:0204:61ff:fe9d:f156/128",
- "1:2:3:4:5:6:7:8/0",
- "1::/0",
- "1:2:3:4:5:6:7::/0",
- "1::8/0",
- "1:2:3:4:5:6::8/0",
- "::/0",
- "::8/0",
- "::2:3:4:5:6:7:8/0",
- "fe80::7:8%eth0/0",
- "fe80::7:8%1/0",
- "::255.255.255.255/0",
- "::ffff:255.255.255.255/0",
- "::ffff:0:255.255.255.255/0",
- "2001:db8:3:4::192.0.2.33/0",
- "64:ff9b::192.0.2.33/0",
- ]
- def test_config_invalid_subnet_type_validation(self):
- for invalid_subnet in self.INVALID_SUBNET_TYPES:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config(invalid_subnet)
- assert "contains an invalid type" in exc.value.msg
- def test_config_invalid_subnet_format_validation(self):
- for invalid_subnet in self.INVALID_SUBNET_MAPPINGS:
- with pytest.raises(ConfigurationError) as exc:
- self.check_config(invalid_subnet)
- assert "should use the CIDR format" in exc.value.msg
- def test_config_valid_subnet_format_validation(self):
- for valid_subnet in self.VALID_SUBNET_MAPPINGS:
- self.check_config(valid_subnet)
- def check_config(self, subnet):
- config.load(
- build_config_details({
- 'version': '3.5',
- 'services': {
- 'web': {
- 'image': 'busybox'
- }
- },
- 'networks': {
- 'default': {
- 'ipam': {
- 'config': [
- {
- 'subnet': subnet
- }
- ],
- 'driver': 'default'
- }
- }
- }
- })
- )
- class InterpolationTest(unittest.TestCase):
- @mock.patch.dict(os.environ)
- def test_config_file_with_environment_file(self):
- project_dir = 'tests/fixtures/default-env-file'
- service_dicts = config.load(
- config.find(
- project_dir, None, Environment.from_env_file(project_dir)
- )
- ).services
- assert service_dicts[0] == {
- 'name': 'web',
- 'image': 'alpine:latest',
- 'ports': [
- types.ServicePort.parse('5643')[0],
- types.ServicePort.parse('9999')[0]
- ],
- 'command': 'true'
- }
- @mock.patch.dict(os.environ)
- def test_config_file_with_environment_variable(self):
- project_dir = 'tests/fixtures/environment-interpolation'
- os.environ.update(
- IMAGE="busybox",
- HOST_PORT="80",
- LABEL_VALUE="myvalue",
- )
- service_dicts = config.load(
- config.find(
- project_dir, None, Environment.from_env_file(project_dir)
- )
- ).services
- assert service_dicts == [
- {
- 'name': 'web',
- 'image': 'busybox',
- 'ports': types.ServicePort.parse('80:8000'),
- 'labels': {'mylabel': 'myvalue'},
- 'hostname': 'host-',
- 'command': '${ESCAPED}',
- }
- ]
- @mock.patch.dict(os.environ)
- def test_config_file_with_environment_variable_with_defaults(self):
- project_dir = 'tests/fixtures/environment-interpolation-with-defaults'
- os.environ.update(
- IMAGE="busybox",
- )
- service_dicts = config.load(
- config.find(
- project_dir, None, Environment.from_env_file(project_dir)
- )
- ).services
- assert service_dicts == [
- {
- 'name': 'web',
- 'image': 'busybox',
- 'ports': types.ServicePort.parse('80:8000'),
- 'hostname': 'host-',
- }
- ]
- @mock.patch.dict(os.environ)
- def test_unset_variable_produces_warning(self):
- os.environ.pop('FOO', None)
- os.environ.pop('BAR', None)
- config_details = build_config_details(
- {
- 'web': {
- 'image': '${FOO}',
- 'command': '${BAR}',
- 'container_name': '${BAR}',
- },
- },
- '.',
- None,
- )
- with mock.patch('compose.config.environment.log') as log:
- config.load(config_details)
- assert 2 == log.warn.call_count
- warnings = sorted(args[0][0] for args in log.warn.call_args_list)
- assert 'BAR' in warnings[0]
- assert 'FOO' in warnings[1]
- @mock.patch.dict(os.environ)
- def test_invalid_interpolation(self):
- with pytest.raises(config.ConfigurationError) as cm:
- config.load(
- build_config_details(
- {'web': {'image': '${'}},
- 'working_dir',
- 'filename.yml'
- )
- )
- assert 'Invalid' in cm.value.msg
- assert 'for "image" option' in cm.value.msg
- assert 'in service "web"' in cm.value.msg
- assert '"${"' in cm.value.msg
- @mock.patch.dict(os.environ)
- def test_interpolation_secrets_section(self):
- os.environ['FOO'] = 'baz.bar'
- config_dict = config.load(build_config_details({
- 'version': '3.1',
- 'secrets': {
- 'secretdata': {
- 'external': {'name': '$FOO'}
- }
- }
- }))
- assert config_dict.secrets == {
- 'secretdata': {
- 'external': {'name': 'baz.bar'},
- 'name': 'baz.bar'
- }
- }
- @mock.patch.dict(os.environ)
- def test_interpolation_configs_section(self):
- os.environ['FOO'] = 'baz.bar'
- config_dict = config.load(build_config_details({
- 'version': '3.3',
- 'configs': {
- 'configdata': {
- 'external': {'name': '$FOO'}
- }
- }
- }))
- assert config_dict.configs == {
- 'configdata': {
- 'external': {'name': 'baz.bar'},
- 'name': 'baz.bar'
- }
- }
- class VolumeConfigTest(unittest.TestCase):
- def test_no_binding(self):
- d = make_service_dict('foo', {'build': '.', 'volumes': ['/data']}, working_dir='.')
- assert d['volumes'] == ['/data']
- @mock.patch.dict(os.environ)
- def test_volume_binding_with_environment_variable(self):
- os.environ['VOLUME_PATH'] = '/host/path'
- d = config.load(
- build_config_details(
- {'foo': {'build': '.', 'volumes': ['${VOLUME_PATH}:/container/path']}},
- '.',
- None,
- )
- ).services[0]
- assert d['volumes'] == [VolumeSpec.parse('/host/path:/container/path')]
- @pytest.mark.skipif(IS_WINDOWS_PLATFORM, reason='posix paths')
- @mock.patch.dict(os.environ)
- def test_volume_binding_with_home(self):
- os.environ['HOME'] = '/home/user'
- d = make_service_dict('foo', {'build': '.', 'volumes': ['~:/container/path']}, working_dir='.')
- assert d['volumes'] == ['/home/user:/container/path']
- def test_name_does_not_expand(self):
- d = make_service_dict('foo', {'build': '.', 'volumes': ['mydatavolume:/data']}, working_dir='.')
- assert d['volumes'] == ['mydatavolume:/data']
- def test_absolute_posix_path_does_not_expand(self):
- d = make_service_dict('foo', {'build': '.', 'volumes': ['/var/lib/data:/data']}, working_dir='.')
- assert d['volumes'] == ['/var/lib/data:/data']
- def test_absolute_windows_path_does_not_expand(self):
- d = make_service_dict('foo', {'build': '.', 'volumes': ['c:\\data:/data']}, working_dir='.')
- assert d['volumes'] == ['c:\\data:/data']
- @pytest.mark.skipif(IS_WINDOWS_PLATFORM, reason='posix paths')
- def test_relative_path_does_expand_posix(self):
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['./data:/data']},
- working_dir='/home/me/myproject')
- assert d['volumes'] == ['/home/me/myproject/data:/data']
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['.:/data']},
- working_dir='/home/me/myproject')
- assert d['volumes'] == ['/home/me/myproject:/data']
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['../otherproject:/data']},
- working_dir='/home/me/myproject')
- assert d['volumes'] == ['/home/me/otherproject:/data']
- @pytest.mark.skipif(not IS_WINDOWS_PLATFORM, reason='windows paths')
- def test_relative_path_does_expand_windows(self):
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['./data:/data']},
- working_dir='c:\\Users\\me\\myproject')
- assert d['volumes'] == ['c:\\Users\\me\\myproject\\data:/data']
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['.:/data']},
- working_dir='c:\\Users\\me\\myproject')
- assert d['volumes'] == ['c:\\Users\\me\\myproject:/data']
- d = make_service_dict(
- 'foo',
- {'build': '.', 'volumes': ['../otherproject:/data']},
- working_dir='c:\\Users\\me\\myproject')
- assert d['volumes'] == ['c:\\Users\\me\\otherproject:/data']
- @mock.patch.dict(os.environ)
- def test_home_directory_with_driver_does_not_expand(self):
- os.environ['NAME'] = 'surprise!'
- d = make_service_dict('foo', {
- 'build': '.',
- 'volumes': ['~:/data'],
- 'volume_driver': 'foodriver',
- }, working_dir='.')
- assert d['volumes'] == ['~:/data']
- def test_volume_path_with_non_ascii_directory(self):
- volume = u'/Füü/data:/data'
- container_path = config.resolve_volume_path(".", volume)
- assert container_path == volume
- class MergePathMappingTest(object):
- config_name = ""
- def test_empty(self):
- service_dict = config.merge_service_dicts({}, {}, DEFAULT_VERSION)
- assert self.config_name not in service_dict
- def test_no_override(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: ['/foo:/code', '/data']},
- {},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(['/foo:/code', '/data'])
- def test_no_base(self):
- service_dict = config.merge_service_dicts(
- {},
- {self.config_name: ['/bar:/code']},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(['/bar:/code'])
- def test_override_explicit_path(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: ['/foo:/code', '/data']},
- {self.config_name: ['/bar:/code']},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(['/bar:/code', '/data'])
- def test_add_explicit_path(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: ['/foo:/code', '/data']},
- {self.config_name: ['/bar:/code', '/quux:/data']},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(['/bar:/code', '/quux:/data'])
- def test_remove_explicit_path(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: ['/foo:/code', '/quux:/data']},
- {self.config_name: ['/bar:/code', '/data']},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(['/bar:/code', '/data'])
- class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
- config_name = 'volumes'
- class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
- config_name = 'devices'
- class BuildOrImageMergeTest(unittest.TestCase):
- def test_merge_build_or_image_no_override(self):
- assert config.merge_service_dicts({'build': '.'}, {}, V1) == {'build': '.'}
- assert config.merge_service_dicts({'image': 'redis'}, {}, V1) == {'image': 'redis'}
- def test_merge_build_or_image_override_with_same(self):
- assert config.merge_service_dicts({'build': '.'}, {'build': './web'}, V1) == {'build': './web'}
- assert config.merge_service_dicts({'image': 'redis'}, {'image': 'postgres'}, V1) == {
- 'image': 'postgres'
- }
- def test_merge_build_or_image_override_with_other(self):
- assert config.merge_service_dicts({'build': '.'}, {'image': 'redis'}, V1) == {
- 'image': 'redis'
- }
- assert config.merge_service_dicts({'image': 'redis'}, {'build': '.'}, V1) == {'build': '.'}
- class MergeListsTest(object):
- config_name = ""
- base_config = []
- override_config = []
- def merged_config(self):
- return set(self.base_config) | set(self.override_config)
- def test_empty(self):
- assert self.config_name not in config.merge_service_dicts({}, {}, DEFAULT_VERSION)
- def test_no_override(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: self.base_config},
- {},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(self.base_config)
- def test_no_base(self):
- service_dict = config.merge_service_dicts(
- {},
- {self.config_name: self.base_config},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(self.base_config)
- def test_add_item(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: self.base_config},
- {self.config_name: self.override_config},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == set(self.merged_config())
- class MergePortsTest(unittest.TestCase, MergeListsTest):
- config_name = 'ports'
- base_config = ['10:8000', '9000']
- override_config = ['20:8000']
- def merged_config(self):
- return self.convert(self.base_config) | self.convert(self.override_config)
- def convert(self, port_config):
- return set(config.merge_service_dicts(
- {self.config_name: port_config},
- {self.config_name: []},
- DEFAULT_VERSION
- )[self.config_name])
- def test_duplicate_port_mappings(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: self.base_config},
- {self.config_name: self.base_config},
- DEFAULT_VERSION
- )
- assert set(service_dict[self.config_name]) == self.convert(self.base_config)
- def test_no_override(self):
- service_dict = config.merge_service_dicts(
- {self.config_name: self.base_config},
- {},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == self.convert(self.base_config)
- def test_no_base(self):
- service_dict = config.merge_service_dicts(
- {},
- {self.config_name: self.base_config},
- DEFAULT_VERSION)
- assert set(service_dict[self.config_name]) == self.convert(self.base_config)
- class MergeNetworksTest(unittest.TestCase, MergeListsTest):
- config_name = 'networks'
- base_config = ['frontend', 'backend']
- override_config = ['monitoring']
- class MergeStringsOrListsTest(unittest.TestCase):
- def test_no_override(self):
- service_dict = config.merge_service_dicts(
- {'dns': '8.8.8.8'},
- {},
- DEFAULT_VERSION)
- assert set(service_dict['dns']) == set(['8.8.8.8'])
- def test_no_base(self):
- service_dict = config.merge_service_dicts(
- {},
- {'dns': '8.8.8.8'},
- DEFAULT_VERSION)
- assert set(service_dict['dns']) == set(['8.8.8.8'])
- def test_add_string(self):
- service_dict = config.merge_service_dicts(
- {'dns': ['8.8.8.8']},
- {'dns': '9.9.9.9'},
- DEFAULT_VERSION)
- assert set(service_dict['dns']) == set(['8.8.8.8', '9.9.9.9'])
- def test_add_list(self):
- service_dict = config.merge_service_dicts(
- {'dns': '8.8.8.8'},
- {'dns': ['9.9.9.9']},
- DEFAULT_VERSION)
- assert set(service_dict['dns']) == set(['8.8.8.8', '9.9.9.9'])
- class MergeLabelsTest(unittest.TestCase):
- def test_empty(self):
- assert 'labels' not in config.merge_service_dicts({}, {}, DEFAULT_VERSION)
- def test_no_override(self):
- service_dict = config.merge_service_dicts(
- make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
- make_service_dict('foo', {'build': '.'}, 'tests/'),
- DEFAULT_VERSION)
- assert service_dict['labels'] == {'foo': '1', 'bar': ''}
- def test_no_base(self):
- service_dict = config.merge_service_dicts(
- make_service_dict('foo', {'build': '.'}, 'tests/'),
- make_service_dict('foo', {'build': '.', 'labels': ['foo=2']}, 'tests/'),
- DEFAULT_VERSION)
- assert service_dict['labels'] == {'foo': '2'}
- def test_override_explicit_value(self):
- service_dict = config.merge_service_dicts(
- make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
- make_service_dict('foo', {'build': '.', 'labels': ['foo=2']}, 'tests/'),
- DEFAULT_VERSION)
- assert service_dict['labels'] == {'foo': '2', 'bar': ''}
- def test_add_explicit_value(self):
- service_dict = config.merge_service_dicts(
- make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar']}, 'tests/'),
- make_service_dict('foo', {'build': '.', 'labels': ['bar=2']}, 'tests/'),
- DEFAULT_VERSION)
- assert service_dict['labels'] == {'foo': '1', 'bar': '2'}
- def test_remove_explicit_value(self):
- service_dict = config.merge_service_dicts(
- make_service_dict('foo', {'build': '.', 'labels': ['foo=1', 'bar=2']}, 'tests/'),
- make_service_dict('foo', {'build': '.', 'labels': ['bar']}, 'tests/'),
- DEFAULT_VERSION)
- assert service_dict['labels'] == {'foo': '1', 'bar': ''}
- class MergeBuildTest(unittest.TestCase):
- def test_full(self):
- base = {
- 'context': '.',
- 'dockerfile': 'Dockerfile',
- 'args': {
- 'x': '1',
- 'y': '2',
- },
- 'cache_from': ['ubuntu'],
- 'labels': ['com.docker.compose.test=true']
- }
- override = {
- 'context': './prod',
- 'dockerfile': 'Dockerfile.prod',
- 'args': ['x=12'],
- 'cache_from': ['debian'],
- 'labels': {
- 'com.docker.compose.test': 'false',
- 'com.docker.compose.prod': 'true',
- }
- }
- result = config.merge_build(None, {'build': base}, {'build': override})
- assert result['context'] == override['context']
- assert result['dockerfile'] == override['dockerfile']
- assert result['args'] == {'x': '12', 'y': '2'}
- assert set(result['cache_from']) == set(['ubuntu', 'debian'])
- assert result['labels'] == override['labels']
- def test_empty_override(self):
- base = {
- 'context': '.',
- 'dockerfile': 'Dockerfile',
- 'args': {
- 'x': '1',
- 'y': '2',
- },
- 'cache_from': ['ubuntu'],
- 'labels': {
- 'com.docker.compose.test': 'true'
- }
- }
- override = {}
- result = config.merge_build(None, {'build': base}, {'build': override})
- assert result == base
- def test_empty_base(self):
- base = {}
- override = {
- 'context': './prod',
- 'dockerfile': 'Dockerfile.prod',
- 'args': {'x': '12'},
- 'cache_from': ['debian'],
- 'labels': {
- 'com.docker.compose.test': 'false',
- 'com.docker.compose.prod': 'true',
- }
- }
- result = config.merge_build(None, {'build': base}, {'build': override})
- assert result == override
- class MemoryOptionsTest(unittest.TestCase):
- def test_validation_fails_with_just_memswap_limit(self):
- """
- When you set a 'memswap_limit' it is invalid config unless you also set
- a mem_limit
- """
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'foo': {'image': 'busybox', 'memswap_limit': 2000000},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "foo.memswap_limit is invalid: when defining " \
- "'memswap_limit' you must set 'mem_limit' as well" \
- in excinfo.exconly()
- def test_validation_with_correct_memswap_values(self):
- service_dict = config.load(
- build_config_details(
- {'foo': {'image': 'busybox', 'mem_limit': 1000000, 'memswap_limit': 2000000}},
- 'tests/fixtures/extends',
- 'common.yml'
- )
- ).services
- assert service_dict[0]['memswap_limit'] == 2000000
- def test_memswap_can_be_a_string(self):
- service_dict = config.load(
- build_config_details(
- {'foo': {'image': 'busybox', 'mem_limit': "1G", 'memswap_limit': "512M"}},
- 'tests/fixtures/extends',
- 'common.yml'
- )
- ).services
- assert service_dict[0]['memswap_limit'] == "512M"
- class EnvTest(unittest.TestCase):
- def test_parse_environment_as_list(self):
- environment = [
- 'NORMAL=F1',
- 'CONTAINS_EQUALS=F=2',
- 'TRAILING_EQUALS=',
- ]
- assert config.parse_environment(environment) == {
- 'NORMAL': 'F1', 'CONTAINS_EQUALS': 'F=2', 'TRAILING_EQUALS': ''
- }
- def test_parse_environment_as_dict(self):
- environment = {
- 'NORMAL': 'F1',
- 'CONTAINS_EQUALS': 'F=2',
- 'TRAILING_EQUALS': None,
- }
- assert config.parse_environment(environment) == environment
- def test_parse_environment_invalid(self):
- with pytest.raises(ConfigurationError):
- config.parse_environment('a=b')
- def test_parse_environment_empty(self):
- assert config.parse_environment(None) == {}
- @mock.patch.dict(os.environ)
- def test_resolve_environment(self):
- os.environ['FILE_DEF'] = 'E1'
- os.environ['FILE_DEF_EMPTY'] = 'E2'
- os.environ['ENV_DEF'] = 'E3'
- service_dict = {
- 'build': '.',
- 'environment': {
- 'FILE_DEF': 'F1',
- 'FILE_DEF_EMPTY': '',
- 'ENV_DEF': None,
- 'NO_DEF': None
- },
- }
- assert resolve_environment(
- service_dict, Environment.from_env_file(None)
- ) == {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': None}
- def test_resolve_environment_from_env_file(self):
- assert resolve_environment({'env_file': ['tests/fixtures/env/one.env']}) == {
- 'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'bar'
- }
- def test_environment_overrides_env_file(self):
- assert resolve_environment({
- 'environment': {'FOO': 'baz'},
- 'env_file': ['tests/fixtures/env/one.env'],
- }) == {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'baz'}
- def test_resolve_environment_with_multiple_env_files(self):
- service_dict = {
- 'env_file': [
- 'tests/fixtures/env/one.env',
- 'tests/fixtures/env/two.env'
- ]
- }
- assert resolve_environment(service_dict) == {
- 'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'baz', 'DOO': 'dah'
- }
- def test_resolve_environment_nonexistent_file(self):
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details(
- {'foo': {'image': 'example', 'env_file': 'nonexistent.env'}},
- working_dir='tests/fixtures/env'))
- assert 'Couldn\'t find env file' in exc.exconly()
- assert 'nonexistent.env' in exc.exconly()
- @mock.patch.dict(os.environ)
- def test_resolve_environment_from_env_file_with_empty_values(self):
- os.environ['FILE_DEF'] = 'E1'
- os.environ['FILE_DEF_EMPTY'] = 'E2'
- os.environ['ENV_DEF'] = 'E3'
- assert resolve_environment(
- {'env_file': ['tests/fixtures/env/resolve.env']},
- Environment.from_env_file(None)
- ) == {
- 'FILE_DEF': u'bär',
- 'FILE_DEF_EMPTY': '',
- 'ENV_DEF': 'E3',
- 'NO_DEF': None
- }
- @mock.patch.dict(os.environ)
- def test_resolve_build_args(self):
- os.environ['env_arg'] = 'value2'
- build = {
- 'context': '.',
- 'args': {
- 'arg1': 'value1',
- 'empty_arg': '',
- 'env_arg': None,
- 'no_env': None
- }
- }
- assert resolve_build_args(build['args'], Environment.from_env_file(build['context'])) == {
- 'arg1': 'value1', 'empty_arg': '', 'env_arg': 'value2', 'no_env': None
- }
- @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
- @mock.patch.dict(os.environ)
- def test_resolve_path(self):
- os.environ['HOSTENV'] = '/tmp'
- os.environ['CONTAINERENV'] = '/host/tmp'
- service_dict = config.load(
- build_config_details(
- {'foo': {'build': '.', 'volumes': ['$HOSTENV:$CONTAINERENV']}},
- "tests/fixtures/env",
- )
- ).services[0]
- assert set(service_dict['volumes']) == set([VolumeSpec.parse('/tmp:/host/tmp')])
- service_dict = config.load(
- build_config_details(
- {'foo': {'build': '.', 'volumes': ['/opt${HOSTENV}:/opt${CONTAINERENV}']}},
- "tests/fixtures/env",
- )
- ).services[0]
- assert set(service_dict['volumes']) == set([VolumeSpec.parse('/opt/tmp:/opt/host/tmp')])
- def load_from_filename(filename, override_dir=None):
- return config.load(
- config.find('.', [filename], Environment.from_env_file('.'), override_dir=override_dir)
- ).services
- class ExtendsTest(unittest.TestCase):
- def test_extends(self):
- service_dicts = load_from_filename('tests/fixtures/extends/docker-compose.yml')
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'mydb',
- 'image': 'busybox',
- 'command': 'top',
- },
- {
- 'name': 'myweb',
- 'image': 'busybox',
- 'command': 'top',
- 'network_mode': 'bridge',
- 'links': ['mydb:db'],
- 'environment': {
- "FOO": "1",
- "BAR": "2",
- "BAZ": "2",
- },
- }
- ])
- def test_merging_env_labels_ulimits(self):
- service_dicts = load_from_filename('tests/fixtures/extends/common-env-labels-ulimits.yml')
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'web',
- 'image': 'busybox',
- 'command': '/bin/true',
- 'network_mode': 'host',
- 'environment': {
- "FOO": "2",
- "BAR": "1",
- "BAZ": "3",
- },
- 'labels': {'label': 'one'},
- 'ulimits': {'nproc': 65535, 'memlock': {'soft': 1024, 'hard': 2048}}
- }
- ])
- def test_nested(self):
- service_dicts = load_from_filename('tests/fixtures/extends/nested.yml')
- assert service_dicts == [
- {
- 'name': 'myweb',
- 'image': 'busybox',
- 'command': '/bin/true',
- 'network_mode': 'host',
- 'environment': {
- "FOO": "2",
- "BAR": "2",
- },
- },
- ]
- def test_self_referencing_file(self):
- """
- We specify a 'file' key that is the filename we're already in.
- """
- service_dicts = load_from_filename('tests/fixtures/extends/specify-file-as-self.yml')
- assert service_sort(service_dicts) == service_sort([
- {
- 'environment':
- {
- 'YEP': '1', 'BAR': '1', 'BAZ': '3'
- },
- 'image': 'busybox',
- 'name': 'myweb'
- },
- {
- 'environment':
- {'YEP': '1'},
- 'image': 'busybox',
- 'name': 'otherweb'
- },
- {
- 'environment':
- {'YEP': '1', 'BAZ': '3'},
- 'image': 'busybox',
- 'name': 'web'
- }
- ])
- def test_circular(self):
- with pytest.raises(config.CircularReference) as exc:
- load_from_filename('tests/fixtures/extends/circle-1.yml')
- path = [
- (os.path.basename(filename), service_name)
- for (filename, service_name) in exc.value.trail
- ]
- expected = [
- ('circle-1.yml', 'web'),
- ('circle-2.yml', 'other'),
- ('circle-1.yml', 'web'),
- ]
- assert path == expected
- def test_extends_validation_empty_dictionary(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {'image': 'busybox', 'extends': {}},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert 'service' in excinfo.exconly()
- def test_extends_validation_missing_service_key(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {'image': 'busybox', 'extends': {'file': 'common.yml'}},
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "'service' is a required property" in excinfo.exconly()
- def test_extends_validation_invalid_key(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {
- 'image': 'busybox',
- 'extends': {
- 'file': 'common.yml',
- 'service': 'web',
- 'rogue_key': 'is not allowed'
- }
- },
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "web.extends contains unsupported option: 'rogue_key'" \
- in excinfo.exconly()
- def test_extends_validation_sub_property_key(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details(
- {
- 'web': {
- 'image': 'busybox',
- 'extends': {
- 'file': 1,
- 'service': 'web',
- }
- },
- },
- 'tests/fixtures/extends',
- 'filename.yml'
- )
- )
- assert "web.extends.file contains 1, which is an invalid type, it should be a string" \
- in excinfo.exconly()
- def test_extends_validation_no_file_key_no_filename_set(self):
- dictionary = {'extends': {'service': 'web'}}
- with pytest.raises(ConfigurationError) as excinfo:
- make_service_dict('myweb', dictionary, working_dir='tests/fixtures/extends')
- assert 'file' in excinfo.exconly()
- def test_extends_validation_valid_config(self):
- service = config.load(
- build_config_details(
- {
- 'web': {'image': 'busybox', 'extends': {'service': 'web', 'file': 'common.yml'}},
- },
- 'tests/fixtures/extends',
- 'common.yml'
- )
- ).services
- assert len(service) == 1
- assert isinstance(service[0], dict)
- assert service[0]['command'] == "/bin/true"
- def test_extended_service_with_invalid_config(self):
- with pytest.raises(ConfigurationError) as exc:
- load_from_filename('tests/fixtures/extends/service-with-invalid-schema.yml')
- assert (
- "myweb has neither an image nor a build context specified" in
- exc.exconly()
- )
- def test_extended_service_with_valid_config(self):
- service = load_from_filename('tests/fixtures/extends/service-with-valid-composite-extends.yml')
- assert service[0]['command'] == "top"
- def test_extends_file_defaults_to_self(self):
- """
- Test not specifying a file in our extends options that the
- config is valid and correctly extends from itself.
- """
- service_dicts = load_from_filename('tests/fixtures/extends/no-file-specified.yml')
- assert service_sort(service_dicts) == service_sort([
- {
- 'name': 'myweb',
- 'image': 'busybox',
- 'environment': {
- "BAR": "1",
- "BAZ": "3",
- }
- },
- {
- 'name': 'web',
- 'image': 'busybox',
- 'environment': {
- "BAZ": "3",
- }
- }
- ])
- def test_invalid_links_in_extended_service(self):
- with pytest.raises(ConfigurationError) as excinfo:
- load_from_filename('tests/fixtures/extends/invalid-links.yml')
- assert "services with 'links' cannot be extended" in excinfo.exconly()
- def test_invalid_volumes_from_in_extended_service(self):
- with pytest.raises(ConfigurationError) as excinfo:
- load_from_filename('tests/fixtures/extends/invalid-volumes.yml')
- assert "services with 'volumes_from' cannot be extended" in excinfo.exconly()
- def test_invalid_net_in_extended_service(self):
- with pytest.raises(ConfigurationError) as excinfo:
- load_from_filename('tests/fixtures/extends/invalid-net-v2.yml')
- assert 'network_mode: service' in excinfo.exconly()
- assert 'cannot be extended' in excinfo.exconly()
- with pytest.raises(ConfigurationError) as excinfo:
- load_from_filename('tests/fixtures/extends/invalid-net.yml')
- assert 'net: container' in excinfo.exconly()
- assert 'cannot be extended' in excinfo.exconly()
- @mock.patch.dict(os.environ)
- def test_load_config_runs_interpolation_in_extended_service(self):
- os.environ.update(HOSTNAME_VALUE="penguin")
- expected_interpolated_value = "host-penguin"
- service_dicts = load_from_filename(
- 'tests/fixtures/extends/valid-interpolation.yml')
- for service in service_dicts:
- assert service['hostname'] == expected_interpolated_value
- @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
- def test_volume_path(self):
- dicts = load_from_filename('tests/fixtures/volume-path/docker-compose.yml')
- paths = [
- VolumeSpec(
- os.path.abspath('tests/fixtures/volume-path/common/foo'),
- '/foo',
- 'rw'),
- VolumeSpec(
- os.path.abspath('tests/fixtures/volume-path/bar'),
- '/bar',
- 'rw')
- ]
- assert set(dicts[0]['volumes']) == set(paths)
- def test_parent_build_path_dne(self):
- child = load_from_filename('tests/fixtures/extends/nonexistent-path-child.yml')
- assert child == [
- {
- 'name': 'dnechild',
- 'image': 'busybox',
- 'command': '/bin/true',
- 'environment': {
- "FOO": "1",
- "BAR": "2",
- },
- },
- ]
- def test_load_throws_error_when_base_service_does_not_exist(self):
- with pytest.raises(ConfigurationError) as excinfo:
- load_from_filename('tests/fixtures/extends/nonexistent-service.yml')
- assert "Cannot extend service 'foo'" in excinfo.exconly()
- assert "Service not found" in excinfo.exconly()
- def test_partial_service_config_in_extends_is_still_valid(self):
- dicts = load_from_filename('tests/fixtures/extends/valid-common-config.yml')
- assert dicts[0]['environment'] == {'FOO': '1'}
- def test_extended_service_with_verbose_and_shorthand_way(self):
- services = load_from_filename('tests/fixtures/extends/verbose-and-shorthand.yml')
- assert service_sort(services) == service_sort([
- {
- 'name': 'base',
- 'image': 'busybox',
- 'environment': {'BAR': '1'},
- },
- {
- 'name': 'verbose',
- 'image': 'busybox',
- 'environment': {'BAR': '1', 'FOO': '1'},
- },
- {
- 'name': 'shorthand',
- 'image': 'busybox',
- 'environment': {'BAR': '1', 'FOO': '2'},
- },
- ])
- @mock.patch.dict(os.environ)
- def test_extends_with_environment_and_env_files(self):
- tmpdir = py.test.ensuretemp('test_extends_with_environment')
- self.addCleanup(tmpdir.remove)
- commondir = tmpdir.mkdir('common')
- commondir.join('base.yml').write("""
- app:
- image: 'example/app'
- env_file:
- - 'envs'
- environment:
- - SECRET
- - TEST_ONE=common
- - TEST_TWO=common
- """)
- tmpdir.join('docker-compose.yml').write("""
- ext:
- extends:
- file: common/base.yml
- service: app
- env_file:
- - 'envs'
- environment:
- - THING
- - TEST_ONE=top
- """)
- commondir.join('envs').write("""
- COMMON_ENV_FILE
- TEST_ONE=common-env-file
- TEST_TWO=common-env-file
- TEST_THREE=common-env-file
- TEST_FOUR=common-env-file
- """)
- tmpdir.join('envs').write("""
- TOP_ENV_FILE
- TEST_ONE=top-env-file
- TEST_TWO=top-env-file
- TEST_THREE=top-env-file
- """)
- expected = [
- {
- 'name': 'ext',
- 'image': 'example/app',
- 'environment': {
- 'SECRET': 'secret',
- 'TOP_ENV_FILE': 'secret',
- 'COMMON_ENV_FILE': 'secret',
- 'THING': 'thing',
- 'TEST_ONE': 'top',
- 'TEST_TWO': 'common',
- 'TEST_THREE': 'top-env-file',
- 'TEST_FOUR': 'common-env-file',
- },
- },
- ]
- os.environ['SECRET'] = 'secret'
- os.environ['THING'] = 'thing'
- os.environ['COMMON_ENV_FILE'] = 'secret'
- os.environ['TOP_ENV_FILE'] = 'secret'
- config = load_from_filename(str(tmpdir.join('docker-compose.yml')))
- assert config == expected
- def test_extends_with_mixed_versions_is_error(self):
- tmpdir = py.test.ensuretemp('test_extends_with_mixed_version')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('docker-compose.yml').write("""
- version: "2"
- services:
- web:
- extends:
- file: base.yml
- service: base
- image: busybox
- """)
- tmpdir.join('base.yml').write("""
- base:
- volumes: ['/foo']
- ports: ['3000:3000']
- """)
- with pytest.raises(ConfigurationError) as exc:
- load_from_filename(str(tmpdir.join('docker-compose.yml')))
- assert 'Version mismatch' in exc.exconly()
- def test_extends_with_defined_version_passes(self):
- tmpdir = py.test.ensuretemp('test_extends_with_defined_version')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('docker-compose.yml').write("""
- version: "2"
- services:
- web:
- extends:
- file: base.yml
- service: base
- image: busybox
- """)
- tmpdir.join('base.yml').write("""
- version: "2"
- services:
- base:
- volumes: ['/foo']
- ports: ['3000:3000']
- command: top
- """)
- service = load_from_filename(str(tmpdir.join('docker-compose.yml')))
- assert service[0]['command'] == "top"
- def test_extends_with_depends_on(self):
- tmpdir = py.test.ensuretemp('test_extends_with_depends_on')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('docker-compose.yml').write("""
- version: "2"
- services:
- base:
- image: example
- web:
- extends: base
- image: busybox
- depends_on: ['other']
- other:
- image: example
- """)
- services = load_from_filename(str(tmpdir.join('docker-compose.yml')))
- assert service_sort(services)[2]['depends_on'] == {
- 'other': {'condition': 'service_started'}
- }
- def test_extends_with_healthcheck(self):
- service_dicts = load_from_filename('tests/fixtures/extends/healthcheck-2.yml')
- assert service_sort(service_dicts) == [{
- 'name': 'demo',
- 'image': 'foobar:latest',
- 'healthcheck': {
- 'test': ['CMD', '/health.sh'],
- 'interval': 10000000000,
- 'timeout': 5000000000,
- 'retries': 36,
- }
- }]
- def test_extends_with_ports(self):
- tmpdir = py.test.ensuretemp('test_extends_with_ports')
- self.addCleanup(tmpdir.remove)
- tmpdir.join('docker-compose.yml').write("""
- version: '2'
- services:
- a:
- image: nginx
- ports:
- - 80
- b:
- extends:
- service: a
- """)
- services = load_from_filename(str(tmpdir.join('docker-compose.yml')))
- assert len(services) == 2
- for svc in services:
- assert svc['ports'] == [types.ServicePort('80', None, None, None, None)]
- @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
- class ExpandPathTest(unittest.TestCase):
- working_dir = '/home/user/somedir'
- def test_expand_path_normal(self):
- result = config.expand_path(self.working_dir, 'myfile')
- assert result == self.working_dir + '/' + 'myfile'
- def test_expand_path_absolute(self):
- abs_path = '/home/user/otherdir/somefile'
- result = config.expand_path(self.working_dir, abs_path)
- assert result == abs_path
- def test_expand_path_with_tilde(self):
- test_path = '~/otherdir/somefile'
- with mock.patch.dict(os.environ):
- os.environ['HOME'] = user_path = '/home/user/'
- result = config.expand_path(self.working_dir, test_path)
- assert result == user_path + 'otherdir/somefile'
- class VolumePathTest(unittest.TestCase):
- def test_split_path_mapping_with_windows_path(self):
- host_path = "c:\\Users\\msamblanet\\Documents\\anvil\\connect\\config"
- windows_volume_path = host_path + ":/opt/connect/config:ro"
- expected_mapping = ("/opt/connect/config", (host_path, 'ro'))
- mapping = config.split_path_mapping(windows_volume_path)
- assert mapping == expected_mapping
- def test_split_path_mapping_with_windows_path_in_container(self):
- host_path = 'c:\\Users\\remilia\\data'
- container_path = 'c:\\scarletdevil\\data'
- expected_mapping = (container_path, (host_path, None))
- mapping = config.split_path_mapping('{0}:{1}'.format(host_path, container_path))
- assert mapping == expected_mapping
- def test_split_path_mapping_with_root_mount(self):
- host_path = '/'
- container_path = '/var/hostroot'
- expected_mapping = (container_path, (host_path, None))
- mapping = config.split_path_mapping('{0}:{1}'.format(host_path, container_path))
- assert mapping == expected_mapping
- @pytest.mark.xfail(IS_WINDOWS_PLATFORM, reason='paths use slash')
- class BuildPathTest(unittest.TestCase):
- def setUp(self):
- self.abs_context_path = os.path.join(os.getcwd(), 'tests/fixtures/build-ctx')
- def test_nonexistent_path(self):
- with pytest.raises(ConfigurationError):
- config.load(
- build_config_details(
- {
- 'foo': {'build': 'nonexistent.path'},
- },
- 'working_dir',
- 'filename.yml'
- )
- )
- def test_relative_path(self):
- relative_build_path = '../build-ctx/'
- service_dict = make_service_dict(
- 'relpath',
- {'build': relative_build_path},
- working_dir='tests/fixtures/build-path'
- )
- assert service_dict['build'] == self.abs_context_path
- def test_absolute_path(self):
- service_dict = make_service_dict(
- 'abspath',
- {'build': self.abs_context_path},
- working_dir='tests/fixtures/build-path'
- )
- assert service_dict['build'] == self.abs_context_path
- def test_from_file(self):
- service_dict = load_from_filename('tests/fixtures/build-path/docker-compose.yml')
- assert service_dict == [{'name': 'foo', 'build': {'context': self.abs_context_path}}]
- def test_from_file_override_dir(self):
- override_dir = os.path.join(os.getcwd(), 'tests/fixtures/')
- service_dict = load_from_filename(
- 'tests/fixtures/build-path-override-dir/docker-compose.yml', override_dir=override_dir)
- assert service_dict == [{'name': 'foo', 'build': {'context': self.abs_context_path}}]
- def test_valid_url_in_build_path(self):
- valid_urls = [
- 'git://github.com/docker/docker',
- '[email protected]:docker/docker.git',
- '[email protected]:atlassianlabs/atlassian-docker.git',
- 'https://github.com/docker/docker.git',
- 'http://github.com/docker/docker.git',
- 'github.com/docker/docker.git',
- ]
- for valid_url in valid_urls:
- service_dict = config.load(build_config_details({
- 'validurl': {'build': valid_url},
- }, '.', None)).services
- assert service_dict[0]['build'] == {'context': valid_url}
- def test_invalid_url_in_build_path(self):
- invalid_urls = [
- 'example.com/bogus',
- 'ftp://example.com/',
- '/path/does/not/exist',
- ]
- for invalid_url in invalid_urls:
- with pytest.raises(ConfigurationError) as exc:
- config.load(build_config_details({
- 'invalidurl': {'build': invalid_url},
- }, '.', None))
- assert 'build path' in exc.exconly()
- class HealthcheckTest(unittest.TestCase):
- def test_healthcheck(self):
- config_dict = config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'test': {
- 'image': 'busybox',
- 'healthcheck': {
- 'test': ['CMD', 'true'],
- 'interval': '1s',
- 'timeout': '1m',
- 'retries': 3,
- 'start_period': '10s',
- }
- }
- }
- })
- )
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['test']
- assert serialized_service['healthcheck'] == {
- 'test': ['CMD', 'true'],
- 'interval': '1s',
- 'timeout': '1m',
- 'retries': 3,
- 'start_period': '10s'
- }
- def test_disable(self):
- config_dict = config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'test': {
- 'image': 'busybox',
- 'healthcheck': {
- 'disable': True,
- }
- }
- }
- })
- )
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['test']
- assert serialized_service['healthcheck'] == {
- 'test': ['NONE'],
- }
- def test_disable_with_other_config_is_invalid(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'invalid-healthcheck': {
- 'image': 'busybox',
- 'healthcheck': {
- 'disable': True,
- 'interval': '1s',
- }
- }
- }
- })
- )
- assert 'invalid-healthcheck' in excinfo.exconly()
- assert '"disable: true" cannot be combined with other options' in excinfo.exconly()
- def test_healthcheck_with_invalid_test(self):
- with pytest.raises(ConfigurationError) as excinfo:
- config.load(
- build_config_details({
- 'version': '2.3',
- 'services': {
- 'invalid-healthcheck': {
- 'image': 'busybox',
- 'healthcheck': {
- 'test': ['true'],
- 'interval': '1s',
- 'timeout': '1m',
- 'retries': 3,
- 'start_period': '10s',
- }
- }
- }
- })
- )
- assert 'invalid-healthcheck' in excinfo.exconly()
- assert 'the first item must be either NONE, CMD or CMD-SHELL' in excinfo.exconly()
- class GetDefaultConfigFilesTestCase(unittest.TestCase):
- files = [
- 'docker-compose.yml',
- 'docker-compose.yaml',
- ]
- def test_get_config_path_default_file_in_basedir(self):
- for index, filename in enumerate(self.files):
- assert filename == get_config_filename_for_files(self.files[index:])
- with pytest.raises(config.ComposeFileNotFound):
- get_config_filename_for_files([])
- def test_get_config_path_default_file_in_parent_dir(self):
- """Test with files placed in the subdir"""
- def get_config_in_subdir(files):
- return get_config_filename_for_files(files, subdir=True)
- for index, filename in enumerate(self.files):
- assert filename == get_config_in_subdir(self.files[index:])
- with pytest.raises(config.ComposeFileNotFound):
- get_config_in_subdir([])
- def get_config_filename_for_files(filenames, subdir=None):
- def make_files(dirname, filenames):
- for fname in filenames:
- with open(os.path.join(dirname, fname), 'w') as f:
- f.write('')
- project_dir = tempfile.mkdtemp()
- try:
- make_files(project_dir, filenames)
- if subdir:
- base_dir = tempfile.mkdtemp(dir=project_dir)
- else:
- base_dir = project_dir
- filename, = config.get_default_config_files(base_dir)
- return os.path.basename(filename)
- finally:
- shutil.rmtree(project_dir)
- class SerializeTest(unittest.TestCase):
- def test_denormalize_depends_on_v3(self):
- service_dict = {
- 'image': 'busybox',
- 'command': 'true',
- 'depends_on': {
- 'service2': {'condition': 'service_started'},
- 'service3': {'condition': 'service_started'},
- }
- }
- assert denormalize_service_dict(service_dict, V3_0) == {
- 'image': 'busybox',
- 'command': 'true',
- 'depends_on': ['service2', 'service3']
- }
- def test_denormalize_depends_on_v2_1(self):
- service_dict = {
- 'image': 'busybox',
- 'command': 'true',
- 'depends_on': {
- 'service2': {'condition': 'service_started'},
- 'service3': {'condition': 'service_started'},
- }
- }
- assert denormalize_service_dict(service_dict, V2_1) == service_dict
- def test_serialize_time(self):
- data = {
- 9: '9ns',
- 9000: '9us',
- 9000000: '9ms',
- 90000000: '90ms',
- 900000000: '900ms',
- 999999999: '999999999ns',
- 1000000000: '1s',
- 60000000000: '1m',
- 60000000001: '60000000001ns',
- 9000000000000: '150m',
- 90000000000000: '25h',
- }
- for k, v in data.items():
- assert serialize_ns_time_value(k) == v
- def test_denormalize_healthcheck(self):
- service_dict = {
- 'image': 'test',
- 'healthcheck': {
- 'test': 'exit 1',
- 'interval': '1m40s',
- 'timeout': '30s',
- 'retries': 5,
- 'start_period': '2s90ms'
- }
- }
- processed_service = config.process_service(config.ServiceConfig(
- '.', 'test', 'test', service_dict
- ))
- denormalized_service = denormalize_service_dict(processed_service, V2_3)
- assert denormalized_service['healthcheck']['interval'] == '100s'
- assert denormalized_service['healthcheck']['timeout'] == '30s'
- assert denormalized_service['healthcheck']['start_period'] == '2090ms'
- def test_denormalize_image_has_digest(self):
- service_dict = {
- 'image': 'busybox'
- }
- image_digest = 'busybox@sha256:abcde'
- assert denormalize_service_dict(service_dict, V3_0, image_digest) == {
- 'image': 'busybox@sha256:abcde'
- }
- def test_denormalize_image_no_digest(self):
- service_dict = {
- 'image': 'busybox'
- }
- assert denormalize_service_dict(service_dict, V3_0) == {
- 'image': 'busybox'
- }
- def test_serialize_secrets(self):
- service_dict = {
- 'image': 'example/web',
- 'secrets': [
- {'source': 'one'},
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- }
- ]
- }
- secrets_dict = {
- 'one': {'file': '/one.txt'},
- 'source': {'file': '/source.pem'},
- 'two': {'external': True},
- }
- config_dict = config.load(build_config_details({
- 'version': '3.1',
- 'services': {'web': service_dict},
- 'secrets': secrets_dict
- }))
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['web']
- assert secret_sort(serialized_service['secrets']) == secret_sort(service_dict['secrets'])
- assert 'secrets' in serialized_config
- assert serialized_config['secrets']['two'] == secrets_dict['two']
- def test_serialize_ports(self):
- config_dict = config.Config(version=V2_0, services=[
- {
- 'ports': [types.ServicePort('80', '8080', None, None, None)],
- 'image': 'alpine',
- 'name': 'web'
- }
- ], volumes={}, networks={}, secrets={}, configs={})
- serialized_config = yaml.load(serialize_config(config_dict))
- assert '8080:80/tcp' in serialized_config['services']['web']['ports']
- def test_serialize_configs(self):
- service_dict = {
- 'image': 'example/web',
- 'configs': [
- {'source': 'one'},
- {
- 'source': 'source',
- 'target': 'target',
- 'uid': '100',
- 'gid': '200',
- 'mode': 0o777,
- }
- ]
- }
- configs_dict = {
- 'one': {'file': '/one.txt'},
- 'source': {'file': '/source.pem'},
- 'two': {'external': True},
- }
- config_dict = config.load(build_config_details({
- 'version': '3.3',
- 'services': {'web': service_dict},
- 'configs': configs_dict
- }))
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['web']
- assert secret_sort(serialized_service['configs']) == secret_sort(service_dict['configs'])
- assert 'configs' in serialized_config
- assert serialized_config['configs']['two'] == configs_dict['two']
- def test_serialize_bool_string(self):
- cfg = {
- 'version': '2.2',
- 'services': {
- 'web': {
- 'image': 'example/web',
- 'command': 'true',
- 'environment': {'FOO': 'Y', 'BAR': 'on'}
- }
- }
- }
- config_dict = config.load(build_config_details(cfg))
- serialized_config = serialize_config(config_dict)
- assert 'command: "true"\n' in serialized_config
- assert 'FOO: "Y"\n' in serialized_config
- assert 'BAR: "on"\n' in serialized_config
- def test_serialize_escape_dollar_sign(self):
- cfg = {
- 'version': '2.2',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': 'echo $$FOO',
- 'environment': {
- 'CURRENCY': '$$'
- },
- 'entrypoint': ['$$SHELL', '-c'],
- }
- }
- }
- config_dict = config.load(build_config_details(cfg))
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['web']
- assert serialized_service['environment']['CURRENCY'] == '$$'
- assert serialized_service['command'] == 'echo $$FOO'
- assert serialized_service['entrypoint'][0] == '$$SHELL'
- def test_serialize_unicode_values(self):
- cfg = {
- 'version': '2.3',
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'command': 'echo 十六夜 咲夜'
- }
- }
- }
- config_dict = config.load(build_config_details(cfg))
- serialized_config = yaml.load(serialize_config(config_dict))
- serialized_service = serialized_config['services']['web']
- assert serialized_service['command'] == 'echo 十六夜 咲夜'
|