magic-pocket-cli 0.2.0__py3-none-any.whl

pocket_cli/cli/dsql_cli.py

@@ -0,0 +1,60 @@
+import click
+
+from pocket.context import Context
+from pocket.utils import echo
+from pocket_cli.resources.dsql import Dsql
+
+
+def _get_dsql_resource(stage: str) -> Dsql:
+    context = Context.from_toml(stage=stage)
+    if not context.dsql:
+        raise click.ClickException("dsql is not configured for this stage")
+    return Dsql(context.dsql)
+
+
+@click.group()
+def dsql():
+    pass
+
+
+@dsql.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def status(stage):
+    """クラスター状態表示"""
+    r = _get_dsql_resource(stage)
+    echo.info("Tag Name: %s" % r.context.tag_name)
+    echo.info("Status: %s" % r.status)
+    if r.identifier:
+        echo.info("Identifier: %s" % r.identifier)
+
+
+@dsql.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def endpoint(stage):
+    """接続情報表示"""
+    r = _get_dsql_resource(stage)
+    if not r.cluster:
+        echo.warning("Cluster not found")
+        return
+    _print_endpoint(r)
+
+
+@dsql.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def destroy(stage):
+    """確認付き削除"""
+    r = _get_dsql_resource(stage)
+    if r.status == "NOEXIST":
+        echo.info("DSQL cluster does not exist.")
+        return
+    click.confirm(
+        "DSQL クラスター '%s' を削除しますか？" % r.context.tag_name,
+        abort=True,
+    )
+    r.delete()
+
+
+def _print_endpoint(r: Dsql):
+    echo.success("Endpoint: %s" % r.endpoint)
+    echo.success("Region: %s" % r.context.region)
+    echo.success("Port: 5432")

pocket_cli/cli/main_cli.py

@@ -0,0 +1,91 @@
+import click
+
+from pocket import __version__
+from pocket_cli import django_cli
+from pocket_cli.cli import (
+    awscontainer_cli,
+    cloudfront_cli,
+    cloudfront_keys_cli,
+    cloudfront_waf_cli,
+    deploy_cli,
+    destroy_cli,
+    dsql_cli,
+    migrate_cli,
+    neon_cli,
+    permissions_cli,
+    rds_cli,
+    runtime_config_cli,
+    s3_cli,
+    status_cli,
+    tidb_cli,
+    vpc_cli,
+    waf_cli,
+)
+
+
+class PocketCLI(click.Group):
+    def invoke(self, ctx):
+        try:
+            return super().invoke(ctx)
+        except ValueError as e:
+            click.echo(f"エラー: {e}", err=True)
+            ctx.exit(1)
+
+
+@click.group(cls=PocketCLI)
+def main():
+    pass
+
+
+@main.command()
+def version():
+    """Print the version number."""
+    click.echo(__version__)
+
+
+@main.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def context(stage):
+    """Context を JSON で出力する（AWS API 呼び出しを伴う）。"""
+    from pocket.context import Context
+
+    ctx = Context.from_toml(stage=stage)
+    print(ctx.model_dump_json(indent=2))
+
+
+@main.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def settings(stage):
+    """Settings を JSON で出力する（pocket.toml のみ、AWS 不要）。"""
+    from pocket.settings import Settings
+
+    s = Settings.from_toml(stage=stage)
+    print(s.model_dump_json(indent=2))
+
+
+main.add_command(deploy_cli.deploy)
+main.add_command(deploy_cli.promote)
+main.add_command(destroy_cli.destroy)
+main.add_command(status_cli.status)
+main.add_command(django_cli.django)
+main.add_command(runtime_config_cli.runtime_config)
+main.add_command(migrate_cli.migrate)
+main.add_command(permissions_cli.permissions)
+main.add_command(waf_cli.waf)
+
+
+@main.group()
+def resource():
+    pass
+
+
+resource.add_command(vpc_cli.vpc)
+resource.add_command(awscontainer_cli.awscontainer)
+resource.add_command(neon_cli.neon)
+resource.add_command(tidb_cli.tidb)
+resource.add_command(dsql_cli.dsql)
+resource.add_command(rds_cli.rds)
+resource.add_command(s3_cli.s3)
+resource.add_command(cloudfront_cli.cloudfront)
+resource.add_command(cloudfront_keys_cli.cloudfront_keys)
+resource.add_command(cloudfront_waf_cli.cloudfront_waf)

