sovereign 0.32.0__tar.gz → 1.0.0a3__tar.gz

{sovereign-0.32.0 → sovereign-1.0.0a3}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sovereign
-Version: 0.32.0
+Version: 1.0.0a3
 Summary: Envoy Proxy control-plane written in Python
-Home-page: https://pypi.org/project/sovereign/
-License: Apache-2.0
-Keywords: envoy,envoyproxy,control-plane,management,server
-Author: Vasili Syrakis
-Author-email: vsyrakis@atlassian.com
-Requires-Python: >=3.11,<4.0
+Project-URL: Homepage, https://pypi.org/project/sovereign/
+Project-URL: Repository, https://bitbucket.org/atlassian/sovereign/src/master/
+Project-URL: Documentation, https://developer.atlassian.com/platform/sovereign/
+Author-email: Vasili Syrakis <vsyrakis@atlassian.com>
+License-Expression: Apache-2.0
+Keywords: control-plane,envoy,envoyproxy,management,server
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: No Input/Output (Daemon)
 Classifier: Intended Audience :: Developers
@@ -16,48 +16,46 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.10
 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: Topic :: Internet :: Proxy Servers
+Requires-Python: <4.0,>=3.11.0
+Requires-Dist: aiofiles<24,>=23.2.1
+Requires-Dist: cachelib<0.11,>=0.10.2
+Requires-Dist: cachetools<6,>=5.3.2
+Requires-Dist: croniter<2,>=1.4.1
+Requires-Dist: cryptography>=45.0.2
+Requires-Dist: fastapi<0.129,>=0.128.0
+Requires-Dist: glom<24,>=23.3.0
+Requires-Dist: h11<0.17,>=0.16.0
+Requires-Dist: jinja2<4,>=3.1.2
+Requires-Dist: jmespath<2,>=1.0.1
+Requires-Dist: pydantic-settings<2.6.0
+Requires-Dist: pydantic<3,>=2.7.2
+Requires-Dist: pyyaml<7,>=6.0.1
+Requires-Dist: requests<3,>=2.32.4
+Requires-Dist: rich>=14.2.0
+Requires-Dist: starlette-context<0.4,>=0.3.6
+Requires-Dist: starlette<0.50,>=0.49.1
+Requires-Dist: structlog<24,>=23.1.0
+Requires-Dist: supervisor<5,>=4.2.5
+Requires-Dist: uvicorn<0.24,>=0.23.2
+Requires-Dist: uvloop<1.0,>0.19.0
 Provides-Extra: boto
+Requires-Dist: boto3<2,>=1.28.62; extra == 'boto'
 Provides-Extra: caching
 Provides-Extra: httptools
+Requires-Dist: httptools<0.7,>=0.6.0; extra == 'httptools'
 Provides-Extra: orjson
+Requires-Dist: orjson<4,>=3.9.15; extra == 'orjson'
 Provides-Extra: sentry
+Requires-Dist: sentry-sdk<3,>=2.14.0; extra == 'sentry'
 Provides-Extra: statsd
+Requires-Dist: datadog>=0.50.1; extra == 'statsd'
 Provides-Extra: ujson
