Fix events exception raising when ensuring server. Closes #3515.
[leap_pycommon.git] / src / leap / common / events / server.py
index 8a0d4e5..41aede3 100644 (file)
@@ -48,6 +48,13 @@ SERVER_PORT = 8090
 registered_clients = {}
 
 
+class PortAlreadyTaken(Exception):
+    """
+    Raised when trying to open a server in a port that is already taken.
+    """
+    pass
+
+
 def ensure_server(port=SERVER_PORT):
     """
     Make sure the server is running on the given port.
@@ -60,18 +67,55 @@ def ensure_server(port=SERVER_PORT):
 
     :return: the daemon instance or nothing
     :rtype: EventsServerDaemon or None
+
+    :raise PortAlreadyTaken: Raised if C{port} is already taken by something
+                             that is not an events server.
     """
     try:
+        # check if port is available
         s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         s.connect(('localhost', port))
         s.close()
-        logger.info('Server is already running on port %d.', port)
-        return None
+        # port is taken, check if there's a server running there
+        response = ping(port=port, timeout=1000)
+        if response is not None and response.status == proto.EventResponse.OK:
+            logger.info('A server is already running on port %d.', port)
+            return
+        # port is taken, and not by an events server
+        logger.warning(
+            'Port %d is taken by something not an events server.', port)
+        raise PortAlreadyTaken(port)
     except socket.error:
+        # port is available, run a server
         logger.info('Launching server on port %d.', port)
         return EventsServerDaemon.ensure(port)
 
 
+def ping(port=SERVER_PORT, reqcbk=None, timeout=1000):
+    """
+    Ping the server.
+
+    :param port: the port in which server should be listening
+    :type port: int
+    :param reqcbk: a callback to be called when a response from server is
+                   received
+    :type reqcbk: function(proto.PingRequest, proto.EventResponse)
+    :param timeout: the timeout for synch calls
+    :type timeout: int
+
+    :return: the response from server for synch calls or nothing for asynch
+             calls.
+    :rtype: leap.common.events.events_pb2.EventsResponse or None
+    """
+    request = proto.PingRequest()
+    service = RpcService(
+        proto.EventsServerService_Stub,
+        port,
+        'localhost')
+    logger.debug("Pinging server in port %d..." % port)
+    return service.ping(request, callback=reqcbk, timeout=timeout)
+
+
 class EventsServerService(proto.EventsServerService):
     """
     Service for receiving events in clients.
@@ -139,14 +183,14 @@ class EventsServerService(proto.EventsServerService):
         :param done: callback to be called when done
         :type done: protobuf.socketrpc.server.Callback
         """
-        logger.info('Received signal from client: %s...', str(request)[:40])
+        logger.debug('Received signal from client: %s...', str(request)[:40])
         # send signal to all registered clients
         # TODO: verify signal auth
         if request.event in registered_clients:
             for port in registered_clients[request.event]:
 
                 def callback(req, resp):
-                    logger.info("Signal received by " + str(port))
+                    logger.debug("Signal received by " + str(port))
 
                 service = RpcService(proto.EventsClientService_Stub,
                                      port, 'localhost')
@@ -156,6 +200,22 @@ class EventsServerService(proto.EventsServerService):
         response.status = proto.EventResponse.OK
         done.run(response)
 
+    def ping(self, controller, request, done):
+        """
+        Reply to a ping request.
+
+        :param controller: used to mediate a single method call
+        :type controller: protobuf.socketrpc.controller.SocketRpcController
+        :param request: the request received from the client
+        :type request: leap.common.events.events_pb2.RegisterRequest
+        :param done: callback to be called when done
+        :type done: protobuf.socketrpc.server.Callback
+        """
+        logger.debug("Received ping request, sending response.")
+        response = proto.EventResponse()
+        response.status = proto.EventResponse.OK
+        done.run(response)
+
 
 class EventsServerDaemon(daemon.EventsSingletonDaemon):
     """