pocket_cli/cli/migrate_cli.py

@@ -0,0 +1,148 @@
+"""pocket migrate: スタックのテンプレートハッシュタグを一括付与する。
+
+旧バージョンでデプロイされたスタックに pocket:template_hash タグを付与し、
+yaml_synced の判定をハッシュベースに移行する。
+"""
+
+from __future__ import annotations
+
+import hashlib
+
+import click
+import yaml
+
+from pocket.context import Context
+from pocket.utils import echo
+from pocket_cli.cli.deploy_cli import get_resources
+
+
+def _get_existing_stacks(context: Context) -> list:
+    """デプロイ済みの全スタックを収集する"""
+    stacks = []
+    for resource in get_resources(context):
+        if hasattr(resource, "stack") and resource.stack.exists:
+            stacks.append(resource.stack)
+    return stacks
+
+
+def _compute_uploaded_hash(stack) -> str | None:
+    """uploaded template からハッシュを計算する"""
+    uploaded = stack.uploaded_template
+    if uploaded is None:
+        return None
+    if isinstance(uploaded, str):
+        return hashlib.sha256(uploaded.encode()).hexdigest()[:16]
+    return hashlib.sha256(
+        yaml.dump(dict(uploaded), sort_keys=True).encode()
+    ).hexdigest()[:16]
+
+
+def _backfill_tags(stacks: list) -> None:
+    """タグがないスタックに uploaded template のハッシュでタグを付与する"""
+    for stack in stacks:
+        if stack._deployed_template_hash is not None:
+            continue
+        h = _compute_uploaded_hash(stack)
+        if h is None:
+            continue
+        echo.log("タグ付与 (uploaded hash): %s (%s)" % (stack.name, h))
+        stack.client.update_stack(
+            StackName=stack.name,
+            UsePreviousTemplate=True,
+            Capabilities=stack.capabilities,
+            Tags=stack.stack_tags + [{"Key": "pocket:template_hash", "Value": h}],
+        )
+        stack.wait_status("COMPLETED", timeout=300, interval=5)
+        stack.clear_status()
+        echo.success("完了: %s" % stack.name)
+
+
+def _find_stacks_needing_update(stacks: list) -> list:
+    """ローカルテンプレートとハッシュが異なるスタックを返す"""
+    targets = []
+    for stack in stacks:
+        if stack._deployed_template_hash == stack._template_hash:
+            echo.info("%s: タグは最新です" % stack.name)
+            continue
+        targets.append(stack)
+    return targets
+
+
+def _apply_local_tags(targets: list) -> None:
+    """ローカルテンプレートのハッシュでタグを更新する"""
+    for stack in targets:
+        echo.log("タグ更新 (local hash): %s" % stack.name)
+        stack.client.update_stack(
+            StackName=stack.name,
+            UsePreviousTemplate=True,
+            Capabilities=stack.capabilities,
+            Tags=stack._build_tags(),
+        )
+        stack.wait_status("COMPLETED", timeout=300, interval=5)
+        echo.success("完了: %s" % stack.name)
+
+
+def _check_real_diffs(stacks: list) -> list[str]:
+    """非 ASCII 文字化け以外のテンプレート差分があるスタックを返す"""
+    needs_deploy = []
+    for stack in stacks:
+        diff = stack.yaml_diff
+        if diff == {}:
+            continue
+        if set(diff.keys()) == {"values_changed"}:
+            all_garbled = all(
+                isinstance(c.get("old_value"), str) and "??" in c["old_value"]
+                for c in diff["values_changed"].values()
+            )
+            if all_garbled:
+                continue
+        needs_deploy.append(stack.name)
+    return needs_deploy
+
+
+@click.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+@click.option(
+    "--yes", "-y", is_flag=True, default=False, help="確認プロンプトをスキップ"
+)
+def migrate(stage: str, yes: bool):
+    """スタックのテンプレートハッシュタグを一括付与する"""
+    from pocket_cli.cli.aws_auth import check_aws_credentials
+
+    check_aws_credentials()
+    context = Context.from_toml(stage=stage)
+    stacks = _get_existing_stacks(context)
+
+    if not stacks:
+        echo.warning("対象のスタックがありません。")
+        return
+
+    # 1. タグがないスタックに uploaded template のハッシュで仮タグを付与
+    _backfill_tags(stacks)
+
+    # 2. ローカルとの差分チェック（非 ASCII 文字化け以外の差分があれば中断）
+    needs_deploy = _check_real_diffs(stacks)
+    if needs_deploy:
+        echo.danger("以下のスタックにテンプレートの差分があります:")
+        for name in needs_deploy:
+            echo.info("  - %s" % name)
+        echo.danger(
+            "先に pocket deploy --stage=%s で最新バージョンを"
+            "デプロイしてから再実行してください。" % stage
+        )
+        raise SystemExit(1)
+
+    # 3. ローカルテンプレートのハッシュでタグを更新
+    targets = _find_stacks_needing_update(stacks)
+    if not targets:
+        echo.success("全スタックのタグが最新です。")
+        return
+
+    echo.info("以下のスタックのタグをローカルハッシュに更新します:")
+    for stack in targets:
+        echo.info("  - %s" % stack.name)
+    if not yes:
+        click.confirm("実行しますか？", abort=True)
+
+    _apply_local_tags(targets)
+    echo.success("全スタックのマイグレーションが完了しました。")

