sovereign 0.18.1__tar.gz → 0.19.1__tar.gz

{sovereign-0.18.1 → sovereign-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sovereign
-Version: 0.18.1
+Version: 0.19.1
 Summary: Envoy Proxy control-plane written in Python
 Home-page: https://pypi.org/project/sovereign/
 License: Apache-2.0

{sovereign-0.18.1 → sovereign-0.19.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sovereign"
-version = "0.18.1"
+version = "0.19.1"
 description = "Envoy Proxy control-plane written in Python"
 license = "Apache-2.0"
 packages = [

{sovereign-0.18.1 → sovereign-0.19.1}/setup.py

@@ -47,7 +47,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'sovereign',
-    'version': '0.18.1',
+    'version': '0.19.1',
     'description': 'Envoy Proxy control-plane written in Python',
     'long_description': 'sovereign\n=========\n\nMission statement\n-----------------\nThis project implements a JSON control-plane based on the [envoy](https://envoyproxy.io) [data-plane-api](https://github.com/envoyproxy/data-plane-api)\n\nThe purpose of `sovereign` is to supply downstream envoy proxies with \nconfiguration in near-realtime by responding to discovery requests.\n\nMechanism of Operation\n----------------------\ntl;dr version:\n```\n* Polls HTTP/File/Other for data\n* (optional) Applies transforms to the data\n* Uses the data to generate Envoy configuration from templates\n```\n\nIn a nutshell, Sovereign \ngathers contextual data (*"sources"* and *"template context"*), \noptionally applies transforms to that data (using *"modifiers"*) and finally \nuses the data to generate envoy configuration from either python code, or jinja2 templates.\n\nThis is performed in a semi-stateless way, where the only state is data cached in memory.\n\nTemplate context is intended to be statically configured, whereas *Sources* \nare meant to be dynamic - for example, fetching from an API, an S3 bucket, \nor a file that receives updates.\n\n*Modifiers* can mutate the data retrieved from sources, just in case the data \nis in a less than favorable structure.\n\nBoth modifiers and sources are pluggable, i.e. it\'s easy to write your own and \nplug them into Sovereign for your use-case.\n\nCurrently, Sovereign supports only providing configuration to Envoy as JSON. \nThat is to say, gRPC is not supported yet. Contributions in this area are highly\nappreciated!\n\nThe JSON configuration can be viewed in real-time with Sovereign\'s read-only web interface.\n\nRequirements\n------------\n* Python 3.8+\n\nInstallation\n------------\n```\npip install sovereign\n```\n\nDocumentation\n-------------\n[Read the docs here!](https://vsyrakis.bitbucket.io/sovereign/docs/)\n\n:new: Read-only user interface\n------------------------\nAdded in `v0.5.3`!\n\nThis interface allows you to browse the resources currently returned by Sovereign.\n\n![Sovereign User Interface Screenshot](https://bitbucket.org/atlassian/sovereign/src/master/assets/sovereign_ui.png)\n\nLocal development\n=================\n\nRequirements\n------------\n* Docker\n* Docker-compose\n\nInstalling dependencies for dev\n-------------------------------\nI recommend creating a virtualenv before doing any dev work\n\n```\npython3 -m venv venv\nsource venv/bin/activate\npip install -r requirements-dev.txt\n```\n\nRunning locally\n---------------\nRunning the test env\n\n```\nmake run\n```\n    \nRunning the test env daemonized\n\n```\nmake run-daemon\n```\n\nPylint\n\n```\nmake lint\n```\n\nUnit tests\n\n```\nmake unit\n```\n\nAcceptance tests\n\n```\nmake run-daemon acceptance\n```\n\n\nContributors\n============\n\nPull requests, issues and comments welcome. For pull requests:\n\n* Add tests for new features and bug fixes\n* Follow the existing style\n* Separate unrelated changes into multiple pull requests\n\nSee the existing issues for things to start contributing.\n\nFor bigger changes, make sure you start a discussion first by creating\nan issue and explaining the intended change.\n\nAtlassian requires contributors to sign a Contributor License Agreement,\nknown as a CLA. This serves as a record stating that the contributor is\nentitled to contribute the code/documentation/translation to the project\nand is willing to have it used in distributions and derivative works\n(or is willing to transfer ownership).\n\nPrior to accepting your contributions we ask that you please follow the appropriate\nlink below to digitally sign the CLA. The Corporate CLA is for those who are\ncontributing as a member of an organization and the individual CLA is for\nthose contributing as an individual.\n\n* [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)\n* [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)\n\n\nLicense\n========\n\nCopyright (c) 2018 Atlassian and others.\nApache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.\n\n\n',
     'author': 'Vasili Syrakis',

{sovereign-0.18.1 → sovereign-0.19.1}/src/sovereign/__init__.py

@@ -1,7 +1,8 @@
 import os
 from contextvars import ContextVar
 from typing import Type, Any, Mapping
-from pkg_resources import get_distribution, resource_filename
+from importlib.metadata import version
+from pkg_resources import resource_filename
 
 from fastapi.responses import JSONResponse
 from starlette.templating import Jinja2Templates
@@ -52,9 +53,12 @@ def get_request_id() -> str:
     return _request_id_ctx_var.get()
 
 
-__version__ = get_distribution("sovereign").version
+DIST_NAME = "sovereign"
+
+__version__ = version(DIST_NAME)
 config_path = os.getenv("SOVEREIGN_CONFIG", "file:///etc/sovereign.yaml")
-html_templates = Jinja2Templates(resource_filename("sovereign", "templates"))
+
+html_templates = Jinja2Templates(resource_filename(DIST_NAME, "templates"))
 
 try:
     config = SovereignConfigv2(**parse_raw_configuration(config_path))

{sovereign-0.18.1 → sovereign-0.19.1}/src/sovereign/context.py

@@ -26,10 +26,10 @@ class TemplateContext:
         self.configured_context = configured_context
         self.crypto = encryption_suite
         self.disabled_suite = disabled_suite
-        # initial load
-        self.context = self.load_context_variables()
         self.logger = logger
         self.stats = stats
+        # initial load
+        self.context = self.load_context_variables()
 
     async def start_refresh_context(self) -> NoReturn:
         if self.refresh_cron is not None:
@@ -40,21 +40,26 @@ class TemplateContext:
         raise RuntimeError("Failed to start refresh_context, this should never happen")
 
     async def refresh_context(self) -> None:
-        try:
-            self.context = self.load_context_variables()
-            self.stats.increment("context.refresh.success")
-        # pylint: disable=broad-except
-        except Exception as e:
-            self.logger(event=e)
-            self.stats.increment("context.refresh.error")
+        self.context = self.load_context_variables()
 
     def load_context_variables(self) -> Dict[str, Any]:
         ret = dict()
         for k, v in self.configured_context.items():
-            if isinstance(v, Loadable):
-                ret[k] = v.load()
-            elif isinstance(v, str):
-                ret[k] = Loadable.from_legacy_fmt(v).load()
+            try:
+                if isinstance(v, Loadable):
+                    ret[k] = v.load()
+                elif isinstance(v, str):
+                    ret[k] = Loadable.from_legacy_fmt(v).load()
+                self.stats.increment(
+                    "context.refresh.success",
+                    tags=[f"context:{k}"],
+                )
+            except Exception as e:  # pylint: disable=broad-exception-caught
+                self.logger(event=e)
+                self.stats.increment(
+                    "context.refresh.error",
+                    tags=[f"context:{k}"],
+                )
         if "crypto" not in ret:
             ret["crypto"] = self.crypto
         return ret

{sovereign-0.18.1 → sovereign-0.19.1}/src/sovereign/server.py

@@ -1,14 +1,18 @@
 import gunicorn.app.base
 from fastapi import FastAPI
-from typing import Optional, Dict, Any
+from typing import Optional, Dict, Any, Callable
 from sovereign import asgi_config
 from sovereign.app import app
+from sovereign.utils.entry_point_loader import EntryPointLoader
 
 
 class StandaloneApplication(gunicorn.app.base.BaseApplication):  # type: ignore
+    _HOOKS = ["pre_fork", "post_fork"]
+
     def __init__(
         self, application: FastAPI, options: Optional[Dict[str, Any]] = None
     ) -> None:
+        self.loader = EntryPointLoader(*self._HOOKS)
         self.options = options or {}
         self.application = application
         super().__init__()
@@ -17,6 +21,20 @@ class StandaloneApplication(gunicorn.app.base.BaseApplication):  # type: ignore
         for key, value in self.options.items():
             self.cfg.set(key.lower(), value)
 
+        for hook in self._HOOKS:
+            self._install_hooks(hook)
+
+    def _install_hooks(self, name: str) -> None:
+        hooks: list[Callable[[Any, Any], None]] = [
+            ep.load() for ep in self.loader.groups[name]
+        ]
+
+        def master_hook(server: Any, worker: Any) -> None:
+            for hook in hooks:
+                hook(server, worker)
+
+        self.cfg.set(name, master_hook)
+
     def load(self) -> FastAPI:
         return self.application
 

{sovereign-0.18.1 → sovereign-0.19.1}/src/sovereign/sources/poller.py

@@ -1,12 +1,13 @@
 import asyncio
 import traceback
 from copy import deepcopy
+from importlib.metadata import EntryPoint
 from datetime import timedelta, datetime
-from pkg_resources import iter_entry_points, EntryPoint
 from typing import Iterable, Any, Dict, List, Union, Type, Optional
 
 from glom import glom, PathAccessError
 
+from sovereign.utils.entry_point_loader import EntryPointLoader
 from sovereign.sources.lib import Source
 from sovereign.modifiers.lib import Modifier, GlobalModifier
 from sovereign.schemas import (
@@ -50,14 +51,10 @@ class SourcePoller:
         self.logger = logger
         self.stats = stats
 
-        self.entry_points: Dict[str, List[EntryPoint]] = dict()
-        for entry_point in ("sources", "modifiers", "global_modifiers"):
-            self.entry_points[entry_point] = list(
-                iter_entry_points(f"sovereign.{entry_point}")
-            )
+        self.entry_points = EntryPointLoader("sources", "modifiers", "global_modifiers")
 
         self.source_classes: Dict[str, Type[Source]] = {
-            e.name: e.load() for e in self.entry_points["sources"]
+            e.name: e.load() for e in self.entry_points.groups["sources"]
         }
         self.sources = [self.setup_source(s) for s in sources]
         if not self.sources:
@@ -89,14 +86,14 @@ class SourcePoller:
         if len(self.modifiers) == len(modifiers):
             return
         self.modifiers = self.load_modifier_entrypoints(
-            self.entry_points["modifiers"], modifiers
+            self.entry_points.groups["modifiers"], modifiers
         )
 
     def lazy_load_global_modifiers(self, global_modifiers: List[str]) -> None:
         if len(self.global_modifiers) == len(global_modifiers):
             return
         self.global_modifiers = self.load_global_modifier_entrypoints(
-            self.entry_points["global_modifiers"], global_modifiers
+            self.entry_points.groups["global_modifiers"], global_modifiers
         )
 
     def load_modifier_entrypoints(

sovereign-0.19.1/src/sovereign/utils/entry_point_loader.py

@@ -0,0 +1,18 @@
+from typing import Dict
+from functools import cached_property
+from importlib.metadata import entry_points, EntryPoints
+
+
+class EntryPointLoader:
+    ENTRY_POINTS = entry_points()
+
+    def __init__(self, *args: str) -> None:
+        self._groups = args
+
+    @classmethod
+    def _select(cls, group: str) -> EntryPoints:
+        return cls.ENTRY_POINTS.select(group=f"sovereign.{group}")
+
+    @cached_property
+    def groups(self) -> Dict[str, EntryPoints]:
+        return {group: self._select(group) for group in self._groups}