Merge branch 'master' into skip-ssl-check

dmitry-lipetsk · dmitry-lipetsk · commit 547081ee3583 · 2024-12-04T10:48:37.000+03:00
diff --git a/README.md b/README.md
@@ -59,12 +59,12 @@ with testgres.get_new_node() as node:
 # ... node stops and its files are about to be removed
 ```
 
-There are four API methods for runnig queries:
+There are four API methods for running queries:
 
 | Command | Description |
 |----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
 | `node.psql(query, ...)` | Runs query via `psql` command and returns tuple `(error code, stdout, stderr)`. |
-| `node.safe_psql(query, ...)` | Same as `psql()` except that it returns only `stdout`. If an error occures during the execution, an exception will be thrown. |
+| `node.safe_psql(query, ...)` | Same as `psql()` except that it returns only `stdout`. If an error occurs during the execution, an exception will be thrown. |
 | `node.execute(query, ...)` | Connects to PostgreSQL using `psycopg2` or `pg8000` (depends on which one is installed in your system) and returns two-dimensional array with data. |
 | `node.connect(dbname, ...)` | Returns connection wrapper (`NodeConnection`) capable of running several queries within a single transaction. |
 
diff --git a/setup.py b/setup.py
@@ -27,7 +27,7 @@
     readme = f.read()
 
 setup(
-    version='1.10.1',
+    version='1.10.3',
     name='testgres',
     packages=['testgres', 'testgres.operations', 'testgres.helpers'],
     description='Testing utility for PostgreSQL and its extensions',
diff --git a/testgres/node.py b/testgres/node.py
@@ -1161,7 +1161,7 @@ def restore(self, filename, dbname=None, username=None):
             filename
         ]  # yapf: disable
 
-        # try pg_restore if dump is binary formate, and psql if not
+        # try pg_restore if dump is binary format, and psql if not
         try:
             execute_utility(_params, self.utils_log_name)
         except ExecUtilException:
@@ -1304,7 +1304,7 @@ def set_synchronous_standbys(self, standbys):
 
         Args:
             standbys: either :class:`.First` or :class:`.Any` object specifying
-                sychronization parameters or just a plain list of
+                synchronization parameters or just a plain list of
                 :class:`.PostgresNode`s replicas which would be equivalent
                 to passing ``First(1, <list>)``. For PostgreSQL 9.5 and below
                 it is only possible to specify a plain list of standbys as
@@ -1646,23 +1646,31 @@ def set_auto_conf(self, options, config='postgresql.auto.conf', rm_options=None)
 
             name, var = line.partition('=')[::2]
             name = name.strip()
-            var = var.strip()
-            var = var.strip('"')
-            var = var.strip("'")
 
-            # remove options specified in rm_options list
+            # Remove options specified in rm_options list
             if name in rm_options:
                 continue
 
             current_options[name] = var
 
         for option in options:
-            current_options[option] = options[option]
+            assert type(option) == str  # noqa: E721
+            assert option != ""
+            assert option.strip() == option
+
+            value = options[option]
+            valueType = type(value)
+
+            if valueType == str:
+                value = __class__._escape_config_value(value)
+            elif valueType == bool:
+                value = "on" if value else "off"
+
+            current_options[option] = value
 
         auto_conf = ''
         for option in current_options:
-            auto_conf += "{0} = '{1}'\n".format(
-                option, current_options[option])
+            auto_conf += option + " = " + str(current_options[option]) + "\n"
 
         for directive in current_directives:
             auto_conf += directive + "\n"
@@ -1710,6 +1718,30 @@ def _get_bin_path(self, filename):
             bin_path = get_bin_path(filename)
         return bin_path
 
+    def _escape_config_value(value):
+        assert type(value) == str  # noqa: E721
+
+        result = "'"
+
+        for ch in value:
+            if ch == "'":
+                result += "\\'"
+            elif ch == "\n":
+                result += "\\n"
+            elif ch == "\r":
+                result += "\\r"
+            elif ch == "\t":
+                result += "\\t"
+            elif ch == "\b":
+                result += "\\b"
+            elif ch == "\\":
+                result += "\\\\"
+            else:
+                result += ch
+
+        result += "'"
+        return result
+
 
 class NodeApp:
 
diff --git a/testgres/plugins/pg_probackup2/pg_probackup2/app.py b/testgres/plugins/pg_probackup2/pg_probackup2/app.py
@@ -74,6 +74,8 @@ def run(self, command, gdb=False, old_binary=False, return_id=True, env=None,
             command = [command[0], *use_backup_dir.pb_args, *command[1:]]
         elif use_backup_dir:
             command = [command[0], *self.backup_dir.pb_args, *command[1:]]
+        else:
+            command = [command[0], *self.backup_dir.pb_args[2:], *command[1:]]
 
         if not self.probackup_old_path and old_binary:
             logging.error('PGPROBACKUPBIN_OLD is not set')
diff --git a/testgres/plugins/pg_probackup2/pg_probackup2/gdb.py b/testgres/plugins/pg_probackup2/pg_probackup2/gdb.py
@@ -37,7 +37,7 @@ def __init__(self, cmd, env, attach=False):
                                    " to run GDB tests")
             raise GdbException("No gdb usage possible.")
 
-        # Check gdb presense
+        # Check gdb presence
         try:
             gdb_version, _ = subprocess.Popen(
                 ['gdb', '--version'],
@@ -108,6 +108,9 @@ def kill(self):
         self.proc.stdin.close()
         self.proc.stdout.close()
 
+    def terminate_subprocess(self):
+        self._execute('kill')
+
     def set_breakpoint(self, location):
 
         result = self._execute('break ' + location)
diff --git a/testgres/plugins/pg_probackup2/setup.py b/testgres/plugins/pg_probackup2/setup.py
@@ -4,7 +4,7 @@
     from distutils.core import setup
 
 setup(
-    version='0.0.3',
+    version='0.0.4',
     name='testgres_pg_probackup2',
     packages=['pg_probackup2', 'pg_probackup2.storage'],
     description='Plugin for testgres that manages pg_probackup2',
diff --git a/tests/test_simple.py b/tests/test_simple.py
@@ -501,15 +501,15 @@ def test_logical_replication(self):
             sub.disable()
             node1.safe_psql('insert into test values (3, 3)')
 
-            # enable and ensure that data successfully transfered
+            # enable and ensure that data successfully transferred
             sub.enable()
             sub.catchup()
             res = node2.execute('select * from test')
             self.assertListEqual(res, [(1, 1), (2, 2), (3, 3)])
 
             # Add new tables. Since we added "all tables" to publication
             # (default behaviour of publish() method) we don't need
-            # to explicitely perform pub.add_tables()
+            # to explicitly perform pub.add_tables()
             create_table = 'create table test2 (c char)'
             node1.safe_psql(create_table)
             node2.safe_psql(create_table)
@@ -526,7 +526,7 @@ def test_logical_replication(self):
             pub.drop()
 
             # create new publication and subscription for specific table
-            # (ommitting copying data as it's already done)
+            # (omitting copying data as it's already done)
             pub = node1.publish('newpub', tables=['test'])
             sub = node2.subscribe(pub, 'newsub', copy_data=False)
 
@@ -535,7 +535,7 @@ def test_logical_replication(self):
             res = node2.execute('select * from test')
             self.assertListEqual(res, [(1, 1), (2, 2), (3, 3), (4, 4)])
 
-            # explicitely add table
+            # explicitly add table
             with self.assertRaises(ValueError):
                 pub.add_tables([])    # fail
             pub.add_tables(['test2'])
@@ -1045,7 +1045,7 @@ def test_the_same_port(self):
                 node2._should_free_port = False
                 node2.init().start()
 
-    def test_make_simple_with_bin_dir(self):
+    def test_simple_with_bin_dir(self):
         with get_new_node() as node:
             node.init().start()
             bin_dir = node.bin_dir
@@ -1063,6 +1063,52 @@ def test_make_simple_with_bin_dir(self):
         except FileNotFoundError:
             pass  # Expected error
 
+    def test_set_auto_conf(self):
+        # elements contain [property id, value, storage value]
+        testData = [
+            ["archive_command",
+             "cp '%p' \"/mnt/server/archivedir/%f\"",
+             "'cp \\'%p\\' \"/mnt/server/archivedir/%f\""],
+            ["restore_command",
+             'cp "/mnt/server/archivedir/%f" \'%p\'',
+             "'cp \"/mnt/server/archivedir/%f\" \\'%p\\''"],
+            ["log_line_prefix",
+             "'\n\r\t\b\\\"",
+             "'\\\'\\n\\r\\t\\b\\\\\""],
+            ["log_connections",
+             True,
+             "on"],
+            ["log_disconnections",
+             False,
+             "off"],
+            ["autovacuum_max_workers",
+             3,
+             "3"]
+        ]
+
+        with get_new_node() as node:
+            node.init().start()
+
+            options = {}
+
+            for x in testData:
+                options[x[0]] = x[1]
+
+            node.set_auto_conf(options)
+            node.stop()
+            node.slow_start()
+
+            auto_conf_path = f"{node.data_dir}/postgresql.auto.conf"
+            with open(auto_conf_path, "r") as f:
+                content = f.read()
+
+                for x in testData:
+                    self.assertIn(
+                        x[0] + " = " + x[2],
+                        content,
+                        x[0] + " stored wrong"
+                    )
+
 
 if __name__ == '__main__':
     if os.environ.get('ALT_CONFIG'):
diff --git a/tests/test_simple_remote.py b/tests/test_simple_remote.py
@@ -480,15 +480,15 @@ def test_logical_replication(self):
             sub.disable()
             node1.safe_psql('insert into test values (3, 3)')
 
-            # enable and ensure that data successfully transfered
+            # enable and ensure that data successfully transferred
             sub.enable()
             sub.catchup()
             res = node2.execute('select * from test')
             self.assertListEqual(res, [(1, 1), (2, 2), (3, 3)])
 
             # Add new tables. Since we added "all tables" to publication
             # (default behaviour of publish() method) we don't need
-            # to explicitely perform pub.add_tables()
+            # to explicitly perform pub.add_tables()
             create_table = 'create table test2 (c char)'
             node1.safe_psql(create_table)
             node2.safe_psql(create_table)
@@ -505,7 +505,7 @@ def test_logical_replication(self):
             pub.drop()
 
             # create new publication and subscription for specific table
-            # (ommitting copying data as it's already done)
+            # (omitting copying data as it's already done)
             pub = node1.publish('newpub', tables=['test'])
             sub = node2.subscribe(pub, 'newsub', copy_data=False)
 
@@ -514,7 +514,7 @@ def test_logical_replication(self):
             res = node2.execute('select * from test')
             self.assertListEqual(res, [(1, 1), (2, 2), (3, 3), (4, 4)])
 
-            # explicitely add table
+            # explicitly add table
             with self.assertRaises(ValueError):
                 pub.add_tables([])  # fail
             pub.add_tables(['test2'])
