From: Nicki Křížek <nicki@isc.org>
Date: Mon, 23 Jun 2025 15:36:08 +0000 (+0200)
Subject: Change NamedInstance.rndc() doctest into doc example
X-Git-Tag: v9.21.11~40^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcfb6c23da975427e73a21a77636b6f5afcfe5ac;p=thirdparty%2Fbind9.git

Change NamedInstance.rndc() doctest into doc example

The test is troublesome, because NamedInstance(identifier) expects that
a directory with such a name exists. While it'd be possible to mock
those directories as well, it'd make the doctest overly long and
complex, which isn't justified, given that it's only testing a couple of
options. Turn it into regular documentation instead.
---

diff --git a/bin/tests/system/isctest/instance.py b/bin/tests/system/isctest/instance.py
index ee2916b9e6d..83d396d1cd4 100644
--- a/bin/tests/system/isctest/instance.py
+++ b/bin/tests/system/isctest/instance.py
@@ -118,35 +118,28 @@ class NamedInstance:
         The RNDC command will be logged to `rndc.log` (along with the server's
         response) unless `log` is set to `False`.
 
-        >>> # Instances of the `NamedInstance` class are expected to be passed
-        >>> # to pytest tests as fixtures; here, some instances are created
-        >>> # directly (with a fake RNDC executor) so that doctest can work.
-        >>> import unittest.mock
-        >>> mock_rndc_executor = unittest.mock.Mock()
-        >>> ns1 = NamedInstance("ns1", rndc_executor=mock_rndc_executor)
-        >>> ns2 = NamedInstance("ns2", rndc_executor=mock_rndc_executor)
-        >>> ns3 = NamedInstance("ns3", rndc_executor=mock_rndc_executor)
-        >>> ns4 = NamedInstance("ns4", rndc_executor=mock_rndc_executor)
-
-        >>> # Send the "status" command to ns1.  An `RNDCException` will be
-        >>> # raised if the RNDC command fails.  This command will be logged.
-        >>> response = ns1.rndc("status")
-
-        >>> # Send the "thaw foo" command to ns2.  No exception will be raised
-        >>> # in case the RNDC command fails.  This command will be logged
-        >>> # (even if it fails).
-        >>> response = ns2.rndc("thaw foo", ignore_errors=True)
-
-        >>> # Send the "stop" command to ns3.  An `RNDCException` will be
-        >>> # raised if the RNDC command fails, but this command will not be
-        >>> # logged (the server's response will still be returned to the
-        >>> # caller, though).
-        >>> response = ns3.rndc("stop", log=False)
-
-        >>> # Send the "halt" command to ns4 in "fire & forget mode": no
-        >>> # exceptions will be raised and no logging will take place (the
-        >>> # server's response will still be returned to the caller, though).
-        >>> response = ns4.rndc("stop", ignore_errors=True, log=False)
+        ```python
+        def test_foo(servers):
+            # Send the "status" command to ns1.  An `RNDCException` will be
+            # raised if the RNDC command fails.  This command will be logged.
+            response = servers["ns1"].rndc("status")
+
+            # Send the "thaw foo" command to ns2.  No exception will be raised
+            # in case the RNDC command fails.  This command will be logged
+            # (even if it fails).
+            response = servers["ns2"].rndc("thaw foo", ignore_errors=True)
+
+            # Send the "stop" command to ns3.  An `RNDCException` will be
+            # raised if the RNDC command fails, but this command will not be
+            # logged (the server's response will still be returned to the
+            # caller, though).
+            response = servers["ns3"].rndc("stop", log=False)
+
+            # Send the "halt" command to ns4 in "fire & forget mode": no
+            # exceptions will be raised and no logging will take place (the
+            # server's response will still be returned to the caller, though).
+            response = servers["ns4"].rndc("stop", ignore_errors=True, log=False)
+        ```
         """
         try:
             response = self._rndc_executor.call(self.ip, self.ports.rndc, command)