sovereign 0.19.3__py3-none-any.whl → 1.0.0a4__py3-none-any.whl

sovereign/sources/__init__.py

@@ -1,3 +0,0 @@
-from sovereign.sources.poller import SourcePoller
-
-__all__ = ["SourcePoller"]

sovereign/sources/file.py

@@ -1,21 +0,0 @@
-from typing import Any, Dict
-from sovereign.sources.lib import Source
-from sovereign.config_loader import Loadable
-
-
-class File(Source):
-    def __init__(self, config: Dict[str, Any], scope: str = "default"):
-        super(File, self).__init__(config, scope)
-        try:
-            self.path = Loadable.from_legacy_fmt(config["path"])
-        except KeyError:
-            try:
-                self.path = Loadable(**config["spec"])
-            except KeyError:
-                raise KeyError('File source needs to specify "spec" within config')
-
-    def get(self) -> Any:
-        """
-        Uses the file config loader to load the given path
-        """
-        return self.path.load()

sovereign/sources/inline.py

@@ -1,38 +0,0 @@
-"""
-Inline Source
--------------
-
-Example configuration (YAML):
-
-.. code-block:: yaml
-
-   sources:
-     - type: inline
-       config:
-         instances:
-           - instance_id: my_service
-             service_clusters:
-               - P2
-             parameters:
-               upstream_address:
-                 - address: service.domain.com
-                   region: us-east-1
-             plan_id: 7d57270a-0348-58d3-829d-447a98fe98d5
-"""
-from typing import Dict, Any, List
-from sovereign.sources.lib import Source
-
-
-class Inline(Source):
-    def __init__(
-        self, config: Dict[str, List[Dict[str, Any]]], scope: str = "default"
-    ) -> None:
-        super(Inline, self).__init__(config, scope)
-        try:
-            self.instances = config["instances"]
-        except KeyError:
-            raise KeyError('Inline source config must contain "instances"')
-
-    def get(self) -> List[Dict[str, Any]]:
-        """Returns the data passed via configuration"""
-        return self.instances

sovereign/sources/lib.py

@@ -1,40 +0,0 @@
-"""
-Source abstract class
----------------------
-This class can be subclassed, installed as an entry point, and then
-used via configuration.
-
-`todo entry point install guide`
-"""
-import abc
-from typing import Any, Dict, List
-
-
-class Source(abc.ABC):
-    def __init__(self, config: Dict[str, Any], scope: str) -> None:
-        """
-        :param config: arbitrary configuration which can be used by the subclass
-        """
-        self.config = config
-        self.scope = scope
-
-    def setup(self) -> None:
-        """
-        Optional method which is invoked prior to the Source running self.get()
-        """
-        return None
-
-    @abc.abstractmethod
-    def get(self) -> List[Dict[str, Any]]:
-        """
-        Required method to retrieve data from an arbitrary source
-        """
-        raise NotImplementedError
-
-
-class SourceImplementation(Source):
-    def __call__(self, config: Dict[str, Any], scope: str) -> "SourceImplementation":
-        return self
-
-    def get(self) -> List[Dict[str, Any]]:
-        return []

sovereign/sources/poller.py

