Merge lp:~cjwatson/rabbitfixture/ctltimeout-parameter into lp:rabbitfixture

[Colin Watson]

Allow changing the default server control timeout.

The default of 15 often seems to not quite be enough for massively-parallel Launchpad tests, but rather than changing the hardcoded value I'd rather make it a parameter.

[Kristian Glass (doismellburning)]

review: Approve

=== modified file 'rabbitfixture/server.py'
--- rabbitfixture/server.py	2019-03-22 18:01:19 +0000
+++ rabbitfixture/server.py	2019-08-21 13:58:53 +0000
@@ -167,14 +167,16 @@
 
     """
 
-    def __init__(self, config):
+    def __init__(self, config, ctltimeout=None):
         """Create a `RabbitServerEnvironment` instance.
 
         :param config: An object exporting the variables
             `RabbitServerResources` exports.
+        :param ctltimeout: Timeout for server control operations.
         """
         super(RabbitServerEnvironment, self).__init__()
         self.config = config
+        self._ctltimeout = ctltimeout or 15
 
     def setUp(self):
         super(RabbitServerEnvironment, self).setUp()
@@ -212,7 +214,7 @@
 
     @property
     def ctltimeout(self):
-        return 15
+        return self._ctltimeout
 
     def rabbitctl(self, command, strip=False, timeout=None):
         """Executes a ``rabbitctl`` command and returns status."""
@@ -269,7 +271,7 @@
 class RabbitServerRunner(Fixture):
     """Run a RabbitMQ server."""
 
-    def __init__(self, config):
+    def __init__(self, config, ctltimeout=None):
         """Create a `RabbitServerRunner` instance.
 
         :param config: An object exporting the variables
@@ -277,12 +279,13 @@
         """
         super(RabbitServerRunner, self).__init__()
         self.config = config
+        self._ctltimeout = ctltimeout
         self.process = None
 
     def setUp(self):
         super(RabbitServerRunner, self).setUp()
         self.environment = self.useFixture(
-            RabbitServerEnvironment(self.config))
+            RabbitServerEnvironment(self.config, ctltimeout=self._ctltimeout))
         self._start()
 
     def is_running(self):
@@ -344,7 +347,7 @@
         self._spawn()
         # Wait for the server to come up: stop when the process is dead, or
         # the timeout expires, or the server responds.
-        timeout = time.time() + 15
+        timeout = time.time() + self.environment.ctltimeout
         while time.time() < timeout and self.is_running():
             if self.environment.is_node_running():
                 break
@@ -358,8 +361,8 @@
         # fails to get together.
         self.addCleanup(self._stop)
         # `rabbitctl status` can say a node is up before it is ready to accept
-        # connections. Wait at least 5 more seconds for the node to come up...
-        timeout = max(timeout, time.time() + 5)
+        # connections. Wait for the node to come up...
+        timeout = max(timeout, time.time() + self.environment.ctltimeout)
         while time.time() < timeout and self.check_running():
             try:
                 self.environment.get_connection().close()
@@ -384,7 +387,7 @@
         try:
             self._request_stop()
             # Wait for the node to go down...
-            timeout = time.time() + 15
+            timeout = time.time() + self.environment.ctltimeout
             while time.time() < timeout:
                 if not self.environment.is_node_running():
                     break
@@ -396,8 +399,8 @@
             # Go straight to killing the process directly.
             timeout = time.time()
 
-        # Wait at least 5 more seconds for the process to end...
-        timeout = max(timeout, time.time() + 5)
+        # Wait for the process to end...
+        timeout = max(timeout, time.time() + self.environment.ctltimeout)
         while time.time() < timeout:
             if not self.is_running():
                 break
@@ -427,14 +430,16 @@
     :ivar runner: The `RabbitServerRunner` that bootstraps the server.
     """
 
-    def __init__(self, config=None):
+    def __init__(self, config=None, ctltimeout=None):
         super(RabbitServer, self).__init__()
         self.config = config
+        self._ctltimeout = ctltimeout
 
     def setUp(self):
         super(RabbitServer, self).setUp()
         if self.config is None:
             self.config = RabbitServerResources()
         self.useFixture(self.config)
-        self.runner = RabbitServerRunner(self.config)
+        self.runner = RabbitServerRunner(
+            self.config, ctltimeout=self._ctltimeout)
         self.useFixture(self.runner)

=== modified file 'rabbitfixture/tests/test_server.py'
--- rabbitfixture/tests/test_server.py	2019-03-22 18:01:19 +0000
+++ rabbitfixture/tests/test_server.py	2019-08-21 13:58:53 +0000
@@ -76,7 +76,7 @@
             f.write("while :; do sleep 1 || exit; done\n")
         os.chmod(fakectlbin, stat.S_IRWXU)
 
-        with RabbitServer() as fixture:
+        with RabbitServer(ctltimeout=0.1) as fixture:
             try:
                 connect_arguments = {
                     "host": 'localhost:%s' % fixture.config.port,
@@ -87,9 +87,6 @@
                 self.useFixture(MonkeyPatch(
                     "rabbitfixture.server.RabbitServerEnvironment.ctlbin",
                     fakectlbin))
-                self.useFixture(MonkeyPatch(
-                    "rabbitfixture.server.RabbitServerEnvironment.ctltimeout",
-                    0.1))
             except Exception:
                 # self.useFixture() is not being used because we want to
                 # handle the fixture's lifecycle, so we must also be