pocket_cli/cli/neon_cli.py

@@ -0,0 +1,97 @@
+from pprint import pprint
+
+import click
+
+from pocket.context import Context
+from pocket.utils import echo
+from pocket_cli.resources.neon import Neon
+
+
+@click.group()
+def neon():
+    pass
+
+
+def get_neon_resource(stage):
+    context = Context.from_toml(stage=stage)
+    if not context.neon:
+        echo.danger("neon is not configured for this stage")
+        raise Exception("neon is not configured for this stage")
+    return Neon(context=context.neon)
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def context(stage):
+    neon = get_neon_resource(stage)
+    pprint(neon.context.model_dump())
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def create(stage):
+    neon = get_neon_resource(stage)
+    neon.create()
+    echo.success("New branch was created")
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def reset_database(stage):
+    neon = get_neon_resource(stage)
+    neon.reset_database()
+    echo.success("Reset database")
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+@click.option("--base-stage", default=None)
+def branch_out(stage, base_stage):
+    neon = get_neon_resource(stage)
+    if neon.branch:
+        raise Exception("Branch already exists")
+    base_neon = get_neon_resource(base_stage)
+    if not base_neon.working:
+        raise Exception("Base stage is not working")
+    assert base_neon.branch
+    neon.create_branch(base_neon.branch)
+    echo.success("New branch was created")
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def delete(stage):
+    neon = get_neon_resource(stage)
+    neon.delete_branch()
+    echo.success("Branch was deleted successfully.")
+
+
+@neon.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def status(stage):
+    neon = get_neon_resource(stage)
+    if neon.project:
+        echo.success("Project found")
+    else:
+        echo.warning("Project not found")
+        return
+    if neon.branch:
+        echo.success("Branch found")
+    else:
+        echo.warning("Branch not found")
+        return
+    if neon.database:
+        echo.success("Database found")
+    else:
+        echo.warning("Database not found")
+        return
+    if neon.endpoint:
+        echo.success("Endpoint found: %s" % neon.endpoint.host)
+    else:
+        echo.warning("Endpoint not found")
+    if neon.role:
+        echo.success("Role found: %s" % neon.context.role_name)
+    else:
+        echo.warning("Role not found")
+    if neon.role and neon.endpoint:
+        echo.success("Database url: %s" % neon.database_url)

pocket_cli/cli/permissions_cli.py

@@ -0,0 +1,46 @@
+"""`pocket permissions` サブコマンド群。
+
+`pocket.toml` の構成から必要な AWS IAM Action を算出して出力する。
+外部の IAM Role プロビジョニング処理が GitHub Actions デプロイ用 IAM Role を
+作る際の inline policy 生成に使用することを想定。
+"""
+
+from __future__ import annotations
+
+import json
+
+import click
+
+from pocket.permissions import compute_actions
+from pocket.settings import Settings
+
+
+@click.group()
+def permissions():
+    """IAM 権限関連のサブコマンド。"""
+
+
+@permissions.command("list")
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+@click.option(
+    "--format",
+    "format_",
+    type=click.Choice(["text", "json"]),
+    default="text",
+    show_default=True,
+    help='出力形式。text: 1 行 1 Action / json: {"actions": [...]}',
+)
+def list_(stage: str, format_: str):
+    """pocket.toml から必要な AWS Action 一覧を出力する。
+
+    docs/permissions/aws.md のテーブルに基づき、`[cloudfront]` / `[rds]` /
+    `[ses]` などの設定有無に応じて必要 Action を組み立てる。粒度は
+    ワイルドカード中心 (`cloudformation:*` 等)。
+    """
+    settings = Settings.from_toml(stage=stage)
+    actions = compute_actions(settings)
+    if format_ == "json":
+        click.echo(json.dumps({"actions": actions}, indent=2))
+    else:
+        for action in actions:
+            click.echo(action)

