Project Utilities¶

Utility functions for CDK projects.

utils ¶

Classes¶

Functions¶

resolve_repo_root ¶

resolve_repo_root(
    start_path: str | Path | None = None,
) -> str

Find the root of the git repository

Returns:

Type	Description
`str`	Absolute root path

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def resolve_repo_root(start_path: str | pathlib.Path | None = None) -> str:
    """Find the root of the git repository

    Returns:
        Absolute root path
    """
    return str(
        next(
            filter(
                lambda p: (p / ".git").is_dir(),  # type: ignore
                pathlib.Path(start_path or __file__).absolute().parents,
            )
        )
    )

get_package_root ¶

get_package_root() -> str

Find the root package

ASSUMPTION: the infrastructure package name is "aibs-informatics-cdk-lib"

Returns:

Type	Description
`str`	Absolute root path

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def get_package_root() -> str:
    """Find the root package

    ASSUMPTION: the infrastructure package name is "aibs-informatics-cdk-lib"

    Returns:
        Absolute root path
    """
    return str(
        next(
            filter(
                lambda p: (p / "aibs-informatics-cdk-lib").is_dir(),  # type: ignore
                pathlib.Path(__file__).absolute().parents,
            )
        )
    )

get_env_base ¶

get_env_base(node: Node) -> EnvBase

Resolves EnvBase from cdk context or environment

Order of resolution

CDK context value (specifying -c K=V)
1. look for EnvBase
2. look for EnvType/EnvLabel
env variable
1. Look for EnvBase
2. Look for EnvType/EnvLabel

Parameters:

Name	Type	Description	Default
`node`	`Node`	cdk construct node	required

Returns:

Type	Description
`EnvBase`	Environment base

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def get_env_base(node: constructs.Node) -> EnvBase:
    """Resolves EnvBase from cdk context or environment

    Order of resolution:
        1. CDK context value (specifying -c K=V)
            1. look for EnvBase
            2. look for EnvType/EnvLabel
        2. env variable
            1. Look for EnvBase
            2. Look for EnvType/EnvLabel

    Args:
        node (constructs.Node): cdk construct node

    Returns:
        Environment base
    """
    # We need to check from context node FIRST before reading from env variables
    env_base_str = _get_from_context(node, ENV_BASE_KEYS)
    env_type_str = _get_from_context(node, ENV_TYPE_KEYS)
    env_label__from_context = _get_from_context(node, ENV_LABEL_KEYS)
    env_label__from_env = EnvBase.load_env_label__from_env()
    if env_base_str:
        env_base = EnvBase(env_base_str)
        logger.info(f"Loading EnvBase from CDK CONTEXT: env_base={env_base}")
        return env_base

    if env_type_str:
        env_type = EnvType(env_type_str)
        env_label = env_label__from_context or env_label__from_env
        env_base = EnvBase.from_type_and_label(env_type=env_type, env_label=env_label)
        logger.info(f"Loading EnvBase from type/label CDK CONTEXT: env_base={env_base}")
        return env_base

    # Now we try to load env base from environment
    try:
        env_base = EnvBase.from_env()
        logger.info(f"Loading EnvBase from ENV_VARs: env_base={env_base}")
        return env_base
    except Exception:
        env_type = EnvType.DEV

        env_label = env_label__from_context
        if env_label is None:
            if env_label__from_env:
                env_label = env_label__from_env
            else:
                env_label = (get_env_var("USER") or "anonymous").split(".")[0]
        logger.info(
            f"No EnvBase defaults set by CDK CONTEXT or ENV VAR. "
            f"Using env_type={env_type}, env_label={env_label}"
        )
        return EnvBase.from_type_and_label(env_type=env_type, env_label=env_label)

set_env_base ¶

set_env_base(env_base: EnvBase) -> None

Set the environment base

Parameters:

Name	Type	Description	Default
`env_base`	`EnvBase`	environment base	required

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def set_env_base(env_base: EnvBase) -> None:
    """Set the environment base

    Args:
        env_base (EnvBase): environment base
    """
    set_env_var(EnvBase.ENV_BASE_KEY, env_base)
    set_env_var(EnvBase.ENV_TYPE_KEY, env_base.env_type)
    if env_base.env_label:
        set_env_var(EnvBase.ENV_LABEL_KEY, env_base.env_label)
    else:
        os.environ.pop(EnvBase.ENV_LABEL_KEY, None)

get_project_config_and_env_base ¶

get_project_config_and_env_base(
    node: Node, project_config_cls: type[P] | None = None
) -> tuple[P, EnvBase]

Get the project configuration and environment base for a given node.

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def get_project_config_and_env_base(
    node: constructs.Node, project_config_cls: type[P] | None = None
) -> tuple[P, EnvBase]:
    """Get the project configuration and environment base for a given node."""
    if project_config_cls is None:
        project_config_cls = cast(type[P], ProjectConfig)
    env_base = get_env_base(node)

    config = project_config_cls.load_config()
    return config, env_base

get_config ¶

get_config(
    node: Node,
    project_config_cls: type[
        BaseProjectConfig[G, S]
    ] = ProjectConfig,
) -> S

Retrieves the stage configuration for a given node.

Parameters:

Name	Type	Description	Default
`node`	`Node`	The node for which to retrieve the configuration.	required
`project_config_cls`	`Type[BaseProjectConfig[G, S]]`	The project configuration class to use. Defaults to ProjectConfig.	`ProjectConfig`

Returns:

Type	Description
`S`	The stage configuration object.

Source code in src/aibs_informatics_cdk_lib/project/utils.py

def get_config(
    node: constructs.Node,
    project_config_cls: type[BaseProjectConfig[G, S]] = ProjectConfig,  # type: ignore # the type signature is a bit complex and mypy is having trouble with it, but the intention is that the caller can specify a project config class with any generic params and the return type will be the stage config type of that project config class
) -> S:
    """
    Retrieves the stage configuration for a given node.

    Args:
        node (constructs.Node): The node for which to retrieve the configuration.
        project_config_cls (Type[BaseProjectConfig[G, S]], optional):
            The project configuration class to use. Defaults to ProjectConfig.

    Returns:
        The stage configuration object.

    """
    project_config, env_base = get_project_config_and_env_base(  # type: ignore
        node, project_config_cls=project_config_cls
    )
    set_env_base(env_base)

    stage_config: S = project_config.get_stage_config(env_type=env_base.env_type)
    stage_config.env.label = env_base.env_label

    return stage_config