bakefile 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

{bakefile-0.0.6.dist-info → bakefile-0.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bakefile
-Version: 0.0.6
+Version: 0.0.8
 Summary: Add your description here
 Author: Wisaroot Lertthaweedech
 Author-email: Wisaroot Lertthaweedech <l.wisaroot@gmail.com>
@@ -10,6 +10,7 @@ Requires-Dist: loguru>=0.7.3
 Requires-Dist: orjson>=3.11.5
 Requires-Dist: pydantic-settings>=2.0.0
 Requires-Dist: pydantic>=2.12.5
+Requires-Dist: python-dotenv>=1.2.1
 Requires-Dist: pyyaml>=6.0.3
 Requires-Dist: rich>=14.2.0
 Requires-Dist: ruff>=0.14.10

{bakefile-0.0.6.dist-info → bakefile-0.0.8.dist-info}/RECORD

@@ -52,12 +52,17 @@ bake/utils/__init__.py,sha256=GUu_xlJy3RAHo6UcZXu2x4khxGqLHMA9Zos4hDiQIY8,326
 bake/utils/constants.py,sha256=mRq5IpgOTdlHOTWPq5dx0A-LwhiFkWgYHfr8cLWG7rY,471
 bake/utils/env.py,sha256=bzNdH_2bTJebQaw7D0uVJv-vzZ-uYl0pCAS8oQONVsA,190
 bake/utils/exceptions.py,sha256=pwsQnKH5ljMNxmqEREutXa7TohiBHATHg_D5kQUPT30,519
-bakelib/__init__.py,sha256=sZeRiNINWL8xI3b1MxkGyF3f2lKMjyhjKt7qyCCAufs,126
+bakelib/__init__.py,sha256=7lWfLpL82AVkot3BXodJpyuEzEAiythFevMtzxzd_i4,455
+bakelib/environ/__init__.py,sha256=XIFVtu8SQySjPetu9WR_Q8HgqxUzenMNm1K24pYSfNo,356
+bakelib/environ/bakebook.py,sha256=gnOvi3t5Ww0_6N5wozXLVvLe8KAK-u-6_v0UYCl_iKY,749
+bakelib/environ/base.py,sha256=azPUdc9C5zVU8iyXJrEm3uDfe39nG48DRAZiF9rTdHI,3753
+bakelib/environ/get_bakebook.py,sha256=LihxB3VDcVq81KJy1HT-N-beyt2C7ReWm2kMPrd7VlA,1563
+bakelib/environ/presets.py,sha256=IwHGeDeQe4e57k9_u_vBQ61bjMS5Z2Jj9zkXw6YJHAE,1943
 bakelib/space/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bakelib/space/base.py,sha256=bJlpPkP85xBu8X5fJoVaHrMzX27rQrYTEPSObwBANJ8,6008
 bakelib/space/python.py,sha256=UEr4Jo76T2cbAQdClVu7RvJYzflLE9i_xFohcNhjFjw,2597
 bakelib/space/utils.py,sha256=xx4X_txhDH_p97CKJ-KuvFpgfNBC0y_din1IBlUVusU,2983
-bakefile-0.0.6.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-bakefile-0.0.6.dist-info/entry_points.txt,sha256=Ecvvh7BYHCPJ0UdntrDc3Od6AZdRPXN5Z7o_7ok_0Qw,107
-bakefile-0.0.6.dist-info/METADATA,sha256=6tec3_eRxbtTAsdHJHUC1Vo4yIondUR_U28oRq2Cp1c,2331
-bakefile-0.0.6.dist-info/RECORD,,
+bakefile-0.0.8.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+bakefile-0.0.8.dist-info/entry_points.txt,sha256=Ecvvh7BYHCPJ0UdntrDc3Od6AZdRPXN5Z7o_7ok_0Qw,107
+bakefile-0.0.8.dist-info/METADATA,sha256=3v3_P5s-qZZcRrMlgHwYEV8_lSP10mLPBe1unm7hWYg,2367
+bakefile-0.0.8.dist-info/RECORD,,

bakelib/__init__.py

@@ -1,4 +1,23 @@
+from bakelib.environ import (
+    BaseEnv,
+    DevEnvBakebook,
+    EnvBakebook,
+    GcpLandingZoneEnv,
+    ProdEnvBakebook,
+    StagingEnvBakebook,
+    get_bakebook,
+)
 from bakelib.space.base import BaseSpace
 from bakelib.space.python import PythonSpace
 
-__all__ = ["BaseSpace", "PythonSpace"]
+__all__ = [
+    "BaseEnv",
+    "BaseSpace",
+    "DevEnvBakebook",
+    "EnvBakebook",
+    "GcpLandingZoneEnv",
+    "ProdEnvBakebook",
+    "PythonSpace",
+    "StagingEnvBakebook",
+    "get_bakebook",
+]

bakelib/environ/__init__.py

@@ -0,0 +1,14 @@
+from .bakebook import DevEnvBakebook, EnvBakebook, ProdEnvBakebook, StagingEnvBakebook
+from .base import BaseEnv
+from .get_bakebook import get_bakebook
+from .presets import GcpLandingZoneEnv
+
+__all__ = [
+    "BaseEnv",
+    "DevEnvBakebook",
+    "EnvBakebook",
+    "GcpLandingZoneEnv",
+    "ProdEnvBakebook",
+    "StagingEnvBakebook",
+    "get_bakebook",
+]

bakelib/environ/bakebook.py

@@ -0,0 +1,30 @@
+from typing import Annotated
+
+from pydantic import Field, computed_field
+
+from bake.bakebook.bakebook import Bakebook
+from bakelib.environ.base import BaseEnv
+
+BaseEnvFieldType = Annotated[BaseEnv, Field(exclude=True, repr=False)]
+
+
+class EnvBakebook(Bakebook):
+    # Field name uses underscore suffix to avoid Pydantic reading from ENV env var
+    env_: BaseEnvFieldType = Field(exclude=True, repr=False)
+
+    @computed_field
+    @property
+    def env(self) -> BaseEnv:
+        return self.env_
+
+
+class DevEnvBakebook(EnvBakebook):
+    env_: BaseEnvFieldType = BaseEnv("dev")
+
+
+class StagingEnvBakebook(EnvBakebook):
+    env_: BaseEnvFieldType = BaseEnv("staging")
+
+
+class ProdEnvBakebook(EnvBakebook):
+    env_: BaseEnvFieldType = BaseEnv("prod")

bakelib/environ/base.py

@@ -0,0 +1,112 @@
+from typing import Any, ClassVar
+
+from pydantic import GetCoreSchemaHandler
+from pydantic_core import CoreSchema, core_schema
+
+
+class BaseEnv(str):
+    """BaseEnvironment string with comparison and Pydantic support.
+
+    Inherits from str to provide natural string behavior while adding
+    comparison operators for priority-based ordering.
+
+    ENV_ORDER is a list where each element is either:
+    - A string (normal priority, order matters)
+    - A set of strings (equal priority group)
+
+    Example: ["dev", "staging", {"prod", "share"}]
+    - "dev" has highest priority (index 0)
+    - "staging" has medium priority (index 1)
+    - "prod" and "share" have equal lowest priority (both in set at index 2)
+    """
+
+    ENV_ORDER: ClassVar[list[str | set[str]]] = ["dev", "staging", "prod"]
+
+    def __init__(self, value: str):
+        if not self._is_valid(value):
+            raise ValueError(
+                f"Invalid {self.__class__.__name__}: '{value}'. "
+                f"Must be one of: {self._flattened_env_order()}"
+            )
+
+    @classmethod
+    def _is_valid(cls, value: str) -> bool:
+        try:
+            cls._get_priority_index(value)
+            return True
+        except ValueError:
+            return False
+
+    @classmethod
+    def _flattened_env_order(cls) -> list[str]:
+        result: list[str] = []
+        for item in cls.ENV_ORDER:
+            if isinstance(item, set):
+                result.extend(sorted(item))
+            else:
+                result.append(item)
+        return result
+
+    @classmethod
+    def _get_priority_index(cls, value: str) -> int:
+        for idx, item in enumerate(cls.ENV_ORDER):
+            is_in_set = isinstance(item, set) and value in item
+            is_equal = item == value
+            if is_in_set or is_equal:
+                return idx
+        raise ValueError(f"Value '{value}' not found in ENV_ORDER")
+
+    def __lt__(self, other: str) -> bool:
+        if type(other) is not type(self):
+            return NotImplemented
+        self_idx = self._get_priority_index(str(self))
+        other_idx = self._get_priority_index(str(other))
+        if self_idx != other_idx:
+            return self_idx < other_idx
+        # Same priority group, use alphabetical as tiebreaker
+        return str(self) < str(other)
+
+    def __le__(self, other: str) -> bool:
+        if type(other) is not type(self):
+            return NotImplemented
+        return self < other or self == other
+
+    def __gt__(self, other: str) -> bool:
+        if type(other) is not type(self):
+            return NotImplemented
+        return not (self < other) and self != other
+
+    def __ge__(self, other: str) -> bool:
+        if type(other) is not type(self):
+            return NotImplemented
+        return not (self < other)
+
+    def __eq__(self, other: object) -> bool:
+        if type(other) is not type(self):
+            return False
+        return str(self) == str(other)
+
+    def __ne__(self, other: object) -> bool:
+        return not self.__eq__(other)
+
+    def __hash__(self) -> int:
+        return hash(str(self))
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}('{self!s}')"
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls, source_type: Any, handler: GetCoreSchemaHandler
+    ) -> CoreSchema:
+        """Pydantic v2 integration for custom type validation."""
+        return core_schema.no_info_after_validator_function(cls, handler(str))
+
+    @classmethod
+    def validate(cls, v: object) -> "BaseEnv":
+        """Validate and convert input to BaseEnv."""
+        if isinstance(v, cls):
+            return v
+        if isinstance(v, str):
+            return cls(v)
+        raise ValueError(f"Cannot convert {type(v).__name__} to {cls.__name__}")

