12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122 |
- """Test suite for supervisor.options"""
- import os
- import sys
- import tempfile
- import socket
- import unittest
- import signal
- import shutil
- import errno
- from supervisor.compat import StringIO
- from supervisor.compat import as_bytes
- from supervisor.tests.base import Mock, sentinel, patch
- from supervisor.loggers import LevelsByName
- from supervisor.tests.base import DummySupervisor
- from supervisor.tests.base import DummyLogger
- from supervisor.tests.base import DummyOptions
- from supervisor.tests.base import DummyPConfig
- from supervisor.tests.base import DummyProcess
- from supervisor.tests.base import DummySocketConfig
- from supervisor.tests.base import lstrip
- class OptionTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import Options
- return Options
- def _makeOptions(self, read_error=False):
- Options = self._getTargetClass()
- from supervisor.datatypes import integer
- class MyOptions(Options):
- master = {
- 'other': 41 }
- def __init__(self, read_error=read_error):
- self.read_error = read_error
- Options.__init__(self)
- class Foo(object): pass
- self.configroot = Foo()
- def read_config(self, fp):
- if self.read_error:
- raise ValueError(self.read_error)
- # Pretend we read it from file:
- self.configroot.__dict__.update(self.default_map)
- self.configroot.__dict__.update(self.master)
- options = MyOptions()
- options.configfile = StringIO()
- options.add(name='anoption', confname='anoption',
- short='o', long='option', default='default')
- options.add(name='other', confname='other', env='OTHER',
- short='p:', long='other=', handler=integer)
- return options
- def test_add_flag_not_None_handler_not_None(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(ValueError, inst.add, flag=True, handler=True)
- def test_add_flag_not_None_long_false_short_false(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- flag=True,
- long=False,
- short=False,
- )
- def test_add_flag_not_None_short_endswith_colon(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- flag=True,
- long=False,
- short=":",
- )
- def test_add_flag_not_None_long_endswith_equal(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- flag=True,
- long='=',
- short=False,
- )
- def test_add_inconsistent_short_long_options(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- long='=',
- short='abc',
- )
- def test_add_short_option_startswith_dash(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- long=False,
- short='-abc',
- )
- def test_add_short_option_too_long(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- long=False,
- short='abc',
- )
- def test_add_duplicate_short_option_key(self):
- cls = self._getTargetClass()
- inst = cls()
- inst.options_map = {'-a':True}
- self.assertRaises(
- ValueError,
- inst.add,
- long=False,
- short='a',
- )
- def test_add_long_option_startswith_dash(self):
- cls = self._getTargetClass()
- inst = cls()
- self.assertRaises(
- ValueError,
- inst.add,
- long='-abc',
- short=False,
- )
- def test_add_duplicate_long_option_key(self):
- cls = self._getTargetClass()
- inst = cls()
- inst.options_map = {'--abc':True}
- self.assertRaises(
- ValueError,
- inst.add,
- long='abc',
- short=False,
- )
- def test_searchpaths(self):
- options = self._makeOptions()
- self.assertEqual(len(options.searchpaths), 5)
- self.assertTrue('supervisord.conf' in options.searchpaths)
- self.assertTrue('etc/supervisord.conf' in options.searchpaths)
- self.assertTrue('/etc/supervisord.conf' in options.searchpaths)
- def test_options_and_args_order(self):
- # Only config file exists
- options = self._makeOptions()
- options.realize([])
- self.assertEqual(options.anoption, 'default')
- self.assertEqual(options.other, 41)
- # Env should trump config
- options = self._makeOptions()
- os.environ['OTHER'] = '42'
- options.realize([])
- self.assertEqual(options.other, 42)
- # Opt should trump both env (still set) and config
- options = self._makeOptions()
- options.realize(['-p', '43'])
- self.assertEqual(options.other, 43)
- del os.environ['OTHER']
- def test_config_reload(self):
- options = self._makeOptions()
- options.realize([])
- self.assertEqual(options.other, 41)
- options.master['other'] = 42
- options.process_config()
- self.assertEqual(options.other, 42)
- def test_config_reload_do_usage_false(self):
- options = self._makeOptions(read_error='error')
- self.assertRaises(ValueError, options.process_config,
- False)
- def test_config_reload_do_usage_true(self):
- options = self._makeOptions(read_error='error')
- exitcodes = []
- options.exit = lambda x: exitcodes.append(x)
- options.stderr = options.stdout = StringIO()
- options.configroot.anoption = 1
- options.configroot.other = 1
- options.process_config(True)
- self.assertEqual(exitcodes, [2])
- def test__set(self):
- from supervisor.options import Options
- options = Options()
- options._set('foo', 'bar', 0)
- self.assertEqual(options.foo, 'bar')
- self.assertEqual(options.attr_priorities['foo'], 0)
- options._set('foo', 'baz', 1)
- self.assertEqual(options.foo, 'baz')
- self.assertEqual(options.attr_priorities['foo'], 1)
- options._set('foo', 'gazonk', 0)
- self.assertEqual(options.foo, 'baz')
- self.assertEqual(options.attr_priorities['foo'], 1)
- options._set('foo', 'gazonk', 1)
- self.assertEqual(options.foo, 'gazonk')
- def test_missing_default_config(self):
- options = self._makeOptions()
- options.searchpaths = []
- exitcodes = []
- options.exit = lambda x: exitcodes.append(x)
- options.stderr = StringIO()
- options.default_configfile()
- self.assertEqual(exitcodes, [2])
- msg = "Error: No config file found at default paths"
- self.assertTrue(options.stderr.getvalue().startswith(msg))
- def test_default_config(self):
- options = self._makeOptions()
- with tempfile.NamedTemporaryFile() as f:
- options.searchpaths = [f.name]
- config = options.default_configfile()
- self.assertEqual(config, f.name)
- def test_help(self):
- options = self._makeOptions()
- exitcodes = []
- options.exit = lambda x: exitcodes.append(x)
- options.stdout = StringIO()
- options.progname = 'test_help'
- options.doc = 'A sample docstring for %s'
- options.help('')
- self.assertEqual(exitcodes, [0])
- msg = 'A sample docstring for test_help\n'
- self.assertEqual(options.stdout.getvalue(), msg)
- class ClientOptionsTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import ClientOptions
- return ClientOptions
- def _makeOne(self):
- return self._getTargetClass()()
- def test_no_config_file(self):
- """Making sure config file is not required."""
- instance = self._makeOne()
- instance.searchpaths = []
- exitcodes = []
- instance.exit = lambda x: exitcodes.append(x)
- instance.realize(args=['-s', 'http://localhost:9001', '-u', 'chris',
- '-p', '123'])
- self.assertEqual(exitcodes, [])
- self.assertEqual(instance.interactive, 1)
- self.assertEqual(instance.serverurl, 'http://localhost:9001')
- self.assertEqual(instance.username, 'chris')
- self.assertEqual(instance.password, '123')
- def test_options(self):
- tempdir = tempfile.gettempdir()
- s = lstrip("""[supervisorctl]
- serverurl=http://localhost:9001
- username=chris
- password=123
- prompt=mysupervisor
- history_file=%s/sc_history
- """ % tempdir)
- fp = StringIO(s)
- instance = self._makeOne()
- instance.configfile = fp
- instance.realize(args=[])
- self.assertEqual(instance.interactive, True)
- history_file = os.path.join(tempdir, 'sc_history')
- self.assertEqual(instance.history_file, history_file)
- options = instance.configroot.supervisorctl
- self.assertEqual(options.prompt, 'mysupervisor')
- self.assertEqual(options.serverurl, 'http://localhost:9001')
- self.assertEqual(options.username, 'chris')
- self.assertEqual(options.password, '123')
- self.assertEqual(options.history_file, history_file)
- def test_options_ignores_inline_comments(self):
- text = lstrip("""
- [supervisorctl]
- serverurl=http://localhost:9001 ;comment should not be in serverurl
- """)
- instance = self._makeOne()
- instance.configfile = StringIO(text)
- instance.realize(args=[])
- options = instance.configroot.supervisorctl
- self.assertEqual(options.serverurl, 'http://localhost:9001')
- def test_options_with_environment_expansions(self):
- s = lstrip("""[supervisorctl]
- serverurl=http://localhost:%(ENV_SERVER_PORT)s
- username=%(ENV_CLIENT_USER)s
- password=%(ENV_CLIENT_PASS)s
- prompt=%(ENV_CLIENT_PROMPT)s
- history_file=/path/to/histdir/.supervisorctl%(ENV_CLIENT_HIST_EXT)s
- """)
- fp = StringIO(s)
- instance = self._makeOne()
- instance.environ_expansions = {'ENV_HOME': tempfile.gettempdir(),
- 'ENV_USER': 'johndoe',
- 'ENV_SERVER_PORT': '9210',
- 'ENV_CLIENT_USER': 'someuser',
- 'ENV_CLIENT_PASS': 'passwordhere',
- 'ENV_CLIENT_PROMPT': 'xsupervisor',
- 'ENV_CLIENT_HIST_EXT': '.hist',
- }
- instance.configfile = fp
- instance.realize(args=[])
- self.assertEqual(instance.interactive, True)
- options = instance.configroot.supervisorctl
- self.assertEqual(options.prompt, 'xsupervisor')
- self.assertEqual(options.serverurl, 'http://localhost:9210')
- self.assertEqual(options.username, 'someuser')
- self.assertEqual(options.password, 'passwordhere')
- self.assertEqual(options.history_file, '/path/to/histdir/.supervisorctl.hist')
- def test_read_config_not_found(self):
- nonexistent = os.path.join(os.path.dirname(__file__), 'nonexistent')
- instance = self._makeOne()
- try:
- instance.read_config(nonexistent)
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertTrue("could not find config file" in exc.args[0])
- def test_read_config_unreadable(self):
- instance = self._makeOne()
- def dummy_open(fn, mode):
- raise IOError(errno.EACCES, 'Permission denied: %s' % fn)
- instance.open = dummy_open
- try:
- instance.read_config(__file__)
- self.fail("expected exception")
- except ValueError as exc:
- self.assertTrue("could not read config file" in exc.args[0])
- def test_read_config_no_supervisord_section_raises_valueerror(self):
- instance = self._makeOne()
- try:
- instance.read_config(StringIO())
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- ".ini file does not include supervisorctl section")
- def test_options_unixsocket_cli(self):
- fp = StringIO('[supervisorctl]')
- instance = self._makeOne()
- instance.configfile = fp
- instance.realize(args=['--serverurl', 'unix:///dev/null'])
- self.assertEqual(instance.serverurl, 'unix:///dev/null')
- def test_options_unixsocket_configfile(self):
- s = lstrip("""[supervisorctl]
- serverurl=unix:///dev/null
- """)
- fp = StringIO(s)
- instance = self._makeOne()
- instance.configfile = fp
- instance.realize(args=[])
- self.assertEqual(instance.serverurl, 'unix:///dev/null')
- class ServerOptionsTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import ServerOptions
- return ServerOptions
- def _makeOne(self):
- return self._getTargetClass()()
- def test_version(self):
- from supervisor.options import VERSION
- options = self._makeOne()
- options.stdout = StringIO()
- self.assertRaises(SystemExit, options.version, None)
- self.assertEqual(options.stdout.getvalue(), VERSION + '\n')
- def test_options(self):
- s = lstrip("""[inet_http_server]
- port=127.0.0.1:8999
- username=chrism
- password=foo
- [supervisord]
- directory=%(tempdir)s
- backofflimit=10
- user=root
- umask=022
- logfile=supervisord.log
- logfile_maxbytes=1000MB
- logfile_backups=5
- loglevel=error
- pidfile=supervisord.pid
- nodaemon=true
- identifier=fleeb
- childlogdir=%(tempdir)s
- nocleanup=true
- minfds=2048
- minprocs=300
- environment=FAKE_ENV_VAR=/some/path
- [program:cat1]
- command=/bin/cat
- priority=1
- autostart=true
- user=root
- stdout_logfile=/tmp/cat.log
- stopsignal=KILL
- stopwaitsecs=5
- startsecs=5
- startretries=10
- directory=/tmp
- umask=002
- [program:cat2]
- priority=2
- command=/bin/cat
- autostart=true
- autorestart=false
- stdout_logfile_maxbytes = 1024
- stdout_logfile_backups = 2
- stdout_logfile = /tmp/cat2.log
- [program:cat3]
- priority=3
- process_name = replaced
- command=/bin/cat
- autorestart=true
- exitcodes=0,1,127
- stopasgroup=true
- killasgroup=true
- [program:cat4]
- priority=4
- process_name = fleeb_%%(process_num)s
- numprocs = 2
- command = /bin/cat
- autorestart=unexpected
- [program:cat5]
- priority=5
- process_name = foo_%%(process_num)02d
- numprocs = 2
- numprocs_start = 1
- command = /bin/cat
- directory = /some/path/foo_%%(process_num)02d
- """ % {'tempdir':tempfile.gettempdir()})
- from supervisor import datatypes
- fp = StringIO(s)
- instance = self._makeOne()
- instance.configfile = fp
- instance.realize(args=[])
- options = instance.configroot.supervisord
- self.assertEqual(options.directory, tempfile.gettempdir())
- self.assertEqual(options.umask, 18) # 022 in Py2, 0o22 in Py3
- self.assertEqual(options.logfile, 'supervisord.log')
- self.assertEqual(options.logfile_maxbytes, 1000 * 1024 * 1024)
- self.assertEqual(options.logfile_backups, 5)
- self.assertEqual(options.loglevel, 40)
- self.assertEqual(options.pidfile, 'supervisord.pid')
- self.assertEqual(options.nodaemon, True)
- self.assertEqual(options.identifier, 'fleeb')
- self.assertEqual(options.childlogdir, tempfile.gettempdir())
- self.assertEqual(len(options.server_configs), 1)
- self.assertEqual(options.server_configs[0]['family'], socket.AF_INET)
- self.assertEqual(options.server_configs[0]['host'], '127.0.0.1')
- self.assertEqual(options.server_configs[0]['port'], 8999)
- self.assertEqual(options.server_configs[0]['username'], 'chrism')
- self.assertEqual(options.server_configs[0]['password'], 'foo')
- self.assertEqual(options.nocleanup, True)
- self.assertEqual(options.minfds, 2048)
- self.assertEqual(options.minprocs, 300)
- self.assertEqual(options.nocleanup, True)
- self.assertEqual(len(options.process_group_configs), 5)
- self.assertEqual(options.environment, dict(FAKE_ENV_VAR='/some/path'))
- cat1 = options.process_group_configs[0]
- self.assertEqual(cat1.name, 'cat1')
- self.assertEqual(cat1.priority, 1)
- self.assertEqual(len(cat1.process_configs), 1)
- proc1 = cat1.process_configs[0]
- self.assertEqual(proc1.name, 'cat1')
- self.assertEqual(proc1.command, '/bin/cat')
- self.assertEqual(proc1.priority, 1)
- self.assertEqual(proc1.autostart, True)
- self.assertEqual(proc1.autorestart, datatypes.RestartWhenExitUnexpected)
- self.assertEqual(proc1.startsecs, 5)
- self.assertEqual(proc1.startretries, 10)
- self.assertEqual(proc1.uid, 0)
- self.assertEqual(proc1.stdout_logfile, '/tmp/cat.log')
- self.assertEqual(proc1.stopsignal, signal.SIGKILL)
- self.assertEqual(proc1.stopwaitsecs, 5)
- self.assertEqual(proc1.stopasgroup, False)
- self.assertEqual(proc1.killasgroup, False)
- self.assertEqual(proc1.stdout_logfile_maxbytes,
- datatypes.byte_size('50MB'))
- self.assertEqual(proc1.stdout_logfile_backups, 10)
- self.assertEqual(proc1.exitcodes, [0,2])
- self.assertEqual(proc1.directory, '/tmp')
- self.assertEqual(proc1.umask, 2)
- self.assertEqual(proc1.environment, dict(FAKE_ENV_VAR='/some/path'))
- cat2 = options.process_group_configs[1]
- self.assertEqual(cat2.name, 'cat2')
- self.assertEqual(cat2.priority, 2)
- self.assertEqual(len(cat2.process_configs), 1)
- proc2 = cat2.process_configs[0]
- self.assertEqual(proc2.name, 'cat2')
- self.assertEqual(proc2.command, '/bin/cat')
- self.assertEqual(proc2.priority, 2)
- self.assertEqual(proc2.autostart, True)
- self.assertEqual(proc2.autorestart, False)
- self.assertEqual(proc2.uid, None)
- self.assertEqual(proc2.stdout_logfile, '/tmp/cat2.log')
- self.assertEqual(proc2.stopsignal, signal.SIGTERM)
- self.assertEqual(proc2.stopasgroup, False)
- self.assertEqual(proc2.killasgroup, False)
- self.assertEqual(proc2.stdout_logfile_maxbytes, 1024)
- self.assertEqual(proc2.stdout_logfile_backups, 2)
- self.assertEqual(proc2.exitcodes, [0,2])
- self.assertEqual(proc2.directory, None)
- cat3 = options.process_group_configs[2]
- self.assertEqual(cat3.name, 'cat3')
- self.assertEqual(cat3.priority, 3)
- self.assertEqual(len(cat3.process_configs), 1)
- proc3 = cat3.process_configs[0]
- self.assertEqual(proc3.name, 'replaced')
- self.assertEqual(proc3.command, '/bin/cat')
- self.assertEqual(proc3.priority, 3)
- self.assertEqual(proc3.autostart, True)
- self.assertEqual(proc3.autorestart, datatypes.RestartUnconditionally)
- self.assertEqual(proc3.uid, None)
- self.assertEqual(proc3.stdout_logfile, datatypes.Automatic)
- self.assertEqual(proc3.stdout_logfile_maxbytes,
- datatypes.byte_size('50MB'))
- self.assertEqual(proc3.stdout_logfile_backups, 10)
- self.assertEqual(proc3.exitcodes, [0,1,127])
- self.assertEqual(proc3.stopsignal, signal.SIGTERM)
- self.assertEqual(proc3.stopasgroup, True)
- self.assertEqual(proc3.killasgroup, True)
- cat4 = options.process_group_configs[3]
- self.assertEqual(cat4.name, 'cat4')
- self.assertEqual(cat4.priority, 4)
- self.assertEqual(len(cat4.process_configs), 2)
- proc4_a = cat4.process_configs[0]
- self.assertEqual(proc4_a.name, 'fleeb_0')
- self.assertEqual(proc4_a.command, '/bin/cat')
- self.assertEqual(proc4_a.priority, 4)
- self.assertEqual(proc4_a.autostart, True)
- self.assertEqual(proc4_a.autorestart,
- datatypes.RestartWhenExitUnexpected)
- self.assertEqual(proc4_a.uid, None)
- self.assertEqual(proc4_a.stdout_logfile, datatypes.Automatic)
- self.assertEqual(proc4_a.stdout_logfile_maxbytes,
- datatypes.byte_size('50MB'))
- self.assertEqual(proc4_a.stdout_logfile_backups, 10)
- self.assertEqual(proc4_a.exitcodes, [0,2])
- self.assertEqual(proc4_a.stopsignal, signal.SIGTERM)
- self.assertEqual(proc4_a.stopasgroup, False)
- self.assertEqual(proc4_a.killasgroup, False)
- self.assertEqual(proc4_a.directory, None)
- proc4_b = cat4.process_configs[1]
- self.assertEqual(proc4_b.name, 'fleeb_1')
- self.assertEqual(proc4_b.command, '/bin/cat')
- self.assertEqual(proc4_b.priority, 4)
- self.assertEqual(proc4_b.autostart, True)
- self.assertEqual(proc4_b.autorestart,
- datatypes.RestartWhenExitUnexpected)
- self.assertEqual(proc4_b.uid, None)
- self.assertEqual(proc4_b.stdout_logfile, datatypes.Automatic)
- self.assertEqual(proc4_b.stdout_logfile_maxbytes,
- datatypes.byte_size('50MB'))
- self.assertEqual(proc4_b.stdout_logfile_backups, 10)
- self.assertEqual(proc4_b.exitcodes, [0,2])
- self.assertEqual(proc4_b.stopsignal, signal.SIGTERM)
- self.assertEqual(proc4_b.stopasgroup, False)
- self.assertEqual(proc4_b.killasgroup, False)
- self.assertEqual(proc4_b.directory, None)
- cat5 = options.process_group_configs[4]
- self.assertEqual(cat5.name, 'cat5')
- self.assertEqual(cat5.priority, 5)
- self.assertEqual(len(cat5.process_configs), 2)
- proc5_a = cat5.process_configs[0]
- self.assertEqual(proc5_a.name, 'foo_01')
- self.assertEqual(proc5_a.directory, '/some/path/foo_01')
- proc5_b = cat5.process_configs[1]
- self.assertEqual(proc5_b.name, 'foo_02')
- self.assertEqual(proc5_b.directory, '/some/path/foo_02')
- here = os.path.abspath(os.getcwd())
- self.assertEqual(instance.uid, 0)
- self.assertEqual(instance.gid, 0)
- self.assertEqual(instance.directory, tempfile.gettempdir())
- self.assertEqual(instance.umask, 18) # 022 in Py2, 0o22 in Py3
- self.assertEqual(instance.logfile, os.path.join(here,'supervisord.log'))
- self.assertEqual(instance.logfile_maxbytes, 1000 * 1024 * 1024)
- self.assertEqual(instance.logfile_backups, 5)
- self.assertEqual(instance.loglevel, 40)
- self.assertEqual(instance.pidfile, os.path.join(here,'supervisord.pid'))
- self.assertEqual(instance.nodaemon, True)
- self.assertEqual(instance.passwdfile, None)
- self.assertEqual(instance.identifier, 'fleeb')
- self.assertEqual(instance.childlogdir, tempfile.gettempdir())
- self.assertEqual(len(instance.server_configs), 1)
- self.assertEqual(instance.server_configs[0]['family'], socket.AF_INET)
- self.assertEqual(instance.server_configs[0]['host'], '127.0.0.1')
- self.assertEqual(instance.server_configs[0]['port'], 8999)
- self.assertEqual(instance.server_configs[0]['username'], 'chrism')
- self.assertEqual(instance.server_configs[0]['password'], 'foo')
- self.assertEqual(instance.nocleanup, True)
- self.assertEqual(instance.minfds, 2048)
- self.assertEqual(instance.minprocs, 300)
- def test_options_ignores_inline_comments(self):
- text = lstrip("""
- [supervisord]
- identifier=foo ;comment should not be in identifier
- """)
- instance = self._makeOne()
- instance.configfile = StringIO(text)
- instance.realize(args=[])
- options = instance.configroot.supervisord
- self.assertEqual(options.identifier, 'foo')
- def test_reload(self):
- text = lstrip("""\
- [supervisord]
- user=root
- [program:one]
- command = /bin/cat
- [program:two]
- command = /bin/dog
- [program:four]
- command = /bin/sheep
- [group:thegroup]
- programs = one,two
- """)
- instance = self._makeOne()
- instance.configfile = StringIO(text)
- instance.realize(args=[])
- section = instance.configroot.supervisord
- self.assertEqual(len(section.process_group_configs), 2)
- cat = section.process_group_configs[0]
- self.assertEqual(len(cat.process_configs), 1)
- cat = section.process_group_configs[1]
- self.assertEqual(len(cat.process_configs), 2)
- self.assertTrue(section.process_group_configs is
- instance.process_group_configs)
- text = lstrip("""\
- [supervisord]
- user=root
- [program:one]
- command = /bin/cat
- [program:three]
- command = /bin/pig
- [group:thegroup]
- programs = three
- """)
- instance.configfile = StringIO(text)
- instance.process_config()
- section = instance.configroot.supervisord
- self.assertEqual(len(section.process_group_configs), 2)
- cat = section.process_group_configs[0]
- self.assertEqual(len(cat.process_configs), 1)
- proc = cat.process_configs[0]
- self.assertEqual(proc.name, 'one')
- self.assertEqual(proc.command, '/bin/cat')
- self.assertTrue(section.process_group_configs is
- instance.process_group_configs)
- cat = section.process_group_configs[1]
- self.assertEqual(len(cat.process_configs), 1)
- proc = cat.process_configs[0]
- self.assertEqual(proc.name, 'three')
- self.assertEqual(proc.command, '/bin/pig')
- def test_reload_clears_parse_warnings(self):
- instance = self._makeOne()
- old_warning = "Warning from a prior config read"
- instance.parse_warnings = [old_warning]
- text = lstrip("""\
- [supervisord]
- user=root
- [program:cat]
- command = /bin/cat
- """)
- instance.configfile = StringIO(text)
- instance.realize(args=[])
- self.assertFalse(old_warning in instance.parse_warnings)
- def test_reload_clears_parse_infos(self):
- instance = self._makeOne()
- old_info = "Info from a prior config read"
- instance.infos = [old_info]
- text = lstrip("""\
- [supervisord]
- user=root
- [program:cat]
- command = /bin/cat
- """)
- instance.configfile = StringIO(text)
- instance.realize(args=[])
- self.assertFalse(old_info in instance.parse_infos)
- def test_read_config_not_found(self):
- nonexistent = os.path.join(os.path.dirname(__file__), 'nonexistent')
- instance = self._makeOne()
- try:
- instance.read_config(nonexistent)
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertTrue("could not find config file" in exc.args[0])
- def test_read_config_unreadable(self):
- instance = self._makeOne()
- def dummy_open(fn, mode):
- raise IOError(errno.EACCES, 'Permission denied: %s' % fn)
- instance.open = dummy_open
- try:
- instance.read_config(__file__)
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertTrue("could not read config file" in exc.args[0])
- def test_read_config_malformed_config_file_raises_valueerror(self):
- instance = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- try:
- f.write("[supervisord]\njunk")
- f.flush()
- instance.read_config(f.name)
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertTrue('contains parsing errors:' in exc.args[0])
- self.assertTrue(f.name in exc.args[0])
- def test_read_config_no_supervisord_section_raises_valueerror(self):
- instance = self._makeOne()
- try:
- instance.read_config(StringIO())
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- ".ini file does not include supervisord section")
- def test_read_config_include_with_no_files_raises_valueerror(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [include]
- ;no files=
- """)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- ".ini file has [include] section, but no files setting")
- def test_read_config_include_with_no_matching_files_logs_warning(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [include]
- files=nonexistent/*
- """)
- instance.read_config(StringIO(text))
- self.assertEqual(instance.parse_warnings,
- ['No file matches via include "./nonexistent/*"'])
- def test_read_config_include_reads_extra_files(self):
- dirname = tempfile.mkdtemp()
- conf_d = os.path.join(dirname, "conf.d")
- os.mkdir(conf_d)
- supervisord_conf = os.path.join(dirname, "supervisord.conf")
- text = lstrip("""\
- [supervisord]
- [include]
- files=%s/conf.d/*.conf %s/conf.d/*.ini
- """ % (dirname, dirname))
- with open(supervisord_conf, 'w') as f:
- f.write(text)
- conf_file = os.path.join(conf_d, "a.conf")
- with open(conf_file, 'w') as f:
- f.write("[inet_http_server]\nport=8000\n")
- ini_file = os.path.join(conf_d, "a.ini")
- with open(ini_file, 'w') as f:
- f.write("[unix_http_server]\nfile=/tmp/file\n")
- instance = self._makeOne()
- try:
- instance.read_config(supervisord_conf)
- options = instance.configroot.supervisord
- self.assertEqual(len(options.server_configs), 2)
- msg = 'Included extra file "%s" during parsing' % conf_file
- self.assertTrue(msg in instance.parse_infos)
- msg = 'Included extra file "%s" during parsing' % ini_file
- self.assertTrue(msg in instance.parse_infos)
- finally:
- shutil.rmtree(dirname)
- def test_include_reads_files_in_sorted_order(self):
- dirname = tempfile.mkdtemp()
- conf_d = os.path.join(dirname, "conf.d")
- os.mkdir(conf_d)
- supervisord_conf = os.path.join(dirname, "supervisord.conf")
- text = lstrip("""\
- [supervisord]
- [include]
- files=%s/conf.d/*.conf
- """ % dirname)
- with open(supervisord_conf, 'w') as f:
- f.write(text)
- from supervisor.compat import letters
- a_z = letters[:26]
- for letter in reversed(a_z):
- filename = os.path.join(conf_d, "%s.conf" % letter)
- with open(filename, "w") as f:
- f.write("[program:%s]\n"
- "command=/bin/%s\n" % (letter, letter))
- instance = self._makeOne()
- try:
- instance.read_config(supervisord_conf)
- expected_msgs = []
- for letter in sorted(a_z):
- filename = os.path.join(conf_d, "%s.conf" % letter)
- expected_msgs.append(
- 'Included extra file "%s" during parsing' % filename)
- self.assertEqual(instance.parse_infos, expected_msgs)
- finally:
- shutil.rmtree(dirname)
- def test_read_config_include_extra_file_malformed(self):
- dirname = tempfile.mkdtemp()
- conf_d = os.path.join(dirname, "conf.d")
- os.mkdir(conf_d)
- supervisord_conf = os.path.join(dirname, "supervisord.conf")
- text = lstrip("""\
- [supervisord]
- [include]
- files=%s/conf.d/*.conf
- """ % dirname)
- with open(supervisord_conf, 'w') as f:
- f.write(text)
- malformed_file = os.path.join(conf_d, "a.conf")
- with open(malformed_file, 'w') as f:
- f.write("[inet_http_server]\njunk\n")
- instance = self._makeOne()
- try:
- instance.read_config(supervisord_conf)
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertTrue('contains parsing errors:' in exc.args[0])
- self.assertTrue(malformed_file in exc.args[0])
- msg = 'Included extra file "%s" during parsing' % malformed_file
- self.assertTrue(msg in instance.parse_infos)
- finally:
- shutil.rmtree(dirname)
- def test_readFile_failed(self):
- from supervisor.options import readFile
- try:
- readFile('/notthere', 0, 10)
- except ValueError as inst:
- self.assertEqual(inst.args[0], 'FAILED')
- else:
- raise AssertionError("Didn't raise")
- def test_get_pid(self):
- instance = self._makeOne()
- self.assertEqual(os.getpid(), instance.get_pid())
- def test_get_signal_delegates_to_signal_receiver(self):
- instance = self._makeOne()
- instance.signal_receiver.receive(signal.SIGTERM, None)
- instance.signal_receiver.receive(signal.SIGCHLD, None)
- self.assertEqual(instance.get_signal(), signal.SIGTERM)
- self.assertEqual(instance.get_signal(), signal.SIGCHLD)
- self.assertEqual(instance.get_signal(), None)
- def test_check_execv_args_cant_find_command(self):
- instance = self._makeOne()
- from supervisor.options import NotFound
- self.assertRaises(NotFound, instance.check_execv_args,
- '/not/there', None, None)
- def test_check_execv_args_notexecutable(self):
- instance = self._makeOne()
- from supervisor.options import NotExecutable
- self.assertRaises(NotExecutable,
- instance.check_execv_args, '/etc/passwd',
- ['etc/passwd'], os.stat('/etc/passwd'))
- def test_check_execv_args_isdir(self):
- instance = self._makeOne()
- from supervisor.options import NotExecutable
- self.assertRaises(NotExecutable,
- instance.check_execv_args, '/',
- ['/'], os.stat('/'))
- def test_realize_positional_args_not_supported(self):
- instance = self._makeOne()
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.configfile=StringIO('[supervisord]')
- args = ['foo', 'bar']
- instance.realize(args=args)
- self.assertEqual(len(recorder), 1)
- self.assertEqual(recorder[0],
- 'positional arguments are not supported: %s' % args)
- def test_realize_getopt_error(self):
- instance = self._makeOne()
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.configfile=StringIO('[supervisord]')
- instance.realize(args=["--bad=1"])
- self.assertEqual(len(recorder), 1)
- self.assertEqual(recorder[0],
- "GetoptError('option --bad not recognized', 'bad')")
- def test_options_afunix(self):
- instance = self._makeOne()
- text = lstrip("""\
- [unix_http_server]
- file=/tmp/supvtest.sock
- username=johndoe
- password=passwordhere
- [supervisord]
- ; ...
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance.configfile = StringIO(text)
- instance.read_config(StringIO(text))
- instance.realize(args=[])
- # unix_http_server
- options = instance.configroot.supervisord
- self.assertEqual(options.server_configs[0]['family'], socket.AF_UNIX)
- self.assertEqual(options.server_configs[0]['file'], '/tmp/supvtest.sock')
- self.assertEqual(options.server_configs[0]['chmod'], 448) # defaults
- self.assertEqual(options.server_configs[0]['chown'], (-1,-1)) # defaults
- def test_options_afunix_chxxx_values_valid(self):
- instance = self._makeOne()
- text = lstrip("""\
- [unix_http_server]
- file=/tmp/supvtest.sock
- username=johndoe
- password=passwordhere
- chmod=0755
- [supervisord]
- ; ...
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance.configfile = StringIO(text)
- instance.read_config(StringIO(text))
- instance.realize(args=[])
- # unix_http_server
- options = instance.configroot.supervisord
- self.assertEqual(options.server_configs[0]['family'], socket.AF_UNIX)
- self.assertEqual(options.server_configs[0]['file'], '/tmp/supvtest.sock')
- self.assertEqual(options.server_configs[0]['chmod'], 493)
- def test_options_afunix_chmod_bad(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [unix_http_server]
- file=/tmp/file
- chmod=NaN
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "Invalid chmod value NaN")
- def test_options_afunix_chown_bad(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [unix_http_server]
- file=/tmp/file
- chown=thisisnotavaliduser
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "Invalid sockchown value thisisnotavaliduser")
- def test_options_afunix_no_file(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [unix_http_server]
- ;no file=
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "section [unix_http_server] has no file value")
- def test_options_afunix_password_without_username(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [unix_http_server]
- file=/tmp/supvtest.sock
- password=passwordhere
- chmod=0755
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "Must specify username if password is specified "
- "in [unix_http_server]")
- def test_options_afinet_password_without_username(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [inet_http_server]
- password=passwordhere
- ;no username=
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "Must specify username if password is specified "
- "in [inet_http_server]")
- def test_options_afinet_no_port(self):
- instance = self._makeOne()
- text = lstrip("""\
- [supervisord]
- [inet_http_server]
- ;no port=
- """)
- instance.configfile = StringIO(text)
- try:
- instance.read_config(StringIO(text))
- self.fail("nothing raised")
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- "section [inet_http_server] has no port value")
- def test_cleanup_afunix_unlink(self):
- fn = tempfile.mktemp()
- with open(fn, 'w') as f:
- f.write('foo')
- instance = self._makeOne()
- class Server:
- pass
- instance.httpservers = [({'family':socket.AF_UNIX, 'file':fn},
- Server())]
- instance.pidfile = ''
- instance.cleanup()
- self.assertFalse(os.path.exists(fn))
- def test_cleanup_afunix_nounlink(self):
- fn = tempfile.mktemp()
- try:
- with open(fn, 'w') as f:
- f.write('foo')
- instance = self._makeOne()
- class Server:
- pass
- instance.httpservers = [({'family':socket.AF_UNIX, 'file':fn},
- Server())]
- instance.pidfile = ''
- instance.unlink_socketfiles = False
- instance.cleanup()
- self.assertTrue(os.path.exists(fn))
- finally:
- try:
- os.unlink(fn)
- except OSError:
- pass
- def test_cleanup_afunix_ignores_oserror_enoent(self):
- notfound = os.path.join(os.path.dirname(__file__), 'notfound')
- socketname = tempfile.mktemp()
- try:
- with open(socketname, 'w') as f:
- f.write('foo')
- instance = self._makeOne()
- class Server:
- pass
- instance.httpservers = [
- ({'family': socket.AF_UNIX, 'file': notfound}, Server()),
- ({'family': socket.AF_UNIX, 'file': socketname}, Server()),
- ]
- instance.pidfile = ''
- instance.cleanup()
- self.assertFalse(os.path.exists(socketname))
- finally:
- try:
- os.unlink(socketname)
- except OSError:
- pass
- def test_cleanup_removes_pidfile(self):
- pidfile = tempfile.mktemp()
- try:
- with open(pidfile, 'w') as f:
- f.write('2')
- instance = self._makeOne()
- instance.pidfile = pidfile
- instance.cleanup()
- self.assertFalse(os.path.exists(pidfile))
- finally:
- try:
- os.unlink(pidfile)
- except OSError:
- pass
- def test_cleanup_pidfile_ignores_oserror_enoent(self):
- notfound = os.path.join(os.path.dirname(__file__), 'notfound')
- instance = self._makeOne()
- instance.pidfile = notfound
- instance.cleanup() # shouldn't raise
- def test_cleanup_fds_closes_5_upto_minfds_ignores_oserror(self):
- instance = self._makeOne()
- instance.minfds = 10
- closed = []
- def close(fd):
- if fd == 7:
- raise OSError
- closed.append(fd)
- @patch('os.close', close)
- def f():
- instance.cleanup_fds()
- f()
- self.assertEqual(closed, [5,6,8,9])
- def test_close_httpservers(self):
- instance = self._makeOne()
- class Server:
- closed = False
- def close(self):
- self.closed = True
- server = Server()
- instance.httpservers = [({}, server)]
- instance.close_httpservers()
- self.assertEqual(server.closed, True)
- def test_close_logger(self):
- instance = self._makeOne()
- logger = DummyLogger()
- instance.logger = logger
- instance.close_logger()
- self.assertEqual(logger.closed, True)
- def test_close_parent_pipes(self):
- instance = self._makeOne()
- closed = []
- def close_fd(fd):
- closed.append(fd)
- instance.close_fd = close_fd
- pipes = {'stdin': 0, 'stdout': 1, 'stderr': 2,
- 'child_stdin': 3, 'child_stdout': 4, 'child_stderr': 5}
- instance.close_parent_pipes(pipes)
- self.assertEqual(sorted(closed), [0, 1, 2])
- def test_close_parent_pipes_ignores_fd_of_none(self):
- instance = self._makeOne()
- closed = []
- def close_fd(fd):
- closed.append(fd)
- instance.close_fd = close_fd
- pipes = {'stdin': None}
- instance.close_parent_pipes(pipes)
- self.assertEqual(closed, [])
- def test_close_child_pipes(self):
- instance = self._makeOne()
- closed = []
- def close_fd(fd):
- closed.append(fd)
- instance.close_fd = close_fd
- pipes = {'stdin': 0, 'stdout': 1, 'stderr': 2,
- 'child_stdin': 3, 'child_stdout': 4, 'child_stderr': 5}
- instance.close_child_pipes(pipes)
- self.assertEqual(sorted(closed), [3, 4, 5])
- def test_close_child_pipes_ignores_fd_of_none(self):
- instance = self._makeOne()
- closed = []
- def close_fd(fd):
- closed.append(fd)
- instance.close_fd = close_fd
- pipes = {'child_stdin': None}
- instance.close_parent_pipes(pipes)
- self.assertEqual(sorted(closed), [])
- def test_reopenlogs(self):
- instance = self._makeOne()
- logger = DummyLogger()
- logger.handlers = [DummyLogger()]
- instance.logger = logger
- instance.reopenlogs()
- self.assertEqual(logger.handlers[0].reopened, True)
- self.assertEqual(logger.data[0], 'supervisord logreopen')
- def test_write_pidfile_ok(self):
- fn = tempfile.mktemp()
- try:
- instance = self._makeOne()
- instance.logger = DummyLogger()
- instance.pidfile = fn
- instance.write_pidfile()
- self.assertTrue(os.path.exists(fn))
- with open(fn, 'r') as f:
- pid = int(f.read().strip())
- self.assertEqual(pid, os.getpid())
- msg = instance.logger.data[0]
- self.assertTrue(msg.startswith('supervisord started with pid'))
- finally:
- try:
- os.unlink(fn)
- except OSError:
- pass
- def test_write_pidfile_fail(self):
- fn = '/cannot/possibly/exist'
- instance = self._makeOne()
- instance.logger = DummyLogger()
- instance.pidfile = fn
- instance.write_pidfile()
- msg = instance.logger.data[0]
- self.assertTrue(msg.startswith('could not write pidfile'))
- def test_close_fd(self):
- instance = self._makeOne()
- innie, outie = os.pipe()
- os.read(innie, 0) # we can read it while its open
- os.write(outie, as_bytes('foo')) # we can write to it while its open
- instance.close_fd(innie)
- self.assertRaises(OSError, os.read, innie, 0)
- instance.close_fd(outie)
- self.assertRaises(OSError, os.write, outie, as_bytes('foo'))
- @patch('os.close', Mock(side_effect=OSError))
- def test_close_fd_ignores_oserror(self):
- instance = self._makeOne()
- instance.close_fd(0) # shouldn't raise
- def test_processes_from_section(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- priority = 1
- autostart = false
- autorestart = false
- startsecs = 100
- startretries = 100
- user = root
- stdout_logfile = NONE
- stdout_logfile_backups = 1
- stdout_logfile_maxbytes = 100MB
- stdout_events_enabled = true
- stopsignal = KILL
- stopwaitsecs = 100
- killasgroup = true
- exitcodes = 1,4
- redirect_stderr = false
- environment = KEY1=val1,KEY2=val2,KEY3=%(process_num)s
- numprocs = 2
- process_name = %(group_name)s_%(program_name)s_%(process_num)02d
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(len(pconfigs), 2)
- pconfig = pconfigs[0]
- self.assertEqual(pconfig.name, 'bar_foo_00')
- self.assertEqual(pconfig.command, '/bin/cat')
- self.assertEqual(pconfig.autostart, False)
- self.assertEqual(pconfig.autorestart, False)
- self.assertEqual(pconfig.startsecs, 100)
- self.assertEqual(pconfig.startretries, 100)
- self.assertEqual(pconfig.uid, 0)
- self.assertEqual(pconfig.stdout_logfile, None)
- self.assertEqual(pconfig.stdout_capture_maxbytes, 0)
- self.assertEqual(pconfig.stdout_logfile_maxbytes, 104857600)
- self.assertEqual(pconfig.stdout_events_enabled, True)
- self.assertEqual(pconfig.stopsignal, signal.SIGKILL)
- self.assertEqual(pconfig.stopasgroup, False)
- self.assertEqual(pconfig.killasgroup, True)
- self.assertEqual(pconfig.stopwaitsecs, 100)
- self.assertEqual(pconfig.exitcodes, [1,4])
- self.assertEqual(pconfig.redirect_stderr, False)
- self.assertEqual(pconfig.environment,
- {'KEY1':'val1', 'KEY2':'val2', 'KEY3':'0'})
- def test_processes_from_section_host_node_name_expansion(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo --host=%(host_node_name)s
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- import platform
- expected = "/bin/foo --host=" + platform.node()
- self.assertEqual(pconfigs[0].command, expected)
- def test_processes_from_section_process_num_expansion(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo --num=%(process_num)d
- directory = /tmp/foo_%(process_num)d
- stderr_logfile = /tmp/foo_%(process_num)d_stderr
- stdout_logfile = /tmp/foo_%(process_num)d_stdout
- environment = NUM=%(process_num)d
- process_name = foo_%(process_num)d
- numprocs = 2
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(len(pconfigs), 2)
- for num in (0, 1):
- self.assertEqual(pconfigs[num].name, 'foo_%d' % num)
- self.assertEqual(pconfigs[num].command, "/bin/foo --num=%d" % num)
- self.assertEqual(pconfigs[num].directory, '/tmp/foo_%d' % num)
- self.assertEqual(pconfigs[num].stderr_logfile,
- '/tmp/foo_%d_stderr' % num)
- self.assertEqual(pconfigs[num].stdout_logfile,
- '/tmp/foo_%d_stdout' % num)
- self.assertEqual(pconfigs[num].environment, {'NUM': '%d' % num})
- def test_processes_from_section_expands_directory(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- directory = /tmp/%(ENV_FOO)s
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.expansions = {'ENV_FOO': 'bar'}
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(pconfigs[0].directory, '/tmp/bar')
- def test_processes_from_section_environment_variables_expansion(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo --path='%(ENV_PATH)s'
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- expected = "/bin/foo --path='%s'" % os.environ['PATH']
- self.assertEqual(pconfigs[0].command, expected)
- def test_processes_from_section_expands_env_in_environment(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo
- environment = PATH='/foo/bar:%(ENV_PATH)s'
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- expected = "/foo/bar:%s" % os.environ['PATH']
- self.assertEqual(pconfigs[0].environment['PATH'], expected)
- def test_processes_from_section_redirect_stderr_with_filename(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo
- redirect_stderr = true
- stderr_logfile = /tmp/logfile
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(instance.parse_warnings[0],
- 'For [program:foo], redirect_stderr=true but stderr_logfile has '
- 'also been set to a filename, the filename has been ignored')
- self.assertEqual(pconfigs[0].stderr_logfile, None)
- def test_processes_from_section_redirect_stderr_with_auto(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo
- redirect_stderr = true
- stderr_logfile = auto
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(instance.parse_warnings, [])
- self.assertEqual(pconfigs[0].stderr_logfile, None)
- def test_options_with_environment_expansions(self):
- text = lstrip("""\
- [inet_http_server]
- port=*:%(ENV_HTSRV_PORT)s
- username=%(ENV_HTSRV_USER)s
- password=%(ENV_HTSRV_PASS)s
- [supervisord]
- logfile = %(ENV_HOME)s/supervisord.log
- logfile_maxbytes = %(ENV_SUPD_LOGFILE_MAXBYTES)s
- logfile_backups = %(ENV_SUPD_LOGFILE_BACKUPS)s
- loglevel = %(ENV_SUPD_LOGLEVEL)s
- nodaemon = %(ENV_SUPD_NODAEMON)s
- minfds = %(ENV_SUPD_MINFDS)s
- minprocs = %(ENV_SUPD_MINPROCS)s
- umask = %(ENV_SUPD_UMASK)s
- identifier = supervisor_%(ENV_USER)s
- nocleanup = %(ENV_SUPD_NOCLEANUP)s
- childlogdir = %(ENV_HOME)s
- strip_ansi = %(ENV_SUPD_STRIP_ANSI)s
- environment = FAKE_ENV_VAR=/some/path
- [program:cat1]
- command=%(ENV_CAT1_COMMAND)s --logdir=%(ENV_CAT1_COMMAND_LOGDIR)s
- priority=%(ENV_CAT1_PRIORITY)s
- autostart=%(ENV_CAT1_AUTOSTART)s
- user=%(ENV_CAT1_USER)s
- stdout_logfile=%(ENV_CAT1_STDOUT_LOGFILE)s
- stdout_logfile_maxbytes = %(ENV_CAT1_STDOUT_LOGFILE_MAXBYTES)s
- stdout_logfile_backups = %(ENV_CAT1_STDOUT_LOGFILE_BACKUPS)s
- stopsignal=%(ENV_CAT1_STOPSIGNAL)s
- stopwaitsecs=%(ENV_CAT1_STOPWAIT)s
- startsecs=%(ENV_CAT1_STARTWAIT)s
- startretries=%(ENV_CAT1_STARTRETRIES)s
- directory=%(ENV_CAT1_DIR)s
- umask=%(ENV_CAT1_UMASK)s
- """)
- from supervisor import datatypes
- from supervisor.options import UnhosedConfigParser
- instance = self._makeOne()
- instance.environ_expansions = {
- 'ENV_HOME': tempfile.gettempdir(),
- 'ENV_USER': 'johndoe',
- 'ENV_HTSRV_PORT': '9210',
- 'ENV_HTSRV_USER': 'someuser',
- 'ENV_HTSRV_PASS': 'passwordhere',
- 'ENV_SUPD_LOGFILE_MAXBYTES': '51MB',
- 'ENV_SUPD_LOGFILE_BACKUPS': '10',
- 'ENV_SUPD_LOGLEVEL': 'info',
- 'ENV_SUPD_NODAEMON': 'false',
- 'ENV_SUPD_MINFDS': '1024',
- 'ENV_SUPD_MINPROCS': '200',
- 'ENV_SUPD_UMASK': '002',
- 'ENV_SUPD_NOCLEANUP': 'true',
- 'ENV_SUPD_STRIP_ANSI': 'false',
- 'ENV_CAT1_COMMAND': '/bin/customcat',
- 'ENV_CAT1_COMMAND_LOGDIR': '/path/to/logs',
- 'ENV_CAT1_PRIORITY': '3',
- 'ENV_CAT1_AUTOSTART': 'true',
- 'ENV_CAT1_USER': 'root', # resolved to uid
- 'ENV_CAT1_STDOUT_LOGFILE': '/tmp/cat.log',
- 'ENV_CAT1_STDOUT_LOGFILE_MAXBYTES': '78KB',
- 'ENV_CAT1_STDOUT_LOGFILE_BACKUPS': '2',
- 'ENV_CAT1_STOPSIGNAL': 'KILL',
- 'ENV_CAT1_STOPWAIT': '5',
- 'ENV_CAT1_STARTWAIT': '5',
- 'ENV_CAT1_STARTRETRIES': '10',
- 'ENV_CAT1_DIR': '/tmp',
- 'ENV_CAT1_UMASK': '002',
- }
- config = UnhosedConfigParser()
- config.expansions = instance.environ_expansions
- config.read_string(text)
- instance.configfile = StringIO(text)
- instance.read_config(StringIO(text))
- instance.realize(args=[])
- # supervisord
- self.assertEqual(instance.logfile,
- '%(ENV_HOME)s/supervisord.log' % config.expansions)
- self.assertEqual(instance.identifier,
- 'supervisor_%(ENV_USER)s' % config.expansions)
- self.assertEqual(instance.logfile_maxbytes, 53477376)
- self.assertEqual(instance.logfile_backups, 10)
- self.assertEqual(instance.loglevel, LevelsByName.INFO)
- self.assertEqual(instance.nodaemon, False)
- self.assertEqual(instance.minfds, 1024)
- self.assertEqual(instance.minprocs, 200)
- self.assertEqual(instance.nocleanup, True)
- self.assertEqual(instance.childlogdir, config.expansions['ENV_HOME'])
- self.assertEqual(instance.strip_ansi, False)
- # inet_http_server
- options = instance.configroot.supervisord
- self.assertEqual(options.server_configs[0]['family'], socket.AF_INET)
- self.assertEqual(options.server_configs[0]['host'], '')
- self.assertEqual(options.server_configs[0]['port'], 9210)
- self.assertEqual(options.server_configs[0]['username'], 'someuser')
- self.assertEqual(options.server_configs[0]['password'], 'passwordhere')
- # cat1
- cat1 = options.process_group_configs[0]
- self.assertEqual(cat1.name, 'cat1')
- self.assertEqual(cat1.priority, 3)
- self.assertEqual(len(cat1.process_configs), 1)
- proc1 = cat1.process_configs[0]
- self.assertEqual(proc1.name, 'cat1')
- self.assertEqual(proc1.command,
- '/bin/customcat --logdir=/path/to/logs')
- self.assertEqual(proc1.priority, 3)
- self.assertEqual(proc1.autostart, True)
- self.assertEqual(proc1.autorestart, datatypes.RestartWhenExitUnexpected)
- self.assertEqual(proc1.startsecs, 5)
- self.assertEqual(proc1.startretries, 10)
- self.assertEqual(proc1.uid, 0)
- self.assertEqual(proc1.stdout_logfile, '/tmp/cat.log')
- self.assertEqual(proc1.stopsignal, signal.SIGKILL)
- self.assertEqual(proc1.stopwaitsecs, 5)
- self.assertEqual(proc1.stopasgroup, False)
- self.assertEqual(proc1.killasgroup, False)
- self.assertEqual(proc1.stdout_logfile_maxbytes,
- datatypes.byte_size('78KB'))
- self.assertEqual(proc1.stdout_logfile_backups, 2)
- self.assertEqual(proc1.exitcodes, [0,2])
- self.assertEqual(proc1.directory, '/tmp')
- self.assertEqual(proc1.umask, 2)
- self.assertEqual(proc1.environment, dict(FAKE_ENV_VAR='/some/path'))
- def test_processes_from_section_bad_program_name_spaces(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:spaces are bad]
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:spaces are bad', None)
- def test_processes_from_section_bad_program_name_colons(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:colons:are:bad]
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:colons:are:bad', None)
- def test_processes_from_section_no_procnum_in_processname(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- numprocs = 2
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:foo', None)
- def test_processes_from_section_no_command(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- try:
- instance.processes_from_section(config, 'program:foo', None)
- self.fail('nothing raised')
- except ValueError as exc:
- self.assertTrue(exc.args[0].startswith(
- 'program section program:foo does not specify a command'))
- def test_processes_from_section_missing_replacement_in_process_name(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- process_name = %(not_there)s
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:foo', None)
- def test_processes_from_section_bad_expression_in_process_name(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- process_name = %(program_name)
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:foo', None)
- def test_processes_from_section_bad_chars_in_process_name(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- process_name = colons:are:bad
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:foo', None)
- def test_processes_from_section_stopasgroup_implies_killasgroup(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- process_name = %(program_name)s
- stopasgroup = true
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- pconfigs = instance.processes_from_section(config, 'program:foo', 'bar')
- self.assertEqual(len(pconfigs), 1)
- pconfig = pconfigs[0]
- self.assertEqual(pconfig.stopasgroup, True)
- self.assertEqual(pconfig.killasgroup, True)
- def test_processes_from_section_killasgroup_mismatch_w_stopasgroup(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- process_name = %(program_name)s
- stopasgroup = true
- killasgroup = false
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- self.assertRaises(ValueError, instance.processes_from_section,
- config, 'program:foo', None)
- def test_processes_from_section_unexpected_end_of_key_value_pairs(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/cat
- environment = KEY1=val1,KEY2=val2,KEY3
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- try:
- instance.processes_from_section(config, 'program:foo', None)
- except ValueError as e:
- self.assertTrue(
- "Unexpected end of key/value pairs in value "
- "'KEY1=val1,KEY2=val2,KEY3' in section 'program:foo'"
- in str(e))
- else:
- self.fail('instance.processes_from_section should '
- 'raise a ValueError')
- def test_processes_from_section_shows_conf_filename_on_valueerror(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- ;no command
- """)
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- try:
- f.write(text)
- f.flush()
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read(f.name)
- instance.processes_from_section(config, 'program:foo', None)
- except ValueError as e:
- self.assertEqual(e.args[0],
- "program section program:foo does not specify a command "
- "in section 'program:foo' (file: %s)" % f.name)
- else:
- self.fail('nothing raised')
- def test_processes_from_section_autolog_without_rollover(self):
- instance = self._makeOne()
- text = lstrip("""\
- [program:foo]
- command = /bin/foo
- stdout_logfile = AUTO
- stdout_logfile_maxbytes = 0
- stderr_logfile = AUTO
- stderr_logfile_maxbytes = 0
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- instance.logger = DummyLogger()
- config.read_string(text)
- instance.processes_from_section(config, 'program:foo', None)
- self.assertEqual(instance.parse_warnings[0],
- 'For [program:foo], AUTO logging used for stdout_logfile '
- 'without rollover, set maxbytes > 0 to avoid filling up '
- 'filesystem unintentionally')
- self.assertEqual(instance.parse_warnings[1],
- 'For [program:foo], AUTO logging used for stderr_logfile '
- 'without rollover, set maxbytes > 0 to avoid filling up '
- 'filesystem unintentionally')
- def test_homogeneous_process_groups_from_parser(self):
- text = lstrip("""\
- [program:many]
- process_name = %(program_name)s_%(process_num)s
- command = /bin/cat
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 1)
- gconfig = gconfigs[0]
- self.assertEqual(gconfig.name, 'many')
- self.assertEqual(gconfig.priority, 1)
- self.assertEqual(len(gconfig.process_configs), 2)
- def test_event_listener_pools_from_parser(self):
- text = lstrip("""\
- [eventlistener:dog]
- events=PROCESS_COMMUNICATION
- process_name = %(program_name)s_%(process_num)s
- command = /bin/dog
- numprocs = 2
- priority = 1
- [eventlistener:cat]
- events=PROCESS_COMMUNICATION
- process_name = %(program_name)s_%(process_num)s
- command = /bin/cat
- numprocs = 3
- [eventlistener:biz]
- events=PROCESS_COMMUNICATION
- process_name = %(program_name)s_%(process_num)s
- command = /bin/biz
- numprocs = 2
- """)
- from supervisor.options import UnhosedConfigParser
- from supervisor.dispatchers import default_handler
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 3)
- gconfig1 = gconfigs[0]
- self.assertEqual(gconfig1.name, 'biz')
- self.assertEqual(gconfig1.result_handler, default_handler)
- self.assertEqual(len(gconfig1.process_configs), 2)
- gconfig1 = gconfigs[1]
- self.assertEqual(gconfig1.name, 'cat')
- self.assertEqual(gconfig1.priority, -1)
- self.assertEqual(gconfig1.result_handler, default_handler)
- self.assertEqual(len(gconfig1.process_configs), 3)
- gconfig1 = gconfigs[2]
- self.assertEqual(gconfig1.name, 'dog')
- self.assertEqual(gconfig1.priority, 1)
- self.assertEqual(gconfig1.result_handler, default_handler)
- self.assertEqual(len(gconfig1.process_configs), 2)
- def test_event_listener_pools_from_parser_with_environment_expansions(self):
- text = lstrip("""\
- [eventlistener:dog]
- events=PROCESS_COMMUNICATION
- process_name = %(ENV_EL1_PROCNAME)s_%(program_name)s_%(process_num)s
- command = %(ENV_EL1_COMMAND)s
- numprocs = %(ENV_EL1_NUMPROCS)s
- priority = %(ENV_EL1_PRIORITY)s
- [eventlistener:cat]
- events=PROCESS_COMMUNICATION
- process_name = %(program_name)s_%(process_num)s
- command = /bin/cat
- numprocs = 3
- """)
- from supervisor.options import UnhosedConfigParser
- from supervisor.dispatchers import default_handler
- instance = self._makeOne()
- instance.environ_expansions = {'ENV_HOME': tempfile.gettempdir(),
- 'ENV_USER': 'johndoe',
- 'ENV_EL1_PROCNAME': 'myeventlistener',
- 'ENV_EL1_COMMAND': '/bin/dog',
- 'ENV_EL1_NUMPROCS': '2',
- 'ENV_EL1_PRIORITY': '1',
- }
- config = UnhosedConfigParser()
- config.expansions = instance.environ_expansions
- config.read_string(text)
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 2)
- gconfig0 = gconfigs[0]
- self.assertEqual(gconfig0.name, 'cat')
- self.assertEqual(gconfig0.priority, -1)
- self.assertEqual(gconfig0.result_handler, default_handler)
- self.assertEqual(len(gconfig0.process_configs), 3)
- gconfig1 = gconfigs[1]
- self.assertEqual(gconfig1.name, 'dog')
- self.assertEqual(gconfig1.priority, 1)
- self.assertEqual(gconfig1.result_handler, default_handler)
- self.assertEqual(len(gconfig1.process_configs), 2)
- dog0 = gconfig1.process_configs[0]
- self.assertEqual(dog0.name, 'myeventlistener_dog_0')
- self.assertEqual(dog0.command, '/bin/dog')
- self.assertEqual(dog0.priority, 1)
- dog1 = gconfig1.process_configs[1]
- self.assertEqual(dog1.name, 'myeventlistener_dog_1')
- self.assertEqual(dog1.command, '/bin/dog')
- self.assertEqual(dog1.priority, 1)
- def test_event_listener_pool_disallows_redirect_stderr(self):
- text = lstrip("""\
- [eventlistener:dog]
- events=PROCESS_COMMUNICATION
- command = /bin/dog
- redirect_stderr = True
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- try:
- instance.process_groups_from_parser(config)
- self.fail('nothing raised')
- except ValueError as exc:
- self.assertEqual(exc.args[0], '[eventlistener:dog] section sets '
- 'redirect_stderr=true but this is not allowed because it '
- 'will interfere with the eventlistener protocol')
- def test_event_listener_pool_with_event_result_handler(self):
- text = lstrip("""\
- [eventlistener:dog]
- events=PROCESS_COMMUNICATION
- command = /bin/dog
- result_handler = supervisor.tests.base:dummy_handler
- """)
- from supervisor.options import UnhosedConfigParser
- from supervisor.tests.base import dummy_handler
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 1)
- gconfig1 = gconfigs[0]
- self.assertEqual(gconfig1.result_handler, dummy_handler)
- def test_event_listener_pool_result_handler_unimportable(self):
- text = lstrip("""\
- [eventlistener:cat]
- events=PROCESS_COMMUNICATION
- command = /bin/cat
- result_handler = supervisor.tests.base:nonexistent
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- try:
- instance.process_groups_from_parser(config)
- self.fail('nothing raised')
- except ValueError as exc:
- self.assertEqual(exc.args[0],
- 'supervisor.tests.base:nonexistent cannot be '
- 'resolved within [eventlistener:cat]')
- def test_event_listener_pool_noeventsline(self):
- text = lstrip("""\
- [eventlistener:dog]
- process_name = %(program_name)s_%(process_num)s
- command = /bin/dog
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_event_listener_pool_unknown_eventtype(self):
- text = lstrip("""\
- [eventlistener:dog]
- events=PROCESS_COMMUNICATION,THIS_EVENT_TYPE_DOESNT_EXIST
- process_name = %(program_name)s_%(process_num)s
- command = /bin/dog
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_programs_from_parser(self):
- from supervisor.options import FastCGIGroupConfig
- from supervisor.options import FastCGIProcessConfig
- text = lstrip("""\
- [fcgi-program:foo]
- socket = unix:///tmp/%(program_name)s.sock
- socket_owner = testuser:testgroup
- socket_mode = 0666
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- [fcgi-program:bar]
- socket = unix:///tmp/%(program_name)s.sock
- process_name = %(program_name)s_%(process_num)s
- command = /bin/bar
- user = testuser
- numprocs = 3
- [fcgi-program:flub]
- socket = unix:///tmp/%(program_name)s.sock
- command = /bin/flub
- [fcgi-program:cub]
- socket = tcp://localhost:6000
- command = /bin/cub
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- #Patch pwd and grp module functions to give us sentinel
- #uid/gid values so that the test does not depend on
- #any specific system users
- pwd_mock = Mock()
- pwd_mock.return_value = (None, None, sentinel.uid, sentinel.gid)
- grp_mock = Mock()
- grp_mock.return_value = (None, None, sentinel.gid)
- @patch('pwd.getpwuid', pwd_mock)
- @patch('pwd.getpwnam', pwd_mock)
- @patch('grp.getgrnam', grp_mock)
- def get_process_groups(instance, config):
- return instance.process_groups_from_parser(config)
- gconfigs = get_process_groups(instance, config)
- exp_owner = (sentinel.uid, sentinel.gid)
- self.assertEqual(len(gconfigs), 4)
- gconf_foo = gconfigs[0]
- self.assertEqual(gconf_foo.__class__, FastCGIGroupConfig)
- self.assertEqual(gconf_foo.name, 'foo')
- self.assertEqual(gconf_foo.priority, 1)
- self.assertEqual(gconf_foo.socket_config.url,
- 'unix:///tmp/foo.sock')
- self.assertEqual(exp_owner, gconf_foo.socket_config.get_owner())
- self.assertEqual(438, gconf_foo.socket_config.get_mode()) # 0666 in Py2, 0o666 in Py3
- self.assertEqual(len(gconf_foo.process_configs), 2)
- pconfig_foo = gconf_foo.process_configs[0]
- self.assertEqual(pconfig_foo.__class__, FastCGIProcessConfig)
- gconf_bar = gconfigs[1]
- self.assertEqual(gconf_bar.name, 'bar')
- self.assertEqual(gconf_bar.priority, 999)
- self.assertEqual(gconf_bar.socket_config.url,
- 'unix:///tmp/bar.sock')
- self.assertEqual(exp_owner, gconf_bar.socket_config.get_owner())
- self.assertEqual(448, gconf_bar.socket_config.get_mode()) # 0700 in Py2, 0o700 in Py3
- self.assertEqual(len(gconf_bar.process_configs), 3)
- gconf_cub = gconfigs[2]
- self.assertEqual(gconf_cub.name, 'cub')
- self.assertEqual(gconf_cub.socket_config.url,
- 'tcp://localhost:6000')
- self.assertEqual(len(gconf_cub.process_configs), 1)
- gconf_flub = gconfigs[3]
- self.assertEqual(gconf_flub.name, 'flub')
- self.assertEqual(gconf_flub.socket_config.url,
- 'unix:///tmp/flub.sock')
- self.assertEqual(None, gconf_flub.socket_config.get_owner())
- self.assertEqual(448, gconf_flub.socket_config.get_mode()) # 0700 in Py2, 0o700 in Py3
- self.assertEqual(len(gconf_flub.process_configs), 1)
- def test_fcgi_programs_from_parser_with_environment_expansions(self):
- from supervisor.options import FastCGIGroupConfig
- from supervisor.options import FastCGIProcessConfig
- text = lstrip("""\
- [fcgi-program:foo]
- socket = unix:///tmp/%(program_name)s%(ENV_FOO_SOCKET_EXT)s
- socket_owner = %(ENV_FOO_SOCKET_USER)s:testgroup
- socket_mode = %(ENV_FOO_SOCKET_MODE)s
- process_name = %(ENV_FOO_PROCESS_PREFIX)s_%(program_name)s_%(process_num)s
- command = /bin/foo --arg1=%(ENV_FOO_COMMAND_ARG1)s
- numprocs = %(ENV_FOO_NUMPROCS)s
- priority = %(ENV_FOO_PRIORITY)s
- """)
- from supervisor.options import UnhosedConfigParser
- instance = self._makeOne()
- instance.environ_expansions = {'ENV_HOME': '/tmp',
- 'ENV_SERVER_PORT': '9210',
- 'ENV_FOO_SOCKET_EXT': '.usock',
- 'ENV_FOO_SOCKET_USER': 'testuser',
- 'ENV_FOO_SOCKET_MODE': '0666',
- 'ENV_FOO_PROCESS_PREFIX': 'fcgi-',
- 'ENV_FOO_COMMAND_ARG1': 'bar',
- 'ENV_FOO_NUMPROCS': '2',
- 'ENV_FOO_PRIORITY': '1',
- }
- config = UnhosedConfigParser()
- config.expansions = instance.environ_expansions
- config.read_string(text)
- # Patch pwd and grp module functions to give us sentinel
- # uid/gid values so that the test does not depend on
- # any specific system users
- pwd_mock = Mock()
- pwd_mock.return_value = (None, None, sentinel.uid, sentinel.gid)
- grp_mock = Mock()
- grp_mock.return_value = (None, None, sentinel.gid)
- @patch('pwd.getpwuid', pwd_mock)
- @patch('pwd.getpwnam', pwd_mock)
- @patch('grp.getgrnam', grp_mock)
- def get_process_groups(instance, config):
- return instance.process_groups_from_parser(config)
- gconfigs = get_process_groups(instance, config)
- exp_owner = (sentinel.uid, sentinel.gid)
- self.assertEqual(len(gconfigs), 1)
- gconf_foo = gconfigs[0]
- self.assertEqual(gconf_foo.__class__, FastCGIGroupConfig)
- self.assertEqual(gconf_foo.name, 'foo')
- self.assertEqual(gconf_foo.priority, 1)
- self.assertEqual(gconf_foo.socket_config.url,
- 'unix:///tmp/foo.usock')
- self.assertEqual(exp_owner, gconf_foo.socket_config.get_owner())
- self.assertEqual(438, gconf_foo.socket_config.get_mode()) # 0666 in Py2, 0o666 in Py3
- self.assertEqual(len(gconf_foo.process_configs), 2)
- pconfig_foo = gconf_foo.process_configs[0]
- self.assertEqual(pconfig_foo.__class__, FastCGIProcessConfig)
- self.assertEqual(pconfig_foo.command, '/bin/foo --arg1=bar')
- def test_fcgi_program_no_socket(self):
- text = lstrip("""\
- [fcgi-program:foo]
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_unknown_socket_protocol(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket=junk://blah
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_rel_unix_sock_path(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket=unix://relative/path
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_bad_tcp_sock_format(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket=tcp://missingport
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_bad_expansion_proc_num(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket=unix:///tmp/%(process_num)s.sock
- process_name = %(program_name)s_%(process_num)s
- command = /bin/foo
- numprocs = 2
- priority = 1
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_socket_owner_set_for_tcp(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket=tcp://localhost:8000
- socket_owner=nobody:nobody
- command = /bin/foo
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_socket_mode_set_for_tcp(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket = tcp://localhost:8000
- socket_mode = 0777
- command = /bin/foo
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_bad_socket_owner(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket = unix:///tmp/foo.sock
- socket_owner = sometotaljunkuserthatshouldnobethere
- command = /bin/foo
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_fcgi_program_bad_socket_mode(self):
- text = lstrip("""\
- [fcgi-program:foo]
- socket = unix:///tmp/foo.sock
- socket_mode = junk
- command = /bin/foo
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError,instance.process_groups_from_parser,config)
- def test_heterogeneous_process_groups_from_parser(self):
- text = lstrip("""\
- [program:one]
- command = /bin/cat
- [program:two]
- command = /bin/cat
- [group:thegroup]
- programs = one,two
- priority = 5
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 1)
- gconfig = gconfigs[0]
- self.assertEqual(gconfig.name, 'thegroup')
- self.assertEqual(gconfig.priority, 5)
- self.assertEqual(len(gconfig.process_configs), 2)
- def test_mixed_process_groups_from_parser1(self):
- text = lstrip("""\
- [program:one]
- command = /bin/cat
- [program:two]
- command = /bin/cat
- [program:many]
- process_name = %(program_name)s_%(process_num)s
- command = /bin/cat
- numprocs = 2
- priority = 1
- [group:thegroup]
- programs = one,two
- priority = 5
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 2)
- manyconfig = gconfigs[0]
- self.assertEqual(manyconfig.name, 'many')
- self.assertEqual(manyconfig.priority, 1)
- self.assertEqual(len(manyconfig.process_configs), 2)
- gconfig = gconfigs[1]
- self.assertEqual(gconfig.name, 'thegroup')
- self.assertEqual(gconfig.priority, 5)
- self.assertEqual(len(gconfig.process_configs), 2)
- def test_mixed_process_groups_from_parser2(self):
- text = lstrip("""\
- [program:one]
- command = /bin/cat
- [program:two]
- command = /bin/cat
- [program:many]
- process_name = %(program_name)s_%(process_num)s
- command = /bin/cat
- numprocs = 2
- priority = 1
- [group:thegroup]
- programs = one,two, many
- priority = 5
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- gconfigs = instance.process_groups_from_parser(config)
- self.assertEqual(len(gconfigs), 1)
- gconfig = gconfigs[0]
- self.assertEqual(gconfig.name, 'thegroup')
- self.assertEqual(gconfig.priority, 5)
- self.assertEqual(len(gconfig.process_configs), 4)
- def test_unknown_program_in_heterogeneous_group(self):
- text = lstrip("""\
- [program:one]
- command = /bin/cat
- [group:foo]
- programs = notthere
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- self.assertRaises(ValueError, instance.process_groups_from_parser,
- config)
- def test_rpcinterfaces_from_parser(self):
- text = lstrip("""\
- [rpcinterface:dummy]
- supervisor.rpcinterface_factory = %s
- foo = bar
- baz = qux
- """ % __name__)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- factories = instance.get_plugins(config,
- 'supervisor.rpcinterface_factory',
- 'rpcinterface:')
- self.assertEqual(len(factories), 1)
- factory = factories[0]
- self.assertEqual(factory[0], 'dummy')
- self.assertEqual(factory[1], sys.modules[__name__])
- self.assertEqual(factory[2], {'foo':'bar', 'baz':'qux'})
- def test_rpcinterfaces_from_parser_factory_expansions(self):
- text = lstrip("""\
- [rpcinterface:dummy]
- supervisor.rpcinterface_factory = %(factory)s
- foo = %(pet)s
- """)
- from supervisor.options import UnhosedConfigParser
- instance = self._makeOne()
- config = UnhosedConfigParser()
- config.expansions = {'factory': __name__, 'pet': 'cat'}
- config.read_string(text)
- factories = instance.get_plugins(config,
- 'supervisor.rpcinterface_factory',
- 'rpcinterface:')
- self.assertEqual(len(factories), 1)
- factory = factories[0]
- self.assertEqual(factory[0], 'dummy')
- self.assertEqual(factory[1], sys.modules[__name__])
- self.assertEqual(factory[2], {'foo': 'cat'})
- def test_rpcinterfaces_from_parser_factory_missing(self):
- text = lstrip("""\
- [rpcinterface:dummy]
- # note: no supervisor.rpcinterface_factory here
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- try:
- instance.get_plugins(config,
- 'supervisor.rpcinterface_factory',
- 'rpcinterface:')
- self.fail('nothing raised')
- except ValueError as exc:
- self.assertEqual(exc.args[0], 'section [rpcinterface:dummy] '
- 'does not specify a supervisor.rpcinterface_factory')
- def test_rpcinterfaces_from_parser_factory_not_importable(self):
- text = lstrip("""\
- [rpcinterface:dummy]
- supervisor.rpcinterface_factory = nonexistent
- """)
- from supervisor.options import UnhosedConfigParser
- config = UnhosedConfigParser()
- config.read_string(text)
- instance = self._makeOne()
- try:
- instance.get_plugins(config,
- 'supervisor.rpcinterface_factory',
- 'rpcinterface:')
- self.fail('nothing raised')
- except ValueError as exc:
- self.assertEqual(exc.args[0], 'nonexistent cannot be resolved '
- 'within [rpcinterface:dummy]')
- def test_clear_autochildlogdir(self):
- dn = tempfile.mkdtemp()
- try:
- instance = self._makeOne()
- instance.childlogdir = dn
- sid = 'supervisor'
- instance.identifier = sid
- logfn = instance.get_autochildlog_name('foo', sid,'stdout')
- first = logfn + '.1'
- second = logfn + '.2'
- f1 = open(first, 'w')
- f2 = open(second, 'w')
- instance.clear_autochildlogdir()
- self.assertFalse(os.path.exists(logfn))
- self.assertFalse(os.path.exists(first))
- self.assertFalse(os.path.exists(second))
- f1.close()
- f2.close()
- finally:
- shutil.rmtree(dn)
- def test_clear_autochildlogdir_listdir_oserror(self):
- instance = self._makeOne()
- instance.childlogdir = '/tmp/this/cant/possibly/existjjjj'
- instance.logger = DummyLogger()
- instance.clear_autochildlogdir()
- self.assertEqual(instance.logger.data, ['Could not clear childlog dir'])
- def test_clear_autochildlogdir_unlink_oserror(self):
- dirname = tempfile.mkdtemp()
- instance = self._makeOne()
- instance.childlogdir = dirname
- ident = instance.identifier
- filename = os.path.join(dirname, 'cat-stdout---%s-ayWAp9.log' % ident)
- with open(filename, 'w') as f:
- f.write("log")
- def raise_oserror(*args):
- raise OSError(errno.ENOENT)
- instance.remove = raise_oserror
- instance.logger = DummyLogger()
- instance.clear_autochildlogdir()
- self.assertEqual(instance.logger.data,
- ["Failed to clean up '%s'" % filename])
- def test_openhttpservers_reports_friendly_usage_when_eaddrinuse(self):
- supervisord = DummySupervisor()
- instance = self._makeOne()
- def raise_eaddrinuse(supervisord):
- raise socket.error(errno.EADDRINUSE)
- instance.make_http_servers = raise_eaddrinuse
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.openhttpservers(supervisord)
- self.assertEqual(len(recorder), 1)
- expected = 'Another program is already listening'
- self.assertTrue(recorder[0].startswith(expected))
- def test_openhttpservers_reports_socket_error_with_errno(self):
- supervisord = DummySupervisor()
- instance = self._makeOne()
- def make_http_servers(supervisord):
- raise socket.error(errno.EPERM)
- instance.make_http_servers = make_http_servers
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.openhttpservers(supervisord)
- self.assertEqual(len(recorder), 1)
- expected = ('Cannot open an HTTP server: socket.error '
- 'reported errno.EPERM (%d)' % errno.EPERM)
- self.assertEqual(recorder[0], expected)
- def test_openhttpservers_reports_other_socket_errors(self):
- supervisord = DummySupervisor()
- instance = self._makeOne()
- def make_http_servers(supervisord):
- raise socket.error('uh oh')
- instance.make_http_servers = make_http_servers
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.openhttpservers(supervisord)
- self.assertEqual(len(recorder), 1)
- expected = ('Cannot open an HTTP server: socket.error '
- 'reported uh oh')
- self.assertEqual(recorder[0], expected)
- def test_openhttpservers_reports_value_errors(self):
- supervisord = DummySupervisor()
- instance = self._makeOne()
- def make_http_servers(supervisord):
- raise ValueError('not prefixed with help')
- instance.make_http_servers = make_http_servers
- recorder = []
- def record_usage(message):
- recorder.append(message)
- instance.usage = record_usage
- instance.openhttpservers(supervisord)
- self.assertEqual(len(recorder), 1)
- expected = 'not prefixed with help'
- self.assertEqual(recorder[0], expected)
- def test_openhttpservers_does_not_catch_other_exception_types(self):
- supervisord = DummySupervisor()
- instance = self._makeOne()
- def make_http_servers(supervisord):
- raise OverflowError
- instance.make_http_servers = make_http_servers
- # this scenario probably means a bug in supervisor. we dump
- # all the gory details on the poor user for troubleshooting
- self.assertRaises(OverflowError,
- instance.openhttpservers, supervisord)
- def test_dropPrivileges_user_none(self):
- instance = self._makeOne()
- msg = instance.dropPrivileges(None)
- self.assertEqual(msg, "No user specified to setuid to!")
- @patch('pwd.getpwuid', Mock(return_value=["foo", None, 12, 34]))
- @patch('os.getuid', Mock(return_value=12))
- def test_dropPrivileges_nonroot_same_user(self):
- instance = self._makeOne()
- msg = instance.dropPrivileges(os.getuid())
- self.assertEqual(msg, None) # no error if same user
- @patch('pwd.getpwuid', Mock(return_value=["foo", None, 55, 34]))
- @patch('os.getuid', Mock(return_value=12))
- def test_dropPrivileges_nonroot_different_user(self):
- instance = self._makeOne()
- msg = instance.dropPrivileges(42)
- self.assertEqual(msg, "Can't drop privilege as nonroot user")
- def test_daemonize_notifies_poller_before_and_after_fork(self):
- instance = self._makeOne()
- instance._daemonize = lambda: None
- instance.poller = Mock()
- instance.daemonize()
- instance.poller.before_daemonize.assert_called_once_with()
- instance.poller.after_daemonize.assert_called_once_with()
- def test_include_here(self):
- conf = os.path.join(
- os.path.abspath(os.path.dirname(__file__)), 'fixtures',
- 'include.conf')
- root_here = os.path.dirname(conf)
- include_here = os.path.join(root_here, 'example')
- parser = self._makeOne()
- parser.configfile = conf
- parser.process_config_file(True)
- section = parser.configroot.supervisord
- self.assertEqual(section.logfile, root_here)
- self.assertEqual(section.childlogdir, include_here)
- class TestProcessConfig(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import ProcessConfig
- return ProcessConfig
- def _makeOne(self, *arg, **kw):
- defaults = {}
- for name in ('name', 'command', 'directory', 'umask',
- 'priority', 'autostart', 'autorestart',
- 'startsecs', 'startretries', 'uid',
- 'stdout_logfile', 'stdout_capture_maxbytes',
- 'stdout_events_enabled', 'stdout_syslog',
- 'stderr_logfile', 'stderr_capture_maxbytes',
- 'stderr_events_enabled', 'stderr_syslog',
- 'stopsignal', 'stopwaitsecs', 'stopasgroup',
- 'killasgroup', 'exitcodes', 'redirect_stderr',
- 'environment'):
- defaults[name] = name
- for name in ('stdout_logfile_backups', 'stdout_logfile_maxbytes',
- 'stderr_logfile_backups', 'stderr_logfile_maxbytes'):
- defaults[name] = 10
- defaults.update(kw)
- return self._getTargetClass()(*arg, **defaults)
- def test_create_autochildlogs(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- from supervisor.datatypes import Automatic
- instance.stdout_logfile = Automatic
- instance.stderr_logfile = Automatic
- instance.create_autochildlogs()
- self.assertEqual(instance.stdout_logfile, options.tempfile_name)
- self.assertEqual(instance.stderr_logfile, options.tempfile_name)
- def test_make_process(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- process = instance.make_process()
- from supervisor.process import Subprocess
- self.assertEqual(process.__class__, Subprocess)
- self.assertEqual(process.group, None)
- def test_make_process_with_group(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- process = instance.make_process('abc')
- from supervisor.process import Subprocess
- self.assertEqual(process.__class__, Subprocess)
- self.assertEqual(process.group, 'abc')
- def test_make_dispatchers_stderr_not_redirected(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- with tempfile.NamedTemporaryFile() as stdout_logfile:
- with tempfile.NamedTemporaryFile() as stderr_logfile:
- instance.stdout_logfile = stdout_logfile.name
- instance.stderr_logfile = stderr_logfile.name
- instance.redirect_stderr = False
- process1 = DummyProcess(instance)
- dispatchers, pipes = instance.make_dispatchers(process1)
- self.assertEqual(dispatchers[5].channel, 'stdout')
- from supervisor.events import ProcessCommunicationStdoutEvent
- self.assertEqual(dispatchers[5].event_type,
- ProcessCommunicationStdoutEvent)
- self.assertEqual(pipes['stdout'], 5)
- self.assertEqual(dispatchers[7].channel, 'stderr')
- from supervisor.events import ProcessCommunicationStderrEvent
- self.assertEqual(dispatchers[7].event_type,
- ProcessCommunicationStderrEvent)
- self.assertEqual(pipes['stderr'], 7)
- def test_make_dispatchers_stderr_redirected(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- with tempfile.NamedTemporaryFile() as stdout_logfile:
- instance.stdout_logfile = stdout_logfile.name
- process1 = DummyProcess(instance)
- dispatchers, pipes = instance.make_dispatchers(process1)
- self.assertEqual(dispatchers[5].channel, 'stdout')
- self.assertEqual(pipes['stdout'], 5)
- self.assertEqual(pipes['stderr'], None)
- class EventListenerConfigTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import EventListenerConfig
- return EventListenerConfig
- def _makeOne(self, *arg, **kw):
- defaults = {}
- for name in ('name', 'command', 'directory', 'umask',
- 'priority', 'autostart', 'autorestart',
- 'startsecs', 'startretries', 'uid',
- 'stdout_logfile', 'stdout_capture_maxbytes',
- 'stdout_events_enabled', 'stdout_syslog',
- 'stderr_logfile', 'stderr_capture_maxbytes',
- 'stderr_events_enabled', 'stderr_syslog',
- 'stopsignal', 'stopwaitsecs', 'stopasgroup',
- 'killasgroup', 'exitcodes', 'redirect_stderr',
- 'environment'):
- defaults[name] = name
- for name in ('stdout_logfile_backups', 'stdout_logfile_maxbytes',
- 'stderr_logfile_backups', 'stderr_logfile_maxbytes'):
- defaults[name] = 10
- defaults.update(kw)
- return self._getTargetClass()(*arg, **defaults)
- def test_make_dispatchers(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- with tempfile.NamedTemporaryFile() as stdout_logfile:
- with tempfile.NamedTemporaryFile() as stderr_logfile:
- instance.stdout_logfile = stdout_logfile.name
- instance.stderr_logfile = stderr_logfile.name
- instance.redirect_stderr = False
- process1 = DummyProcess(instance)
- dispatchers, pipes = instance.make_dispatchers(process1)
- self.assertEqual(dispatchers[4].channel, 'stdin')
- self.assertEqual(dispatchers[4].closed, False)
- self.assertEqual(dispatchers[5].channel, 'stdout')
- from supervisor.states import EventListenerStates
- self.assertEqual(dispatchers[5].process.listener_state,
- EventListenerStates.ACKNOWLEDGED)
- self.assertEqual(pipes['stdout'], 5)
- self.assertEqual(dispatchers[7].channel, 'stderr')
- from supervisor.events import ProcessCommunicationStderrEvent
- self.assertEqual(dispatchers[7].event_type,
- ProcessCommunicationStderrEvent)
- self.assertEqual(pipes['stderr'], 7)
- class FastCGIProcessConfigTest(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import FastCGIProcessConfig
- return FastCGIProcessConfig
- def _makeOne(self, *arg, **kw):
- defaults = {}
- for name in ('name', 'command', 'directory', 'umask',
- 'priority', 'autostart', 'autorestart',
- 'startsecs', 'startretries', 'uid',
- 'stdout_logfile', 'stdout_capture_maxbytes',
- 'stdout_events_enabled', 'stdout_syslog',
- 'stderr_logfile', 'stderr_capture_maxbytes',
- 'stderr_events_enabled', 'stderr_syslog',
- 'stopsignal', 'stopwaitsecs', 'stopasgroup',
- 'killasgroup', 'exitcodes', 'redirect_stderr',
- 'environment'):
- defaults[name] = name
- for name in ('stdout_logfile_backups', 'stdout_logfile_maxbytes',
- 'stderr_logfile_backups', 'stderr_logfile_maxbytes'):
- defaults[name] = 10
- defaults.update(kw)
- return self._getTargetClass()(*arg, **defaults)
- def test_make_process(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- self.assertRaises(NotImplementedError, instance.make_process)
- def test_make_process_with_group(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- process = instance.make_process('abc')
- from supervisor.process import FastCGISubprocess
- self.assertEqual(process.__class__, FastCGISubprocess)
- self.assertEqual(process.group, 'abc')
- def test_make_dispatchers(self):
- options = DummyOptions()
- instance = self._makeOne(options)
- with tempfile.NamedTemporaryFile() as stdout_logfile:
- with tempfile.NamedTemporaryFile() as stderr_logfile:
- instance.stdout_logfile = stdout_logfile.name
- instance.stderr_logfile = stderr_logfile.name
- instance.redirect_stderr = False
- process1 = DummyProcess(instance)
- dispatchers, pipes = instance.make_dispatchers(process1)
- self.assertEqual(dispatchers[4].channel, 'stdin')
- self.assertEqual(dispatchers[4].closed, True)
- self.assertEqual(dispatchers[5].channel, 'stdout')
- from supervisor.events import ProcessCommunicationStdoutEvent
- self.assertEqual(dispatchers[5].event_type,
- ProcessCommunicationStdoutEvent)
- self.assertEqual(pipes['stdout'], 5)
- self.assertEqual(dispatchers[7].channel, 'stderr')
- from supervisor.events import ProcessCommunicationStderrEvent
- self.assertEqual(dispatchers[7].event_type,
- ProcessCommunicationStderrEvent)
- self.assertEqual(pipes['stderr'], 7)
- class ProcessGroupConfigTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import ProcessGroupConfig
- return ProcessGroupConfig
- def _makeOne(self, options, name, priority, pconfigs):
- return self._getTargetClass()(options, name, priority, pconfigs)
- def test_ctor(self):
- options = DummyOptions()
- instance = self._makeOne(options, 'whatever', 999, [])
- self.assertEqual(instance.options, options)
- self.assertEqual(instance.name, 'whatever')
- self.assertEqual(instance.priority, 999)
- self.assertEqual(instance.process_configs, [])
- def test_after_setuid(self):
- options = DummyOptions()
- pconfigs = [DummyPConfig(options, 'process1', '/bin/process1')]
- instance = self._makeOne(options, 'whatever', 999, pconfigs)
- instance.after_setuid()
- self.assertEqual(pconfigs[0].autochildlogs_created, True)
- def test_make_group(self):
- options = DummyOptions()
- pconfigs = [DummyPConfig(options, 'process1', '/bin/process1')]
- instance = self._makeOne(options, 'whatever', 999, pconfigs)
- group = instance.make_group()
- from supervisor.process import ProcessGroup
- self.assertEqual(group.__class__, ProcessGroup)
- class EventListenerPoolConfigTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import EventListenerPoolConfig
- return EventListenerPoolConfig
- def _makeOne(self, options, name, priority, process_configs, buffer_size,
- pool_events, result_handler):
- return self._getTargetClass()(options, name, priority,
- process_configs, buffer_size,
- pool_events, result_handler)
- def test_after_setuid(self):
- options = DummyOptions()
- pconfigs = [DummyPConfig(options, 'process1', '/bin/process1')]
- instance = self._makeOne(options, 'name', 999, pconfigs, 1, [], None)
- instance.after_setuid()
- self.assertEqual(pconfigs[0].autochildlogs_created, True)
- def test_make_group(self):
- options = DummyOptions()
- pconfigs = [DummyPConfig(options, 'process1', '/bin/process1')]
- instance = self._makeOne(options, 'name', 999, pconfigs, 1, [], None)
- group = instance.make_group()
- from supervisor.process import EventListenerPool
- self.assertEqual(group.__class__, EventListenerPool)
- class FastCGIGroupConfigTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import FastCGIGroupConfig
- return FastCGIGroupConfig
- def _makeOne(self, *args, **kw):
- return self._getTargetClass()(*args, **kw)
- def test_ctor(self):
- options = DummyOptions()
- sock_config = DummySocketConfig(6)
- instance = self._makeOne(options, 'whatever', 999, [], sock_config)
- self.assertEqual(instance.options, options)
- self.assertEqual(instance.name, 'whatever')
- self.assertEqual(instance.priority, 999)
- self.assertEqual(instance.process_configs, [])
- self.assertEqual(instance.socket_config, sock_config)
- def test_same_sockets_are_equal(self):
- options = DummyOptions()
- sock_config1 = DummySocketConfig(6)
- instance1 = self._makeOne(options, 'whatever', 999, [], sock_config1)
- sock_config2 = DummySocketConfig(6)
- instance2 = self._makeOne(options, 'whatever', 999, [], sock_config2)
- self.assertTrue(instance1 == instance2)
- self.assertFalse(instance1 != instance2)
- def test_diff_sockets_are_not_equal(self):
- options = DummyOptions()
- sock_config1 = DummySocketConfig(6)
- instance1 = self._makeOne(options, 'whatever', 999, [], sock_config1)
- sock_config2 = DummySocketConfig(7)
- instance2 = self._makeOne(options, 'whatever', 999, [], sock_config2)
- self.assertTrue(instance1 != instance2)
- self.assertFalse(instance1 == instance2)
- def test_make_group(self):
- options = DummyOptions()
- sock_config = DummySocketConfig(6)
- instance = self._makeOne(options, 'name', 999, [], sock_config)
- group = instance.make_group()
- from supervisor.process import FastCGIProcessGroup
- self.assertEqual(group.__class__, FastCGIProcessGroup)
- class SignalReceiverTests(unittest.TestCase):
- def test_returns_None_initially(self):
- from supervisor.options import SignalReceiver
- sr = SignalReceiver()
- self.assertEqual(sr.get_signal(), None)
- def test_returns_signals_in_order_received(self):
- from supervisor.options import SignalReceiver
- sr = SignalReceiver()
- sr.receive(signal.SIGTERM, 'frame')
- sr.receive(signal.SIGCHLD, 'frame')
- self.assertEqual(sr.get_signal(), signal.SIGTERM)
- self.assertEqual(sr.get_signal(), signal.SIGCHLD)
- self.assertEqual(sr.get_signal(), None)
- def test_does_not_queue_duplicate_signals(self):
- from supervisor.options import SignalReceiver
- sr = SignalReceiver()
- sr.receive(signal.SIGTERM, 'frame')
- sr.receive(signal.SIGTERM, 'frame')
- self.assertEqual(sr.get_signal(), signal.SIGTERM)
- self.assertEqual(sr.get_signal(), None)
- def test_queues_again_after_being_emptied(self):
- from supervisor.options import SignalReceiver
- sr = SignalReceiver()
- sr.receive(signal.SIGTERM, 'frame')
- self.assertEqual(sr.get_signal(), signal.SIGTERM)
- self.assertEqual(sr.get_signal(), None)
- sr.receive(signal.SIGCHLD, 'frame')
- self.assertEqual(sr.get_signal(), signal.SIGCHLD)
- self.assertEqual(sr.get_signal(), None)
- class UnhosedConfigParserTests(unittest.TestCase):
- def _getTargetClass(self):
- from supervisor.options import UnhosedConfigParser
- return UnhosedConfigParser
- def _makeOne(self, *args, **kw):
- return self._getTargetClass()(*args, **kw)
- def test_saneget_no_default(self):
- parser = self._makeOne()
- parser.read_string("[supervisord]\n")
- from supervisor.compat import ConfigParser
- self.assertRaises(ConfigParser.NoOptionError,
- parser.saneget, "supervisord", "missing")
- def test_saneget_with_default(self):
- parser = self._makeOne()
- parser.read_string("[supervisord]\n")
- result = parser.saneget("supervisord", "missing", default="abc")
- self.assertEqual(result, "abc")
- def test_saneget_with_default_and_expand(self):
- parser = self._makeOne()
- parser.expansions = {'pet': 'dog'}
- parser.read_string("[supervisord]\n")
- result = parser.saneget("supervisord", "foo", default="%(pet)s")
- self.assertEqual(result, "dog")
- def test_saneget_with_default_no_expand(self):
- parser = self._makeOne()
- parser.expansions = {'pet': 'dog'}
- parser.read_string("[supervisord]\n")
- result = parser.saneget("supervisord", "foo",
- default="%(pet)s", do_expand=False)
- self.assertEqual(result, "%(pet)s")
- def test_saneget_no_default_no_expand(self):
- parser = self._makeOne()
- parser.read_string("[supervisord]\nfoo=%(pet)s\n")
- result = parser.saneget("supervisord", "foo", do_expand=False)
- self.assertEqual(result, "%(pet)s")
- def test_saneget_expands_instance_expansions(self):
- parser = self._makeOne()
- parser.expansions = {'pet': 'dog'}
- parser.read_string("[supervisord]\nfoo=%(pet)s\n")
- result = parser.saneget("supervisord", "foo")
- self.assertEqual(result, "dog")
- def test_saneget_expands_arg_expansions(self):
- parser = self._makeOne()
- parser.expansions = {'pet': 'dog'}
- parser.read_string("[supervisord]\nfoo=%(pet)s\n")
- result = parser.saneget("supervisord", "foo",
- expansions={'pet': 'cat'})
- self.assertEqual(result, "cat")
- def test_getdefault_does_saneget_with_mysection(self):
- parser = self._makeOne()
- parser.read_string("[%s]\nfoo=bar\n" % parser.mysection)
- self.assertEqual(parser.getdefault("foo"), "bar")
- def test_read_filenames_as_string(self):
- parser = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- f.write("[foo]\n")
- f.flush()
- ok_filenames = parser.read(f.name)
- self.assertEqual(ok_filenames, [f.name])
- def test_read_filenames_as_list(self):
- parser = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- f.write("[foo]\n")
- f.flush()
- ok_filenames = parser.read([f.name])
- self.assertEqual(ok_filenames, [f.name])
- def test_read_returns_ok_filenames_like_rawconfigparser(self):
- nonexistent = os.path.join(os.path.dirname(__file__), "nonexistent")
- parser = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- f.write("[foo]\n")
- f.flush()
- ok_filenames = parser.read([nonexistent, f.name])
- self.assertEqual(ok_filenames, [f.name])
- def test_read_section_to_file_initially_empty(self):
- parser = self._makeOne()
- self.assertEqual(parser.section_to_file, {})
- def test_read_section_to_file_read_one_file(self):
- parser = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f:
- f.write("[foo]\n")
- f.flush()
- parser.read([f.name])
- self.assertEqual(parser.section_to_file['foo'], f.name)
- def test_read_section_to_file_read_multiple_files(self):
- parser = self._makeOne()
- with tempfile.NamedTemporaryFile(mode="w+") as f1:
- with tempfile.NamedTemporaryFile(mode="w+") as f2:
- f1.write("[foo]\n")
- f1.flush()
- f2.write("[bar]\n")
- f2.flush()
- parser.read([f1.name, f2.name])
- self.assertEqual(parser.section_to_file['foo'], f1.name)
- self.assertEqual(parser.section_to_file['bar'], f2.name)
- class UtilFunctionsTests(unittest.TestCase):
- def test_make_namespec(self):
- from supervisor.options import make_namespec
- self.assertEqual(make_namespec('group', 'process'), 'group:process')
- self.assertEqual(make_namespec('process', 'process'), 'process')
- def test_split_namespec(self):
- from supervisor.options import split_namespec
- s = split_namespec
- self.assertEqual(s('process:group'), ('process', 'group'))
- self.assertEqual(s('process'), ('process', 'process'))
- self.assertEqual(s('group:'), ('group', None))
- self.assertEqual(s('group:*'), ('group', None))
- def test_suite():
- return unittest.findTestCases(sys.modules[__name__])
- if __name__ == '__main__':
- unittest.main(defaultTest='test_suite')
|