postgresql-charms-single-kernel 16.1.12__tar.gz → 16.2.2__tar.gz

{postgresql_charms_single_kernel-16.1.12 → postgresql_charms_single_kernel-16.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: postgresql-charms-single-kernel
-Version: 16.1.12
+Version: 16.2.2
 Summary: Shared and reusable code for PostgreSQL-related charms
 Author: Canonical Data Platform
 Author-email: Canonical Data Platform <data-platform@lists.launchpad.net>
@@ -212,7 +212,9 @@ Classifier: Operating System :: POSIX :: Linux
 Requires-Dist: ops>=2.0.0
 Requires-Dist: psycopg2>=2.9.10
 Requires-Dist: tenacity>=9.0.0
+Requires-Dist: httpx ; python_full_version >= '3.12' and extra == 'postgresql'
 Requires-Python: >=3.8, <4.0
+Provides-Extra: postgresql
 Description-Content-Type: text/markdown
 
 # postgresql-single-kernel-library

{postgresql_charms_single_kernel-16.1.12 → postgresql_charms_single_kernel-16.2.2}/pyproject.toml

@@ -4,7 +4,7 @@
 [project]
 name = "postgresql-charms-single-kernel"
 description = "Shared and reusable code for PostgreSQL-related charms"
-version = "16.1.12"
+version = "16.2.2"
 readme = "README.md"
 license = {file = "LICENSE"}
 authors = [
@@ -22,6 +22,9 @@ dependencies = [
     "tenacity>=9.0.0",
 ]
 
+[project.optional-dependencies]
+postgresql = ["httpx; python_version >= '3.12'"]
+
 [build-system]
 requires = ["uv_build>=0.11.0,<0.12.0"]
 build-backend = "uv_build"
@@ -32,11 +35,11 @@ module-root = ""
 
 [dependency-groups]
 format = [
-    "ruff==0.15.13"
+    "ruff==0.15.14"
 ]
 lint = [
     "codespell==2.4.2",
-    "ty==0.0.37"
+    "ty==0.0.39"
 ]
 unit = [
     "coverage[toml]==7.14.0",

{postgresql_charms_single_kernel-16.1.12 → postgresql_charms_single_kernel-16.2.2}/single_kernel_postgresql/config/literals.py

@@ -22,6 +22,8 @@ SNAP_USER = "_daemon_"
 USER = "operator"
 SYSTEM_USERS = [MONITORING_USER, REPLICATION_USER, REWIND_USER, USER]
 
+API_REQUEST_TIMEOUT = 5
+
 
 class Substrates(str, Enum):
     """Possible substrates."""

postgresql_charms_single_kernel-16.2.2/single_kernel_postgresql/utils/__init__.py

@@ -0,0 +1,197 @@
+# Copyright 2022 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+"""A collection of utility functions that are used in the charm."""
+
+import os
+import pwd
+import re
+import secrets
+import string
+from asyncio import as_completed, create_task, run, wait
+from contextlib import suppress
+from ssl import CERT_NONE, create_default_context
+from typing import Any
+
+from httpx import AsyncClient, BasicAuth, HTTPError
+
+from ..config.literals import API_REQUEST_TIMEOUT, Substrates
+
+
+def new_password() -> str:
+    """Generate a random password string.
+
+    Returns:
+       A random password string.
+    """
+    choices = string.ascii_letters + string.digits
+    password = "".join([secrets.choice(choices) for _ in range(16)])
+    return password
+
+
+def split_mem(mem_str) -> tuple:
+    """Split a memory string into a number and a unit.
+
+    Args:
+        mem_str: a string representing a memory value, e.g. "1Gi"
+    """
+    pattern = r"^(\d+)(\w+)$"
+    parts = re.match(pattern, mem_str)
+    if parts:
+        return parts.groups()
+    return None, "No unit found"
+
+
+def any_memory_to_bytes(mem_str) -> int:
+    """Convert a memory string to bytes.
+
+    Args:
+        mem_str: a string representing a memory value, e.g. "1Gi"
+    """
+    units = {
+        "KI": 1024,
+        "K": 10**3,
+        "MI": 1048576,
+        "M": 10**6,
+        "GI": 1073741824,
+        "G": 10**9,
+        "TI": 1099511627776,
+        "T": 10**12,
+    }
+    try:
+        num = int(mem_str)
+        return num
+    except ValueError as e:
+        memory, unit = split_mem(mem_str)
+        unit = unit.upper()
+        if unit not in units:
+            raise ValueError(f"Invalid memory definition in '{mem_str}'") from e
+
+        num = int(memory)
+        return int(num * units[unit])
+
+
+def any_cpu_to_cores(cpu_str) -> int:
+    """Convert a CPU string to cores.
+
+    Args:
+        cpu_str: a string representing a CPU value, as integer or millis
+    """
+    if cpu_str.endswith("m"):
+        # convert millis to cores, undercommited
+        return int(cpu_str[:-1]) // 1000
+    return int(cpu_str)
+
+
+def label2name(label: str) -> str:
+    """Convert a unit label (with `-`) to a unit name (with `/`).
+
+    Args:
+        label: The label to convert.
+
+    Returns:
+        The converted name.
+    """
+    return "/".join(label.rsplit("-", 1))
+
+
+def render_file(
+    substrate: Substrates, path: str, content: str, mode: int, change_owner: bool = True
+) -> None:
+    """Write a content rendered from a template to a file.
+
+    Args:
+        substrate: Charm substrate.
+        path: the path to the file.
+        content: the data to be written to the file.
+        mode: access permission mask applied to the
+          file using chmod (e.g. 0o640).
+        change_owner: whether to change the file owner
+          to the _daemon_ user.
+    """
+    # TODO: keep this method to use it also for generating replication configuration files and
+    # move it to an utils / helpers file.
+    # Write the content to the file.
+    with open(path, "w+") as file:
+        file.write(content)
+    # Ensure correct permissions are set on the file.
+    os.chmod(path, mode)
+    if change_owner:
+        _change_owner(substrate, path)
+
+
+def create_directory(substrate: Substrates, path: str, mode: int) -> None:
+    """Creates a directory.
+
+    Args:
+        substrate: Charm substrate.
+        path: the path of the directory that should be created.
+        mode: access permission mask applied to the
+          directory using chmod (e.g. 0o640).
+    """
+    os.makedirs(path, mode=mode, exist_ok=True)
+    # Ensure correct permissions are set on the directory.
+    os.chmod(path, mode)
+    _change_owner(substrate, path)
+
+
+def _change_owner(substrate: Substrates, path: str) -> None:
+    """Change the ownership of a file or a directory to the postgres user.
+
+    Args:
+        substrate: Charm substrate.
+        path: path to a file or directory.
+    """
+    try:
+        # Get the uid/gid for the _daemon_ user.
+        user_database = (
+            pwd.getpwnam("_daemon_") if substrate == Substrates.VM else pwd.getpwnam("postgres")
+        )
+        # Set the correct ownership for the file or directory.
+        os.chown(path, uid=user_database.pw_uid, gid=user_database.pw_gid)
+    except KeyError:
+        # Ignore non existing user error when it wasn't created yet.
+        pass
+
+
+async def _httpx_get_request(
+    url: str, cafile: str, auth: BasicAuth | None = None, verify: bool = True
+) -> dict[str, Any] | None:
+    ssl_ctx = create_default_context()
+    if verify:
+        with suppress(FileNotFoundError):
+            ssl_ctx.load_verify_locations(cafile=cafile)
+    else:
+        ssl_ctx.check_hostname = False
+        ssl_ctx.verify_mode = CERT_NONE
+    async with AsyncClient(auth=auth, timeout=API_REQUEST_TIMEOUT, verify=ssl_ctx) as client:
+        try:
+            return (await client.get(url)).raise_for_status().json()
+        except (HTTPError, ValueError):
+            return None
+
+
+async def _async_get_request(
+    uri: str, endpoints: list[str], cafile: str, auth: BasicAuth | None, verify: bool = True
+) -> dict[str, Any] | None:
+    tasks = [
+        create_task(_httpx_get_request(f"https://{ip}:8008{uri}", cafile, auth, verify))
+        for ip in endpoints
+    ]
+    for task in as_completed(tasks):
+        if result := await task:
+            for task in tasks:
+                task.cancel()
+            await wait(tasks)
+            return result
+
+
+def parallel_patroni_get_request(
+    uri: str,
+    endpoints: list[str],
+    cafile: str,
+    auth: BasicAuth | None = None,
+    verify: bool = True,
+) -> dict[str, Any] | None:
+    """Call all possible patroni endpoints in parallel."""
+    return run(_async_get_request(uri, endpoints, cafile, auth, verify))

{postgresql_charms_single_kernel-16.1.12 → postgresql_charms_single_kernel-16.2.2}/single_kernel_postgresql/utils/postgresql.py

@@ -1381,14 +1381,14 @@ $$ LANGUAGE plpgsql security definer;"""  # noqa: S608
             parameters[parameter] = value
         shared_buffers_max_value_in_mb = int(available_memory * 0.4 / 10**6)
         shared_buffers_max_value = int(shared_buffers_max_value_in_mb * 10**3 / 8)
-        if parameters.get("shared_buffers", 0) > shared_buffers_max_value:
+        if int(parameters.get("shared_buffers", 0)) > shared_buffers_max_value:
             raise Exception(
                 f"Shared buffers config option should be at most 40% of the available memory, which is {shared_buffers_max_value_in_mb}MB"
             )
         if profile == "production":
             if "shared_buffers" in parameters:
                 # Convert to bytes to use in the calculation.
-                shared_buffers = parameters["shared_buffers"] * 8 * 10**3
+                shared_buffers = int(parameters["shared_buffers"]) * 8 * 10**3
             else:
                 # Use 25% of the available memory for shared_buffers.
                 # and the remaining as cache memory.

postgresql_charms_single_kernel-16.1.12/single_kernel_postgresql/utils/__init__.py

@@ -1,3 +0,0 @@
-# Copyright 2025 Canonical Ltd.
-# See LICENSE file for licensing details.
-"""Utils and helpers for PostgreSQL charms."""