StopNodeException is added

Also:
 - New class NodeException is a base class for Start/Stop node exceptions

Author: dmitry-lipetsk

src/__init__.py

@@ -24,6 +24,7 @@
     TimeoutException, \
     CatchUpException, \
     StartNodeException, \
+    StopNodeException, \
     InitNodeException, \
     BackupException, \
     InvalidOperationException
@@ -73,6 +74,7 @@
     "QueryTimeoutException",
     "TimeoutException", "CatchUpException", "StartNodeException", "InitNodeException", "BackupException", "InvalidOperationException",
     "XLogMethod", "IsolationLevel", "NodeStatus", "ProcessType", "DumpFormat",
+    "StopNodeException",
     "NodeApp",
     "PostgresNode",
     "PortManager",

src/exceptions.py

@@ -160,7 +160,7 @@ def __repr__(self) -> str:
         return result
 
 
-class StartNodeException(TestgresException):
+class NodeException(TestgresException):
     _description: typing.Optional[str]
     _files: typing.Optional[typing.Iterable]
 
@@ -224,6 +224,14 @@ def __repr__(self) -> str:
         return result
 
 
+class StartNodeException(NodeException):
+    pass
+
+
+class StopNodeException(NodeException):
+    pass
+
+
 class InitNodeException(TestgresException):
     _message: typing.Optional[str]
 

src/node.py

@@ -46,6 +46,7 @@
     QueryException,     \
     QueryTimeoutException, \
     StartNodeException, \
+    StopNodeException, \
     TimeoutException,   \
     InitNodeException,  \
     TestgresException,  \
@@ -1410,6 +1411,10 @@ def stop(
                 logfile=self.utils_log_file,
             )
             self._manually_started_pm_pid = None
+        except ExecUtilException as e:
+            msg = 'Cannot stop node'
+            files = self._collect_special_files()
+            raise StopNodeException(msg, files) from e
         finally:
             # always stop the reader thread, even if pg_ctl stop failed,
             # so it can't leak into interpreter shutdown.

tests/test_testgres_common.py

@@ -38,6 +38,7 @@
 
 from src import InitNodeException
 from src import StartNodeException
+from src import StopNodeException
 from src import QueryException
 from src import ExecUtilException
 from src import QueryTimeoutException
@@ -539,6 +540,9 @@ def helper_step_of_failure_during_slow_start(
             assert "Connection reset by peer" in str(x.value)
             return False
 
+        if type(x.value) is StopNodeException:
+            return True
+
         assert not node.is_started
         assert node.status() == NodeStatus.Stopped
 
@@ -642,7 +646,11 @@ def test_double_stop(self, node_svc: PostgresNodeService):
                 node.stop()
 
             assert x is not None
-            assert "Is server running?" in str(x.value)
+            e1 = x.value
+            assert type(e1) is StopNodeException
+            e2 = e1.__cause__
+            assert type(e2) is ExecUtilException
+            assert "Is server running?" in str(e2)
 
             assert not node.is_started
 
@@ -2038,7 +2046,7 @@ def impl__test_pg_ctl_wait_option(
             try:
                 node.stop(wait=False)
                 break
-            except ExecUtilException as e:
+            except StopNodeException as e:
                 # it's ok to get this exception here since node
                 # could be not started yet
                 logging.info("Node is not stopped. Exception ({0}): {1}".format(type(e).__name__, e))

tests/units/exceptions/StopNodeException/__init__.py

@@ -0,0 +1,52 @@
+from src.exceptions import StopNodeException
+from src.exceptions import TestgresException as testgres__TestgresException
+
+
+class TestSet001_Constructor:
+    def test_001__default(self):
+        e = StopNodeException()
+        assert type(e) is StopNodeException
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == ""
+        assert e.description is None
+        assert e.files is None
+        assert str(e) == ""
+        assert repr(e) == "StopNodeException()"
+        return
+
+    def test_002__message(self):
+        e = StopNodeException(message="abc\n123")
+        assert type(e) is StopNodeException
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "abc\n123"
+        assert e.description == "abc\n123"
+        assert e.files is None
+        assert str(e) == "abc\n123"
+        assert repr(e) == "StopNodeException(message='abc\\n123')"
+        return
+
+    def test_003__files(self):
+        e = StopNodeException(files=[("f\n1", b'line1\nline2')])
+        assert type(e) is StopNodeException
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "f\n1\n----\nb'line1\\nline2'\n"
+        assert e.description is None
+        assert e.files == [("f\n1", b'line1\nline2')]
+        assert str(e) == "f\n1\n----\nb'line1\\nline2'\n"
+        assert repr(e) == "StopNodeException(files=[('f\\n1', b'line1\\nline2')])"
+        return
+
+    def test_004__all(self):
+        e = StopNodeException(message="mmm", files=[("f\n1", b'line1\nline2')])
+        assert type(e) is StopNodeException
+        assert isinstance(e, testgres__TestgresException)
+        assert e.source is None
+        assert e.message == "mmm\nf\n1\n----\nb'line1\\nline2'\n"
+        assert e.description == "mmm"
+        assert e.files == [("f\n1", b'line1\nline2')]
+        assert str(e) == "mmm\nf\n1\n----\nb'line1\\nline2'\n"
+        assert repr(e) == "StopNodeException(message='mmm', files=[('f\\n1', b'line1\\nline2')])"
+        return