Merge "Improve usability when backdoor_port is nonzero"

2 files changed, 129 insertions, 4 deletions

diff --git a/tests/unit/test_eventlet_backdoor.py b/tests/unit/test_eventlet_backdoor.py
new file mode 100644
index 0000000..986678e
--- /dev/null
+++ b/tests/unit/test_eventlet_backdoor.py
@@ -0,0 +1,71 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2010 United States Government as represented by the
+# Administrator of the National Aeronautics and Space Administration.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""
+Unit Tests for eventlet backdoor
+"""
+import errno
+import eventlet
+import mox
+import socket
+
+from openstack.common import eventlet_backdoor
+from tests import utils
+
+
+class BackdoorPortTest(utils.BaseTestCase):
+
+    def common_backdoor_port_setup(self):
+        self.sock = self.mox.CreateMockAnything()
+        self.mox.StubOutWithMock(eventlet, 'listen')
+        self.mox.StubOutWithMock(eventlet, 'spawn_n')
+
+    def test_backdoor_port_inuse(self):
+        self.config(backdoor_port=2345)
+        self.common_backdoor_port_setup()
+        eventlet.listen(('localhost', 2345)).AndRaise(
+            socket.error(errno.EADDRINUSE, ''))
+        self.mox.ReplayAll()
+        self.assertRaises(socket.error,
+                          eventlet_backdoor.initialize_if_enabled)
+
+    def test_backdoor_port_range(self):
+        self.config(backdoor_port='8800:8899')
+        self.common_backdoor_port_setup()
+        eventlet.listen(('localhost', 8800)).AndReturn(self.sock)
+        self.sock.getsockname().AndReturn(('127.0.0.1', 8800))
+        eventlet.spawn_n(eventlet.backdoor.backdoor_server, self.sock,
+                         locals=mox.IsA(dict))
+        self.mox.ReplayAll()
+        port = eventlet_backdoor.initialize_if_enabled()
+        self.assertEqual(port, 8800)
+
+    def test_backdoor_port_range_all_inuse(self):
+        self.config(backdoor_port='8800:8899')
+        self.common_backdoor_port_setup()
+        for i in range(8800, 8900):
+            eventlet.listen(('localhost', i)).AndRaise(
+                socket.error(errno.EADDRINUSE, ''))
+        self.mox.ReplayAll()
+        self.assertRaises(socket.error,
+                          eventlet_backdoor.initialize_if_enabled)
+
+    def test_backdoor_port_bad(self):
+        self.config(backdoor_port='abc')
+        self.assertRaises(eventlet_backdoor.EventletBackdoorConfigValueError,
+                          eventlet_backdoor.initialize_if_enabled)
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 7e07f28..0f93830 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -17,18 +17,23 @@
 #    under the License.
 
 """
-Unit Tests for remote procedure calls using queue
+Unit Tests for service class
 """
 
 from __future__ import print_function
 
+import errno
+import eventlet
+import mox
 import os
 import signal
+import socket
 import time
 import traceback
 
 from oslo.config import cfg
 
+from openstack.common import eventlet_backdoor
 from openstack.common import log as logging
 from openstack.common.notifier import api as notifier_api
 from openstack.common import service
@@ -191,10 +196,59 @@ class ServiceLauncherTest(utils.BaseTestCase):
 
 
 class LauncherTest(utils.BaseTestCase):
+
     def test_backdoor_port(self):
-        # backdoor port should get passed to the service being launched
-        self.config(backdoor_port=1234)
+        self.config(backdoor_port='1234')
+
+        sock = self.mox.CreateMockAnything()
+        self.mox.StubOutWithMock(eventlet, 'listen')
+        self.mox.StubOutWithMock(eventlet, 'spawn_n')
+
+        eventlet.listen(('localhost', 1234)).AndReturn(sock)
+        sock.getsockname().AndReturn(('127.0.0.1', 1234))
+        eventlet.spawn_n(eventlet.backdoor.backdoor_server, sock,
+                         locals=mox.IsA(dict))
+
+        self.mox.ReplayAll()
+
         svc = service.Service()
         launcher = service.launch(svc)
-        self.assertEqual(1234, svc.backdoor_port)
+        self.assertEqual(svc.backdoor_port, 1234)
         launcher.stop()
+
+    def test_backdoor_inuse(self):
+        sock = eventlet.listen(('localhost', 0))
+        port = sock.getsockname()[1]
+        self.config(backdoor_port=port)
+        svc = service.Service()
+        self.assertRaises(socket.error,
+                          service.launch, svc)
+        sock.close()
+
+    def test_backdoor_port_range_one_inuse(self):
+        self.config(backdoor_port='8800:8900')
+
+        sock = self.mox.CreateMockAnything()
+        self.mox.StubOutWithMock(eventlet, 'listen')
+        self.mox.StubOutWithMock(eventlet, 'spawn_n')
+
+        eventlet.listen(('localhost', 8800)).AndRaise(
+            socket.error(errno.EADDRINUSE, ''))
+        eventlet.listen(('localhost', 8801)).AndReturn(sock)
+        sock.getsockname().AndReturn(('127.0.0.1', 8801))
+        eventlet.spawn_n(eventlet.backdoor.backdoor_server, sock,
+                         locals=mox.IsA(dict))
+
+        self.mox.ReplayAll()
+
+        svc = service.Service()
+        launcher = service.launch(svc)
+        self.assertEqual(svc.backdoor_port, 8801)
+        launcher.stop()
+
+    def test_backdoor_port_reverse_range(self):
+        # backdoor port should get passed to the service being launched
+        self.config(backdoor_port='8888:7777')
+        svc = service.Service()
+        self.assertRaises(eventlet_backdoor.EventletBackdoorConfigValueError,
+                          service.launch, svc)