PostgresNode::safe_psql raises InvalidOperationException

If expect_error is True and no error is detected, safe_psql raises InvalidOperationException exception. Tests (local, remote) are added.
postgrespro · dmitry-lipetsk · Dec 10, 2024 · Dec 8, 2024 · Dec 9, 2024 · Dec 9, 2024
commit f848a63fd3dce4a50d1a994f2b5ee1ce9e15a7b6
diff --git a/testgres/__init__.py b/testgres/__init__.py
@@ -23,7 +23,8 @@
     CatchUpException, \
     StartNodeException, \
     InitNodeException, \
-    BackupException
+    BackupException, \
+    InvalidOperationException
 
 from .enums import \
     XLogMethod, \

diff --git a/testgres/exceptions.py b/testgres/exceptions.py
@@ -103,3 +103,6 @@ class InitNodeException(TestgresException):
 
 class BackupException(TestgresException):
     pass
+
+class InvalidOperationException(TestgresException):
+    pass
diff --git a/testgres/node.py b/testgres/node.py
@@ -73,7 +73,8 @@
     TimeoutException,   \
     InitNodeException,  \
     TestgresException,  \
-    BackupException
+    BackupException, \
+    InvalidOperationException
 
 from .logger import TestgresLogger
 
@@ -1089,7 +1090,7 @@ def safe_psql(self, query=None, expect_error=False, **kwargs):
             return e.error
 
         if expect_error:
-            assert False, "Exception was expected, but query finished successfully: `{}` ".format(query)
+            raise InvalidOperationException("Exception was expected, but query finished successfully: `{}`.".format(query))
 
         return out
 

diff --git a/tests/test_simple.py b/tests/test_simple.py
@@ -23,7 +23,9 @@
     BackupException, \
     QueryException, \
     TimeoutException, \
-    TestgresException, NodeApp
+    TestgresException, \
+    InvalidOperationException, \
+    NodeApp
 
 from testgres import \
     TestgresConfig, \
@@ -310,6 +312,23 @@ def test_psql(self):
             with self.assertRaises(QueryException):
                 node.safe_psql('select 1')
 
+    def test_safe_psql__expect_error(self):
+        with get_new_node().init().start() as node:
+            err = node.safe_psql('select_or_not_select 1', expect_error=True)
+            self.assertTrue(type(err) == str)  # noqa: E721
+            self.assertIn('select_or_not_select', err)
+            self.assertIn('ERROR:  syntax error at or near "select_or_not_select"', err)
+
+            # ---------
+            with self.assertRaises(InvalidOperationException) as ctx:
+                node.safe_psql("select 1;", expect_error=True)
+
+            self.assertEqual(str(ctx.exception), "Exception was expected, but query finished successfully: `select 1;`.")
+
+            # ---------
+            res = node.safe_psql("select 1;", expect_error=False)
+            self.assertEqual(res, b'1\n')
+
     def test_transactions(self):
         with get_new_node().init().start() as node:
 

diff --git a/tests/test_simple_remote.py b/tests/test_simple_remote.py
@@ -23,7 +23,8 @@
     BackupException, \
     QueryException, \
     TimeoutException, \
-    TestgresException
+    TestgresException, \
+    InvalidOperationException
 
 from testgres.config import \
     TestgresConfig, \
@@ -295,6 +296,23 @@ def test_psql(self):
             with self.assertRaises(QueryException):
                 node.safe_psql('select 1')
 
+    def test_safe_psql__expect_error(self):
+        with get_remote_node(conn_params=conn_params).init().start() as node:
+            err = node.safe_psql('select_or_not_select 1', expect_error=True)
+            self.assertTrue(type(err) == str)  # noqa: E721
+            self.assertIn('select_or_not_select', err)
+            self.assertIn('ERROR:  syntax error at or near "select_or_not_select"', err)
+
+            # ---------
+            with self.assertRaises(InvalidOperationException) as ctx:
+                node.safe_psql("select 1;", expect_error=True)
+
+            self.assertEqual(str(ctx.exception), "Exception was expected, but query finished successfully: `select 1;`.")
+
+            # ---------
+            res = node.safe_psql("select 1;", expect_error=False)
+            self.assertEqual(res, b'1\n')
+
     def test_transactions(self):
         with get_remote_node(conn_params=conn_params).init().start() as node:
             with node.connect() as con:
-Original file line number
+Diff line change
@@ Expand Up / @@ -103,3 +103,6 @@ class InitNodeException(TestgresException): @@
     class BackupException(TestgresException):
         pass
+    class InvalidOperationException(TestgresException):
+        pass