Release v1.2.2

Merge in PLAYG/keep-it-secret from release to development

.gitea/workflows/ci.yaml

@@ -0,0 +1,27 @@
+name: "CI"
+
+on:
+  push:
+    branches:
+      - "release"
+
+jobs:
+  run-checks:
+    name: "Checks"
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.10"
+      - uses: "Gr1N/setup-poetry@v8"
+        with:
+          poetry-version: "1.7.1"
+      - name: "Install deps"
+        run: |
+          set -x
+          poetry install
+      - name: "Run CI task"
+        run: |
+          set -x
+          poetry run inv ci

CHANGELOG.md

@@ -1,5 +1,25 @@
 ## Keep It Secret Changelog
 
+#### v1.2.2 (2024-06-05)
+
+* TeamCity integration for private builds.
+
+#### v1.2.1 (2024-05-29)
+
+* Gitea Actions integration.
+* `README.md` language fixes.
+
+#### v1.2.0 (2024-02-08)
+
+* Hashicorp Vault integration.
+
+#### v1.1.0 (2024-01-18)
+
+* `Secrets.resolve_dependency()` API for resolving field dependencies.
+* AWS Secrets Manager client management moved from `AWSSecretsManagerField` to
+  `AWSSecrets`.
+* Docs tweaked.
+
 #### v1.0.0 (2024-01-04)
 
 * Initial public release.

Dockerfile