bakelib/environ/get_bakebook.py

@@ -0,0 +1,49 @@
+import os
+from typing import TypeVar
+
+from dotenv import load_dotenv as _load_dotenv
+
+from .bakebook import EnvBakebook
+
+# TODO: When min Python >= 3.12, use PEP 695 type parameter syntax:
+# def get_bakebook[E: EnvBakebook](bakebooks: list[E], ...) -> E:
+E = TypeVar("E", bound=EnvBakebook)
+
+
+def get_bakebook(
+    bakebooks: list[E],
+    *,
+    env_var_name: str = "ENV",
+    env_value: str | None = None,
+    load_dotenv: bool = True,
+) -> E:
+    if not bakebooks:
+        raise ValueError("bakebooks list cannot be empty")
+
+    # Convert to dict for O(1) lookup and duplicate detection
+    bakebooks_by_env: dict[str, E] = {}
+    for bb in bakebooks:
+        if not hasattr(bb, "env") or bb.env is None:
+            raise ValueError(f"All bakebooks must have an 'env' attribute. Found: {bb}")
+        env = str(bb.env)
+        if env in bakebooks_by_env:
+            raise ValueError(f"Duplicate env '{env}' found in bakebooks list")
+        bakebooks_by_env[env] = bb
+
+    # Get environment value
+    if env_value is None:
+        if load_dotenv:
+            _load_dotenv()
+        env_value = os.getenv(env_var_name)
+
+    # Env var not set - return lowest priority (min)
+    if env_value is None or env_value == "":
+        return bakebooks_by_env[str(min(bb.env for bb in bakebooks))]
+    # If env var is set, require exact match
+    elif env_value in bakebooks_by_env:
+        return bakebooks_by_env[env_value]
+
+    raise ValueError(
+        f"No bakebook found with env='{env_value}'. "
+        f"Available envs: {sorted(bakebooks_by_env.keys())}"
+    )

