Merge lp:~cjwatson/rabbitfixture/ctl-dist-port into lp:rabbitfixture

[Colin Watson]

Set RABBITMQ_CTL_DIST_PORT_{MIN,MAX} environment variables.

Otherwise `rabbitmqctl` starts this port range at `RABBITMQ_DIST_PORT` + 10000, which may exceed 65535.

Needed as of rabbitmq-server 3.7.4.

I gave this a full test run on a hacked focal buildbot worker, and it's behaving much better - no more `RabbitMQLayer` setup failures in the test runs I did there.

[William Grant (wgrant)]

Oh my, good find.

review: Approve (code)

[Jürgen Gmach (jugmac00)]

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2022-09-01 15:47:58 +0000
+++ NEWS.rst	2022-09-06 23:52:37 +0000
@@ -5,7 +5,9 @@
 0.5.3
 =====
 
-- Nothing yet.
+- Set ``RABBITMQ_CTL_DIST_PORT_MIN`` and ``RABBITMQ_CTL_DIST_PORT_MAX``
+  environment variables, as otherwise ``rabbitmqctl`` starts this port range
+  at ``RABBITMQ_DIST_PORT`` + 10000, which may exceed 65535.
 
 0.5.2 (2022-08-01)
 ==================

=== modified file 'rabbitfixture/server.py'
--- rabbitfixture/server.py	2022-09-01 11:48:33 +0000
+++ rabbitfixture/server.py	2022-09-06 23:52:37 +0000
@@ -122,6 +122,9 @@
     :ivar dist_port: A port that was free at the time setUp() was
         called. Used for the `RABBITMQ_DIST_PORT` environment variable,
         which is related to clustering in RabbitMQ >= 3.3.
+    :ivar ctl_dist_port: A port that was free at the time setUp() was
+        called. Used for the `RABBITMQ_CTL_DIST_PORT_MIN` environment
+        variable.
     :ivar homedir: A directory to put the RabbitMQ logs in.
     :ivar mnesiadir: A directory for the RabbitMQ db.
     :ivar logfile: The logfile allocated for the server.
@@ -131,12 +134,13 @@
 
     def __init__(self, hostname=None, port=None, homedir=None,
                  mnesiadir=None, logfile=None, nodename=None,
-                 dist_port=None):
+                 dist_port=None, ctl_dist_port=None):
         super(RabbitServerResources, self).__init__()
         self._defaults = dict(
             hostname=hostname,
             port=port,
             dist_port=dist_port,
+            ctl_dist_port=ctl_dist_port,
             homedir=homedir,
             mnesiadir=mnesiadir,
             logfile=logfile,
@@ -148,10 +152,16 @@
         self.__dict__.update(self._defaults)
         if self.hostname is None:
             self.hostname = 'localhost'
+        port_vars = []
         if self.port is None:
-            [self.port] = allocate_ports(self.hostname)
+            port_vars.append("port")
         if self.dist_port is None:
-            [self.dist_port] = allocate_ports(self.hostname)
+            port_vars.append("dist_port")
+        if self.ctl_dist_port is None:
+            port_vars.append("ctl_dist_port")
+        ports = allocate_ports(*([self.hostname] * len(port_vars)))
+        for port_var, port in zip(port_vars, ports):
+            setattr(self, port_var, port)
         if self.homedir is None:
             self.homedir = self.useFixture(TempDir()).path
         if self.mnesiadir is None:
@@ -181,6 +191,8 @@
     - ``RABBITMQ_NODE_IP_ADDRESS``
     - ``RABBITMQ_NODE_PORT``
     - ``RABBITMQ_DIST_PORT``
+    - ``RABBITMQ_CTL_DIST_PORT_MIN``
+    - ``RABBITMQ_CTL_DIST_PORT_MAX``
     - ``RABBITMQ_NODENAME``
     - ``RABBITMQ_PLUGINS_DIR``
     - ``RABBITMQ_ENABLED_PLUGINS_FILE``
@@ -212,6 +224,10 @@
         self.useFixture(EnvironmentVariableFixture(
             "RABBITMQ_DIST_PORT", str(self.config.dist_port)))
         self.useFixture(EnvironmentVariableFixture(
+            "RABBITMQ_CTL_DIST_PORT_MIN", str(self.config.ctl_dist_port)))
+        self.useFixture(EnvironmentVariableFixture(
+            "RABBITMQ_CTL_DIST_PORT_MAX", str(self.config.ctl_dist_port + 10)))
+        self.useFixture(EnvironmentVariableFixture(
             "RABBITMQ_NODENAME", self.config.fq_nodename))
         self.useFixture(EnvironmentVariableFixture(
             "RABBITMQ_ENABLED_PLUGINS_FILE", self.config.pluginsfile))

=== modified file 'rabbitfixture/tests/test_server.py'
--- rabbitfixture/tests/test_server.py	2021-02-01 12:16:29 +0000
+++ rabbitfixture/tests/test_server.py	2022-09-06 23:52:37 +0000
@@ -125,6 +125,7 @@
             self.assertEqual("localhost", resources.hostname)
             self.assertIsInstance(resources.port, int)
             self.assertIsInstance(resources.dist_port, int)
+            self.assertIsInstance(resources.ctl_dist_port, int)
             self.assertIsInstance(resources.homedir, six.string_types)
             self.assertIsInstance(resources.mnesiadir, six.string_types)
             self.assertIsInstance(resources.logfile, six.string_types)
@@ -134,7 +135,7 @@
 
     def test_passed_to_init(self):
         args = dict(
-            hostname="hostname", port=1234, dist_port=2345,
+            hostname="hostname", port=1234, dist_port=2345, ctl_dist_port=3456,
             homedir="homedir", mnesiadir="mnesiadir",
             logfile="logfile", nodename="nodename")
         resources = RabbitServerResources(**args)
@@ -172,6 +173,8 @@
             "RABBITMQ_NODE_IP_ADDRESS": socket.gethostbyname(config.hostname),
             "RABBITMQ_NODE_PORT": str(config.port),
             "RABBITMQ_DIST_PORT": str(config.dist_port),
+            "RABBITMQ_CTL_DIST_PORT_MIN": str(config.ctl_dist_port),
+            "RABBITMQ_CTL_DIST_PORT_MAX": str(config.ctl_dist_port + 10),
             "RABBITMQ_NODENAME": config.fq_nodename,
             "RABBITMQ_ENABLED_PLUGINS_FILE": config.pluginsfile,
         }