pytest-postgresql 6.0.1__tar.gz → 6.1.0__tar.gz

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/CHANGES.rst

@@ -3,6 +3,22 @@ CHANGELOG
 
 .. towncrier release notes start
 
+6.1.0 (2024-09-04)
+==================
+
+Features
+--------
+
+- add support for \\ character in pytest temporary path (`#982 <https://github.com/ClearcodeHQ/pytest-postgresql/issues/982>`__)
+
+
+Miscellaneus
+------------
+
+- Add test for `PR #965 <https://github.com/ClearcodeHQ/pytest-postgresql/pull/965>`_
+- refactors test_executor.py to enable Mac
+
+
 6.0.1 (2024-08-14)
 ==================
 

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: pytest-postgresql
-Version: 6.0.1
+Version: 6.1.0
 Summary: Postgresql fixtures and fixture factories for Pytest.
 Author-email: Grzegorz Śliwiński <fizyk+pypi@fizyk.dev>
 Project-URL: Source, https://github.com/ClearcodeHQ/pytest-postgresql
 Project-URL: Bug Tracker, https://github.com/ClearcodeHQ/pytest-postgresql/issues
-Project-URL: Changelog, https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.0.1/CHANGES.rst
+Project-URL: Changelog, https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.1.0/CHANGES.rst
 Keywords: tests,pytest,fixture,postgresql
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-postgresql"
-version = "6.0.1"
+version = "6.1.0"
 description = "Postgresql fixtures and fixture factories for Pytest."
 readme = "README.rst"
 keywords = ["tests", "pytest", "fixture", "postgresql"]
@@ -39,7 +39,7 @@ requires-python = ">= 3.8"
 [project.urls]
 "Source" = "https://github.com/ClearcodeHQ/pytest-postgresql"
 "Bug Tracker" = "https://github.com/ClearcodeHQ/pytest-postgresql/issues"
-"Changelog" = "https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.0.1/CHANGES.rst"
+"Changelog" = "https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.1.0/CHANGES.rst"
 
 [project.entry-points."pytest11"]
 pytest_postgresql = "pytest_postgresql.plugin"
@@ -108,7 +108,7 @@ name = "Miscellaneus"
 showcontent = false
 
 [tool.tbump.version]
-current = "6.0.1"
+current = "6.1.0"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pytest_postgresql/__init__.py

@@ -18,4 +18,4 @@
 # along with pytest-postgresql. If not, see <http://www.gnu.org/licenses/>.
 """Main module for pytest-postgresql."""
 
-__version__ = "6.0.1"
+__version__ = "6.1.0"

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pytest_postgresql/executor.py

