paas-charm 2.0.dev0__tar.gz → 2.0.dev1__tar.gz

{paas_charm-2.0.dev0 → paas_charm-2.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: paas-charm
-Version: 2.0.dev0
+Version: 2.0.dev1
 Summary: Companion library for 12-factor app support in Charmcraft & Rockcraft.
 Author-email: Canonical IS DevOps team <is-devops-team@canonical.com>
 Project-URL: Repository, https://github.com/canonical/paas-charm
@@ -11,12 +11,12 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
-Requires-Dist: cosl==1.9.1
-Requires-Dist: dpcharmlibs-interfaces==1.0.2
+Requires-Dist: cosl==1.10.3
+Requires-Dist: dpcharmlibs-interfaces==1.2.0
 Requires-Dist: Jinja2==3.1.6
 Requires-Dist: jsonschema==4.26.0
-Requires-Dist: ops==3.7.1
-Requires-Dist: pydantic==2.13.4
+Requires-Dist: ops==3.8.2
+Requires-Dist: pydantic[email]==2.13.5
 
 # PaaS Charm
 

{paas_charm-2.0.dev0 → paas_charm-2.0.dev1}/pyproject.toml

@@ -2,7 +2,7 @@
 # See LICENSE file for licensing details.
 [project]
 name = "paas-charm"
-version = "2.0.dev0"
+version = "2.0.dev1"
 description = "Companion library for 12-factor app support in Charmcraft & Rockcraft."
 readme = "README.md"
 authors = [
@@ -17,12 +17,12 @@ classifiers = [
     "Programming Language :: Python :: 3",
 ]
 dependencies = [
-    "cosl==1.9.1",
-    "dpcharmlibs-interfaces==1.0.2",
+    "cosl==1.10.3",
+    "dpcharmlibs-interfaces==1.2.0",
     "Jinja2==3.1.6",
     "jsonschema==4.26.0",
-    "ops==3.7.1",
-    "pydantic==2.13.4",
+    "ops==3.8.2",
+    "pydantic[email]==2.13.5",
 ]
 
 [project.urls]
@@ -37,7 +37,7 @@ where = ["src"]
 
 [tool.uv.sources]
 # opcli is published only from the charm-ci git repository, not PyPI.
-opcli = { git = "https://github.com/canonical/charm-ci.git", branch = "main" }
+opcli = { git = "https://github.com/canonical/charm-ci.git", tag = "v1.0.1" }
 
 [tool.setuptools.package-data]
 paas_charm = ["**/cos/**", "**/cos/**/.**", "**/*.j2", "**/templates/**/*.py", "**/templates/**/*.json"]
@@ -134,13 +134,13 @@ line-length = 99
 
 [dependency-groups]
 unit = [
-    "cosl==1.9.1",
-    "coverage[toml]==7.14.1",
-    "gunicorn==26.0.0",
-    "opentelemetry-api==1.42.1",
-    "opentelemetry-sdk==1.42.1",
-    "ops[testing]==3.7.1",
-    "pydantic[email]==2.13.4",
+    "cosl==1.10.3",
+    "coverage[toml]==7.16.0",
+    "gunicorn==26.2.0",
+    "opentelemetry-api==1.44.0",
+    "opentelemetry-sdk==1.44.0",
+    "ops[testing]==3.8.2",
+    "pydantic[email]==2.13.5",
     "pytest==9.1.1",
 ]
 lint = [
@@ -158,8 +158,7 @@ lint = [
     "pydocstyle",
     "pylint",
     "pyproject-flake8",
-    "pytest_operator",
-    "snowballstemmer<3.0.0",
+    "snowballstemmer<3.1.2",
     "types-PyYAML",
     "types-requests",
 ]
@@ -168,15 +167,16 @@ static = [
 ]
 integration-tests = [
     "pytest>=9.1.1",
-    "aiohttp==3.11.7",
-    "cosl==1.9.1",
+    "aiohttp==3.14.3",
+    "cosl==1.10.3",
     "saml-test-helper @ git+https://github.com/canonical/saml-test-idp.git",
-    "jubilant==1.7.0",
-    "juju==3.6.1.2",
-    "minio==7.2.14",
-    "ops==3.7.1",
-    "tenacity==9.0.0",
-    "playwright==1.61.0",
-    "lightkube==0.21.0",
+    "jubilant==1.13.0",
+    "juju==3.6.1.3",
+    "minio==7.2.20",
+    "ops==3.8.2",
+    "tenacity==9.1.4",
+    "playwright==1.62.0",
+    "lightkube==1.0.1",
+    "pytest-jubilant>=2,<3",
     "opcli"
 ]

paas_charm-2.0.dev1/src/paas_charm/__init__.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+
+# Copyright 2025 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+"""Module __init__."""
+
+import charms.data_platform_libs.v0.data_interfaces  # noqa: F401
+import charms.grafana_k8s.v0.grafana_dashboard  # noqa: F401
+import charms.loki_k8s.v1.loki_push_api  # noqa: F401
+import charms.observability_libs.v0.juju_topology  # noqa: F401
+import charms.prometheus_k8s.v0.prometheus_scrape  # noqa: F401
+import charms.traefik_k8s.v2.ingress  # noqa: F401

{paas_charm-2.0.dev0 → paas_charm-2.0.dev1}/src/paas_charm/_gunicorn/charm.py

@@ -13,7 +13,6 @@ from paas_charm._gunicorn.wsgi_app import WsgiApp
 from paas_charm.app import App, WorkloadConfig
 from paas_charm.charm import PaasCharm
 from paas_charm.exceptions import CharmConfigInvalidError
-from paas_charm.paas_config import read_paas_config
 
 logger = logging.getLogger(__name__)
 
@@ -24,13 +23,12 @@ class GunicornBase(PaasCharm):
     @property
     def _workload_config(self) -> WorkloadConfig:
         """Return a WorkloadConfig instance."""
-        paas_config = read_paas_config()
         return create_workload_config(
             framework_name=self._framework_name,
             unit_name=self.unit.name,
             state_dir=self._state_dir,
             tracing_enabled=bool(self._tracing and self._tracing.is_ready()),
-            logging_format=paas_config.framework_logging_format,
+            paas_config=self._paas_config,
         )
 
     def create_webserver_config(self) -> WebserverConfig:

{paas_charm-2.0.dev0 → paas_charm-2.0.dev1}/src/paas_charm/_gunicorn/webserver.py

@@ -17,8 +17,8 @@ import ops
 from ops.pebble import ExecError, PathError
 
 from paas_charm._gunicorn.workload_config import (
-    APPLICATION_ERROR_LOG_FILE_FMT,
-    APPLICATION_LOG_FILE_FMT,
+    APPLICATION_ERROR_LOG_FILE,
+    APPLICATION_LOG_FILE,
     STATSD_HOST,
 )
 from paas_charm.app import WorkloadConfig
@@ -157,12 +157,8 @@ class GunicornWebserver:  # pylint: disable=too-few-public-methods
             access_log = "-"
             error_log = "-"
         else:
-            access_log = str(
-                APPLICATION_LOG_FILE_FMT.format(framework=self._workload_config.framework)
-            )
-            error_log = str(
-                APPLICATION_ERROR_LOG_FILE_FMT.format(framework=self._workload_config.framework)
-            )
+            access_log = str(APPLICATION_LOG_FILE)
+            error_log = str(APPLICATION_ERROR_LOG_FILE)
 
         jinja_environment = jinja2.Environment(
             loader=jinja2.PackageLoader("paas_charm", "templates"), autoescape=True

paas_charm-2.0.dev1/src/paas_charm/_gunicorn/workload_config.py

@@ -0,0 +1,62 @@
+# Copyright 2025 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+"""This module defines the WorloadConfig class which represents configuration for the workload."""
+
+import pathlib
+
+from paas_charm.app import WorkloadConfig
+from paas_charm.paas_config import PaasConfig
+
+STATSD_HOST = "localhost:9125"
+APPLICATION_LOG_FILE = "/var/log/app/access.log"
+APPLICATION_ERROR_LOG_FILE = "/var/log/app/error.log"
+GUNICORN_CONFIG_DIR = "/var/lib/gunicorn"
+
+
+def create_workload_config(
+    framework_name: str,
+    unit_name: str,
+    state_dir: pathlib.Path,
+    paas_config: PaasConfig | None = None,
+    tracing_enabled: bool = False,
+) -> WorkloadConfig:
+    """Create an WorkloadConfig for Gunicorn.
+
+    Args:
+        framework_name: framework name.
+        unit_name: name of the app unit.
+        state_dir: state folder directory.
+        paas_config: PaasConfig instance. Uses the schema defaults when omitted.
+        tracing_enabled: if True, tracing is enabled.
+
+    Returns:
+       new WorkloadConfig
+    """
+    paas_config = paas_config or PaasConfig()
+    application_port = paas_config.application_port(default_port=8000)
+    metrics_port, metrics_path = paas_config.metrics_endpoint(
+        default_port=9102, default_path="/metrics"
+    )
+    # For Gunicorn, base_dir holds the (mutable) gunicorn.conf.py, kept separate from app_dir
+    # (the application source directory) so the two can have different lifecycles/ownership.
+    base_dir = pathlib.Path(GUNICORN_CONFIG_DIR)
+    app_dir = pathlib.Path("/app")
+    return WorkloadConfig(
+        framework=framework_name,
+        container_name="app",
+        port=application_port,
+        base_dir=base_dir,
+        app_dir=app_dir,
+        state_dir=state_dir,
+        service_name=framework_name,
+        log_files=[
+            pathlib.Path(APPLICATION_LOG_FILE),
+            pathlib.Path(APPLICATION_ERROR_LOG_FILE),
+        ],
+        metrics_path=metrics_path,
+        metrics_port=metrics_port,
+        unit_name=unit_name,
+        tracing_enabled=tracing_enabled,
+        logging_format=paas_config.framework_logging_format,
+    )

{paas_charm-2.0.dev0 → paas_charm-2.0.dev1}/src/paas_charm/app.py

@@ -27,7 +27,6 @@ if TYPE_CHECKING:
     from paas_charm.databases import PaaSDatabaseRelationData
     from paas_charm.oauth import PaaSOAuthRelationData
     from paas_charm.rabbitmq import PaaSRabbitMQRelationData
-    from paas_charm.redis import PaaSRedisRelationData
     from paas_charm.s3 import PaaSS3RelationData
     from paas_charm.saml import PaaSSAMLRelationData
     from paas_charm.tracing import PaaSTracingRelationData
@@ -54,8 +53,8 @@ class WorkloadConfig:  # pylint: disable=too-many-instance-attributes
         state_dir: the directory in the application container to store states information.
         service_name: the WSGI application pebble service name.
         log_files: list of files to monitor.
-        metrics_target: target to scrape for metrics.
         metrics_path: path to scrape for metrics.
+        metrics_port: port on which the application exposes metrics.
         unit_name: Name of the unit. Needed to know if schedulers should run here.
         tracing_enabled: True if tracing should be enabled.
         logging_format: Structured logging format to use; ``LoggingFormat.NONE`` for default.
@@ -71,8 +70,8 @@ class WorkloadConfig:  # pylint: disable=too-many-instance-attributes
     state_dir: pathlib.Path
     service_name: str
     log_files: List[pathlib.Path]
-    metrics_target: str | None = None
     metrics_path: str | None = "/metrics"
+    metrics_port: int = 8080
     unit_name: str
     tracing_enabled: bool = False
     logging_format: LoggingFormat = LoggingFormat.NONE
@@ -152,21 +151,6 @@ def generate_rabbitmq_env(
     return envvars
 
 
-def generate_redis_env(relation_data: "PaaSRedisRelationData | None" = None) -> dict[str, str]:
-    """Generate environment variable from Redis relation data.
-
-    Args:
-        relation_data: The charm Redis integration relation data.
-
-    Returns:
-        Redis environment mappings if Redis relation data is available, empty
-        dictionary otherwise.
-    """
-    if not relation_data:
-        return {}
-    return _db_url_to_env_variables("REDIS", str(relation_data.url))
-
-
 def generate_valkey_env(
     relation_data: ValkeyResponseModel | None = None,
 ) -> dict[str, str]:
@@ -392,7 +376,6 @@ class App:  # pylint: disable=too-many-instance-attributes
         generate_db_env: Maps database connection information to environment variables.
         generate_openfga_env: Maps OpenFGA connection information to environment variables.
         generate_rabbitmq_env: Maps RabbitMQ connection information to environment variables.
-        generate_redis_env: Maps Redis connection information to environment variables.
         generate_valkey_env: Maps Valkey connection information to environment variables.
         generate_s3_env: Maps S3 connection information to environment variables.
         generate_saml_env: Maps SAML connection information to environment variables.
@@ -405,7 +388,6 @@ class App:  # pylint: disable=too-many-instance-attributes
     generate_db_env = staticmethod(generate_db_env)
     generate_openfga_env = staticmethod(generate_openfga_env)
     generate_rabbitmq_env = staticmethod(generate_rabbitmq_env)
-    generate_redis_env = staticmethod(generate_redis_env)
     generate_valkey_env = staticmethod(generate_valkey_env)
     generate_s3_env = staticmethod(generate_s3_env)
     generate_saml_env = staticmethod(generate_saml_env)
@@ -421,7 +403,7 @@ class App:  # pylint: disable=too-many-instance-attributes
         charm_state: CharmState,
         workload_config: WorkloadConfig,
         database_migration: DatabaseMigration,
-        framework_config_prefix: str = "APP_",
+        framework_config_prefix: str = "",
         configuration_prefix: str = "APP_",
         integrations_prefix: str = "",
     ):
@@ -499,6 +481,10 @@ class App:  # pylint: disable=too-many-instance-attributes
                 for k, v in framework_config.items()
             }
         )
+        env[f"{framework_config_prefix}METRICS_PORT"] = str(self._workload_config.metrics_port)
+        env[f"{framework_config_prefix}METRICS_PATH"] = (
+            self._workload_config.metrics_path or "/metrics"
+        )
 
         if self._charm_state.base_url:
             env[f"{prefix}BASE_URL"] = self._charm_state.base_url
@@ -528,7 +514,6 @@ class App:  # pylint: disable=too-many-instance-attributes
         env.update(
             self.generate_rabbitmq_env(relation_data=self._charm_state.integrations.rabbitmq)
         )
-        env.update(self.generate_redis_env(relation_data=self._charm_state.integrations.redis))
         env.update(self.generate_valkey_env(relation_data=self._charm_state.integrations.valkey))
         env.update(self.generate_s3_env(relation_data=self._charm_state.integrations.s3))
         for (