as per comment attached to #477, rename sendXSignal to signalX, dont do anything async in signalGroup, merge logic for _stopresult and _signalresult in supervisorctl

docs/api.rst

@@ -305,9 +305,9 @@ Process Control
 
     .. automethod:: stopAllProcesses
 
-    .. automethod:: sendProcessSignal
+    .. automethod:: signalProcess
 
-    .. automethod:: sendGroupSignal
+    .. automethod:: signalGroup
 
     .. automethod:: sendProcessStdin
 

supervisor/process.py

@@ -463,7 +463,7 @@ class Subprocess:
 
         try:
             options.kill(self.pid, sig)
-        except Exception, e:
+        except Exception:
             io = StringIO.StringIO()
             traceback.print_exc(file=io)
             tb = io.getvalue()

supervisor/rpcinterface.py

@@ -3,7 +3,6 @@ import time
 import datetime
 import errno
 import types
-import signal
 
 from supervisor.datatypes import signal_number
 
@@ -462,7 +461,7 @@ class SupervisorNamespaceRPCInterface:
         return killall # deferred
 
 
-    def sendProcessSignal(self, name, signal='HUP'):
+    def signalProcess(self, name, signal='HUP'):
         """ Send an arbitrary UNIX signal to the process named by name
 
         @param string name The name of the process to signal (or 'group:name')
@@ -470,13 +469,13 @@ class SupervisorNamespaceRPCInterface:
         @return boolean result
         """
 
-        self._update('sendProcessSignal')
+        self._update('signalProcess')
 
         group, process = self._getGroupAndProcess(name)
 
         if process is None:
             group_name, process_name = split_namespec(name)
-            return self.sendGroupSignal(group_name, signal=signal)
+            return self.signalGroup(group_name, signal=signal)
 
         try:
             sig = signal_number(signal)
@@ -494,18 +493,16 @@ class SupervisorNamespaceRPCInterface:
         return True
 
 
-    def sendGroupSignal(self, name, signal='HUP'):
+    def signalGroup(self, name, signal='HUP'):
         """ Send a signal to all processes in the group named 'name'
 
         @param string name  The group name
         @param int signal   The signal to be sent. SIGHUP by default
         @return array result
         """
-
-        self._update('sendGroupSignal')
+        self._update('signalGroup')
 
         group = self.supervisord.process_groups.get(name)
-        
         if group is None:
             raise RPCError(Faults.BAD_NAME, name)
 
@@ -513,13 +510,12 @@ class SupervisorNamespaceRPCInterface:
         processes.sort()
         processes = [(group, process) for process in processes]
 
-        sendall = make_allfunc(processes, isRunning, self.sendProcessSignal,
+        sendall = make_allfunc(processes, isRunning, self.signalProcess,
                                signal=signal)
-        sendall.rpcinterface = self
+        result = sendall()
+        self._update('signalGroup')
 
-        sendall.delay = 0
-        sendall.rpcinterface = self
-        return sendall
+        return result
 
 
     def getAllConfigInfo(self):

supervisor/supervisorctl.py

@@ -747,23 +747,7 @@ class DefaultControllerPlugin(ControllerPluginBase):
             "start <name> <name>\tStart multiple processes or groups")
         self.ctl.output("start all\t\tStart all processes")
 
-    def _stopresult(self, result):
-        name = make_namespec(result['group'], result['name'])
-        code = result['status']
-        fault_string = result['description']
-        template = '%s: ERROR (%s)'
-        if code == xmlrpc.Faults.BAD_NAME:
-            return template % (name, 'no such process')
-        elif code == xmlrpc.Faults.NOT_RUNNING:
-            return template % (name, 'not running')
-        elif code == xmlrpc.Faults.SUCCESS:
-            return '%s: stopped' % name
-        elif code == xmlrpc.Faults.FAILED:
-            return fault_string
-        # assertion
-        raise ValueError('Unknown result code %s for %s' % (code, name))
-
-    def _signalresult(self, result):
+    def _signalresult(self, result, success='signalled'):
         name = make_namespec(result['group'], result['name'])
         code = result['status']
         fault_string = result['description']