pocket_cli/cli/rds_cli.py

@@ -0,0 +1,63 @@
+import click
+
+from pocket.context import Context
+from pocket.utils import echo
+from pocket_cli.resources.rds import Rds
+
+
+def _get_rds_resource(stage: str) -> Rds:
+    context = Context.from_toml(stage=stage)
+    if not context.rds:
+        raise click.ClickException("rds is not configured for this stage")
+    return Rds(context.rds)
+
+
+@click.group()
+def rds():
+    pass
+
+
+@rds.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def status(stage):
+    """クラスター状態表示"""
+    r = _get_rds_resource(stage)
+    echo.info("Cluster: %s" % r.context.cluster_identifier)
+    echo.info("Status: %s" % r.status)
+    if r.cluster:
+        echo.info("Engine: %s" % r.cluster.get("EngineVersion", ""))
+
+
+@rds.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def endpoint(stage):
+    """接続情報表示"""
+    r = _get_rds_resource(stage)
+    if not r.cluster:
+        echo.warning("Cluster not found")
+        return
+    _print_endpoint(r)
+
+
+@rds.command()
+@click.option("--stage", envvar="POCKET_DEPLOY_STAGE", prompt=True)
+def destroy(stage):
+    """確認付き削除"""
+    r = _get_rds_resource(stage)
+    if r.status == "NOEXIST":
+        echo.info("RDS cluster does not exist.")
+        return
+    click.confirm(
+        "RDS Aurora クラスター '%s' を削除しますか？" % r.context.cluster_identifier,
+        abort=True,
+    )
+    r.delete()
+    echo.success("RDS Aurora cluster was destroyed. Final snapshot was created.")
+
+
+def _print_endpoint(r: Rds):
+    assert r.cluster
+    echo.success("Endpoint: %s" % r.cluster.get("Endpoint", ""))
+    echo.success("Port: %s" % r.cluster.get("Port", ""))
+    echo.success("Database: %s" % r.context.database_name)
+    echo.success("Username: %s" % r.context.master_username)

pocket_cli/cli/runtime_config_cli.py

