From f45e777b9f544fe4b6958129ded563eba4585307 Mon Sep 17 00:00:00 2001
From: Tom Krizek <tkrizek@isc.org>
Date: Fri, 22 Dec 2023 10:55:17 +0100
Subject: [PATCH] Add LogFile helper

LogFile class contains a log path and has means to find a string in the
log file.

(cherry picked from commit 05b0ebac0fae3cfc88a216b60a748d56f6eaed42)
---
 bin/tests/system/isctest/__init__.py          |  2 +-
 bin/tests/system/isctest/instance.py          |  8 ++---
 .../system/isctest/{watchlog.py => log.py}    | 36 ++++++++++++++++++-
 3 files changed, 40 insertions(+), 6 deletions(-)
 rename bin/tests/system/isctest/{watchlog.py => log.py} (91%)

diff --git a/bin/tests/system/isctest/__init__.py b/bin/tests/system/isctest/__init__.py
index a55c128007..3ea82a3f45 100644
--- a/bin/tests/system/isctest/__init__.py
+++ b/bin/tests/system/isctest/__init__.py
@@ -13,4 +13,4 @@ from . import check
 from . import instance
 from . import query
 from . import rndc
-from . import watchlog
+from . import log
diff --git a/bin/tests/system/isctest/instance.py b/bin/tests/system/isctest/instance.py
index fdac94c7d2..ede48c095c 100644
--- a/bin/tests/system/isctest/instance.py
+++ b/bin/tests/system/isctest/instance.py
@@ -18,7 +18,7 @@ import os
 import re
 
 from .rndc import RNDCBinaryExecutor, RNDCException, RNDCExecutor
-from .watchlog import WatchLogFromStart, WatchLogFromHere
+from .log import LogFile, WatchLogFromStart, WatchLogFromHere
 
 
 class NamedPorts(NamedTuple):
@@ -63,7 +63,7 @@ class NamedInstance:
         """
         self.ip = self._identifier_to_ip(identifier)
         self.ports = ports
-        self._log_file = os.path.join(identifier, "named.run")
+        self.log = LogFile(os.path.join(identifier, "named.run"))
         self._rndc_executor = rndc_executor or RNDCBinaryExecutor()
         self._rndc_logger = rndc_logger or logging.getLogger()
 
@@ -133,14 +133,14 @@ class NamedInstance:
         Return an instance of the `WatchLogFromStart` context manager for this
         `named` instance's log file.
         """
-        return WatchLogFromStart(self._log_file)
+        return WatchLogFromStart(self.log.path)
 
     def watch_log_from_here(self) -> WatchLogFromHere:
         """
         Return an instance of the `WatchLogFromHere` context manager for this
         `named` instance's log file.
         """
-        return WatchLogFromHere(self._log_file)
+        return WatchLogFromHere(self.log.path)
 
     def reconfigure(self) -> None:
         """
diff --git a/bin/tests/system/isctest/watchlog.py b/bin/tests/system/isctest/log.py
similarity index 91%
rename from bin/tests/system/isctest/watchlog.py
rename to bin/tests/system/isctest/log.py
index 1456c535c9..38c1143821 100644
--- a/bin/tests/system/isctest/watchlog.py
+++ b/bin/tests/system/isctest/log.py
@@ -9,7 +9,7 @@
 # See the COPYRIGHT file distributed with this work for additional
 # information regarding copyright ownership.
 
-from typing import Optional, TextIO, Dict, Any, overload, List, Union
+from typing import Iterator, Optional, TextIO, Dict, Any, overload, List, Union
 
 import abc
 import os
@@ -22,6 +22,40 @@ class WatchLogException(Exception):
     pass
 
 
+class LogFile:
+    """
+    Log file wrapper with a path and means to find a string in its contents.
+    """
+
+    def __init__(self, path: str):
+        self.path = path
+
+    @property
+    def _lines(self) -> Iterator[str]:
+        with open(self.path, encoding="utf-8") as f:
+            yield from f
+
+    def __contains__(self, substring: str) -> bool:
+        """
+        Return whether any of the lines in the log contains a given string.
+        """
+        for line in self._lines:
+            if substring in line:
+                return True
+        return False
+
+    def expect(self, msg: str):
+        """Check the string is present anywhere in the log file."""
+        if msg in self:
+            return
+        assert False, f"log message not found in log {self.path}: {msg}"
+
+    def prohibit(self, msg: str):
+        """Check the string is not present in the entire log file."""
+        if msg in self:
+            assert False, f"forbidden message appeared in log {self.path}: {msg}"
+
+
 class WatchLog(abc.ABC):
 
     """