@@ -0,0 +1,88 @@
+ARG APP_USER_UID=10001
+ARG APP_USER_GID=10001
+ARG IMAGE_TAG=development.000000
+
+FROM python:3.10.14-slim-bookworm AS base
+
+ARG APP_USER_UID
+ARG APP_USER_GID
+ARG IMAGE_TAG
+
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PIP_NO_CACHE_DIR=off \
+    PIP_DISABLE_PIP_VERSION_CHECK=on \
+    PIP_DEFAULT_TIMEOUT=100 \
+    PIP_INDEX_URL="https://nexus.bthlabs.pl/repository/pypi/simple/" \
+    POETRY_VERSION=1.7.1 \
+    POETRY_HOME="/srv/poetry" \
+    POETRY_NO_INTERACTION=1 \
+    VIRTUAL_ENV="/srv/venv" \
+    KEEP_IT_SECRET_IMAGE_TAG=${IMAGE_TAG}
+
+RUN if [ ! $(getent group ${APP_USER_GID}) ];then groupadd -g ${APP_USER_GID} app; fi && \
+    useradd -m -d /home/app -u ${APP_USER_UID} -g ${APP_USER_GID} app && \
+    apt-get update && \
+    apt-get install -y --no-install-recommends wait-for-it dumb-init curl && \
+    (curl -sSL https://install.python-poetry.org | python -) && \
+    python3.10 -m venv ${VIRTUAL_ENV} && \
+    mkdir /srv/app /srv/bin /srv/lib /srv/log /srv/run && \
+    chown -R ${APP_USER_UID}:${APP_USER_GID} /srv
+
+ENV PATH="${VIRTUAL_ENV}/bin:/srv/bin:/srv/poetry/bin:${PATH}"
+
+USER app
+WORKDIR /srv/app
+
+FROM base AS development
+
+ARG APP_USER_UID
+ARG APP_USER_GID
+ARG IMAGE_TAG
+
+USER app
+WORKDIR /srv/app
+
+FROM development AS deployment-build
+
+ARG APP_USER_UID
+ARG APP_USER_GID
+ARG IMAGE_TAG
+
+ADD --chown=$APP_USER_UID:$APP_USER_GID . /srv/app
+RUN poetry install --no-dev
+
+FROM deployment-build AS ci
+
+ARG APP_USER_UID
+ARG APP_USER_GID
+ARG IMAGE_TAG
+
+RUN poetry install
+
+FROM base AS deployment
+
+ARG APP_USER_UID
+ARG APP_USER_GID
+ARG IMAGE_TAG
+
+COPY --from=deployment-build /srv/app /srv/app
+COPY --from=deployment-build /srv/venv /srv/venv
+RUN chown -R $APP_USER_UID:$APP_USER_GID /srv
+
+USER root
+
+RUN apt-get clean autoclean && \
+    apt-get autoremove --yes && \
+    rm -rf /var/lib/apt /var/lib/dpkg && \
+    rm -rf /home/app/.cache
+
+USER app
+
+ENV PYTHONPATH="/srv/app"
+ENV DJANGO_SETTINGS_MODULE="settings"
+
+EXPOSE 8000
+
+ENTRYPOINT ["/usr/bin/dumb-init"]
+CMD ["echo NOOP"]

README.md

@@ -65,7 +65,7 @@ to provide secrets suitable for the development environment:
 ```
 
 The `ProductionSecrets` class uses environment variables and AWS Secrets
-Manager to provide secrets suitable for the development environment:
+Manager to provide secrets suitable for the production environment:
 
 ```
 >>> production_secrets = ProductionSecrets()

docs/source/conf.py

@@ -11,10 +11,10 @@
 project = 'Keep It Secret'
 copyright = '2023-present Tomek Wójcik'
 author = 'Tomek Wójcik'
-version = '1.0.0'
+version = '1.2.2'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
+release = '1.2.2'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -30,5 +30,8 @@ exclude_patterns = []
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 html_static_path = ['_static']
+
+# -- Options for autodoc -----------------------------------------------------
+autodoc_member_order = 'bysource'

docs/source/ext.rst

@@ -25,6 +25,26 @@ to be installed:
 .. autoclass:: keep_it_secret.ext.aws.AWSSecretsManagerField
     :members:
 
+Hashicorp Vault Wrapper
+-----------------------
+
+**Installation**
+
+Since Vault extension has external dependencies it needs to be explicitly named
+to be installed:
+
+.. code-block:: shell
+
+    $ pip install keep_it_secret[vault]
+
+**API**
+
+.. autoclass:: keep_it_secret.ext.vault.VaultSecrets
+    :members:
+
+.. autoclass:: keep_it_secret.ext.vault.VaultKV2Field
+    :members:
+
 Basic secrets loader
 --------------------
 

keep_it_secret/__init__.py

@@ -6,7 +6,7 @@ from .fields import (  # noqa: F401
 )
 from .secrets import Secrets  # noqa: F401
 
-__version__ = '1.0.0'
+__version__ = '1.2.2'
 
 __all__ = [
     'AbstractField',

keep_it_secret/ext/aws.py

@@ -57,6 +57,11 @@ class AWSSecrets(Secrets):
     :type: ``str | None``
     """
 
+    def __init__(self, parent: Secrets | None = None):
+        super().__init__(parent=parent)
+
+        self.client: PAWSSecretsManagerClient | None = None
+
     def as_boto3_client_kwargs(self) -> dict[str, typing.Any]:
         """
         Return representation of the mapped variables for use in
@@ -78,6 +83,15 @@ class AWSSecrets(Secrets):
 
         return result
 
+    def get_client(self) -> PAWSSecretsManagerClient:
+        if self.client is None:
+            self.client = boto3.client(
+                'secretsmanager',
+                **self.as_boto3_client_kwargs(),
+            )
+
+        return self.client
+
 
 class AWSSecretsManagerField(Field):
     """
@@ -87,7 +101,7 @@ class AWSSecretsManagerField(Field):
     :param secret_id: ID of the secret to fetch.
     :param default: Default value. Defaults to ``None``.
     :param decoder: A callable to decode the fetched value. Defaults to
-        ``json.loads``.
+        :py:func:`json.loads`.
     """
     def __init__(self,
                  secret_id: str,
@@ -100,8 +114,6 @@ class AWSSecretsManagerField(Field):
         self.default = default
         self.decoder = decoder
 
-        self.client: PAWSSecretsManagerClient | None = None
-
     @classmethod
     def new(cls: type[AWSSecretsManagerField],  # type: ignore[override]
             secret_id: str,
@@ -110,33 +122,25 @@ class AWSSecretsManagerField(Field):
             **field_options) -> AWSSecretsManagerField:
         return cls(secret_id, default=default, decoder=decoder, **field_options)
 
-    def get_client(self, secrets: Secrets) -> PAWSSecretsManagerClient:
-        if self.client is None:
-            aws_secrets = typing.cast(AWSSecrets, secrets.aws)  # type: ignore[attr-defined]
-
-            self.client = boto3.client(
-                'secretsmanager',
-                **aws_secrets.as_boto3_client_kwargs(),
-            )
-
-        return self.client
-
     def get_value(self, secrets: Secrets) -> typing.Any:
         """
         Retrieve, decode and return the secret specified by *secret_id*.
 
-        Depends on :py:class:`AWSSecrets` to be declared in ``secrets.aws``
+        Depends on :py:class:`AWSSecrets` to be declared in ``aws`` field on
-        field.
+        ``secrets`` or one of its parents.
 
         :raises DependencyMissing: Signal that ``secrets.aws`` field is
             missing.
         :raises RequiredValueMissing: Signal the field's value is required but
             *secret_id* is not present in the Secrets Manager.
         """
-        if hasattr(secrets, 'aws') is False:
+        aws_secrets: AWSSecrets = secrets.resolve_dependency(
+            'aws', include_parents=True,
+        )
+        if aws_secrets is secrets.UNRESOLVED_DEPENDENCY:
             raise self.DependencyMissing('aws')
 
-        client = self.get_client(secrets)
+        client = aws_secrets.get_client()
 
         try:
             secret = client.get_secret_value(SecretId=self.secret_id)

keep_it_secret/ext/vault.py

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+import typing
+
+import hvac
+
+from keep_it_secret.fields import EnvField, Field
+from keep_it_secret.secrets import Secrets
+
+
+class VaultSecrets(Secrets):
+    """
+    Concrete :py:class:`keep_it_secret.Secrets` subclass that maps environment
+    variables to Vault credentials.
+    """
+
+    url: str = EnvField.new('VAULT_URL', required=True)
+    """
+    Maps ``VAULT_URL`` environment variable.
+
+    :type: ``str``
+    """
+
+    token: str = EnvField.new('VAULT_TOKEN', required=True)
+    """
+    Maps ``VAULT_TOKEN`` environment variable.
+
+    :type: ``str``
+    """
+
+    client_cert_path: str | None = EnvField.new('VAULT_CLIENT_CERT_PATH', required=False)
+    """
+    Maps ``VAULT_CLIENT_CERT_PATH`` environment variable.
+
+    :type: ``str | None``
+    """
+
+    client_key_path: str | None = EnvField.new('VAULT_CLIENT_KEY_PATH', required=False)
+    """
+    Maps ``VAULT_CLIENT_KEY_PATH`` environment variable.
+
+    :type: ``str | None``
+    """
+
+    server_cert_path: str | None = EnvField.new('VAULT_SERVER_CERT_PATH', required=False)
+    """
+    Maps ``VAULT_SERVER_CERT_PATH`` environment variable.
+
+    :type: ``str | None``
+    """
+
+    def __init__(self, parent: Secrets | None = None):
+        super().__init__(parent)
+
+        self.client: hvac.Client | None = None
+
+    def as_hvac_client_kwargs(self) -> dict[str, typing.Any]:
+        """
+        Return representation of the mapped variables for use in
+        ``hvac.Client`` constructor.
+        """
+        result: dict[str, typing.Any] = {
+            'url': self.url,
+            'token': self.token,
+        }
+
+        if self.client_cert_path is not None and self.client_key_path is not None:
+            result['cert'] = (self.client_cert_path, self.client_key_path)
+
+        if self.server_cert_path is not None:
+            result['verify'] = self.server_cert_path
+
+        return result
+
+    def get_client(self) -> hvac.Client:
+        """
+        Return the ``hvac.Client`` instance configured using the credentials.
+        """
+        if self.client is None:
+            self.client = hvac.Client(
+                **self.as_hvac_client_kwargs(),
+            )
+
+        return self.client
+
+
+class VaultKV2Field(Field):
+    """
+    Concrete :py:class:`keep_it_secret.Field` subclass that uses Hashicorp
+    Vault KV V2 secrets engine to resolve the value.
+
+    If ``as_type`` isn't provided, the fetched value will be returned as-is (
+    i.e. as a dict). Otherwise, ``as_type`` should be a type which accepts
+    kwargs representing the value's keys in its constructor.
+
+    :param mount_point: Mount path for the secret engine.
+    :param path: Path to the secret to fetch.
+    :param version: Version identifier. Defaults to ``None`` (aka the newest
+        version).
+    :param default: Default value. Defaults to ``None``.
+    """
+
+    def __init__(self,
+                 mount_point: str,
+                 path: str,
+                 version: str | None = None,
+                 default: typing.Any = None,
+                 **field_options):
+        super().__init__(**field_options)
+
+        as_type: type | None = field_options.pop('as_type', None)
+        self.as_type = self.cast if as_type is not None else None  # type: ignore[assignment]
+
+        self.mount_point = mount_point
+        self.path = path
+        self.version = version
+        self.default = default
+        self.cast_to = as_type
+
+    @classmethod
+    def new(cls: type[VaultKV2Field],  # type: ignore[override]
+            mount_point: str,
+            path: str,
+            version: str | None = None,
+            default: typing.Any = None,
+            **field_options):
+        return cls(mount_point, path, version=version, default=default, **field_options)
+
+    def cast(self, data: typing.Any) -> typing.Any:
+        """
+        Cast ``data`` to the type specified in ``as_type`` argument of the
+        constructor.
+        """
+        if isinstance(data, dict) is False:
+            return data
+
+        if self.cast_to is None:
+            return data
+
+        return self.cast_to(**data)
+
+    def get_value(self, secrets: Secrets) -> typing.Any:
+        """
+        Retrieve, decode and return the secret stored in a KV V2 secrets engine
+        mounted at *mount_path* under the path *path*.
+
+        Depends on :py:class:`VaultSecrets` to be declared in ``vault`` field
+        on ``secrets`` or one of its parents.
+
+        :raises DependencyMissing: Signal that ``secrets.aws`` field is
+            missing.
+        :raises RequiredValueMissing: Signal the field's value is required but
+            *secret_id* is not present in the secrets engine.
+        """
+        vault_secrets: VaultSecrets = secrets.resolve_dependency(
+            'vault', include_parents=True,
+        )
+        if vault_secrets is secrets.UNRESOLVED_DEPENDENCY:
+            raise self.DependencyMissing('vault')
+
+        client = vault_secrets.get_client()
+
+        try:
+            secret_response = client.secrets.kv.v2.read_secret_version(
+                self.path,
+                version=self.version,
+                mount_point=self.mount_point,
+                raise_on_deleted_version=True,
+            )
+
+            return secret_response['data']['data']
+        except hvac.exceptions.InvalidPath as exception:
+            if self.required is True:
+                raise self.RequiredValueMissing(f'{self.mount_point}{self.path}') from exception
+            else:
+                return self.default

keep_it_secret/secrets.py

@@ -95,6 +95,10 @@ class Secrets(metaclass=SecretsBase):
 
     :param parent: The parent :py:class:`Secrets` subclass or ``None``.
     """
+
+    #: Sentinel for unresolved dependency.
+    UNRESOLVED_DEPENDENCY: list[typing.Any] = []
+
     __secrets_fields__: TFields
 
     def __init__(self, parent: Secrets | None = None):
@@ -104,3 +108,24 @@ class Secrets(metaclass=SecretsBase):
 
         for field_name, field in self.__secrets_fields__.items():
             self.__secrets_data__[field_name] = getattr(self, field_name)
+
+    def resolve_dependency(self,
+                           name: str,
+                           *,
+                           include_parents: bool = True) -> typing.Any:
+        """
+        Resolve a dependency field identified by *name* and return its value.
+        returns :py:attr:`keep_it_secret.Secrets.UNRESOLVED_DEPENDENCY` if
+        the value can't be resolved.
+
+        :param include_parents: Recursively include parents, if any.
+        """
+        if name in self.__secrets_fields__:
+            return getattr(self, name)
+
+        if include_parents is True and self.__secrets_parent__ is not None:
+            return self.__secrets_parent__.resolve_dependency(
+                name, include_parents=include_parents,
+            )
+
+        return self.UNRESOLVED_DEPENDENCY

poetry.lock

@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand.
 
 [[package]]
 name = "alabaster"
@@ -43,6 +43,27 @@ files = [
 [package.extras]
 dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"]
 
+[[package]]
+name = "beautifulsoup4"
+version = "4.12.3"
+description = "Screen-scraping library"
+optional = false
+python-versions = ">=3.6.0"
+files = [
+    {file = "beautifulsoup4-4.12.3-py3-none-any.whl", hash = "sha256:b80878c9f40111313e55da8ba20bdba06d8fa3969fc68304167741bbf9e082ed"},
+    {file = "beautifulsoup4-4.12.3.tar.gz", hash = "sha256:74e3d1928edc070d21748185c46e3fb33490f22f52a3addee9aee0f4f7781051"},
+]
+
+[package.dependencies]
+soupsieve = ">1.2"
+
+[package.extras]
+cchardet = ["cchardet"]
+chardet = ["chardet"]
+charset-normalizer = ["charset-normalizer"]
+html5lib = ["html5lib"]
+lxml = ["lxml"]
+
 [[package]]
 name = "boto3"
 version = "1.34.8"
@@ -391,6 +412,40 @@ files = [
 [package.dependencies]
 flake8 = ">=2"
 
+[[package]]
+name = "furo"
+version = "2023.9.10"
+description = "A clean customisable Sphinx documentation theme."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "furo-2023.9.10-py3-none-any.whl", hash = "sha256:513092538537dc5c596691da06e3c370714ec99bc438680edc1debffb73e5bfc"},
+    {file = "furo-2023.9.10.tar.gz", hash = "sha256:5707530a476d2a63b8cad83b4f961f3739a69f4b058bcf38a03a39fa537195b2"},
+]
+
+[package.dependencies]
+beautifulsoup4 = "*"
+pygments = ">=2.7"
+sphinx = ">=6.0,<8.0"
+sphinx-basic-ng = "*"
+
+[[package]]
+name = "hvac"
+version = "2.1.0"
+description = "HashiCorp Vault API client"
+optional = false
+python-versions = ">=3.8,<4.0"
+files = [
+    {file = "hvac-2.1.0-py3-none-any.whl", hash = "sha256:73bc91e58c3fc7c6b8107cdaca9cb71fa0a893dfd80ffbc1c14e20f24c0c29d7"},
+    {file = "hvac-2.1.0.tar.gz", hash = "sha256:b48bcda11a4ab0a7b6c47232c7ba7c87fda318ae2d4a7662800c465a78742894"},
+]
+
+[package.dependencies]
+requests = ">=2.27.1,<3.0.0"
+
+[package.extras]
+parser = ["pyhcl (>=0.4.4,<0.5.0)"]
+
 [[package]]
 name = "idna"
 version = "3.6"
@@ -1337,6 +1392,17 @@ files = [
     {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"},
 ]
 
+[[package]]
+name = "soupsieve"
+version = "2.5"
+description = "A modern CSS selector implementation for Beautiful Soup."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "soupsieve-2.5-py3-none-any.whl", hash = "sha256:eaa337ff55a1579b6549dc679565eac1e3d000563bcb1c8ab0d0fefbc0c2cdc7"},
+    {file = "soupsieve-2.5.tar.gz", hash = "sha256:5663d5a7b3bfaeee0bc4372e7fc48f9cff4940b3eec54a6451cc5299f1097690"},
+]
+
 [[package]]
 name = "sphinx"
 version = "7.2.6"
@@ -1372,23 +1438,21 @@ lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-simplify", "isort", "mypy
 test = ["cython (>=3.0)", "filelock", "html5lib", "pytest (>=4.6)", "setuptools (>=67.0)"]
 
 [[package]]
-name = "sphinx-rtd-theme"
+name = "sphinx-basic-ng"
-version = "2.0.0"
+version = "1.0.0b2"
-description = "Read the Docs theme for Sphinx"
+description = "A modern skeleton for Sphinx themes."
 optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.7"
 files = [
-    {file = "sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586"},
+    {file = "sphinx_basic_ng-1.0.0b2-py3-none-any.whl", hash = "sha256:eb09aedbabfb650607e9b4b68c9d240b90b1e1be221d6ad71d61c52e29f7932b"},
-    {file = "sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b"},
+    {file = "sphinx_basic_ng-1.0.0b2.tar.gz", hash = "sha256:9ec55a47c90c8c002b5960c57492ec3021f5193cb26cebc2dc4ea226848651c9"},
 ]
 
 [package.dependencies]
-docutils = "<0.21"
+sphinx = ">=4.0"
-sphinx = ">=5,<8"
-sphinxcontrib-jquery = ">=4,<5"
 
 [package.extras]
-dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"]
+docs = ["furo", "ipython", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs"]
 
 [[package]]
 name = "sphinxcontrib-applehelp"
@@ -1444,20 +1508,6 @@ Sphinx = ">=5"
 lint = ["docutils-stubs", "flake8", "mypy"]
 test = ["html5lib", "pytest"]
 
-[[package]]
-name = "sphinxcontrib-jquery"
-version = "4.1"
-description = "Extension to include jQuery on newer Sphinx releases"
-optional = false
-python-versions = ">=2.7"
-files = [
-    {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"},
-    {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"},
-]
-
-[package.dependencies]
-Sphinx = ">=1.8"
-
 [[package]]
 name = "sphinxcontrib-jsmath"
 version = "1.0.1"
@@ -1659,8 +1709,9 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p
 
 [extras]
 aws = ["boto3"]
+vault = ["hvac"]
 
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.10"
-content-hash = "10bea99532b925eac76461f71e685103a771c5549deeaff65f9a96df9e585341"
+content-hash = "e4959d95b206c17013e548f015fbf288d9bc754584bfc128458cadead137a863"

pyproject.toml

@@ -1,19 +1,26 @@
 [tool.poetry]
 name = "keep-it-secret"
-version = "1.0.0"
+version = "1.2.2"
 description = "Keep It Secret by BTHLabs"
 authors = ["Tomek Wójcik <contact@bthlabs.pl>"]
+maintainers = ["BTHLabs <contact@bthlabs.pl>"]
 license = "MIT"
 readme = "README.md"
+homepage = "https://projects.bthlabs.pl/keep-it-secret/"
+repository = "https://git.bthlabs.pl/tomekwojcik/keep-it-secret/"
+documentation = "https://projects.bthlabs.pl/keep-it-secret/"
 
 [tool.poetry.dependencies]
 python = "^3.10"
 boto3 = {version = ">=1.34.0", optional = true}
+hvac = {version = ">=2.1.0", optional = true}
 
 [tool.poetry.group.dev.dependencies]
 boto3 = "1.34.8"
 flake8 = "6.1.0"
 flake8-commas = "2.1.0"
+furo = "2023.9.10"
+hvac = "2.1.0"
 invoke = "1.7.3"
 ipdb = "0.13.13"
 ipython = "8.19.0"
@@ -23,11 +30,11 @@ pytest = "7.4.3"
 pytest-env = "1.1.3"
 pytest-mock = "3.12.0"
 sphinx = "7.2.6"
-sphinx-rtd-theme = "2.0.0"
 twine = "4.0.2"
 
 [tool.poetry.extras]
 aws = ["boto3"]
+vault = ["hvac"]
 
 [build-system]
 requires = ["poetry-core"]

setup.cfg

@@ -6,12 +6,15 @@ hang-closing = False
 
 [tool:pytest]
 addopts = --disable-warnings
+junit_suite_name = keep_it_secret
 env =
     KEEP_IT_SECRET_TESTS_SPAM=spam
     AWS_ACCESS_KEY_ID=thisisntright
     AWS_SECRET_ACCESS_KEY=thisisntright
     AWS_SESSION_TOKEN=thisisntright
     AWS_DEFAULT_REGION=eu-central-1
+    VAULT_URL=http://thisisntright:8200/
+    VAULT_TOKEN=thisisntright
 
 [mypy]
 
@@ -21,5 +24,8 @@ ignore_missing_imports = True
 [mypy-boto3.*]
 ignore_missing_imports = True
 
+[mypy-hvac.*]
+ignore_missing_imports = True
+
 [mypy-moto.*]
 ignore_missing_imports = True

tasks.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 # type: ignore
+import os
+
 from invoke import task
 
 try:
@@ -20,13 +22,25 @@ def mypy(ctx, warn=False):
 
 @task
 def tests(ctx, warn=False):
-    return ctx.run('pytest -v', warn=warn)
+    pytest_command_line = [
+        'pytest',
+        '-v',
+    ]
+
+    if 'KEEP_IT_SECRET_JUNIT_XML_PATH' in os.environ:
+        pytest_command_line.append(
+            f"--junit-xml={os.environ['KEEP_IT_SECRET_JUNIT_XML_PATH']}",
+        )
+
+    return ctx.run(' '.join(pytest_command_line), warn=warn)
 
 
 @task
 def ci(ctx):
     result = True
 
+    ctx.run('mkdir -p build')
+
     if flake8(ctx, warn=True).exited != 0:
         result = False
 

tests/ext/aws/conftest.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# type: ignore
+from __future__ import annotations
+
+import pytest
+
+from .fixtures import TestingAWSSecrets
+
+
+@pytest.fixture
+def testing_aws_secrets() -> TestingAWSSecrets:
+    return TestingAWSSecrets()

tests/ext/aws/fixtures.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+from keep_it_secret.ext.aws import AWSSecrets
+from keep_it_secret.fields import SecretsField
+from keep_it_secret.secrets import Secrets
+
+
+class TestingAWSSecrets(Secrets):
+    aws = SecretsField.new(AWSSecrets)

tests/ext/aws/test_AWSSecrets.py

@@ -5,8 +5,31 @@ from __future__ import annotations
 import os
 from unittest import mock
 
+import pytest
+from pytest_mock import MockerFixture
+
 from keep_it_secret.ext import aws
 
+from .fixtures import TestingAWSSecrets
+
+
+@pytest.fixture
+def mock_boto3_client(mocker: MockerFixture) -> mock.Mock:
+    return mocker.patch.object(aws.boto3, 'client')
+
+
+@pytest.fixture
+def aws_secrets_manager_client() -> mock.Mock:
+    return mock.Mock()
+
+
+def test_init():
+    # When
+    result = aws.AWSSecrets()
+
+    # Then
+    result.client is None
+
 
 @mock.patch.dict(
     os.environ,
@@ -43,3 +66,40 @@ def test_as_boto3_client_kwargs_empty():
 
     # Then
     assert result == {}
+
+
+def test_get_client_cache_miss(mock_boto3_client: mock.Mock,
+                               aws_secrets_manager_client: mock.Mock,
+                               testing_aws_secrets: TestingAWSSecrets):
+    # Given
+    mock_boto3_client.return_value = aws_secrets_manager_client
+
+    field = aws.AWSSecrets()
+
+    # When
+    result = field.get_client()
+
+    # Then
+    assert result == aws_secrets_manager_client
+
+    assert field.client == aws_secrets_manager_client
+
+    mock_boto3_client.assert_called_once_with(
+        'secretsmanager', **testing_aws_secrets.aws.as_boto3_client_kwargs(),
+    )
+
+
+def test_get_client_cache_hit(mock_boto3_client: mock.Mock,
+                              aws_secrets_manager_client: mock.Mock,
+                              testing_aws_secrets: TestingAWSSecrets):
+    # Given
+    field = aws.AWSSecrets()
+    field.client = aws_secrets_manager_client
+
+    # When
+    result = field.get_client()
+
+    # Then
+    assert result == aws_secrets_manager_client
+
+    mock_boto3_client.assert_not_called()

tests/ext/aws/test_AWSSecretsManagerField.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import datetime
 import json
-from unittest import mock
 
 import boto3
 import moto
@@ -15,25 +14,6 @@ from keep_it_secret.ext import aws
 from keep_it_secret.secrets import Secrets
 
 
-class TestingAWSSecrets(Secrets):
-    aws = aws.AWSSecrets()
-
-
-@pytest.fixture
-def aws_secrets_manager_client() -> mock.Mock:
-    return mock.Mock(spec=['get_secret_value'])
-
-
-@pytest.fixture
-def mock_boto3_client(mocker: MockerFixture) -> mock.Mock:
-    return mocker.patch.object(aws.boto3, 'client')
-
-
-@pytest.fixture
-def testing_aws_secrets() -> TestingAWSSecrets:
-    return TestingAWSSecrets()
-
-
 def test_init():
     # When
     result = aws.AWSSecretsManagerField('keep_it_secret/tests/spam')
@@ -42,7 +22,6 @@ def test_init():
     assert result.secret_id == 'keep_it_secret/tests/spam'
     assert result.default is None
     assert result.decoder == json.loads
-    assert result.client is None
 
 
 def test_init_with_default():
@@ -107,53 +86,11 @@ def test_new(mocker: MockerFixture):
     )
 
 
-def test_get_client_cache_miss(mock_boto3_client: mock.Mock,
-                               aws_secrets_manager_client: mock.Mock,
-                               testing_aws_secrets: TestingAWSSecrets):
-    # Given
-    mock_boto3_client.return_value = aws_secrets_manager_client
-
-    field = aws.AWSSecretsManagerField('keep_it_secret/tests/spam')
-
-    # When
-    result = field.get_client(testing_aws_secrets)
-
-    # Then
-    assert result == aws_secrets_manager_client
-
-    assert field.client == aws_secrets_manager_client
-
-    mock_boto3_client.assert_called_once_with(
-        'secretsmanager', **testing_aws_secrets.aws.as_boto3_client_kwargs(),
-    )
-
-
-def test_get_client_cache_hit(mock_boto3_client: mock.Mock,
-                              aws_secrets_manager_client: mock.Mock,
-                              testing_aws_secrets: TestingAWSSecrets):
-    # Given
-    field = aws.AWSSecretsManagerField('keep_it_secret/tests/spam')
-    field.client = aws_secrets_manager_client
-
-    # When
-    result = field.get_client(testing_aws_secrets)
-
-    # Then
-    assert result == aws_secrets_manager_client
-
-    mock_boto3_client.assert_not_called()
-
-
 def test_get_value_aws_dependency_missing(mocker: MockerFixture,
-                                          aws_secrets_manager_client: mock.Mock,
                                           testing_secrets: Secrets):
     # Given
     field = aws.AWSSecretsManagerField('keep_it_secret/tests/spam')
 
-    mock_field_get_client = mocker.patch.object(
-        field, 'get_client', return_value=aws_secrets_manager_client,
-    )
-
     with pytest.raises(field.DependencyMissing) as exception_info:
         # When
         _ = field(testing_secrets)
@@ -161,10 +98,6 @@ def test_get_value_aws_dependency_missing(mocker: MockerFixture,
     # Then
     assert exception_info.value.args[0] == 'aws'
 
-    mock_field_get_client.assert_not_called()
-
-    aws_secrets_manager_client.get_secret_value.assert_not_called()
-
 
 @moto.mock_secretsmanager
 def test_get_value_required_value_not_found(testing_aws_secrets: Secrets):

tests/ext/vault/conftest.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# type: ignore
+from __future__ import annotations
+
+import pytest
+
+from .fixtures import TestingVaultSecrets
+
+
+@pytest.fixture
+def testing_vault_secrets() -> TestingVaultSecrets:
+    return TestingVaultSecrets()

tests/ext/vault/fixtures.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+from keep_it_secret.ext.vault import VaultSecrets
+from keep_it_secret.fields import SecretsField
+from keep_it_secret.secrets import Secrets
+
+
+class TestingVaultSecrets(Secrets):
+    vault = SecretsField.new(VaultSecrets)

tests/ext/vault/test_VaultKV2Field.py

@@ -0,0 +1,212 @@
+# -*- coding: utf-8 -*-
+# type: ignore
+from __future__ import annotations
+
+from unittest import mock
+
+import hvac
+import pytest
+from pytest_mock import MockerFixture
+
+from keep_it_secret import Secrets
+from keep_it_secret.ext import vault
+
+
+@pytest.fixture
+def field() -> vault.VaultKV2Field:
+    return vault.VaultKV2Field('keep_it_secret/', 'tests/spam')
+
+
+@pytest.fixture
+def as_type() -> mock.Mock:
+    return mock.Mock()
+
+
+@pytest.fixture
+def field_with_as_type(as_type: mock.Mock) -> vault.VaultKV2Field:
+    return vault.VaultKV2Field('keep_it_secret/', 'tests/spam', as_type=as_type)
+
+
+@pytest.fixture
+def hvac_kv_v2_client(mocker: MockerFixture) -> mock.Mock:
+    result = mock.Mock()
+    result.secrets.kv.v2 = mock.Mock(spec=['read_secret_version'])
+
+    return result
+
+
+def test_init():
+    # When
+    result = vault.VaultKV2Field('keep_it_secret/', 'tests/spam')
+
+    # Then
+    assert result.mount_point == 'keep_it_secret/'
+    assert result.path == 'tests/spam'
+    assert result.version is None
+    assert result.default is None
+    assert result.cast_to is None
+    assert result.as_type is None
+
+
+def test_init_with_version():
+    # When
+    result = vault.VaultKV2Field(
+        'keep_it_secret/', 'tests/spam', version='1',
+    )
+
+    # Then
+    assert result.version == '1'
+
+
+def test_init_with_default():
+    # When
+    result = vault.VaultKV2Field(
+        'keep_it_secret/', 'tests/spam', default='eggs',
+    )
+
+    # Then
+    assert result.default == 'eggs'
+
+
+def test_init_with_as_type():
+    # When
+    result = vault.VaultKV2Field(
+        'keep_it_secret/', 'tests/spam', as_type=dict,
+    )
+
+    # Then
+    assert result.as_type == result.cast
+    assert result.cast_to == dict
+
+
+def test_init_with_field_options():
+    # When
+    result = vault.VaultKV2Field(
+        'keep_it_secret/', 'tests/spam', required=False, description='eggs',
+    )
+
+    # Then
+    assert result.required is False
+    assert result.description == 'eggs'
+
+
+def test_new(mocker: MockerFixture):
+    # Given
+    mock_init = mocker.patch.object(
+        vault.VaultKV2Field, '__init__', return_value=None,
+    )
+
+    # When
+    _ = vault.VaultKV2Field.new(
+        'keep_it_secret/',
+        'tests/spam',
+        version='1',
+        default=dict,
+        as_type=dict,
+        required=False,
+        description='eggs',
+    )
+
+    # Then
+    mock_init.assert_called_once_with(
+        'keep_it_secret/',
+        'tests/spam',
+        version='1',
+        default=dict,
+        as_type=dict,
+        required=False,
+        description='eggs',
+    )
+
+
+def test_cast_not_dict(field: vault.VaultKV2Field):
+    # When
+    result = field.cast('spam')
+
+    # Then
+    assert result == 'spam'
+
+
+def test_cast(field_with_as_type: vault.VaultKV2Field, as_type: mock.Mock):
+    # Given
+    as_type.return_value = 'spam'
+
+    # When
+    result = field_with_as_type.cast({
+        'spam': True,
+        'eggs': False,
+    })
+
+    # Then
+    assert result == 'spam'
+
+    as_type.assert_called_once_with(
+        spam=True,
+        eggs=False,
+    )
+
+
+def test_get_value_vault_dependency_missing(field: vault.VaultKV2Field,
+                                            testing_secrets: Secrets):
+    # Given
+    with pytest.raises(field.DependencyMissing) as exception_info:
+        # When
+        _ = field(testing_secrets)
+
+    # Then
+    assert exception_info.value.args[0] == 'vault'
+
+
+def test_get_value_required_value_not_found(testing_vault_secrets: Secrets,
+                                            hvac_kv_v2_client: mock.Mock,
+                                            field: vault.VaultKV2Field):
+    # Given
+    testing_vault_secrets.vault.client = hvac_kv_v2_client
+
+    hvac_kv_v2_client.secrets.kv.v2.read_secret_version.side_effect = hvac.exceptions.InvalidPath()
+
+    with pytest.raises(field.RequiredValueMissing) as exception_info:
+        # When
+        _ = field(testing_vault_secrets)
+
+    # Then
+    assert exception_info.value.args[0] == 'keep_it_secret/tests/spam'
+
+
+def test_get_value_not_found_not_required(testing_vault_secrets: Secrets,
+                                          hvac_kv_v2_client: mock.Mock,
+                                          field: vault.VaultKV2Field):
+    # Given
+    testing_vault_secrets.vault.client = hvac_kv_v2_client
+
+    hvac_kv_v2_client.secrets.kv.v2.read_secret_version.side_effect = hvac.exceptions.InvalidPath()
+
+    field = vault.VaultKV2Field(
+        'keep_it_secret/', 'tests/spam', required=False,
+    )
+
+    result = field(testing_vault_secrets)
+
+    # Then
+    assert result is None
+
+
+def test_get_value(testing_vault_secrets: Secrets,
+                   hvac_kv_v2_client: mock.Mock,
+                   field: vault.VaultKV2Field):
+    # Given
+    testing_vault_secrets.vault.client = hvac_kv_v2_client
+
+    hvac_kv_v2_client.secrets.kv.v2.read_secret_version.return_value = {
+        'data': {
+            'data': {
+                'spam': True,
+            },
+        },
+    }
+
+    # When
+    result = field(testing_vault_secrets)
+
+    # Then
+    assert result == {'spam': True}

tests/ext/vault/test_VaultSecrets.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+# type: ignore
+from __future__ import annotations
+
+import os
+from unittest import mock
+
+import pytest
+from pytest_mock import MockerFixture
+
+from keep_it_secret.ext import vault
+
+
+@pytest.fixture
+def mock_hvac_client(mocker: MockerFixture) -> mock.Mock:
+    return mocker.patch.object(vault.hvac, 'Client')
+
+
+@pytest.fixture
+def hvac_client() -> mock.Mock:
+    return mock.Mock()
+
+
+def test_init():
+    # When
+    result = vault.VaultSecrets()
+
+    # Then
+    assert result.client is None
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        'VAULT_URL': 'https://vault.work/',
+        'VAULT_TOKEN': 'test_vault_token',
+        'VAULT_CLIENT_CERT_PATH': '/tmp/vault_client_cert.pem',
+        'VAULT_CLIENT_KEY_PATH': '/tmp/vault_client_key.pem',
+        'VAULT_SERVER_CERT_PATH': '/tmp/vault_server_cert.pem',
+    },
+)
+def test_as_hvac_client_kwargs():
+    # Given
+    secrets = vault.VaultSecrets()
+
+    # When
+    result = secrets.as_hvac_client_kwargs()
+
+    # Then
+    assert result == {
+        'url': 'https://vault.work/',
+        'token': 'test_vault_token',
+        'cert': ('/tmp/vault_client_cert.pem', '/tmp/vault_client_key.pem'),
+        'verify': '/tmp/vault_server_cert.pem',
+    }
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        'VAULT_URL': 'https://vault.work/',
+        'VAULT_TOKEN': 'test_vault_token',
+    },
+)
+def test_as_hvac_client_kwargs_without_optional_fields():
+    # Given
+    secrets = vault.VaultSecrets()
+
+    # When
+    result = secrets.as_hvac_client_kwargs()
+
+    # Then
+    assert result == {
+        'url': 'https://vault.work/',
+        'token': 'test_vault_token',
+    }
+
+
+def test_get_client_cache_miss(mock_hvac_client: mock.Mock,
+                               hvac_client: mock.Mock):
+    # Given
+    mock_hvac_client.return_value = hvac_client
+
+    secrets = vault.VaultSecrets()
+
+    # When
+    result = secrets.get_client()
+
+    # Then
+    assert result == hvac_client
+
+    assert secrets.client == hvac_client
+
+    mock_hvac_client.assert_called_once_with(**secrets.as_hvac_client_kwargs())
+
+
+def test_get_client_cache_hit(mock_hvac_client: mock.Mock,
+                              hvac_client: mock.Mock):
+    # Given
+    secrets = vault.VaultSecrets()
+    secrets.client = hvac_client
+
+    # When
+    result = secrets.get_client()
+
+    # Then
+    assert result == hvac_client
+
+    mock_hvac_client.assert_not_called()

tests/secrets/test_Secrets.py

@@ -1,14 +1,15 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8 -*-x
 # type: ignore
 from __future__ import annotations
 
 from keep_it_secret import secrets
+from keep_it_secret.fields import LiteralField
 
 from tests.fixtures import TestingSecrets
 
 
-class ParentSecrets(secrets.Secrets):
+class NestedSecrets(secrets.Secrets):
-    pass
+    spameggs: str = LiteralField.new('spameggs')
 
 
 def test_init():
@@ -21,15 +22,12 @@ def test_init():
     assert result.__secrets_data__ == {'spam': 'spam', 'eggs': 'eggs'}
 
 
-def test_init_with_parent():
+def test_init_with_parent(testing_secrets: TestingSecrets):
-    # Given
-    parent_secrets = ParentSecrets()
-
     # When
-    result = TestingSecrets(parent=parent_secrets)
+    result = NestedSecrets(parent=testing_secrets)
 
     # Then
-    assert result.__secrets_parent__ is parent_secrets
+    assert result.__secrets_parent__ is testing_secrets
 
 
 def test_field_property(testing_secrets: TestingSecrets):
@@ -38,3 +36,58 @@ def test_field_property(testing_secrets: TestingSecrets):
 
     # Then
     assert result == testing_secrets.__secrets_data__['spam']
+
+
+def test_resolve_dependency_from_self():
+    # Given
+    secrets = NestedSecrets()
+
+    # When
+    result = secrets.resolve_dependency('spameggs')
+
+    # Then
+    assert result == secrets.spameggs
+
+
+def test_resolve_dependency_from_parent(testing_secrets: TestingSecrets):
+    # Given
+    secrets = NestedSecrets(parent=testing_secrets)
+
+    # When
+    result = secrets.resolve_dependency('spam')
+
+    # Then
+    assert result == testing_secrets.spam
+
+
+def test_resolve_dependency_unresolved_from_self():
+    # Given
+    secrets = NestedSecrets()
+
+    # When
+    result = secrets.resolve_dependency('thisisntright')
+
+    # Then
+    assert result is secrets.UNRESOLVED_DEPENDENCY
+
+
+def test_resolve_dependency_unresolved_with_parent(testing_secrets: TestingSecrets):
+    # Given
+    secrets = NestedSecrets(parent=testing_secrets)
+
+    # When
+    result = secrets.resolve_dependency('thisisntright')
+
+    # Then
+    assert result is secrets.UNRESOLVED_DEPENDENCY
+
+
+def test_resolve_dependency_unresolved_dont_include_parents(testing_secrets: TestingSecrets):
+    # Given
+    secrets = NestedSecrets(parent=testing_secrets)
+
+    # When
+    result = secrets.resolve_dependency('spam', include_parents=False)
+
+    # Then
+    assert result is secrets.UNRESOLVED_DEPENDENCY