@@ -49,11 +49,11 @@ class PostgreSQLExecutor(TCPExecutor):
     """
 
     BASE_PROC_START_COMMAND = (
-        "{executable} start -D {datadir} "
+        '{executable} start -D "{datadir}" '
         "-o \"-F -p {port} -c log_destination='stderr' "
         "-c logging_collector=off "
         "-c unix_socket_directories='{unixsocketdir}' {postgres_options}\" "
-        "-l {logfile} {startparams}"
+        '-l "{logfile}" {startparams}'
     )
 
     VERSION_RE = re.compile(r".* (?P<version>\d+(?:\.\d+)?)")
@@ -216,13 +216,13 @@ class PostgreSQLExecutor(TCPExecutor):
         """Check if server is running."""
         if not os.path.exists(self.datadir):
             return False
-        status_code = subprocess.getstatusoutput(f"{self.executable} status -D {self.datadir}")[0]
+        status_code = subprocess.getstatusoutput(f'{self.executable} status -D "{self.datadir}"')[0]
         return status_code == 0
 
     def stop(self: T, sig: Optional[int] = None, exp_sig: Optional[int] = None) -> T:
         """Issue a stop request to executable."""
         subprocess.check_output(
-            f"{self.executable} stop -D {self.datadir} -m f",
+            f'{self.executable} stop -D "{self.datadir}" -m f',
             shell=True,
         )
         try:

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pytest_postgresql/factories/__init__.py

@@ -19,6 +19,6 @@
 
 from pytest_postgresql.factories.client import postgresql
 from pytest_postgresql.factories.noprocess import postgresql_noproc
-from pytest_postgresql.factories.process import postgresql_proc
+from pytest_postgresql.factories.process import PortType, postgresql_proc
 
-__all__ = ("postgresql_proc", "postgresql_noproc", "postgresql")
+__all__ = ("postgresql_proc", "postgresql_noproc", "postgresql", "PortType")

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pytest_postgresql/factories/process.py

@@ -16,38 +16,67 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with pytest-postgresql.  If not, see <http://www.gnu.org/licenses/>.
 """Fixture factory for postgresql process."""
+
 import os.path
 import platform
 import subprocess
 from pathlib import Path
-from typing import Callable, Iterator, List, Optional, Set, Tuple, Union
+from typing import Callable, Iterator, List, Optional, Tuple, Union
 
+import port_for
 import pytest
 from port_for import get_port
 from pytest import FixtureRequest, TempPathFactory
 
-from pytest_postgresql.config import get_config
+from pytest_postgresql.config import PostgresqlConfigDict, get_config
 from pytest_postgresql.exceptions import ExecutableMissingException
 from pytest_postgresql.executor import PostgreSQLExecutor
 from pytest_postgresql.janitor import DatabaseJanitor
 
+PortType = port_for.PortType  # mypy requires explicit export
+
+
+def _pg_exe(executable: Optional[str], config: PostgresqlConfigDict) -> str:
+    """If executable is set, use it. Otherwise best effort to find the executable."""
+    postgresql_ctl = executable or config["exec"]
+    # check if that executable exists, as it's no on system PATH
+    # only replace if executable isn't passed manually
+    if not os.path.exists(postgresql_ctl) and executable is None:
+        try:
+            pg_bindir = subprocess.check_output(
+                ["pg_config", "--bindir"], universal_newlines=True
+            ).strip()
+        except FileNotFoundError as ex:
+            raise ExecutableMissingException(
+                "Could not found pg_config executable. Is it in systenm $PATH?"
+            ) from ex
+        postgresql_ctl = os.path.join(pg_bindir, "pg_ctl")
+    return postgresql_ctl
+
+
+def _pg_port(port: Optional[PortType], config: PostgresqlConfigDict) -> int:
+    """User specified port, otherwise find an unused port from config."""
+    pg_port = get_port(port) or get_port(config["port"])
+    assert pg_port is not None
+    return pg_port
+
+
+def _prepare_dir(tmpdir: Path, pg_port: PortType) -> Tuple[Path, Path]:
+    """Prepare directory for the executor."""
+    datadir = tmpdir / f"data-{pg_port}"
+    datadir.mkdir()
+    logfile_path = tmpdir / f"postgresql.{pg_port}.log"
+
+    if platform.system() == "FreeBSD":
+        with (datadir / "pg_hba.conf").open(mode="a") as conf_file:
+            conf_file.write("host all all 0.0.0.0/0 trust\n")
+    return datadir, logfile_path
+
 
 def postgresql_proc(
     executable: Optional[str] = None,
     host: Optional[str] = None,
-    port: Union[
-        None,
-        str,
-        int,
-        Tuple[int, int],
-        Set[int],
-        List[str],
-        List[int],
-        List[Tuple[int, int]],
-        List[Set[int]],
-        List[Union[Set[int], Tuple[int, int]]],
-        List[Union[str, int, Tuple[int, int], Set[int]]],
-    ] = -1,
+    port: Optional[PortType] = -1,
     user: Optional[str] = None,
     password: Optional[str] = None,
     dbname: Optional[str] = None,
@@ -90,34 +119,12 @@ def postgresql_proc(
         :returns: tcp executor
         """
         config = get_config(request)
-        postgresql_ctl = executable or config["exec"]
         pg_dbname = dbname or config["dbname"]
         pg_load = load or config["load"]
-
-        # check if that executable exists, as it's no on system PATH
-        # only replace if executable isn't passed manually
-        if not os.path.exists(postgresql_ctl) and executable is None:
-            try:
-                pg_bindir = subprocess.check_output(
-                    ["pg_config", "--bindir"], universal_newlines=True
-                ).strip()
-            except FileNotFoundError as ex:
-                raise ExecutableMissingException(
-                    "Could not found pg_config executable. Is it in systenm $PATH?"
-                ) from ex
-            postgresql_ctl = os.path.join(pg_bindir, "pg_ctl")
-
+        postgresql_ctl = _pg_exe(executable, config)
+        pg_port = _pg_port(port, config)
         tmpdir = tmp_path_factory.mktemp(f"pytest-postgresql-{request.fixturename}")