@@ -0,0 +1,185 @@
+from __future__ import annotations
+
+import copy
+import sys
+from pathlib import Path
+
+import click
+
+from pocket.utils import get_toml_path
+
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    import tomli as tomllib
+
+# awscontainer から除外するキー（ビルド時のみ必要）
+_AWSCONTAINER_REMOVE_KEYS = {
+    "platform",
+    "build",
+    "permissions_boundary",
+    "use_vpc",
+}
+
+# awscontainer でダミー値に置き換えるキー（必須フィールドだが runtime では不要）
+_AWSCONTAINER_DUMMY_VALUES = {
+    "dockerfile_path": "__runtime__",
+}
+
+# cloudfront の各エントリから除外するキー
+_CLOUDFRONT_REMOVE_KEYS = {
+    "managed_assets",
+    "hosted_zone_id_override",
+    "redirect_from",
+    "signing_key",
+    "token_secret",
+}
+
+# route から除外するキー
+_ROUTE_REMOVE_KEYS = {
+    "build",
+    "build_dir",
+    "require_token",
+    "login_path",
+}
+
+# awscontainer.django から除外するキー
+_DJANGO_REMOVE_KEYS = {
+    "project_dir",
+}
+
+# トップレベルから除外するセクション
+_TOPLEVEL_REMOVE_KEYS = {
+    "vpc",
+}
+
+
+def _remove_keys(d: dict, keys: set[str]) -> None:
+    for key in keys:
+        d.pop(key, None)
+
+
+def _clean_cloudfront(cf: dict) -> None:
+    _remove_keys(cf, _CLOUDFRONT_REMOVE_KEYS)
+    for route in cf.get("routes", []):
+        _remove_keys(route, _ROUTE_REMOVE_KEYS)
+
+
+def _clean_section(section: dict) -> None:
+    """awscontainer / cloudfront セクションをクリーンアップする"""
+    if "awscontainer" in section:
+        ac = section["awscontainer"]
+        _remove_keys(ac, _AWSCONTAINER_REMOVE_KEYS)
+        for key, value in _AWSCONTAINER_DUMMY_VALUES.items():
+            if key in ac:
+                ac[key] = value
+        if "django" in ac:
+            _remove_keys(ac["django"], _DJANGO_REMOVE_KEYS)
+    if "cloudfront" in section:
+        for cf in section["cloudfront"].values():
+            _clean_cloudfront(cf)
+
+
+def _clean_data(data: dict) -> dict:
+    """pocket.toml のデータからランタイムに不要な設定を除外する"""
+    result = copy.deepcopy(data)
+    _remove_keys(result, _TOPLEVEL_REMOVE_KEYS)
+    _clean_section(result)
+    for stage in result.get("general", {}).get("stages", []):
+        if stage in result:
+            _clean_section(result[stage])
+    return result
+
+
+def _to_toml(data: dict, prefix: str = "") -> str:
+    """dict を TOML 文字列に変換する（簡易実装）"""
+    lines: list[str] = []
+    # まずスカラー値とリストを出力
+    for key, value in data.items():
+        if isinstance(value, dict):
+            continue
+        lines.append(_format_value(key, value))
+
+    # dict 値をセクションとして出力
+    for key, value in data.items():
+        if not isinstance(value, dict):
+            continue
+        section = f"{prefix}{key}" if prefix else key
+        # dict の中身が全て dict なら、各サブキーをサブセクションに
+        if all(isinstance(v, dict) for v in value.values()) and value:
+            for sub_key, sub_value in value.items():
+                lines.append("")
+                lines.append(f"[{section}.{sub_key}]")
+                lines.append(_to_toml(sub_value, prefix=f"{section}.{sub_key}."))
+            continue
+        lines.append("")
+        lines.append(f"[{section}]")
+        lines.append(_to_toml(value, prefix=f"{section}."))
+
+    return "\n".join(lines)
+
+
+def _format_value(key: str, value) -> str:
+    if isinstance(value, bool):
+        return f"{key} = {'true' if value else 'false'}"
+    if isinstance(value, int):
+        return f"{key} = {value}"
+    if isinstance(value, str):
+        return f'{key} = "{value}"'
+    if isinstance(value, list):
+        return f"{key} = {_format_list(value)}"
+    return f"{key} = {value!r}"
+
+
+def _format_list(items: list) -> str:
+    if not items:
+        return "[]"
+    if all(isinstance(i, str) for i in items):
+        return "[%s]" % ", ".join(f'"{i}"' for i in items)
+    if all(isinstance(i, dict) for i in items):
+        parts = []
+        for item in items:
+            kvs = ", ".join(f"{k} = {_format_inline_value(v)}" for k, v in item.items())
+            parts.append("{ %s }" % kvs)
+        return "[\n    %s,\n]" % ",\n    ".join(parts)
+    return repr(items)
+
+
+def _format_inline_value(value) -> str:
+    if isinstance(value, bool):
+        return "true" if value else "false"
+    if isinstance(value, int):
+        return str(value)
+    if isinstance(value, str):
+        return f'"{value}"'
+    return repr(value)
+
+
+def generate_runtime_config(output_path: Path) -> None:
+    """pocket.runtime.toml を生成する（プログラムから呼び出し用）"""
+    toml_path = get_toml_path()
+    data = tomllib.loads(toml_path.read_text())
+    cleaned = _clean_data(data)
+    toml_str = _to_toml(cleaned).strip() + "\n"
+    output_path.write_text(toml_str)
+
+
+@click.command("runtime-config")
+@click.argument("output", default="-")
+def runtime_config(output: str):
+    """Lambda ランタイム用の pocket.toml を生成する
+
+    ビルド時のみ必要な設定（dockerfile_path, managed_assets 等）を
+    除外した pocket.toml を出力する。Dockerfile 内で使用する。
+
+    OUTPUT: 出力先ファイルパス（省略時は標準出力）
+    """
+    if output == "-":
+        toml_path = get_toml_path()
+        data = tomllib.loads(toml_path.read_text())
+        cleaned = _clean_data(data)
+        toml_str = _to_toml(cleaned).strip() + "\n"
+        click.echo(toml_str, nl=False)
+    else:
+        generate_runtime_config(Path(output))
+        click.echo("runtime-config を出力しました: %s" % output)