@@ -1,294 +0,0 @@
-import asyncio
-import traceback
-from copy import deepcopy
-from importlib.metadata import EntryPoint
-from datetime import timedelta, datetime
-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 (
-    ConfiguredSource,
-    SourceData,
-    Node,
-)
-
-
-def is_debug_request(v: str, debug: bool = False) -> bool:
-    return v == "" and debug
-
-
-def is_wildcard(v: List[str]) -> bool:
-    return v in [["*"], "*", ("*",)]
-
-
-def contains(container: Iterable[Any], item: Any) -> bool:
-    return item in container
-
-
-Mods = Dict[str, Type[Modifier]]
-GMods = Dict[str, Type[GlobalModifier]]
-
-
-class SourcePoller:
-    def __init__(
-        self,
-        sources: List[ConfiguredSource],
-        matching_enabled: bool,
-        node_match_key: str,
-        source_match_key: str,
-        source_refresh_rate: int,
-        logger: Any,
-        stats: Any,
-    ):
-        self.matching_enabled = matching_enabled
-        self.node_match_key = node_match_key
-        self.source_match_key = source_match_key
-        self.source_refresh_rate = source_refresh_rate
-        self.logger = logger
-        self.stats = stats
-
-        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.groups["sources"]
-        }
-        self.sources = [self.setup_source(s) for s in sources]
-        if not self.sources:
-            raise RuntimeError("No data sources available!")
-
-        # These have to be loaded later to avoid circular imports
-        self.modifiers: Mods = dict()
-        self.global_modifiers: GMods = dict()
-
-        # initially set data and modify
-        self.source_data = self.refresh()
-        self.last_updated = datetime.now()
-        self.instance_count = 0
-
-    @property
-    def data_is_stale(self) -> bool:
-        return self.last_updated < datetime.now() - timedelta(minutes=2)
-
-    def setup_source(self, configured_source: ConfiguredSource) -> Source:
-        source_class = self.source_classes[configured_source.type]
-        source = source_class(
-            config=configured_source.config,
-            scope=configured_source.scope,
-        )
-        source.setup()
-        return source
-
-    def lazy_load_modifiers(self, modifiers: List[str]) -> None:
-        if len(self.modifiers) == len(modifiers):
-            return
-        self.modifiers = self.load_modifier_entrypoints(
-            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.groups["global_modifiers"], global_modifiers
-        )
-
-    def load_modifier_entrypoints(
-        self, entry_points: Iterable[EntryPoint], configured_modifiers: List[str]
-    ) -> Dict[str, Type[Modifier]]:
-        ret = dict()
-        for entry_point in entry_points:
-            if entry_point.name in configured_modifiers:
-                self.logger(event=f"Loading modifier {entry_point.name}")
-                ret[entry_point.name] = entry_point.load()
-        loaded = len(ret)
-        configured = len(configured_modifiers)
-        assert loaded == configured, (
-            f"Number of modifiers loaded ({loaded})"
-            f"differ from configured: {configured_modifiers}"
-        )
-        return ret
-
-    def load_global_modifier_entrypoints(
-        self, entry_points: Iterable[EntryPoint], configured_modifiers: List[str]
-    ) -> Dict[str, Type[GlobalModifier]]:
-        ret = dict()
-        for entry_point in entry_points:
-            if entry_point.name in configured_modifiers:
-                self.logger(event=f"Loading global modifier {entry_point.name}")
-                ret[entry_point.name] = entry_point.load()
-
-        loaded = len(ret)
-        configured = len(configured_modifiers)
-        assert loaded == configured, (
-            f"Number of global modifiers loaded ({loaded})"
-            f"differ from configured: {configured_modifiers}"
-        )
-        return ret
-
-    def apply_modifications(self, data: Optional[SourceData]) -> SourceData:
-        with self.stats.timed("modifiers.apply_ms"):
-            if data is None:
-                data = self.source_data
-
-            source_data = deepcopy(data)
-            for scope, instances in source_data.scopes.items():
-                for g in self.global_modifiers.values():
-                    global_modifier = g(instances)
-                    global_modifier.apply()
-                    source_data.scopes[scope] = global_modifier.join()
-
-                for instance in source_data.scopes[scope]:
-                    for m in self.modifiers.values():
-                        modifier = m(instance)
-                        if modifier.match():
-                            # Modifies the instance in-place
-                            modifier.apply()
-            return source_data
-
-    def refresh(self) -> SourceData:
-        self.stats.increment("sources.attempt")
-        try:
-            new = SourceData()
-            for source in self.sources:
-                new.scopes[source.scope].extend(source.get())
-        except Exception as e:
-            self.logger(
-                event="Error while refreshing sources",
-                traceback=[line for line in traceback.format_exc().split("\n")],
-                error=e.__class__.__name__,
-                detail=getattr(e, "detail", "-"),
-            )
-            self.stats.increment("sources.error")
-            raise
-
-        # Is the new data the same as what we currently have
-        if new == getattr(self, "source_data", None):
-            self.stats.increment("sources.unchanged")
-            self.last_updated = datetime.now()
-            return self.source_data
-        else:
-            self.stats.increment("sources.refreshed")
-            self.last_updated = datetime.now()
-            self.instance_count = len(
-                [instance for scope in new.scopes.values() for instance in scope]
-            )
-            return new
-
-    def extract_node_key(self, node: Union[Node, Dict[Any, Any]]) -> Any:
-        if "." not in self.node_match_key:
-            # key is not nested, don't need glom
-            node_value = getattr(node, self.node_match_key)
-        else:
-            try:
-                node_value = glom(node, self.node_match_key)
-            except PathAccessError:
-                raise RuntimeError(
-                    f'Failed to find key "{self.node_match_key}" in discoveryRequest({node}).\n'
-                    f"See the docs for more info: "
-                    f"https://vsyrakis.bitbucket.io/sovereign/docs/html/guides/node_matching.html"
-                )
-        return node_value
-
-    def extract_source_key(self, source: Dict[Any, Any]) -> Any:
-        if "." not in self.source_match_key:
-            # key is not nested, don't need glom
-            source_value = source[self.source_match_key]
-        else:
-            try:
-                source_value = glom(source, self.source_match_key)
-            except PathAccessError:
-                raise RuntimeError(
-                    f'Failed to find key "{self.source_match_key}" in instance({source}).\n'
-                    f"See the docs for more info: "
-                    f"https://vsyrakis.bitbucket.io/sovereign/docs/html/guides/node_matching.html"
-                )
-        return source_value
-
-    def match_node(
-        self,
-        node_value: Any,
-        modify: bool = True,
-    ) -> SourceData:
-        """
-        Checks a node against all sources, using the node_match_key and source_match_key
-        to determine if the node should receive the source in its configuration.
-        """
-
-        if self.data_is_stale:
-            # Log/emit metric and manually refresh sources.
-            self.stats.increment("sources.stale")
-            self.logger(
-                event="Sources have not been refreshed in 2 minutes",
-                last_update=self.last_updated,
-                instance_count=self.instance_count,
-            )
-            self.poll()
-
-        ret = SourceData()
-
-        if modify:
-            if not hasattr(self, "source_data_modified"):
-                self.poll()
-            data = self.source_data_modified
-        else:
-            data = self.source_data
-
-        for scope, instances in data.scopes.items():
-            if self.matching_enabled is False:
-                ret.scopes[scope] = instances
-                continue
-
-            for instance in instances:
-                source_value = self.extract_source_key(instance)
-
-                # If a single expression evaluates true, the remaining are not evaluated/executed.
-                # This saves (a small amount of) computation, which helps when the server starts
-                # to receive thousands of requests. The list has been ordered descending by what
-                # we think will more commonly be true.
-                match = (
-                    contains(source_value, node_value)
-                    or node_value == source_value
-                    or is_wildcard(node_value)
-                    or is_wildcard(source_value)
-                    or is_debug_request(node_value)
-                )
-                if match:
-                    ret.scopes[scope].append(instance)
-        return ret
-
-    @property
-    def match_keys(self) -> List[str]:
-        """
-        Checks for all match keys present in existing sources and adds them to a list
-
-        A dict is used instead of a set because dicts cannot have duplicate keys, and
-        have ordering since python 3.6
-        """
-        ret: Dict[str, None] = dict()
-        ret["*"] = None
-        for _, instances in self.source_data.scopes.items():
-            if self.matching_enabled is False:
-                break
-            for instance in instances:
-                source_value = glom(instance, self.source_match_key)
-                if isinstance(source_value, str):
-                    ret[source_value] = None
-                elif isinstance(source_value, Iterable):
-                    for item in source_value:
-                        ret[item] = None
-                    continue
-                ret[source_value] = None
-        return list(ret.keys())
-
-    def poll(self) -> None:
-        self.source_data = self.refresh()
-        self.source_data_modified = self.apply_modifications(self.source_data)
-
-    async def poll_forever(self) -> None:
-        while True:
-            self.poll()
-            await asyncio.sleep(self.source_refresh_rate)

