feat(testing): add more logging during test suite

Activate `pytest`'s `logcli` setting to better read the client lifecycle during testing.
Add `log()` function to KazooTestHarness class so that it is possible to log like crazy when something is not working
Display the ZK client port in logs when starting a ZK server (useful for test "debug")
Be able to get more than the last 100 lines of ZK logs (can be useful, believe me)

Author: StephenSorriaux

kazoo/testing/common.py

@@ -221,8 +221,9 @@ def run(self):
         )
         self.process = subprocess.Popen(args=args)
         log.info(
-            "Started zookeeper process %s using args %s",
+            "Started zookeeper process %s on port %s using args %s",
             self.process.pid,
+            self.server_info.client_port,
             args,
         )
         self._running = True
@@ -304,12 +305,12 @@ def destroy(self):
 
         shutil.rmtree(self.working_path, True)
 
-    def get_logs(self):
+    def get_logs(self, num_lines=100):
         log_path = pathlib.Path(self.working_path, "zookeeper.log")
         if log_path.exists():
             log_file = log_path.open("r")
             lines = log_file.readlines()
-            return lines[-100:]
+            return lines[-num_lines:]
         return []
 
 

kazoo/testing/harness.py

@@ -167,6 +167,9 @@ def __init__(self, *args, **kw):
     def cluster(self):
         return get_global_cluster()
 
+    def log(self, level, msg, *args, **kwargs):
+        log.log(level, msg, *args, **kwargs)
+
     @property
     def servers(self):
         return ",".join([s.address for s in self.cluster])

kazoo/tests/conftest.py

@@ -4,8 +4,10 @@
 
 
 def pytest_exception_interact(node, call, report):
-    if hasattr(node._testcase, "cluster"):
+    try:
         cluster = node._testcase.cluster
         log.error("Zookeeper cluster logs:")
         for logs in cluster.get_logs():
             log.error(logs)
+    except Exception:
+        log.exception("Cannot get ZK logs:")

pyproject.toml

@@ -21,6 +21,10 @@ extend-exclude = '''
 
 [tool.pytest.ini_options]
 addopts = "-ra -v"
+log_cli = true
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+log_cli_format = "%(asctime)s %(levelname)s %(message)s"
+log_cli_level = "INFO"
 
 [tool.mypy]