Skip to content

Module config.spring

Module for retrieve application's config from Spring Cloud Config.

None

View Source
"""Module for retrieve application's config from Spring Cloud Config."""

import os

from distutils.util import strtobool

from functools import wraps

from typing import Any, Callable, Dict, KeysView, Optional

import attr

from glom import glom

from config import http, logger

from config.auth import OAuth2

from config.core import singleton

from config.exceptions import RequestFailedException

@attr.s(slots=True)

class ConfigClient:

    """Spring Cloud Config Client."""

    address = attr.ib(

        type=str,

        default=os.getenv("CONFIGSERVER_ADDRESS", "http://localhost:8888"),

        validator=attr.validators.instance_of(str),

    )

    branch = attr.ib(

        type=str,

        default=os.getenv("BRANCH", "master"),

        validator=attr.validators.instance_of(str),

    )

    app_name = attr.ib(

        type=str,

        default=os.getenv("APP_NAME", ""),

        validator=attr.validators.instance_of(str),

    )

    profile = attr.ib(

        type=str,

        default=os.getenv("PROFILE", "development"),

        validator=attr.validators.instance_of(str),

    )

    _url = attr.ib(

        type=str,

        default="{address}/{branch}/{app_name}-{profile}.json",

        validator=attr.validators.instance_of(str),

        repr=False,

    )

    fail_fast = attr.ib(

        type=bool,

        default=bool(strtobool(str(os.getenv("CONFIG_FAIL_FAST", True)))),

        validator=attr.validators.instance_of(bool),

        converter=bool,

    )

    oauth2 = attr.ib(

        type=Optional[OAuth2],

        default=None,

        validator=attr.validators.optional(attr.validators.instance_of(OAuth2)),

    )

    _config = attr.ib(

        type=dict,

        factory=dict,

        init=False,

        validator=attr.validators.instance_of(dict),

        repr=False,

    )

    @property

    def url(self) -> str:

        uri = self._url.format(

            address=self.address,

            branch=self.branch,

            app_name=self.app_name,

            profile=self.profile,

        )

        return self._ensure_request_json(uri)

    @url.setter

    def url(self, pattern: str) -> None:

        self._url = pattern

    def _ensure_request_json(self, uri: str) -> str:

        """Ensure that the URI to retrieve the configuration will have the .json extension"""

        if not uri.endswith(".json"):

            dot_position = uri.rfind(".")

            if dot_position > 0:

                uri = uri.replace(uri[dot_position:], ".json")

            else:

                uri = f"{uri}.json"

            logger.warning(

                "URL suffix adjusted to a supported format. "

                "For more details see: "

                "https://config-client.amenezes.net/docs/1.-overview/#default-values"

            )

        logger.debug(f"Target URL configured: {self._url}")

        return uri

    def get_config(self, **kwargs: dict) -> None:

        """Request the configuration from the config server."""

        kwargs = self._configure_oauth2(**kwargs)

        try:

            response = http.get(self.url, **kwargs)

        except Exception as ex:

            logger.error(f"Failed to request: {self.url}")

            logger.error(ex)

            if self.fail_fast:

                logger.info("fail_fast enabled. Terminating process.")

                raise SystemExit(1)

            raise ConnectionError("fail_fast disabled.")

        self._config = response.json()

    def _configure_oauth2(self, **kwargs) -> dict:

        if self.oauth2:

            self.oauth2.configure()

            try:

                kwargs["headers"].update(self.oauth2.authorization_header)

            except KeyError:

                kwargs.update(dict(headers=self.oauth2.authorization_header))

        return kwargs

    def get_file(self, filename: str, **kwargs: dict) -> str:

        """Request a file from the config server."""

        uri = f"{self.address}/{self.app_name}/{self.profile}/{self.branch}/{filename}"

        try:

            response = http.get(uri, **kwargs)

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {uri}")

        return response.text

    def encrypt(

        self,

        value: str,

        path: str = "/encrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a encryption from a value to the config server."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

    def decrypt(

        self,

        value: str,

        path: str = "/decrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a decryption from a value to the config server.."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

    @property

    def config(self) -> Dict:

        """Getter from configurations retrieved from ConfigClient."""

        return self._config

    def get(self, key: str, default: Any = "") -> Any:

        return glom(self._config, key, default=default)

    def keys(self) -> KeysView:

        return self._config.keys()

    def get_attribute(self, value: str) -> Any:

        """

        Get attribute from configuration.

        :value value: -- The filter to query on dict.

        :return: The value matches or ''

        """

        logger.warning("get_attribute it's deprecated, please use get() method.")

        return glom(self._config, value, default="")

    def get_keys(self) -> KeysView:

        """List all keys from configuration retrieved."""

        logger.warning("get_keys it's deprecated, please use keys() method.")

        return self._config.keys()

@singleton

def create_config_client(**kwargs) -> ConfigClient:

    """

    Create ConfigClient singleton instance.

    :param address:

    :param app_name:

    :param branch:

    :param fail_fast:

    :param profile:

    :param url:

    :return: ConfigClient instance.

    """

    obj = ConfigClient(**kwargs)

    obj.get_config()

    return obj

def config_client(**kwargs) -> Callable[[Dict[str, str]], ConfigClient]:

    """ConfigClient decorator.

    Usage:

    @config_client(app_name='test')

    def get_config(config):

        db_user = config.get_attribute('database.user')

    :raises: ConnectionError: If fail_fast enabled.

    :return: ConfigClient instance.

    """

    logger.debug("kwargs: %r", kwargs)

    cls_attributes = attr.fields_dict(ConfigClient).keys()

    instance_params = {}

    get_config_params = {}

    for key, value in kwargs.items():

        if key in cls_attributes:

            instance_params.update({key: value})

        else:

            get_config_params.update({key: value})

    def wrap_function(function):

        logger.debug("caller: %s", function.__name__)

        @wraps(function)

        def enable_config():

            obj = ConfigClient(**instance_params)

            obj.get_config(**get_config_params)

            return function(obj)

        return enable_config

    return wrap_function

Functions

config_client

def config_client(
    **kwargs
) -> Callable[[Dict[str, str]], config.spring.ConfigClient]

ConfigClient decorator.

Usage:

@config_client(app_name='test') def get_config(config): db_user = config.get_attribute('database.user')

Returns:

Type Description
None ConfigClient instance.

Raises:

Type Description
None ConnectionError: If fail_fast enabled.
View Source
def config_client(**kwargs) -> Callable[[Dict[str, str]], ConfigClient]:

    """ConfigClient decorator.

    Usage:

    @config_client(app_name='test')

    def get_config(config):

        db_user = config.get_attribute('database.user')

    :raises: ConnectionError: If fail_fast enabled.

    :return: ConfigClient instance.

    """

    logger.debug("kwargs: %r", kwargs)

    cls_attributes = attr.fields_dict(ConfigClient).keys()

    instance_params = {}

    get_config_params = {}

    for key, value in kwargs.items():

        if key in cls_attributes:

            instance_params.update({key: value})

        else:

            get_config_params.update({key: value})

    def wrap_function(function):

        logger.debug("caller: %s", function.__name__)

        @wraps(function)

        def enable_config():

            obj = ConfigClient(**instance_params)

            obj.get_config(**get_config_params)

            return function(obj)

        return enable_config

    return wrap_function

create_config_client

def create_config_client(
    **kwargs
) -> config.spring.ConfigClient

Create ConfigClient singleton instance.

Parameters:

Name Type Description Default
address None None
app_name None None
branch None None
fail_fast None None
profile None None
url None None

Returns:

Type Description
None ConfigClient instance.
View Source
@singleton

def create_config_client(**kwargs) -> ConfigClient:

    """

    Create ConfigClient singleton instance.

    :param address:

    :param app_name:

    :param branch:

    :param fail_fast:

    :param profile:

    :param url:

    :return: ConfigClient instance.

    """

    obj = ConfigClient(**kwargs)

    obj.get_config()

    return obj

Classes

ConfigClient

class ConfigClient(
    address: str = 'http://localhost:8888',
    branch: str = 'master',
    app_name: str = '',
    profile: str = 'development',
    url: str = '{address}/{branch}/{app_name}-{profile}.json',
    fail_fast=True,
    oauth2: Union[config.auth.OAuth2, NoneType] = None
)
View Source
class ConfigClient:

    """Spring Cloud Config Client."""

    address = attr.ib(

        type=str,

        default=os.getenv("CONFIGSERVER_ADDRESS", "http://localhost:8888"),

        validator=attr.validators.instance_of(str),

    )

    branch = attr.ib(

        type=str,

        default=os.getenv("BRANCH", "master"),

        validator=attr.validators.instance_of(str),

    )

    app_name = attr.ib(

        type=str,

        default=os.getenv("APP_NAME", ""),

        validator=attr.validators.instance_of(str),

    )

    profile = attr.ib(

        type=str,

        default=os.getenv("PROFILE", "development"),

        validator=attr.validators.instance_of(str),

    )

    _url = attr.ib(

        type=str,

        default="{address}/{branch}/{app_name}-{profile}.json",

        validator=attr.validators.instance_of(str),

        repr=False,

    )

    fail_fast = attr.ib(

        type=bool,

        default=bool(strtobool(str(os.getenv("CONFIG_FAIL_FAST", True)))),

        validator=attr.validators.instance_of(bool),

        converter=bool,

    )

    oauth2 = attr.ib(

        type=Optional[OAuth2],

        default=None,

        validator=attr.validators.optional(attr.validators.instance_of(OAuth2)),

    )

    _config = attr.ib(

        type=dict,

        factory=dict,

        init=False,

        validator=attr.validators.instance_of(dict),

        repr=False,

    )

    @property

    def url(self) -> str:

        uri = self._url.format(

            address=self.address,

            branch=self.branch,

            app_name=self.app_name,

            profile=self.profile,

        )

        return self._ensure_request_json(uri)

    @url.setter

    def url(self, pattern: str) -> None:

        self._url = pattern

    def _ensure_request_json(self, uri: str) -> str:

        """Ensure that the URI to retrieve the configuration will have the .json extension"""

        if not uri.endswith(".json"):

            dot_position = uri.rfind(".")

            if dot_position > 0:

                uri = uri.replace(uri[dot_position:], ".json")

            else:

                uri = f"{uri}.json"

            logger.warning(

                "URL suffix adjusted to a supported format. "

                "For more details see: "

                "https://config-client.amenezes.net/docs/1.-overview/#default-values"

            )

        logger.debug(f"Target URL configured: {self._url}")

        return uri

    def get_config(self, **kwargs: dict) -> None:

        """Request the configuration from the config server."""

        kwargs = self._configure_oauth2(**kwargs)

        try:

            response = http.get(self.url, **kwargs)

        except Exception as ex:

            logger.error(f"Failed to request: {self.url}")

            logger.error(ex)

            if self.fail_fast:

                logger.info("fail_fast enabled. Terminating process.")

                raise SystemExit(1)

            raise ConnectionError("fail_fast disabled.")

        self._config = response.json()

    def _configure_oauth2(self, **kwargs) -> dict:

        if self.oauth2:

            self.oauth2.configure()

            try:

                kwargs["headers"].update(self.oauth2.authorization_header)

            except KeyError:

                kwargs.update(dict(headers=self.oauth2.authorization_header))

        return kwargs

    def get_file(self, filename: str, **kwargs: dict) -> str:

        """Request a file from the config server."""

        uri = f"{self.address}/{self.app_name}/{self.profile}/{self.branch}/{filename}"

        try:

            response = http.get(uri, **kwargs)

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {uri}")

        return response.text

    def encrypt(

        self,

        value: str,

        path: str = "/encrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a encryption from a value to the config server."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

    def decrypt(

        self,

        value: str,

        path: str = "/decrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a decryption from a value to the config server.."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

    @property

    def config(self) -> Dict:

        """Getter from configurations retrieved from ConfigClient."""

        return self._config

    def get(self, key: str, default: Any = "") -> Any:

        return glom(self._config, key, default=default)

    def keys(self) -> KeysView:

        return self._config.keys()

    def get_attribute(self, value: str) -> Any:

        """

        Get attribute from configuration.

        :value value: -- The filter to query on dict.

        :return: The value matches or ''

        """

        logger.warning("get_attribute it's deprecated, please use get() method.")

        return glom(self._config, value, default="")

    def get_keys(self) -> KeysView:

        """List all keys from configuration retrieved."""

        logger.warning("get_keys it's deprecated, please use keys() method.")

        return self._config.keys()

Class variables

address
app_name
branch
fail_fast
oauth2
profile

Instance variables

address
app_name
branch
config

Getter from configurations retrieved from ConfigClient.

fail_fast
oauth2
profile
url

Methods

decrypt

def decrypt(
    self,
    value: str,
    path: str = '/decrypt',
    headers: dict = {'Content-Type': 'text/plain'},
    **kwargs: dict
) -> str

Request a decryption from a value to the config server..

View Source
    def decrypt(

        self,

        value: str,

        path: str = "/decrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a decryption from a value to the config server.."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

encrypt

def encrypt(
    self,
    value: str,
    path: str = '/encrypt',
    headers: dict = {'Content-Type': 'text/plain'},
    **kwargs: dict
) -> str

Request a encryption from a value to the config server.

View Source
    def encrypt(

        self,

        value: str,

        path: str = "/encrypt",

        headers: dict = {"Content-Type": "text/plain"},

        **kwargs: dict,

    ) -> str:

        """Request a encryption from a value to the config server."""

        try:

            response = http.post(

                uri=f"{self.address}{path}", data=value, headers=headers, **kwargs

            )

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {self.address}{path}")

        return response.text

get

def get(
    self,
    key: str,
    default: Any = ''
) -> Any
View Source
    def get(self, key: str, default: Any = "") -> Any:

        return glom(self._config, key, default=default)

get_attribute

def get_attribute(
    self,
    value: str
) -> Any

Get attribute from configuration.

Returns:

Type Description
None The value matches or ''
View Source
    def get_attribute(self, value: str) -> Any:

        """

        Get attribute from configuration.

        :value value: -- The filter to query on dict.

        :return: The value matches or ''

        """

        logger.warning("get_attribute it's deprecated, please use get() method.")

        return glom(self._config, value, default="")

get_config

def get_config(
    self,
    **kwargs: dict
) -> None

Request the configuration from the config server.

View Source
    def get_config(self, **kwargs: dict) -> None:

        """Request the configuration from the config server."""

        kwargs = self._configure_oauth2(**kwargs)

        try:

            response = http.get(self.url, **kwargs)

        except Exception as ex:

            logger.error(f"Failed to request: {self.url}")

            logger.error(ex)

            if self.fail_fast:

                logger.info("fail_fast enabled. Terminating process.")

                raise SystemExit(1)

            raise ConnectionError("fail_fast disabled.")

        self._config = response.json()

get_file

def get_file(
    self,
    filename: str,
    **kwargs: dict
) -> str

Request a file from the config server.

View Source
    def get_file(self, filename: str, **kwargs: dict) -> str:

        """Request a file from the config server."""

        uri = f"{self.address}/{self.app_name}/{self.profile}/{self.branch}/{filename}"

        try:

            response = http.get(uri, **kwargs)

        except Exception:

            raise RequestFailedException(f"Failed to request URI: {uri}")

        return response.text

get_keys

def get_keys(
    self
) -> KeysView

List all keys from configuration retrieved.

View Source
    def get_keys(self) -> KeysView:

        """List all keys from configuration retrieved."""

        logger.warning("get_keys it's deprecated, please use keys() method.")

        return self._config.keys()

keys

def keys(
    self
) -> KeysView
View Source
    def keys(self) -> KeysView:

        return self._config.keys()