@@ -775,12 +759,15 @@ class DefaultControllerPlugin(ControllerPluginBase):
         elif code == xmlrpc.Faults.NOT_RUNNING:
             return template % (name, 'not running')
         elif code == xmlrpc.Faults.SUCCESS:
-            return '%s: signalled' % name
+            return '%s: %s' % (name, success)
         elif code == xmlrpc.Faults.FAILED:
             return fault_string
         # assertion
         raise ValueError('Unknown result code %s for %s' % (code, name))
 
+    def _stopresult(self, result):
+        return self._signalresult(result, success='stopped')
+
     def do_stop(self, arg):
         if not self.ctl.upcheck():
             return
@@ -858,7 +845,7 @@ class DefaultControllerPlugin(ControllerPluginBase):
                 group_name, process_name = split_namespec(name)
                 if process_name is None:
                     try:
-                        results = supervisor.sendGroupSignal(group_name, sig)
+                        results = supervisor.signalGroup(group_name, sig)
                         for result in results:
                             result = self._signalresult(result)
                             self.ctl.output(result)
@@ -870,7 +857,7 @@ class DefaultControllerPlugin(ControllerPluginBase):
                             raise
                 else:
                     try:
-                        supervisor.sendProcessSignal(name, sig)
+                        supervisor.signalProcess(name, sig)
                     except xmlrpclib.Fault as e:
                         error = self._signalresult({'status': e.faultCode,
                                                     'name': process_name,

supervisor/tests/test_rpcinterfaces.py

@@ -838,7 +838,7 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
              ]
             )
 
-    def test_sendProcessSignal(self):
+    def test_signalProcess(self):
         options = DummyOptions()
         pconfig = DummyPConfig(options, 'foo', '/bin/foo')
         from supervisor.process import ProcessStates
@@ -846,14 +846,14 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         supervisord.set_procattr('foo', 'state', ProcessStates.RUNNING)
         interface = self._makeOne(supervisord)
 
-        result = interface.sendProcessSignal('foo', 10)
+        result = interface.signalProcess('foo', 10)
 
-        self.assertEqual(interface.update_text, 'sendProcessSignal')
+        self.assertEqual(interface.update_text, 'signalProcess')
         self.assertEqual(result, True)
         p = supervisord.process_groups[supervisord.group_name].processes['foo']
         self.assertEqual(p.sent_signal, 10 )
 
-    def test_sendGroupSignal(self):
+    def test_signalGroup(self):
         options = DummyOptions()
         pconfig1 = DummyPConfig(options, 'process1', '/bin/foo')
         pconfig2 = DummyPConfig(options, 'process2', '/bin/foo2')
@@ -863,8 +863,8 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         supervisord.set_procattr('process1', 'state', ProcessStates.RUNNING)
         supervisord.set_procattr('process2', 'state', ProcessStates.RUNNING)
         interface = self._makeOne(supervisord)
-        callback = interface.sendGroupSignal('foo', 10)
-        self.assertEqual(interface.update_text, 'sendGroupSignal')
+        callback = interface.signalGroup('foo', 10)
+        self.assertEqual(interface.update_text, 'signalGroup')
         from supervisor import http
 
         result = http.NOT_DONE_YET
@@ -883,7 +883,7 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         process2 = supervisord.process_groups['foo'].processes['process2']
         self.assertEqual(process2.sent_signal, 10)
 
-    def test_sendProcessGroupSignal(self):
+    def test_signalGroup(self):
         """ Test that sending foo:* works """
         options = DummyOptions()
         pconfig1 = DummyPConfig(options, 'process1', '/bin/foo')
@@ -894,14 +894,9 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         supervisord.set_procattr('process1', 'state', ProcessStates.RUNNING)
         supervisord.set_procattr('process2', 'state', ProcessStates.RUNNING)
         interface = self._makeOne(supervisord)
-        callback = interface.sendProcessSignal('foo:*', 10)
-        self.assertEqual(interface.update_text, 'sendGroupSignal')
-        from supervisor import http
+        result = interface.signalProcess('foo:*', 10)
+        self.assertEqual(interface.update_text, 'signalGroup')
         
-        result = http.NOT_DONE_YET
-        while result is http.NOT_DONE_YET:
-            result = callback()
-
         # Sort so we get deterministic results despite hash randomization
         result = sorted(result, key=operator.itemgetter('name'))