testgres-pg-probackup2 0.9.2__tar.gz → 0.10.0__tar.gz

testgres_pg_probackup2-0.10.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: testgres_pg_probackup2
+Version: 0.10.0
+Summary: Plugin for testgres that manages pg_probackup2
+Author-email: Postgres Professional <testgres@postgrespro.ru>
+License: PostgreSQL
+Project-URL: HomePage, https://github.com/postgrespro/testgres-pg_probackup2
+Keywords: pg_probackup,testing,testgres
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.7.3
+Description-Content-Type: text/markdown
+Requires-Dist: lz4
+Requires-Dist: pefile
+Requires-Dist: testgres<1.18,>=1.14.4
+Requires-Dist: zstd
+
+[![PyPI package version](https://badge.fury.io/py/testgres-pg_probackup2.svg)](https://badge.fury.io/py/testgres-pg_probackup2)
+
+# testgres-pg_probackup2
+
+Control and testing utility for [pg_probackup2](https://github.com/postgrespro/pg_probackup). Python 3.7+ is supported.
+
+
+## Installation
+
+To install `testgres-pg_probackup`, run:
+
+```
+pip install testgres-pg_probackup
+```
+
+We encourage you to use `virtualenv` for your testing environment.
+The package requires testgres.
+
+## Usage
+
+### Environment variables
+
+| Variable | Required | Default value | Description |
+| - | - | - | - |
+| 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.
+
+### Examples
+
+Here is an example of what you can do with `testgres-pg_probackup2`:
+
+```python
+# You can see full script here plugins/pg_probackup2/pg_probackup2/tests/basic_test.py
+def test_full_backup(self):
+    # Setting up a simple test node
+    node = self.pg_node.make_simple('node', pg_options={"fsync": "off", "synchronous_commit": "off"})
+
+    # Initialize and configure Probackup
+    self.pb.init()
+    self.pb.add_instance('node', node)
+    self.pb.set_archiving('node', node)
+
+    # Start the node and initialize pgbench
+    node.slow_start()
+    node.pgbench_init(scale=100, no_vacuum=True)
+
+    # Perform backup and validation
+    backup_id = self.pb.backup_node('node', node)
+    out = self.pb.validate('node', backup_id)
+
+    # Check if the backup is valid
+    self.assertIn(f"INFO: Backup {backup_id} is valid", out)
+```
+
+## Authors
+
+[Postgres Professional](https://postgrespro.ru/about)

{testgres_pg_probackup2-0.9.2 → testgres_pg_probackup2-0.10.0}/README.md

@@ -1,20 +1,20 @@
 [![PyPI package version](https://badge.fury.io/py/testgres-pg_probackup2.svg)](https://badge.fury.io/py/testgres-pg_probackup2)
 
-# testgres - pg_probackup2
+# testgres-pg_probackup2
 
-Control 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.7+ is supported.
 
 
 ## Installation
 
-To install `testgres`, run:
+To install `testgres-pg_probackup`, run:
 
 ```
 pip install testgres-pg_probackup
 ```
 
 We encourage you to use `virtualenv` for your testing environment.
-The package requires testgres~=1.9.3.
+The package requires testgres.
 
 ## Usage
 

testgres_pg_probackup2-0.10.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-dir]
+"pg_probackup2" = "src"
+
+[tool.setuptools.dynamic]
+version = {attr = "pg_probackup2.__version__"}
+
+[tool.flake8]
+extend-ignore = ["E501"]
+exclude = [".git", "__pycache__", "env", "venv"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+log_file_level = "NOTSET"
+log_file_format = "%(levelname)8s [%(asctime)s] %(message)s"
+log_file_date_format = "%Y-%m-%d %H:%M:%S"
+
+[project]
+name = "testgres_pg_probackup2"
+dynamic = ["version"]
+description = "Plugin for testgres that manages pg_probackup2"
+readme = "README.md"
+requires-python = ">=3.7.3"
+
+# Формат для совместимости с Python 3.7
+license = {text = "PostgreSQL"}
+
+authors = [
+    {name = "Postgres Professional", email = "testgres@postgrespro.ru"},
+]
+
+keywords = [
+    "pg_probackup",
+    "testing",
+    "testgres",
+]
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Operating System :: Unix",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Testing",
+]
+
+dependencies = [
+    "lz4",
+    "pefile",
+    "testgres>=1.14.4,<1.18",
+    "zstd",
+]
+
+[project.urls]
+"HomePage" = "https://github.com/postgrespro/testgres-pg_probackup2"

testgres_pg_probackup2-0.10.0/src/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.10.0"

{testgres_pg_probackup2-0.9.2/pg_probackup2 → testgres_pg_probackup2-0.10.0/src}/app.py

@@ -196,7 +196,7 @@ class ProbackupApp:
                                         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"]
+            valgrind_cmd += ["--suppressions=.valgrind.supp"]
 
         return valgrind_cmd + cmdline
 

{testgres_pg_probackup2-0.9.2/pg_probackup2 → testgres_pg_probackup2-0.10.0/src}/gdb.py

@@ -354,14 +354,15 @@ def needs_gdb(func):
     reason = check[1]
     if check[0] == "skip":
         return unittest.skip(reason)(func)
-    elif check[0] == "fail":
+
+    if check[0] == "fail":
         @functools.wraps(func)
         def fail_wrapper(self, *args, **kwargs):
             self.fail(reason)
 
         return fail_wrapper
-    else:
-        raise "Wrong action {0}".format(check)
+
+    raise RuntimeError("Wrong action {0}".format(check))
 
 
 _set_gdb(GDBobj)

testgres_pg_probackup2-0.10.0/testgres_pg_probackup2.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: testgres_pg_probackup2
+Version: 0.10.0
+Summary: Plugin for testgres that manages pg_probackup2
+Author-email: Postgres Professional <testgres@postgrespro.ru>
+License: PostgreSQL
+Project-URL: HomePage, https://github.com/postgrespro/testgres-pg_probackup2
+Keywords: pg_probackup,testing,testgres
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.7.3
+Description-Content-Type: text/markdown
+Requires-Dist: lz4
+Requires-Dist: pefile
+Requires-Dist: testgres<1.18,>=1.14.4
+Requires-Dist: zstd
+
+[![PyPI package version](https://badge.fury.io/py/testgres-pg_probackup2.svg)](https://badge.fury.io/py/testgres-pg_probackup2)
+
+# testgres-pg_probackup2
+
+Control and testing utility for [pg_probackup2](https://github.com/postgrespro/pg_probackup). Python 3.7+ is supported.
+
+
+## Installation
+
+To install `testgres-pg_probackup`, run:
+
+```
+pip install testgres-pg_probackup
+```
+
+We encourage you to use `virtualenv` for your testing environment.
+The package requires testgres.
+
+## Usage
+
+### Environment variables
+
+| Variable | Required | Default value | Description |
+| - | - | - | - |
+| 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.
+
+### Examples
+
+Here is an example of what you can do with `testgres-pg_probackup2`:
+
+```python
+# You can see full script here plugins/pg_probackup2/pg_probackup2/tests/basic_test.py
+def test_full_backup(self):
+    # Setting up a simple test node
+    node = self.pg_node.make_simple('node', pg_options={"fsync": "off", "synchronous_commit": "off"})
+
+    # Initialize and configure Probackup
+    self.pb.init()
+    self.pb.add_instance('node', node)
+    self.pb.set_archiving('node', node)
+
+    # Start the node and initialize pgbench
+    node.slow_start()
+    node.pgbench_init(scale=100, no_vacuum=True)
+
+    # Perform backup and validation
+    backup_id = self.pb.backup_node('node', node)
+    out = self.pb.validate('node', backup_id)
+
+    # Check if the backup is valid
+    self.assertIn(f"INFO: Backup {backup_id} is valid", out)
+```
+
+## Authors
+
+[Postgres Professional](https://postgrespro.ru/about)

testgres_pg_probackup2-0.10.0/testgres_pg_probackup2.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+src/__init__.py
+src/app.py
+src/gdb.py
+src/init_helpers.py
+src/storage/__init__.py
+src/storage/fs_backup.py
+testgres_pg_probackup2.egg-info/PKG-INFO
+testgres_pg_probackup2.egg-info/SOURCES.txt
+testgres_pg_probackup2.egg-info/dependency_links.txt
+testgres_pg_probackup2.egg-info/requires.txt
+testgres_pg_probackup2.egg-info/top_level.txt
+tests/test_basic.py
+tests/test_common.py
+tests/test_gdb.py

testgres_pg_probackup2-0.10.0/testgres_pg_probackup2.egg-info/requires.txt

@@ -0,0 +1,4 @@
+lz4
+pefile
+testgres<1.18,>=1.14.4
+zstd

testgres_pg_probackup2-0.10.0/tests/test_basic.py

@@ -0,0 +1,142 @@
+from __future__ import annotations
+
+import os
+import shutil
+import pytest
+import unittest
+
+import testgres
+from src.app import ProbackupApp
+from src.init_helpers import Init, init_params
+from src.storage.fs_backup import FSTestBackupDir
+
+
+class ProbackupTest(unittest.TestCase):
+    pg_node: testgres.NodeApp
+
+    @staticmethod
+    def probackup_is_available() -> bool:
+        p = os.environ.get("PGPROBACKUPBIN")
+
+        if p is None:
+            return False
+
+        if not os.path.exists(p):
+            return False
+
+        return True
+
+    @pytest.fixture(autouse=True, scope="function")
+    def implicit_fixture(self, request: pytest.FixtureRequest):
+        assert isinstance(request, pytest.FixtureRequest)
+        self.helper__setUp(request)
+        yield
+        self.helper__tearDown()
+
+    def helper__setUp(self, request: pytest.FixtureRequest):
+        assert isinstance(request, pytest.FixtureRequest)
+
+        self.helper__setup_test_environment(request)
+        self.helper__setup_test_paths()
+        self.helper__setup_backup_dir()
+        self.helper__setup_probackup()
+        return
+
+    def helper__setup_test_environment(self, request: pytest.FixtureRequest):
+        assert isinstance(request, pytest.FixtureRequest)
+
+        self.output = None
+        self.cmd = None
+        self.nodes_to_cleanup = []
+        self.module_name, self.fname = request.node.cls.__name__, request.node.name
+        self.test_env = Init().test_env()
+        return
+
+    def helper__setup_test_paths(self):
+        self.rel_path = os.path.join(self.module_name, self.fname)
+        self.test_path = os.path.join(init_params.tmp_path, self.rel_path)
+        os.makedirs(self.test_path, exist_ok=True)
+        self.pb_log_path = os.path.join(self.test_path, "pb_log")
+
+    def helper__setup_backup_dir(self):
+        self.backup_dir = self.helper__build_backup_dir('backup')
+        self.backup_dir.cleanup()
+        return
+
+    def helper__setup_probackup(self):
+        self.pg_node = testgres.NodeApp(self.test_path, self.nodes_to_cleanup)
+        self.pb = ProbackupApp(
+            self,
+            self.pg_node,
+            self.pb_log_path,
+            self.test_env,
+            auto_compress_alg='zlib',
+            backup_dir=self.backup_dir,
+        )
+        return
+
+    def helper__tearDown(self):
+        if os.path.exists(self.test_path):
+            shutil.rmtree(self.test_path)
+        return
+
+    def helper__build_backup_dir(self, backup='backup'):
+        return FSTestBackupDir(rel_path=self.rel_path, backup=backup)
+
+
+@pytest.mark.skipif(
+    not ProbackupTest.probackup_is_available(),
+    reason="Check that PGPROBACKUPBIN is defined and is valid.",
+)
+class TestBasic(ProbackupTest):
+    def test_full_backup(self):
+        assert self.pg_node is not None
+        assert type(self.pg_node) == testgres.NodeApp  # noqa: E721
+        assert self.pb is not None
+        assert type(self.pb) == ProbackupApp  # noqa: E721
+
+        # Setting up a simple test node
+        node = self.pg_node.make_simple(
+            'node',
+            pg_options={"fsync": "off", "synchronous_commit": "off"},
+        )
+
+        assert node is not None
+        assert type(node) == testgres.PostgresNode  # noqa: E721
+
+        with node:
+            # Initialize and configure Probackup
+            self.pb.init()
+            self.pb.add_instance('node', node)
+            self.pb.set_archiving('node', node)
+
+            # Start the node and initialize pgbench
+            node.slow_start()
+            node.pgbench_init(scale=100, no_vacuum=True)
+
+            # Perform backup and validation
+            backup_id = self.pb.backup_node('node', node)
+            out = self.pb.validate('node', backup_id)
+            assert type(out) is str
+
+            # Check if the backup is valid
+            assert f"INFO: Backup {backup_id} is valid" in out
+            return
+
+
+def test_form_cmdline_respects_use_valgrind(tmp_path):
+    app = ProbackupApp.__new__(ProbackupApp)
+    app.valgrind = 'y'
+    app.valgrind_sup_path = None
+    app.pb_log_path = str(tmp_path)
+
+    binary = '/bin/true'
+    command = ['backup', '--instance=node']
+
+    wrapped = app._form_cmdline(binary, command)
+    plain = app._form_cmdline(binary, command, use_valgrind=False)
+
+    assert wrapped[0] == 'valgrind'
+    assert binary in wrapped
+    assert plain == [binary, *command]
+    return

testgres_pg_probackup2-0.10.0/tests/test_common.py

@@ -0,0 +1,17 @@
+from src import __version__ as pg_probackup2_version
+
+from packaging.version import Version
+
+
+class TestCommon:
+    def test_pg_probackup2_version(self):
+        assert type(pg_probackup2_version) is str
+
+        v = Version(pg_probackup2_version)
+
+        assert v.major == 0
+        assert v.minor == 10
+        assert v.micro == 0
+
+        assert str(v) == pg_probackup2_version
+        return

testgres_pg_probackup2-0.10.0/tests/test_gdb.py

@@ -0,0 +1,29 @@
+import pytest
+from unittest import mock
+
+from src import gdb
+
+
+def test_needs_gdb_decorator_behavior():
+    # Isolate check flag, as in the original test
+    with mock.patch.object(gdb, '_check_gdb_flag_or_skip_test', return_value=None):
+
+        # Создаем тестовую функцию с декоратором @gdb.needs_gdb
+        @gdb.needs_gdb
+        def dummy_test_func(flag):
+            return flag
+
+        # Check that the decorator correctly sets the attribute (or executes the logic)
+        # Note: The original code checked self._gdb_decorated.
+        # Depending on the decorator implementation, the attribute
+        # may be on the function itself:
+        assert getattr(dummy_test_func, '_gdb_decorated', True)
+    return
+
+
+# We check the operation of the parameterizer itself in pytest style
+@pytest.mark.parametrize("flag", [1, 0])
+def test_parameterized_args_integration(flag):
+    with mock.patch.object(gdb, '_check_gdb_flag_or_skip_test', return_value=None):
+        assert flag in (0, 1)
+    return

testgres_pg_probackup2-0.9.2/PKG-INFO

@@ -1,22 +0,0 @@
-Metadata-Version: 2.4
-Name: testgres_pg_probackup2
-Version: 0.9.2
-Summary: Plugin for testgres that manages pg_probackup2
-Home-page: https://github.com/postgrespro/testgres
-Author: Postgres Professional
-Author-email: testgres@postgrespro.ru
-License: PostgreSQL
-Keywords: pg_probackup,testing,testgres
-Description-Content-Type: text/markdown
-Requires-Dist: lz4
-Requires-Dist: pefile
-Requires-Dist: testgres>=1.14.4
-Requires-Dist: zstd
-Dynamic: author
-Dynamic: author-email
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: summary

testgres_pg_probackup2-0.9.2/setup.py

@@ -1,23 +0,0 @@
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
-setup(
-    version='0.9.2',
-    name='testgres_pg_probackup2',
-    packages=['pg_probackup2', 'pg_probackup2.storage'],
-    description='Plugin for testgres that manages pg_probackup2',
-    url='https://github.com/postgrespro/testgres',
-    long_description_content_type='text/markdown',
-    license='PostgreSQL',
-    author='Postgres Professional',
-    author_email='testgres@postgrespro.ru',
-    keywords=['pg_probackup', 'testing', 'testgres'],
-    install_requires=[
-        'lz4',
-        'pefile',
-        'testgres>=1.14.4',
-        'zstd'
-    ]
-)

testgres_pg_probackup2-0.9.2/testgres_pg_probackup2.egg-info/PKG-INFO

@@ -1,22 +0,0 @@
-Metadata-Version: 2.4
-Name: testgres_pg_probackup2
-Version: 0.9.2
-Summary: Plugin for testgres that manages pg_probackup2
-Home-page: https://github.com/postgrespro/testgres
-Author: Postgres Professional
-Author-email: testgres@postgrespro.ru
-License: PostgreSQL
-Keywords: pg_probackup,testing,testgres
-Description-Content-Type: text/markdown
-Requires-Dist: lz4
-Requires-Dist: pefile
-Requires-Dist: testgres>=1.14.4
-Requires-Dist: zstd
-Dynamic: author
-Dynamic: author-email
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: summary

testgres_pg_probackup2-0.9.2/testgres_pg_probackup2.egg-info/SOURCES.txt

@@ -1,13 +0,0 @@
-README.md
-setup.py
-pg_probackup2/__init__.py
-pg_probackup2/app.py
-pg_probackup2/gdb.py
-pg_probackup2/init_helpers.py
-pg_probackup2/storage/__init__.py
-pg_probackup2/storage/fs_backup.py
-testgres_pg_probackup2.egg-info/PKG-INFO
-testgres_pg_probackup2.egg-info/SOURCES.txt
-testgres_pg_probackup2.egg-info/dependency_links.txt
-testgres_pg_probackup2.egg-info/requires.txt
-testgres_pg_probackup2.egg-info/top_level.txt

testgres_pg_probackup2-0.9.2/testgres_pg_probackup2.egg-info/requires.txt

@@ -1,4 +0,0 @@
-lz4
-pefile
-testgres>=1.14.4
-zstd