bakelib/environ/presets.py

@@ -0,0 +1,70 @@
+"""Preset environment configurations.
+
+This module contains pre-configured environment classes for common use cases.
+Users can also create their own environments by inheriting from BaseEnv.
+"""
+
+from typing import ClassVar
+
+from bakelib.environ.base import BaseEnv
+
+
+class GcpLandingZoneEnv(BaseEnv):
+    """GCP Landing Zone base environments.
+
+    Environment codes follow GCP Security Foundations Blueprint conventions:
+    https://docs.cloud.google.com/architecture/blueprints/security-foundations/summary
+
+    Environment Codes:
+    - d               - Development
+    - n               - Nonproduction
+    - p               - Production
+    - s               - Shared
+    - b               - Bootstrap
+    - c               - Common
+    - net             - Network
+
+    Tiers (ordered by priority, lower index = higher priority):
+    - d (development) - lowest priority
+    - n (nonprod)
+    - p/s/b/c/net     - highest priority, all equal (production + shared)
+
+    Example:
+        env = GcpLandingZoneEnv("d")
+        assert env < GcpLandingZoneEnv("n")
+        assert GcpLandingZoneEnv("n") < GcpLandingZoneEnv("p")
+    """
+
+    ENV_ORDER: ClassVar[list[str | set[str]]] = [
+        "d",
+        "n",
+        {"p", "s", "b", "c", "net"},
+    ]
+
+    def is_shared(self) -> bool:
+        return self.code in {"s", "b", "c", "net"}
+
+    @property
+    def name(self) -> str:
+        names = {
+            "d": "Development",
+            "n": "Nonproduction",
+            "p": "Production",
+            "s": "Shared",
+            "b": "Bootstrap",
+            "c": "Common",
+            "net": "Network",
+        }
+        return names[self.code]
+
+    @property
+    def code(self) -> str:
+        return str(self)
+
+    @property
+    def secondary_name(self) -> str:
+        return self.name if not self.is_shared() else "Shared"
+
+    @property
+    def secondary_code(self) -> str:
+        return self.code if not self.is_shared() else "s"