Exception classes are updated (#312)

* PortException is updated

- explicit constructor
- own __repr__ implmentation
- tests

* InitNodeException is updated

- explicit constructor
- own __repr__ implmentation
- tests

* BackupException is updated

- explicit constructor
- own __repr__ implmentation
- tests

* CatchUpException is updated (attention!)

- inherits TestgresException, not QueryException
- explicit constructor
- own __repr__ implmentation
- tests

* QueryTimeoutException replaces TimeoutException

TimeoutException is saved as an alias of QueryTimeoutException

Author: dmitry-lipetsk

src/__init__.py

@@ -19,6 +19,7 @@
     TestgresException, \
     ExecUtilException, \
     QueryException, \
+    QueryTimeoutException, \
     TimeoutException, \
     CatchUpException, \
     StartNodeException, \
@@ -61,7 +62,9 @@
     "NodeBackup", "testgres_config",
     "TestgresConfig", "configure_testgres", "scoped_config", "push_config", "pop_config",
     "NodeConnection", "DatabaseError", "InternalError", "ProgrammingError", "OperationalError",
-    "TestgresException", "ExecUtilException", "QueryException", "TimeoutException", "CatchUpException", "StartNodeException", "InitNodeException", "BackupException", "InvalidOperationException",
+    "TestgresException", "ExecUtilException", "QueryException",
+    QueryTimeoutException.__name__,
+    "TimeoutException", "CatchUpException", "StartNodeException", "InitNodeException", "BackupException", "InvalidOperationException",
     "XLogMethod", "IsolationLevel", "NodeStatus", "ProcessType", "DumpFormat",
     NodeApp.__name__,
     PostgresNode.__name__,

src/exceptions.py

@@ -9,7 +9,38 @@
 
 
 class PortForException(TestgresException):
-    pass
+    _message: typing.Optional[str]
+
+    def __init__(
+        self,
+        message: typing.Optional[str] = None,
+    ):
+        assert message is None or type(message) == str  # noqa: E721
+        super().__init__(message)
+        self._message = message
+        return
+
+    @property
+    def message(self) -> str:
+        assert self._message is None or type(self._message) == str  # noqa: E721
+        if self._message is None:
+            return ""
+        return self._message
+
+    def __repr__(self) -> str:
+        args = []
+
+        if self._message is not None:
+            args.append(("message", self._message))
+
+        result = "{}(".format(type(self).__name__)
+        sep = ""
+        for a in args:
+            result += sep + a[0] + "=" + repr(a[1])
+            sep = ", "
+            continue
+        result += ")"
+        return result
 
 
 @six.python_2_unicode_compatible
@@ -77,12 +108,57 @@ def __repr__(self) -> str:
         return result
 
 
-class TimeoutException(QueryException):
-    pass
+class QueryTimeoutException(QueryException):
+    def __init__(
+        self,
+        message: typing.Optional[str] = None,
+        query: typing.Optional[str] = None
+    ):
+        assert message is None or type(message) == str  # noqa: E721
+        assert query is None or type(query) == str  # noqa: E721
+
+        super().__init__(message, query)
+        return
+
 
+# [2026-01-10] To backward compatibility.
+TimeoutException = QueryTimeoutException
 
-class CatchUpException(QueryException):
-    pass
+
+# [2026-01-10] It inherits TestgresException now, not QueryException
+class CatchUpException(TestgresException):
+    _message: typing.Optional[str]
+
+    def __init__(
+        self,
+        message: typing.Optional[str] = None,
+    ):
+        assert message is None or type(message) == str  # noqa: E721
+        super().__init__(message)
+        self._message = message
+        return
+
+    @property
+    def message(self) -> str:
+        assert self._message is None or type(self._message) == str  # noqa: E721
+        if self._message is None:
+            return ""
+        return self._message
+
+    def __repr__(self) -> str:
+        args = []
+
+        if self._message is not None:
+            args.append(("message", self._message))
+
+        result = "{}(".format(type(self).__name__)
+        sep = ""
+        for a in args:
+            result += sep + a[0] + "=" + repr(a[1])
+            sep = ", "
+            continue
+        result += ")"
+        return result
 
 
 @six.python_2_unicode_compatible
@@ -151,11 +227,73 @@ def __repr__(self) -> str:
 
 
 class InitNodeException(TestgresException):
-    pass
+    _message: typing.Optional[str]
+
+    def __init__(
+        self,
+        message: typing.Optional[str] = None,
+    ):
+        assert message is None or type(message) == str  # noqa: E721
+        super().__init__(message)
+        self._message = message
+        return
+
+    @property
+    def message(self) -> str:
+        assert self._message is None or type(self._message) == str  # noqa: E721
+        if self._message is None:
+            return ""
+        return self._message
+
+    def __repr__(self) -> str:
+        args = []
+
+        if self._message is not None:
+            args.append(("message", self._message))
+
+        result = "{}(".format(type(self).__name__)
+        sep = ""
+        for a in args:
+            result += sep + a[0] + "=" + repr(a[1])
+            sep = ", "
+            continue
+        result += ")"
+        return result
 
 
 class BackupException(TestgresException):
-    pass
+    _message: typing.Optional[str]
+
+    def __init__(
+        self,
+        message: typing.Optional[str] = None,
+    ):
+        assert message is None or type(message) == str  # noqa: E721
+        super().__init__(message)
+        self._message = message
+        return
+
+    @property
+    def message(self) -> str:
+        assert self._message is None or type(self._message) == str  # noqa: E721
+        if self._message is None:
+            return ""
+        return self._message
+
+    def __repr__(self) -> str:
+        args = []
+
+        if self._message is not None:
+            args.append(("message", self._message))
+
+        result = "{}(".format(type(self).__name__)
+        sep = ""
+        for a in args:
+            result += sep + a[0] + "=" + repr(a[1])
+            sep = ", "
+            continue
+        result += ")"
+        return result
 
 
 assert ExecUtilException.__name__ == "ExecUtilException"

src/node.py

@@ -71,6 +71,7 @@
     CatchUpException,   \
     ExecUtilException,  \
     QueryException,     \
+    QueryTimeoutException, \
     StartNodeException, \
     TimeoutException,   \
     InitNodeException,  \
@@ -112,6 +113,9 @@
 OperationalError = pglib.OperationalError
 
 
+assert TimeoutException == QueryTimeoutException
+
+
 class ProcessProxy(object):
     """
     Wrapper for psutil.Process
@@ -1620,7 +1624,7 @@ def poll_query_until(self,
             time.sleep(sleep_time)
             attempts += 1
 
-        raise TimeoutException('Query timeout')
+        raise QueryTimeoutException('Query timeout', query)
 
     @method_decorator(positional_args_hack(['dbname', 'query']))
     def execute(self,

tests/test_testgres_common.py

@@ -27,7 +27,7 @@
 from src import StartNodeException
 from src import QueryException
 from src import ExecUtilException
-from src import TimeoutException
+from src import QueryTimeoutException
 from src import InvalidOperationException
 from src import BackupException
 from src import ProgrammingError
@@ -864,7 +864,7 @@ def test_poll_query_until(self, node_svc: PostgresNodeService):
                 expected=None)
 
             # check arbitrary expected value, fail
-            with pytest.raises(expected_exception=TimeoutException):
+            with pytest.raises(expected_exception=QueryTimeoutException):
                 node.poll_query_until(query='select 3',
                                       expected=1,
                                       max_attempts=3,
@@ -874,7 +874,7 @@ def test_poll_query_until(self, node_svc: PostgresNodeService):
             node.poll_query_until(query='select 2', expected=2)
 
             # check timeout
-            with pytest.raises(expected_exception=TimeoutException):
+            with pytest.raises(expected_exception=QueryTimeoutException):
                 node.poll_query_until(query='select 1 > 2',
                                       max_attempts=3,
                                       sleep_time=0.01)
@@ -884,7 +884,7 @@ def test_poll_query_until(self, node_svc: PostgresNodeService):
                 node.poll_query_until(query='dummy1')
 
             # check ProgrammingError, ok
-            with pytest.raises(expected_exception=(TimeoutException)):
+            with pytest.raises(expected_exception=(QueryTimeoutException)):
                 node.poll_query_until(query='dummy2',
                                       max_attempts=3,
                                       sleep_time=0.01,

tests/units/exceptions/BackupException/__init__.py

@@ -0,0 +1,24 @@
+from src.exceptions import BackupException
+from src.exceptions import TestgresException as testgres__TestgresException
+
+
+class TestSet001_Constructor:
+    def test_001__default(self):
+        e = BackupException()
+        assert type(e) == BackupException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == ""
+        assert str(e) == ""
+        assert repr(e) == "BackupException()"
+        return
+
+    def test_002__message(self):
+        e = BackupException(message="abc\n123")
+        assert type(e) == BackupException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "abc\n123"
+        assert str(e) == "abc\n123"
+        assert repr(e) == "BackupException(message='abc\\n123')"
+        return

tests/units/exceptions/BackupException/test_set001__constructor.py

@@ -0,0 +1,24 @@
+from src.exceptions import CatchUpException
+from src.exceptions import TestgresException as testgres__TestgresException
+
+
+class TestSet001_Constructor:
+    def test_001__default(self):
+        e = CatchUpException()
+        assert type(e) == CatchUpException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == ""
+        assert str(e) == ""
+        assert repr(e) == "CatchUpException()"
+        return
+
+    def test_002__message(self):
+        e = CatchUpException(message="abc\n123")
+        assert type(e) == CatchUpException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "abc\n123"
+        assert str(e) == "abc\n123"
+        assert repr(e) == "CatchUpException(message='abc\\n123')"
+        return

tests/units/exceptions/CatchUpException/__init__.py

@@ -0,0 +1,24 @@
+from src.exceptions import InitNodeException
+from src.exceptions import TestgresException as testgres__TestgresException
+
+
+class TestSet001_Constructor:
+    def test_001__default(self):
+        e = InitNodeException()
+        assert type(e) == InitNodeException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == ""
+        assert str(e) == ""
+        assert repr(e) == "InitNodeException()"
+        return
+
+    def test_002__message(self):
+        e = InitNodeException(message="abc\n123")
+        assert type(e) == InitNodeException  # noqa: E721
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "abc\n123"
+        assert str(e) == "abc\n123"
+        assert repr(e) == "InitNodeException(message='abc\\n123')"
+        return