testgres-pg-probackup2 0.1.1__tar.gz → 0.2.1__tar.gz

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testgres_pg_probackup2
-Version: 0.1.1
+Version: 0.2.1
 Summary: Plugin for testgres that manages pg_probackup2
 Home-page: https://github.com/postgrespro/testgres
 Author: Postgres Professional

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/README.md

@@ -1,6 +1,6 @@
 # testgres - pg_probackup2
 
-Ccontrol and testing utility for [pg_probackup2](https://github.com/postgrespro/pg_probackup). Python 3.5+ is supported.
+Control and testing utility for [pg_probackup2](https://github.com/postgrespro/pg_probackup). Python 3.5+ is supported.
 
 
 ## Installation
@@ -22,6 +22,8 @@ The package requires testgres~=1.9.3.
 | - | - | - | - |
 | PGPROBACKUP_TMP_DIR | No | tests/tmp_dirs | The root of the temporary directory hierarchy where tests store data and logs. Relative paths start from the current working directory. |
 | PG_PROBACKUP_TEST_BACKUP_DIR_PREFIX | No | Temporary test hierarchy | Prefix of the test backup directories. Must be an absolute path. Use this variable to store test backups in a location other than the temporary test hierarchy. |
+| PG_PROBACKUP_VALGRIND | No | Not set | Run pg_probackup through valgrind if the variable is set to 'y'. Setting  PG_PROBACKUP_VALGRIND_SUP (see below) to any value enables valgrind just like setting `PG_PROBACKUP_VALGRIND=y` would do. |
+| PG_PROBACKUP_VALGRIND_SUP | No | Not set | Specify the path to a valgrind suppression file. If the variable is not set then a file named "valgrind.supp" is searched for in the current working directory (normally the root of pg_probackup repository). Setting  PG_PROBACKUP_VALGRIND_SUP to any value enables valgrind just like setting `PG_PROBACKUP_VALGRIND=y` (see above) would do. |
 
 See [Testgres](https://github.com/postgrespro/testgres/tree/master#environment) on how to configure a custom Postgres installation using `PG_CONFIG` and `PG_BIN` environment variables.
 

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/pg_probackup2/app.py

@@ -60,6 +60,8 @@ class ProbackupApp:
         self.archive_compress = init_params.archive_compress
         self.test_class.output = None
         self.execution_time = None
+        self.valgrind = init_params.valgrind
+        self.valgrind_sup_path = init_params.valgrind_sup_path
 
     def form_daemon_process(self, cmdline, env):
         def stream_output(stream: subprocess.PIPE) -> None:
@@ -88,6 +90,7 @@ class ProbackupApp:
 
         return self.process.pid
 
+    # ---- Start run function ---- #
     def run(self, command, gdb=False, old_binary=False, return_id=True, env=None,
             skip_log_directory=False, expect_error=False, use_backup_dir=True, daemonize=False):
         """
@@ -98,26 +101,46 @@ class ProbackupApp:
         gdb: when True it returns GDBObj(), when tuple('suspend', port) it runs probackup
              in suspended gdb mode with attachable gdb port, for local debugging
         """
+        command = self._add_backup_dir_to_cmd(command, use_backup_dir)
+        # Old bin or regular one
+        binary_path = self._get_binary_path(old_binary)
+
+        if not env:
+            env = self.test_env
+        # Add additional options if needed
+        command, strcommand = self._add_options(command, skip_log_directory)
+
+        self.test_class.cmd = f"{binary_path} {strcommand}"
+        if self.verbose:
+            print(self.test_class.cmd)
+
+        cmdline = self._form_cmdline(binary_path, command)
+
+        if gdb is True:
+            # general test flow for using GDBObj
+            return GDBobj(cmdline, self.test_class)
+
+        return self._execute_command(cmdline, env, command, gdb, expect_error, return_id, daemonize)
+
+    def _add_backup_dir_to_cmd(self, command: list, use_backup_dir: TestBackupDir):
         if isinstance(use_backup_dir, TestBackupDir):
-            command = [command[0], *use_backup_dir.pb_args, *command[1:]]
+            return [command[0], *use_backup_dir.pb_args, *command[1:]]
         elif use_backup_dir:
-            command = [command[0], *self.backup_dir.pb_args, *command[1:]]
+            return [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')
-            exit(1)
+            return [command[0], *self.backup_dir.pb_args[2:], *command[1:]]
 
+    def _get_binary_path(self, old_binary):
         if old_binary:
-            binary_path = self.probackup_old_path
-        else:
-            binary_path = self.probackup_path
-
-        if not env:
-            env = self.test_env
+            if not self.probackup_old_path:
+                logging.error('PGPROBACKUPBIN_OLD is not set')
+                exit(1)
+            return self.probackup_old_path
+        return self.probackup_path
 
+    def _add_options(self, command: list, skip_log_directory: bool):
         strcommand = ' '.join(str(p) for p in command)
+
         if '--log-level-file' in strcommand and \
                 '--log-directory' not in strcommand and \
                 not skip_log_directory:
@@ -125,26 +148,51 @@ class ProbackupApp:
             strcommand += ' ' + command[-1]
 
         if 'pglz' in strcommand and \
-                ' -j' not in strcommand and '--thread' not in strcommand:
+                ' -j' not in strcommand and \
+                '--thread' not in strcommand:
             command += ['-j', '1']
             strcommand += ' -j 1'
 
-        self.test_class.cmd = binary_path + ' ' + strcommand
-        if self.verbose:
-            print(self.test_class.cmd)
+        return command, strcommand
 
+    def _form_cmdline(self, binary_path, command):
         cmdline = [binary_path, *command]
-        if gdb is True:
-            # general test flow for using GDBObj
-            return GDBobj(cmdline, self.test_class)
 
+        if (self.valgrind == 'y' or self.valgrind_sup_path) and command[0] != "--version":
+            os.makedirs(self.pb_log_path, exist_ok=True)
+            valgrind_cmd = [
+                "valgrind",
+                "--gen-suppressions=all",
+                "--leak-check=full",
+                "--show-reachable=yes",
+                "--error-limit=no",
+                "--show-leak-kinds=all",
+                "--errors-for-leak-kinds=all",
+                "--error-exitcode=0",
+                f"--log-file={os.path.join(self.pb_log_path, f'valgrind-{command[0]}-%p.log')}"
+            ]
+            if self.valgrind_sup_path:
+                if os.path.isfile(self.valgrind_sup_path):
+                    valgrind_cmd += [f"--suppressions={self.valgrind_sup_path}"]
+                else:
+                    raise FileNotFoundError(f"PG_PROBACKUP_VALGRIND_SUP must be the path to a valgrind suppression file, "
+                                            f"but found: {self.valgrind_sup_path}")
+            else:
+                # Assume the tests are started from the root of pg_probackup repository
+                valgrind_cmd += [f"--suppressions=.valgrind.supp"]
+
+            cmdline = valgrind_cmd + cmdline
+
+        return cmdline
+
+    def _execute_command(self, cmdline, env, command, gdb, expect_error, return_id, daemonize):
         try:
-            if type(gdb) is tuple and gdb[0] == 'suspend':
-                # special test flow for manually debug probackup
+            if isinstance(gdb, tuple) and gdb[0] == 'suspend':
                 gdb_port = gdb[1]
                 cmdline = ['gdbserver'] + ['localhost:' + str(gdb_port)] + cmdline
                 logging.warning("pg_probackup gdb suspended, waiting gdb connection on localhost:{0}".format(gdb_port))
 
+            # Execute command
             start_time = time.time()
             if daemonize:
                 return self.form_daemon_process(cmdline, env)
@@ -174,6 +222,7 @@ class ProbackupApp:
                 return self.test_class.output
             else:
                 raise ProbackupException(self.test_class.output, self.test_class.cmd)
+    # ---- End run function ---- #
 
     def get_backup_id(self):
         if init_params.major_version > 2:

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/pg_probackup2/init_helpers.py

@@ -214,6 +214,9 @@ class Init(object):
         else:
             raise Exception('Can\'t process pg_probackup version \"{}\": the major version is expected to be a number'.format(self.probackup_version))
 
+        self.valgrind = test_env.get('PG_PROBACKUP_VALGRIND')
+        self.valgrind_sup_path = test_env.get('PG_PROBACKUP_VALGRIND_SUP')
+
     def test_env(self):
         return self._test_env.copy()
 

testgres_pg_probackup2-0.2.1/pg_probackup2/storage/__init__.py

@@ -0,0 +1 @@
+

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/setup.py

@@ -4,7 +4,7 @@ except ImportError:
     from distutils.core import setup
 
 setup(
-    version='0.1.1',
+    version='0.2.1',
     name='testgres_pg_probackup2',
     packages=['pg_probackup2', 'pg_probackup2.storage'],
     description='Plugin for testgres that manages pg_probackup2',

{testgres_pg_probackup2-0.1.1 → testgres_pg_probackup2-0.2.1}/testgres_pg_probackup2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testgres-pg-probackup2
-Version: 0.1.1
+Version: 0.2.1
 Summary: Plugin for testgres that manages pg_probackup2
 Home-page: https://github.com/postgrespro/testgres
 Author: Postgres Professional

testgres_pg_probackup2-0.2.1/testgres_pg_probackup2.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+