-Requires-Dist: Jinja2 (>=3.1.2,<4.0.0)
-Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
-Requires-Dist: aiofiles (>=23.2.1,<24.0.0)
-Requires-Dist: boto3 (>=1.28.62,<2.0.0) ; extra == "boto"
-Requires-Dist: cachelib (>=0.10.2,<0.11.0)
-Requires-Dist: cachetools (>=5.3.2,<6.0.0)
-Requires-Dist: cashews[redis] (>=6.3.0,<7.0.0) ; extra == "caching"
-Requires-Dist: croniter (>=1.4.1,<2.0.0)
-Requires-Dist: cryptography (>=42.0.0,<43.0.0)
-Requires-Dist: datadog (>=0.47.0,<0.48.0) ; extra == "statsd"
-Requires-Dist: fastapi (>=0.115.2,<0.116.0)
-Requires-Dist: glom (>=23.3.0,<24.0.0)
-Requires-Dist: gunicorn (>=23.0.0,<24.0.0)
-Requires-Dist: httptools (>=0.6.0,<0.7.0) ; extra == "httptools"
-Requires-Dist: orjson (>=3.9.15,<4.0.0) ; extra == "orjson"
-Requires-Dist: pydantic (>=2.7.2,<3.0.0)
-Requires-Dist: pydantic-settings (<2.6.0)
-Requires-Dist: redis (<=5.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Requires-Dist: sentry-sdk (>=2.14.0,<3.0.0) ; extra == "sentry"
-Requires-Dist: starlette-context (>=0.3.6,<0.4.0)
-Requires-Dist: structlog (>=23.1.0,<24.0.0)
-Requires-Dist: ujson (>=5.8.0,<6.0.0) ; extra == "ujson"
-Requires-Dist: uvicorn (>=0.23.2,<0.24.0)
-Requires-Dist: uvloop (>=0.19.0,<0.20.0)
-Project-URL: Documentation, https://developer.atlassian.com/platform/sovereign/
-Project-URL: Repository, https://bitbucket.org/atlassian/sovereign/src/master/
+Requires-Dist: ujson<6,>=5.8.0; extra == 'ujson'
 Description-Content-Type: text/markdown
 
 sovereign
@@ -133,17 +131,18 @@ Local development
 
 Requirements
 ------------
-* Poetry
+* uv
 * Docker
 * Docker-compose
 
 
 Installing dependencies for dev
 -------------------------------
-Dependencies and creation of virtualenv is handled by poetry
+Dependencies and creation of virtualenv is handled by uv
 ```
-poetry install
-poetry shell
+uv sync
+uv venv activate
+uv run <command>
 ```
 
 Running locally
@@ -208,4 +207,3 @@ Copyright (c) 2018 Atlassian and others.
 Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.
 
 
-

{sovereign-0.32.0 → sovereign-1.0.0a3}/README.md

@@ -71,17 +71,18 @@ Local development
 
 Requirements
 ------------
-* Poetry
+* uv
 * Docker
 * Docker-compose
 
 
 Installing dependencies for dev
 -------------------------------
-Dependencies and creation of virtualenv is handled by poetry
+Dependencies and creation of virtualenv is handled by uv
 ```
-poetry install
-poetry shell
+uv sync
+uv venv activate
+uv run <command>
 ```
 
 Running locally

sovereign-1.0.0a3/pyproject.toml

@@ -0,0 +1,161 @@
+[project]
+name = "sovereign"
+version = "1.0.0a3"
+description = "Envoy Proxy control-plane written in Python"
+authors = [{ name = "Vasili Syrakis", email = "vsyrakis@atlassian.com" }]
+requires-python = ">=3.11.0, <4.0"
+readme = "README.md"
+license = "Apache-2.0"
+keywords = [
+    "envoy",
+    "envoyproxy",
+    "control-plane",
+    "management",
+    "server",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: No Input/Output (Daemon)",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Internet :: Proxy Servers",
+]
+dependencies = [
+    "uvicorn>=0.23.2,<0.24",
+    "aiofiles>=23.2.1,<24",
+    "requests>=2.32.4,<3",
+    "PyYAML>=6.0.1,<7",
+    "Jinja2>=3.1.2,<4",
+    "structlog>=23.1.0,<24",
+    "cachelib>=0.10.2,<0.11",
+    "glom>=23.3.0,<24",
+    "cryptography>=45.0.2",
+    "fastapi>=0.128.0,<0.129",
+    "uvloop>0.19.0,<1.0",
+    "croniter>=1.4.1,<2",
+    "cachetools>=5.3.2,<6",
+    "pydantic>=2.7.2,<3",
+    "pydantic-settings<2.6.0",
+    "starlette-context>=0.3.6,<0.4",
+    "starlette>=0.49.1,<0.50",
+    "h11>=0.16.0,<0.17",
+    "supervisor>=4.2.5,<5",
+    "jmespath>=1.0.1,<2",
+    "rich>=14.2.0",
+]
+
+[project.optional-dependencies]
+sentry = ["sentry-sdk>=2.14.0,<3"]
+boto = ["boto3>=1.28.62,<2"]
+statsd = ["datadog>=0.50.1"]
+ujson = ["ujson>=5.8.0,<6"]
+orjson = ["orjson>=3.9.15,<4"]
+caching = []
+httptools = ["httptools>=0.6.0,<0.7"]
+
+[project.urls]
+Homepage = "https://pypi.org/project/sovereign/"
+Repository = "https://bitbucket.org/atlassian/sovereign/src/master/"
+Documentation = "https://developer.atlassian.com/platform/sovereign/"
+
+[project.scripts]
+sovereign = "sovereign.server:main"
+sovereign-web = "sovereign.server:web"
+sovereign-worker = "sovereign.server:worker"
+
+[project.entry-points."sovereign.sources"]
+file = "sovereign.sources.file:File"
+inline = "sovereign.sources.inline:Inline"
+
+[project.entry-points."sovereign.modifiers"]
+sovereign_3rd_party_test = "sovereign.testing.modifiers:Test"
+
+[project.entry-points."sovereign.loaders"]
+example = "sovereign.testing.loaders:Multiply"
+file = "sovereign.dynamic_config.loaders:File"
+pkgdata = "sovereign.dynamic_config.loaders:PackageData"
+http = "sovereign.dynamic_config.loaders:Web"
+https = "sovereign.dynamic_config.loaders:Web"
+env = "sovereign.dynamic_config.loaders:EnvironmentVariable"
+module = "sovereign.dynamic_config.loaders:PythonModule"
+s3 = "sovereign.dynamic_config.loaders:S3Bucket"
+python = "sovereign.dynamic_config.loaders:PythonInlineCode"
+inline = "sovereign.dynamic_config.loaders:Inline"
+
+[project.entry-points."sovereign.deserializers"]
+yaml = "sovereign.dynamic_config.deser:YamlDeserializer"
+json = "sovereign.dynamic_config.deser:JsonDeserializer"
+jinja = "sovereign.dynamic_config.deser:JinjaDeserializer"
+jinja2 = "sovereign.dynamic_config.deser:JinjaDeserializer"
+string = "sovereign.dynamic_config.deser:StringDeserializer"
+raw = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+none = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+passthrough = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+ujson = "sovereign.dynamic_config.deser:UjsonDeserializer"
+orjson = "sovereign.dynamic_config.deser:OrjsonDeserializer"
+
+[project.entry-points."sovereign.cache.backends"]
+s3 = "sovereign.cache.backends.s3:S3Backend"
+
+[project.entry-points."sovereign.data_stores"]
+memory = "sovereign.v2.data.data_store:InMemoryDataStore"
+sqlite = "sovereign.v2.data.data_store:SqliteDataStore"
+
+[project.entry-points."sovereign.queues"]
+memory = "sovereign.v2.data.worker_queue:InMemoryQueue"
+sqlite = "sovereign.v2.data.worker_queue:SqliteQueue"
+
+[dependency-groups]
+dev = [
+    "freezegun",
+    "httpx",
+    "moto>=5.0.0",
+    "pytest-asyncio",
+    "pytest-mock",
+    "ruff",
+    "tavern",
+    "toml",
+    "ty",
+    "ty==0.0.1a26",
+    "types-PyYAML",
+    "types-cachetools",
+    "types-croniter",
+    "types-mock>=5.2.0.20250306,<6",
+    "types-requests",
+    "types-setuptools",
+    "types-ujson",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/sovereign",
+    "src/sovereign_files",
+    "src/sovereign_files/**/*",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+    "src/sovereign",
+    "src/sovereign_files",
+    "src/sovereign_files/**/*",
+]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/sovereign" = "sovereign"
+"src/sovereign_files" = "sovereign_files"
+
+[[tool.uv.index]]
+url = "https://pypi.org/simple"
+default = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

sovereign-1.0.0a3/src/sovereign/__init__.py

@@ -0,0 +1,32 @@
+from contextvars import ContextVar
+from importlib.metadata import version
+
+from sovereign.configuration import EncryptionConfig, config
+from sovereign.logging.bootstrapper import LoggerBootstrapper
+from sovereign.statistics import configure_statsd
+from sovereign.utils.crypto.crypto import CipherContainer
+from sovereign.utils.crypto.suites import EncryptionType
+
+_request_id_ctx_var: ContextVar[str] = ContextVar("request_id", default="")
+
+
+def get_request_id() -> str:
+    return _request_id_ctx_var.get()
+
+
+WORKER_URL = "http://localhost:9080"
+DIST_NAME = "sovereign"
+__version__ = version(DIST_NAME)
+
+stats = configure_statsd()
+logs = LoggerBootstrapper(config)
+application_logger = logs.application_logger.logger
+
+encryption_configs = config.authentication.encryption_configs
+server_cipher_container = CipherContainer.from_encryption_configs(
+    encryption_configs, logger=application_logger
+)
+disabled_ciphersuite = CipherContainer.from_encryption_configs(
+    encryption_configs=[EncryptionConfig("", EncryptionType.DISABLED)],
+    logger=application_logger,
+)

{sovereign-0.32.0 → sovereign-1.0.0a3}/src/sovereign/app.py

@@ -1,4 +1,3 @@
-import asyncio
 import traceback
 from collections import namedtuple
 
@@ -7,32 +6,17 @@ from fastapi import FastAPI, Request
 from fastapi.responses import FileResponse, JSONResponse, RedirectResponse, Response
 from starlette_context.middleware import RawContextMiddleware
 
-from sovereign import (
-    __version__,
-    asgi_config,
-    config,
-    logs,
-    poller,
-    template_context,
-)
-from sovereign.response_class import json_response_class
+from sovereign import __version__, logs
+from sovereign.configuration import ConfiguredResourceTypes, config
 from sovereign.error_info import ErrorInfo
 from sovereign.middlewares import LoggingMiddleware, RequestContextLogMiddleware
+from sovereign.response_class import json_response_class
 from sovereign.utils.resources import get_package_file
-from sovereign.views import admin, crypto, discovery, healthchecks, interface
+from sovereign.views import api, crypto, discovery, healthchecks, interface
 
 Router = namedtuple("Router", "module tags prefix")
 
 DEBUG = config.debug
-SENTRY_DSN = config.sentry_dsn.get_secret_value()
-
-try:
-    import sentry_sdk
-    from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
-
-    SENTRY_INSTALLED = True
-except ImportError:  # pragma: no cover
-    SENTRY_INSTALLED = False
 
 
 def generic_error_response(e: Exception) -> JSONResponse:
@@ -69,25 +53,35 @@ def init_app() -> FastAPI:
 
     routers = (
         Router(discovery.router, ["Configuration Discovery"], ""),
-        Router(crypto.router, ["Cryptographic Utilities"], "/crypto"),
-        Router(admin.router, ["Debugging Endpoints"], "/admin"),
-        Router(interface.router, ["User Interface"], "/ui"),
+        Router(api.router, ["API"], "/api"),
         Router(healthchecks.router, ["Healthchecks"], ""),
+        Router(interface.router, ["User Interface"], "/ui"),
+        Router(crypto.router, ["Cryptographic Utilities"], "/crypto"),
     )
     for router in routers:
         application.include_router(
             router.module, tags=router.tags, prefix=router.prefix
         )
 
-    application.add_middleware(RequestContextLogMiddleware)
-    application.add_middleware(LoggingMiddleware)
+    application.add_middleware(RequestContextLogMiddleware)  # type: ignore
+    application.add_middleware(LoggingMiddleware)  # type: ignore
 
-    if SENTRY_INSTALLED and SENTRY_DSN:
-        sentry_sdk.init(SENTRY_DSN)
-        application.add_middleware(SentryAsgiMiddleware)
-        logs.application_logger.logger.info("Sentry middleware enabled")
+    if dsn := config.sentry_dsn.get_secret_value():
+        try:
+            # noinspection PyUnusedImports
+            import sentry_sdk
 
-    application.add_middleware(RawContextMiddleware)
+            # noinspection PyUnusedImports
+            from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
+
+            sentry_sdk.init(dsn)
+            application.add_middleware(SentryAsgiMiddleware)  # type: ignore
+        except ImportError:
+            logs.application_logger.logger.error(
+                "Sentry DSN configured but failed to attach to webserver"
+            )
+
+    application.add_middleware(RawContextMiddleware)  # type: ignore
 
     @application.exception_handler(500)
     async def exception_handler(_: Request, exc: Exception) -> JSONResponse:
@@ -105,24 +99,41 @@ def init_app() -> FastAPI:
 
     @application.get("/static/{filename}", summary="Return a static asset")
     async def static(filename: str) -> Response:
-        return FileResponse(get_package_file("sovereign", f"static/{filename}"))  # type: ignore[arg-type]
+        return FileResponse(get_package_file("sovereign_files", f"static/{filename}"))  # type: ignore[arg-type]
 
-    @application.on_event("startup")
-    async def keep_sources_uptodate() -> None:
-        if poller is not None:
-            asyncio.create_task(poller.poll_forever())
-
-    @application.on_event("startup")
-    async def refresh_template_context() -> None:
-        asyncio.create_task(template_context.start_refresh_context())
+    @application.get(
+        "/admin/xds_dump",
+        summary="Deprecated API, please use /api/resources/{resource_type}",
+    )
+    async def dump_resources(request: Request) -> Response:
+        resource_type = ConfiguredResourceTypes(
+            request.query_params.get("xds_type", "cluster")
+        )
+        resource_name = request.query_params.get("name")
+        api_version = request.query_params.get("api_version", "v3")
+        service_cluster = request.query_params.get("service_cluster", "*")
+        region = request.query_params.get("region")
+        version = request.query_params.get("version")
+        response = await api.resource(
+            resource_type=resource_type,
+            resource_name=resource_name,
+            api_version=api_version,
+            service_cluster=service_cluster,
+            region=region,
+            version=version,
+        )
+        response.headers["Deprecation"] = "true"
+        response.headers["Link"] = f'</api/resources/{resource_type}>; rel="alternate"'
+        response.headers["Warning"] = (
+            f'299 - "Deprecated API: please use /api/resources/{resource_type}"'
+        )
+        response.status_code = 299
+        return response
 
     return application
 
 
 app = init_app()
-logs.application_logger.logger.info(
-    f"Sovereign started and listening on {asgi_config.host}:{asgi_config.port}"
-)
 
 
 if __name__ == "__main__":  # pragma: no cover