signalGroup -> signalProcessGroup (for parity with startProcessGroup, etc), add signalAllProcesses, used by supervisorctl

CHANGES.txt

@@ -29,9 +29,9 @@
   it.  See https://github.com/Supervisor/supervisor/pull/129.  Patch by Igor
   Sobreira.
 
-- Added ``signalProcess`` and ``signalGroup`` XML-RPC methods to supervisor
-  RPC interface.  Thanks to Casey Callendrello, Marc Abramowitz, and
-  Moriyoshi Koizumi for the patches.
+- Added ``signalProcess``, ``signalProcessGroup``, and ``signalAllProcesses``
+  XML-RPC methods to supervisor RPC interface.  Thanks to Casey Callendrello,
+  Marc Abramowitz, and Moriyoshi Koizumi for the patches.
 
 - Added ``signal`` command to supervisorctl.  Thanks to Moriyoshi Koizumi and
   Marc Abramowitz for the patches.

docs/api.rst

@@ -322,7 +322,9 @@ Process Control
 
     .. automethod:: signalProcess
 
-    .. automethod:: signalGroup
+    .. automethod:: signalProcessGroup
+
+    .. automethod:: signalAllProcesses
 
     .. automethod:: sendProcessStdin
 

supervisor/rpcinterface.py

@@ -481,7 +481,7 @@ class SupervisorNamespaceRPCInterface:
 
         if process is None:
             group_name, process_name = split_namespec(name)
-            return self.signalGroup(group_name, signal=signal)
+            return self.signalProcessGroup(group_name, signal=signal)
 
         try:
             sig = signal_number(signal)
@@ -499,7 +499,7 @@ class SupervisorNamespaceRPCInterface:
         return True
 
 
-    def signalGroup(self, name, signal='HUP'):
+    def signalProcessGroup(self, name, signal='HUP'):
         """ Send a signal to all processes in the group named 'name'
 
         @param string name  The group name
@@ -508,7 +508,7 @@ class SupervisorNamespaceRPCInterface:
         """
 
         group = self.supervisord.process_groups.get(name)
-        self._update('signalGroup')
+        self._update('signalProcessGroup')
 
         if group is None:
             raise RPCError(Faults.BAD_NAME, name)
@@ -520,10 +520,22 @@ class SupervisorNamespaceRPCInterface:
         sendall = make_allfunc(processes, isRunning, self.signalProcess,
                                signal=signal)
         result = sendall()
-        self._update('signalGroup')
+        self._update('signalProcessGroup')
 
         return result
 
+    def signalAllProcesses(self, signal='SIGHUP'):
+        """ Send a signal to all processes in the process list
+
+        @param int signal   The signal to be sent. SIGHUP by default
+        @return array result   An array of process status info structs
+        """
+        processes = self._getAllProcesses()
+        signalall = make_allfunc(processes, isRunning, self.signalProcess,
+            signal=signal)
+        result = signalall()
+        self._update('signalAllProcesses')
+        return result
 
     def getAllConfigInfo(self):
         """ Get info about all available process configurations. Each struct

supervisor/supervisorctl.py

@@ -821,7 +821,9 @@ class DefaultControllerPlugin(ControllerPluginBase):
                 group_name, process_name = split_namespec(name)
                 if process_name is None:
                     try:
-                        results = supervisor.signalGroup(group_name, sig)
+                        results = supervisor.signalProcessGroup(
+                            group_name, sig
+                            )
                         for result in results:
                             result = self._signalresult(result)
                             self.ctl.output(result)

supervisor/tests/test_rpcinterfaces.py

@@ -855,7 +855,8 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         p = supervisord.process_groups[supervisord.group_name].processes['foo']
         self.assertEqual(p.sent_signal, 10 )
 
-    def test_signalGroup(self):
+    def test_signalProcess_withgroup(self):
+        """ Test that sending foo:* works """
         options = DummyOptions()
         pconfig1 = DummyPConfig(options, 'process1', '/bin/foo')
         pconfig2 = DummyPConfig(options, 'process2', '/bin/foo2')
@@ -865,13 +866,34 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         supervisord.set_procattr('process1', 'state', ProcessStates.RUNNING)
         supervisord.set_procattr('process2', 'state', ProcessStates.RUNNING)
         interface = self._makeOne(supervisord)
-        callback = interface.signalGroup('foo', 10)
-        self.assertEqual(interface.update_text, 'signalGroup')
-        from supervisor import http
+        result = interface.signalProcess('foo:*', 10)
+        self.assertEqual(interface.update_text, 'signalProcessGroup')
+        
+        # Sort so we get deterministic results despite hash randomization
+        result = sorted(result, key=operator.itemgetter('name'))
 
-        result = http.NOT_DONE_YET
-        while result is http.NOT_DONE_YET:
-            result = callback()
+        self.assertEqual(result, [
+            {'status':80,'group':'foo','name': 'process1','description': 'OK'},
+            {'status':80,'group':'foo','name': 'process2','description': 'OK'},
+            ] )
+        process1 = supervisord.process_groups['foo'].processes['process1']
+        self.assertEqual(process1.sent_signal, 10)
+        process2 = supervisord.process_groups['foo'].processes['process2']
+        self.assertEqual(process2.sent_signal, 10)
+
+
+    def test_signalProcessGroup(self):
+        options = DummyOptions()
+        pconfig1 = DummyPConfig(options, 'process1', '/bin/foo')
+        pconfig2 = DummyPConfig(options, 'process2', '/bin/foo2')
+        from supervisor.process import ProcessStates
+        supervisord = PopulatedDummySupervisor(options, 'foo', pconfig1,
+                                               pconfig2)
+        supervisord.set_procattr('process1', 'state', ProcessStates.RUNNING)
+        supervisord.set_procattr('process2', 'state', ProcessStates.RUNNING)
+        interface = self._makeOne(supervisord)
+        result = interface.signalProcessGroup('foo', 10)
+        self.assertEqual(interface.update_text, 'signalProcessGroup')
 
         # Sort so we get deterministic results despite hash randomization
         result = sorted(result, key=operator.itemgetter('name'))
@@ -885,8 +907,7 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         process2 = supervisord.process_groups['foo'].processes['process2']
         self.assertEqual(process2.sent_signal, 10)
 
-    def test_signalGroup(self):
-        """ Test that sending foo:* works """
+    def test_signalAllProcesses(self):
         options = DummyOptions()
         pconfig1 = DummyPConfig(options, 'process1', '/bin/foo')
         pconfig2 = DummyPConfig(options, 'process2', '/bin/foo2')
@@ -896,9 +917,9 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         supervisord.set_procattr('process1', 'state', ProcessStates.RUNNING)
         supervisord.set_procattr('process2', 'state', ProcessStates.RUNNING)
         interface = self._makeOne(supervisord)
-        result = interface.signalProcess('foo:*', 10)
-        self.assertEqual(interface.update_text, 'signalGroup')
-        
+        result = interface.signalAllProcesses(10)
+        self.assertEqual(interface.update_text, 'signalAllProcesses')
+
         # Sort so we get deterministic results despite hash randomization
         result = sorted(result, key=operator.itemgetter('name'))
 
@@ -911,7 +932,6 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         process2 = supervisord.process_groups['foo'].processes['process2']
         self.assertEqual(process2.sent_signal, 10)
 
-
     def test_getAllConfigInfo(self):
         options = DummyOptions()
         supervisord = DummySupervisor(options, 'foo')