-
-        pg_port = get_port(port) or get_port(config["port"])
-        assert pg_port is not None
-        datadir = tmpdir / f"data-{pg_port}"
-        datadir.mkdir()
-        logfile_path = tmpdir / f"postgresql.{pg_port}.log"
-
-        if platform.system() == "FreeBSD":
-            with (datadir / "pg_hba.conf").open(mode="a") as conf_file:
-                conf_file.write("host all all 0.0.0.0/0 trust\n")
+        datadir, logfile_path = _prepare_dir(tmpdir, str(pg_port))
 
         postgresql_executor = PostgreSQLExecutor(
             executable=postgresql_ctl,

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/pytest_postgresql.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: pytest-postgresql
-Version: 6.0.1
+Version: 6.1.0
 Summary: Postgresql fixtures and fixture factories for Pytest.
 Author-email: Grzegorz Śliwiński <fizyk+pypi@fizyk.dev>
 Project-URL: Source, https://github.com/ClearcodeHQ/pytest-postgresql
 Project-URL: Bug Tracker, https://github.com/ClearcodeHQ/pytest-postgresql/issues
-Project-URL: Changelog, https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.0.1/CHANGES.rst
+Project-URL: Changelog, https://github.com/ClearcodeHQ/pytest-postgresql/blob/v6.1.0/CHANGES.rst
 Keywords: tests,pytest,fixture,postgresql
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment

{pytest_postgresql-6.0.1 → pytest_postgresql-6.1.0}/tests/test_executor.py

@@ -1,6 +1,5 @@
 """Test various executor behaviours."""
 
-import sys
 from typing import Any
 
 import psycopg
@@ -10,6 +9,7 @@ from port_for import get_port
 from psycopg import Connection
 from pytest import FixtureRequest
 
+import pytest_postgresql.factories.process as process
 from pytest_postgresql.config import get_config
 from pytest_postgresql.exceptions import PostgreSQLUnsupported
 from pytest_postgresql.executor import PostgreSQLExecutor
@@ -17,6 +17,28 @@ from pytest_postgresql.factories import postgresql, postgresql_proc
 from pytest_postgresql.retry import retry
 
 
+def assert_executor_start_stop(executor: PostgreSQLExecutor) -> None:
+    """Check that the executor is working."""
+    with executor:
+        assert executor.running()
+        psycopg.connect(
+            dbname=executor.user,
+            user=executor.user,
+            password=executor.password,
+            host=executor.host,
+            port=executor.port,
+        )
+        with pytest.raises(psycopg.OperationalError):
+            psycopg.connect(
+                dbname=executor.user,
+                user=executor.user,
+                password="bogus",
+                host=executor.host,
+                port=executor.port,
+            )
+    assert not executor.running()
+
+
 class PatchedPostgreSQLExecutor(PostgreSQLExecutor):
     """PostgreSQLExecutor that always says it's 8.9 version."""
 
@@ -46,10 +68,7 @@ def test_unsupported_version(request: FixtureRequest) -> None:
         executor.start()
 
 
-@pytest.mark.skipif(
-    sys.platform == "darwin", reason="The default pg_ctl path is for linux, not macos"
-)
-@pytest.mark.parametrize("locale", ("en_US.UTF-8", "de_DE.UTF-8"))
+@pytest.mark.parametrize("locale", ("en_US.UTF-8", "de_DE.UTF-8", "nl_NO.UTF-8"))
 def test_executor_init_with_password(
     request: FixtureRequest,
     monkeypatch: pytest.MonkeyPatch,
@@ -59,14 +78,12 @@ def test_executor_init_with_password(
     """Test whether the executor initializes properly."""
     config = get_config(request)
     monkeypatch.setenv("LC_ALL", locale)
-    port = get_port(config["port"])
-    assert port is not None
+    pg_exe = process._pg_exe(None, config)
+    port = process._pg_port(-1, config)
     tmpdir = tmp_path_factory.mktemp(f"pytest-postgresql-{request.node.name}")
-    datadir = tmpdir / f"data-{port}"
-    datadir.mkdir()
-    logfile_path = tmpdir / f"postgresql.{port}.log"
+    datadir, logfile_path = process._prepare_dir(tmpdir, port)
     executor = PostgreSQLExecutor(
-        executable=config["exec"],
+        executable=pg_exe,
         host=config["host"],
         port=port,
         datadir=str(datadir),
@@ -76,24 +93,32 @@ def test_executor_init_with_password(
         password="somepassword",
         dbname="somedatabase",
     )
-    with executor:
-        assert executor.running()
-        psycopg.connect(
-            dbname=executor.user,
-            user=executor.user,
-            password=executor.password,
-            host=executor.host,
-            port=executor.port,
-        )
-        with pytest.raises(psycopg.OperationalError):
-            psycopg.connect(
-                dbname=executor.user,
-                user=executor.user,
-                password="bogus",
-                host=executor.host,
-                port=executor.port,
-            )
-    assert not executor.running()
+    assert_executor_start_stop(executor)
+
+
+def test_executor_init_bad_tmp_path(
+    request: FixtureRequest,
+    tmp_path_factory: pytest.TempPathFactory,
+) -> None:
+    r"""Test init with \ and space chars in the path."""
+    config = get_config(request)
+    pg_exe = process._pg_exe(None, config)
+    port = process._pg_port(-1, config)
+    tmpdir = tmp_path_factory.mktemp(f"pytest-postgresql-{request.node.name}") / r"a bad\path/"
+    tmpdir.mkdir(exist_ok=True)
+    datadir, logfile_path = process._prepare_dir(tmpdir, port)
+    executor = PostgreSQLExecutor(
+        executable=pg_exe,
+        host=config["host"],
+        port=port,
+        datadir=str(datadir),
+        unixsocketdir=config["unixsocketdir"],
+        logfile=str(logfile_path),
+        startparams=config["startparams"],
+        password="some password",
+        dbname="some database",
+    )
+    assert_executor_start_stop(executor)
 
 
 postgres_with_password = postgresql_proc(password="hunter2")