Validate environment variable belongs to Proxima

[github-actions[bot]]

Validate environment variable belongs to Proxima

https://github.com/in03/proxima/blob/cdf0360894cb3b0cc503d20bdcd405215415a943/src/proxima/cli/main.py#L247

    )

@config_app.callback(
    invoke_without_command=True,
    help="Run `config` without args or options to validate and print configuration",
)
def config_callback(ctx: typer.Context):
    if ctx.invoked_subcommand:
        return
    from proxima.settings.manager import settings

    if settings:
        print(settings.dict())

# TODO: Big flaw. Python environment vars are not system env vars.
# We technically want to interface with system environment variables.
# Settings vars here only affects child processes, not current or parent
# How naughty is it to actually change system environment variables?
# Frowned upon? Maybe should re-evalate if we should provide
# the facility for CRUD or just Read.

@config_app.command("env")
def manage_env(
    view: bool = typer.Option(
        False, "--view", help="Print the current toml configuration to stdout"
    ),
    set: Optional[str] = typer.Argument(
        None, show_default=False, help="Set an environment variable."
    ),
    reset: bool = typer.Option(
        False,
        "--reset",
        help="Reset .env configuration to app defaults.",
        show_default=False,
    ),
    force: bool = typer.Option(
        False, "--force", help="Bypass any confirmation prompts.", show_default=False
    ),
):
    """
    Manage .env configuration

    Environment variables override toml configuration.

    This allows for easy unit testing and quick changes
    in different deployment environments.

    See docs for a list of usable environment variables.
    """

    # Print current user config to stdout
    if view:
        [print(f"{x}={os.environ[x]}") for x in get_proxima_env_vars()]
        return

    # Launch editor
    if set:
        # TODO: Validate environment variable belongs to Proxima
        try:
            key, val = set.split("=")
            key = key.upper()
            key = "PROXIMA__" + key.replace(".", "__")
            key = key.strip()
            val = val.strip()

            os.environ[key] = val
            print(f"Set environment variable: '{key}'")

        except ValueError as e:
            print(e)
        return

    # Reset .env file to empty
    if reset:
        # Prompt for confirmation if not forced
        if not force:
            if not Confirm.ask(
                "[yellow]Woah! The action you're about to perform is un-undoable![/]\n"
                "Are you sure you want to reset the toml configuration file to defaults?"
            ):
                return

        for var in get_proxima_env_vars().keys():
            os.environ[var] = ""
            logger.debug(f"[magenta]Unset environment var {var}")
        return

    # Fallback to default: print current user config to stdout
    [print(f"{x}={os.environ[x]}") for x in get_proxima_env_vars()]

@config_app.command("dotenv")
def manage_dotenv(
    view: bool = typer.Option(
        False, "--view", help="Print the current toml configuration to stdout"
    ),
    edit: bool = typer.Option(
        False, "--edit", help="Edit the .env configuration file.", show_default=False
    ),
    reset: bool = typer.Option(
        False,
        "--reset",
        help="Reset .env configuration to app defaults.",
        show_default=False,
    ),
    force: bool = typer.Option(
        False, "--force", help="Bypass any confirmation prompts.", show_default=False
    ),
):
    """
    Manage .env configuration

    Environment variables override toml configuration.

    This allows for easy unit testing and quick changes
    in different deployment environments.

    See docs for a list of usable environment variables.
    """

    from proxima.settings import dotenv_settings_file

    # Ensure exists
    if not os.path.exists(dotenv_settings_file):
        with open(dotenv_settings_file, "x"):
            print("[cyan]Initialised .env config file")

    # Print current user config to stdout
    if view:
        print(
            Syntax.from_path(
                dotenv_settings_file, theme="nord-darker", line_numbers=True
            )
        )

    # Launch editor
    if edit:
        print("[cyan]Editing .env config file")
        typer.launch(str(dotenv_settings_file))
        return

    # Reset .env file to empty
    if reset:
        # Prompt for confirmation if not forced
        if not force:
            if not Confirm.ask(
                "[yellow]Woah! The action you're about to perform is un-undoable![/]\n"
                "Are you sure you want to reset the toml configuration file to defaults?"
            ):
                return

        with open(dotenv_settings_file, "w"):
            print("[cyan]Reset toml config file to defaults")
        return

    # Fallback to default: print current user config to stdout
    print(
        Syntax.from_path(dotenv_settings_file, theme="nord-darker", line_numbers=True)
    )

@config_app.command("toml")
def manage_toml(
    view: bool = typer.Option(
        False, "--view", help="Print the current toml configuration to stdout"
    ),
    edit: bool = typer.Option(
        False, "--edit", help="Edit the toml configuration file.", show_default=False
    ),
    reset: bool = typer.Option(
        False,
        "--reset",
        help="Reset toml configuration to app defaults.",
        show_default=False,
    ),
    force: bool = typer.Option(
        False, "--force", help="Bypass any confirmation prompts.", show_default=False
    ),
):
    """
    Manage toml configuration

    Toml holds all configuration by default.

    Toml configuration can be changed, reset to defaults,

    as well as overriden by environment variables set in shell or .env.
    """

    from proxima.settings import default_settings_file, user_settings_file

    # Ensure exists
    if not os.path.exists(user_settings_file):
        with open(user_settings_file, "x"):
            print("[cyan]Initialised user toml config file")

    # Print current user config to stdout
    if view:
        print(
            Syntax.from_path(user_settings_file, theme="nord-darker", line_numbers=True)
        )

    # Launch editor
    if edit:
        print("[cyan]Editing user toml config file")
        typer.launch(str(user_settings_file))

    # Reset .toml file to defaults
    if reset:
        # Prompt for confirmation if not forced
        if not force:
            if not Confirm.ask(
                "[yellow]Woah! The action you're about to perform is un-undoable![/]\n"
                "Are you sure you want to reset the toml configuration file to defaults?"
            ):
                shutil.move(default_settings_file, user_settings_file)
                print("[cyan]Reset toml config to defaults")
                return

    # Fallback to default: print current user config to stdout
    print(Syntax.from_path(user_settings_file, theme="nord-darker", line_numbers=True))

@config_app.command("reset")
def reset_all_configuration(
    force: bool = typer.Option(
        False, "--force", help="Bypass any confirmation prompts.", show_default=False
    )
):
    """
    Completely reset user configuration to defaults.

    This will result in '.env' being made empty,
    local environment variables being unset,
    and 'user_settings.toml' being reset to default values.
    USE WITH CAUTION!
    """

    # Prompt for confirmation if not forced
    if not force:
        if not Confirm.ask(
            "[yellow]Woah! The action you're about to perform is un-undoable![/]\n"
            "Are you sure you want to reset all user configuration to defaults?"
        ):
            return

    manage_env(edit=False, reset=True, force=True)
    manage_dotenv(edit=False, reset=True, force=True)
    manage_toml(edit=False, reset=True, force=True)

def main():

b483a046cd6db43be8e25d4887db13c8d79c9e8c

[github-actions[bot]]

Closed in 47ac3cdd580e036e7d3b6d5549040dff6a894af0