sovereign/static/sass/style.scss

@@ -1,27 +0,0 @@
-@charset "utf-8";
-
-// Import a Google Font
-@import url('https://fonts.googleapis.com/css?family=Nunito:400,700');
-
-// Update Bulma's global variables
-$family-sans-serif: "Nunito", sans-serif;
-$primary: #433fca;
-$link: #6c90ec;
-
-// Force the navbar menu to not collapse
-$desktop: 1px;
-$body-background-color: rgb(250, 250, 250);
-
-// Import only what you need from Bulma
-@import "../../../../node_modules/bulma/sass/base/_all.sass";
-@import "../../../../node_modules/bulma/sass/form/_all.sass";
-@import "../../../../node_modules/bulma/sass/utilities/_all.sass";
-@import "../../../../node_modules/bulma/sass/helpers/_all.sass";
-@import "../../../../node_modules/bulma/sass/elements/button.sass";
-@import "../../../../node_modules/bulma/sass/elements/title.sass";
-@import "../../../../node_modules/bulma/sass/elements/content.sass";
-@import "../../../../node_modules/bulma/sass/components/navbar.sass";
-@import "../../../../node_modules/bulma/sass/components/dropdown.sass";
-@import "../../../../node_modules/bulma/sass/components/panel.sass";
-@import "../../../../node_modules/bulma/sass/grid/columns.sass";
-@import "../../../../node_modules/bulma/bulma.sass";