[Supervisor-checkins] r797 - supervisor/trunk/src/supervisor supervisor/trunk/src/supervisor/tests supervisor_manual/trunk/chapters
Mike Naberezny
mike at maintainable.com
Mon Aug 11 00:54:49 EDT 2008
Author: Mike Naberezny <mike at maintainable.com>
Date: Mon Aug 11 00:54:48 2008
New Revision: 797
Log:
Renamed new RPC methods for consistency with the other methods:
- addProcess() is now addProcessGroup()
- removeProcessGroup() is now removeProcessGroup()
Updated documentation for this change and fixed inaccuracies. These
methods take a group name, not a group:process namespec as the
documentation previously stated.
Modified:
supervisor/trunk/src/supervisor/rpcinterface.py
supervisor/trunk/src/supervisor/supervisorctl.py
supervisor/trunk/src/supervisor/tests/base.py
supervisor/trunk/src/supervisor/tests/test_rpcinterfaces.py
supervisor_manual/trunk/chapters/api-process-control.xml
Modified: supervisor/trunk/src/supervisor/rpcinterface.py
==============================================================================
--- supervisor/trunk/src/supervisor/rpcinterface.py (original)
+++ supervisor/trunk/src/supervisor/rpcinterface.py Mon Aug 11 00:54:48 2008
@@ -162,13 +162,13 @@
self.supervisord.options.mood = SupervisorStates.RESTARTING
return True
- def addProcess(self, name):
+ def addProcessGroup(self, name):
""" Update the config for a running process from config file.
@param string name name of process to start
@return boolean result true if successful
"""
- self._update('addProcess')
+ self._update('addProcessGroup')
for config in self.supervisord.options.process_group_configs:
if config.name == name:
@@ -178,13 +178,13 @@
return True
raise RPCError(Faults.BAD_NAME, name)
- def removeProcess(self, name):
+ def removeProcessGroup(self, name):
""" Remove a stopped process from the active configuration.
@param string name name of process to remove
@return boolean result Indicates wether the removal was successful
"""
- self._update('removeProcess')
+ self._update('removeProcessGroup')
if name not in self.supervisord.process_groups:
raise RPCError(Faults.BAD_NAME, name)
Modified: supervisor/trunk/src/supervisor/supervisorctl.py
==============================================================================
--- supervisor/trunk/src/supervisor/supervisorctl.py (original)
+++ supervisor/trunk/src/supervisor/supervisorctl.py Mon Aug 11 00:54:48 2008
@@ -652,7 +652,7 @@
supervisor = self.ctl.get_supervisor()
for name in names:
try:
- supervisor.addProcess(name)
+ supervisor.addProcessGroup(name)
except xmlrpclib.Fault, e:
if e.faultCode == xmlrpc.Faults.SHUTDOWN_STATE:
self.ctl.output('ERROR: shutting down')
@@ -676,7 +676,7 @@
supervisor = self.ctl.get_supervisor()
for name in names:
try:
- result = supervisor.removeProcess(name)
+ result = supervisor.removeProcessGroup(name)
except xmlrpclib.Fault, e:
if e.faultCode == xmlrpc.Faults.STILL_RUNNING:
self.ctl.output('ERROR: process/group still running: %s'
Modified: supervisor/trunk/src/supervisor/tests/base.py
==============================================================================
--- supervisor/trunk/src/supervisor/tests/base.py (original)
+++ supervisor/trunk/src/supervisor/tests/base.py Mon Aug 11 00:54:48 2008
@@ -769,7 +769,7 @@
def reloadConfig(self):
return [[['added'], ['changed'], ['dropped']]]
- def addProcess(self, name):
+ def addProcessGroup(self, name):
from xmlrpclib import Fault
from supervisor import xmlrpc
if name == 'ALREADY_ADDED':
@@ -781,7 +781,7 @@
else:
self.processes = [name]
- def removeProcess(self, name):
+ def removeProcessGroup(self, name):
from xmlrpclib import Fault
from supervisor import xmlrpc
if name == 'STILL_RUNNING':
Modified: supervisor/trunk/src/supervisor/tests/test_rpcinterfaces.py
==============================================================================
--- supervisor/trunk/src/supervisor/tests/test_rpcinterfaces.py (original)
+++ supervisor/trunk/src/supervisor/tests/test_rpcinterfaces.py Mon Aug 11 00:54:48 2008
@@ -218,7 +218,7 @@
self.assertEqual(value, True)
self.assertEqual(supervisord.options.mood, 0)
- def test_addProcess(self):
+ def test_addProcessGroup(self):
from supervisor.supervisord import Supervisor
from supervisor import xmlrpc
options = DummyOptions()
@@ -229,19 +229,19 @@
interface = self._makeOne(supervisord)
- result = interface.addProcess('group1')
+ result = interface.addProcessGroup('group1')
self.assertTrue(result)
self.assertEqual(supervisord.process_groups.keys(), ['group1'])
self._assertRPCError(xmlrpc.Faults.ALREADY_ADDED,
- interface.addProcess, 'group1')
+ interface.addProcessGroup, 'group1')
self.assertEqual(supervisord.process_groups.keys(), ['group1'])
self._assertRPCError(xmlrpc.Faults.BAD_NAME,
- interface.addProcess, 'asdf')
+ interface.addProcessGroup, 'asdf')
self.assertEqual(supervisord.process_groups.keys(), ['group1'])
- def test_removeProcess(self):
+ def test_removeProcessGroup(self):
from supervisor.supervisord import Supervisor
options = DummyOptions()
supervisord = Supervisor(options)
@@ -251,12 +251,12 @@
interface = self._makeOne(supervisord)
- interface.addProcess('group1')
- result = interface.removeProcess('group1')
+ interface.addProcessGroup('group1')
+ result = interface.removeProcessGroup('group1')
self.assertTrue(result)
self.assertEqual(supervisord.process_groups.keys(), [])
- def test_removeProcess_bad_name(self):
+ def test_removeProcessGroup_bad_name(self):
from supervisor.supervisord import Supervisor
from supervisor import xmlrpc
options = DummyOptions()
@@ -268,9 +268,9 @@
interface = self._makeOne(supervisord)
self._assertRPCError(xmlrpc.Faults.BAD_NAME,
- interface.removeProcess, 'asdf')
+ interface.removeProcessGroup, 'asdf')
- def test_removeProcess_still_running(self):
+ def test_removeProcessGroup_still_running(self):
from supervisor.supervisord import Supervisor
from supervisor import xmlrpc
options = DummyOptions()
@@ -283,7 +283,7 @@
supervisord.process_groups = {'group1':process}
interface = self._makeOne(supervisord)
self._assertRPCError(xmlrpc.Faults.STILL_RUNNING,
- interface.removeProcess, 'group1')
+ interface.removeProcessGroup, 'group1')
def test_startProcess_already_started(self):
Modified: supervisor_manual/trunk/chapters/api-process-control.xml
==============================================================================
--- supervisor_manual/trunk/chapters/api-process-control.xml (original)
+++ supervisor_manual/trunk/chapters/api-process-control.xml Mon Aug 11 00:54:48 2008
@@ -675,17 +675,17 @@
</para>
</sect2>
- <sect2 id="api.process-control.supervisor-addProcess">
- <title>supervisor.addProcess() (added in 3.0a7)</title>
+ <sect2 id="api.process-control.supervisor-addProcessGroup">
+ <title>supervisor.addProcessGroup() (added in 3.0a7)</title>
<para>
<programlisting><![CDATA[
-supervisor.addProcess(namespec)
+supervisor.addProcessGroup(namespec)
]]></programlisting>
</para>
<table>
- <title>supervisor.addProcess() Parameters</title>
+ <title>supervisor.addProcessGroup() Parameters</title>
<tgroup cols="2">
<thead>
<row>
@@ -697,15 +697,15 @@
<tbody>
<row>
<entry>string</entry>
- <entry>namespec</entry>
- <entry>Name of the group and process</entry>
+ <entry>name</entry>
+ <entry>Name of the group</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>supervisor.addProcess() Return Value</title>
+ <title>supervisor.addProcessGroup() Return Value</title>
<tgroup cols="2">
<thead>
<row>
@@ -723,34 +723,34 @@
</table>
<para>
- The <code>supervisor.addProcess()</code> reads a process' config
- from the supervisord.conf file and adds the process if it hasn't
- already been added (or if it has been removed). It automatically
- starts the process if the process is set to autostart.
+ The <code>supervisor.addProcessGroup()</code> reads a process group's
+ config from the supervisord.conf file and adds the process group if it
+ hasn't already been added (or if it has been removed). It automatically
+ starts the process group if it is set to autostart.
</para>
<para>
- If the process named by the parameter <code>namespec</code> is not
+ If the process group named by the parameter <code>name</code> is not
known by Supervisor, a fault <code>BAD_NAME</code> is raised.
</para>
<para>
- If the process is already active, an <code>ALREADY_ADDED</code>
+ If the process group is already active, an <code>ALREADY_ADDED</code>
is raised.
</para>
</sect2>
- <sect2 id="api.process-control.supervisor-removeProcess">
- <title>supervisor.removeProcess() (added in 3.0a7)</title>
+ <sect2 id="api.process-control.supervisor-removeProcessGroup">
+ <title>supervisor.removeProcessGroup() (added in 3.0a7)</title>
<para>
<programlisting><![CDATA[
-supervisor.removeProcess(namespec)
+supervisor.removeProcessGroup(namespec)
]]></programlisting>
</para>
<table>
- <title>supervisor.removeProcess() Parameters</title>
+ <title>supervisor.removeProcessGroup() Parameters</title>
<tgroup cols="2">
<thead>
<row>
@@ -762,15 +762,15 @@
<tbody>
<row>
<entry>string</entry>
- <entry>namespec</entry>
- <entry>Name of the group and process</entry>
+ <entry>name</entry>
+ <entry>Name of the group</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>supervisor.removeProcess() Return Value</title>
+ <title>supervisor.removeProcessGroup() Return Value</title>
<tgroup cols="2">
<thead>
<row>
@@ -788,17 +788,17 @@
</table>
<para>
- The <code>supervisor.removeProcess()</code> removes a process
- from the supervisord process list.
+ The <code>supervisor.removeProcess()</code> removes a process group
+ from the supervisord runtime configuration.
</para>
<para>
- If the process named by the parameter <code>namespec</code> is not
+ If the process group named by the parameter <code>name</code> is not
known by Supervisor, a fault <code>BAD_NAME</code> is raised.
</para>
<para>
- If the process is not yet stopped, a <code>STILL_RUNNING</code>
+ If the process group is not yet stopped, a <code>STILL_RUNNING</code>
is raised.
</para>
</sect2>
More information about the Supervisor-checkins
mailing list