diff --git a/bin/devbase b/bin/devbase index a4b6222..a3723fd 100755 --- a/bin/devbase +++ b/bin/devbase @@ -168,7 +168,7 @@ run_python() { # Resolve abbreviated command to full command name via unique prefix matching resolve_command() { local input="$1" - local commands="init status shell-rc container ct env plugin pl snapshot ss up down login build ps scale help" + local commands="init status shell-rc project container ct env plugin pl snapshot ss up down login build ps scale help" local matches=() for cmd in $commands; do [[ "$cmd" == "$input"* ]] && matches+=("$cmd") @@ -180,6 +180,48 @@ resolve_command() { fi } +# =================================================================== +# Project name resolution (PLAN06 Task 2) +# =================================================================== +# `devbase project ` および同義のトップレベルシノニム +# `devbase ` の が $DEVBASE_ROOT/projects/ に実在する +# 場合、そのディレクトリへ cd し COMPOSE_PROJECT_NAME / env を再設定する。 +# これにより任意の CWD からプロジェクトを指定してコンテナ操作できる。 +# +# 重要: `build` は shell 実装 (cmd_build) が CWD で動くため、この wrapper cd +# だけが build の name 解決手段になる (PLAN06 方針 A の核心)。Python 側 chdir +# フォールバックでは build を救えない。 +# +# 判定は projects/ 配下の実在性で行う。これにより `login ` / +# `build ` / `scale ` の既存 positional と曖昧にならない: 実在する +# プロジェクト名のときだけ name として解釈し cd + strip する。実在しなければ +# 引数はそのまま下流 (Python パーサ) へ渡し、Python 側で index/image/scale +# あるいは「存在しない name」エラーとして扱わせる。 + +# name 候補を受け取り projects/ 配下に実在すれば cd + env 再設定して 0 を返す。 +maybe_cd_project() { + local name="${1:-}" + case "$name" in -*|"") return 1 ;; esac # フラグ・空は name ではない + local target="${DEVBASE_ROOT}/projects/${name}" + [ -d "$target" ] || return 1 + cd "$target" || return 1 + export COMPOSE_PROJECT_NAME="$name" + # cd 後にプロジェクトの env を再 source (初期 CWD で読んだ値を上書き)。 + # project の .env (dotfile) は CRLF / 特殊文字対策で意図的に source しない + # 方針を踏襲する (冒頭コメント参照)。 + # + # 注意: env は環境変数定義のみを想定したファイルであり subshell ではなく + # 現プロセスで source する。これは wrapper 冒頭 L23-24 の env 読み込みと同一 + # 意図 — set -a で export した変数を後続の run_python / cmd_build へ引き継ぐ + # ため、変数が親プロセスに残らない subshell 化はできない。代償として env 内に + # `exit` 等があると wrapper ごと終了するが、env は (a) プロジェクト所有者が + # 管理する信頼境界内のファイルで (b) 元々 L24 で初期 CWD でも source される + # ため、ここで新たなリスクが増えるわけではない。万一 exit を含む env を読んで + # も「該当プロジェクトの操作が中断する」だけで他プロジェクトへ波及しない。 + [ -f "env" ] && set -a && source ./env && set +a + return 0 +} + # Resolve the command (skip flags like --version, -V, -h, --help) _resolved_cmd="${1:-}" case "$_resolved_cmd" in @@ -187,14 +229,60 @@ case "$_resolved_cmd" in *) _resolved_cmd="$(resolve_command "$_resolved_cmd")" ;; esac +# name 解決: 実在するプロジェクト名を検出したら cd し、その token を argv から +# 取り除いた配列 _DEVBASE_ARGS を組み立てる。検出しなければ素通し。 +# name 候補の位置: +# project|container -> $3 (サブコマンドは保持) +# トップレベルシノニム -> $2 +# +# 重要 (PLAN06 codex 指摘対応): `project`/`container` グループでは parser が +# `name` positional を持つサブコマンド (`up`/`down`/`ps`/`logs`/`scale`) に限定 +# して $3 を name 解決する。`project login` / `project build` は単一 positional が +# index / image (旧 container 互換) であり parser が name を受け付けない +# (cli.py の _add_login_subparser / _add_build_subparser 参照)。これらで $3 を +# name strip すると、`project build web` の image=web や `project login web` の +# index 引数が実在プロジェクト名と一致した瞬間に消えて別操作へ化けるため除外する。 +# +# トップレベルシノニム (`build`/`login` を含む) は従来どおり「実在 project なら +# cd」方針を維持する: トップレベル `build`/`login` は Python parser を経由せず +# shell cmd_build / wrapper cd だけが name 指定の手段であり、`build carmo` / +# `login carmo` を「そのプロジェクトを操作」と解釈する設計 (存在性ベース判定)。 +_DEVBASE_ARGS=("${@:2}") +# 同期注意 (メンテナンス性): 下記 2 リストは cli.py の parser 定義に対応する。 +# _PROJECT_NAME_SUBCOMMANDS = `project`/`container` で `name` positional を +# 受け付けるサブコマンド集合。cli.py の _add_project_parser で +# `add_argument('name', ...)` を持つもの (up/down/ps/logs/scale) と一致させる。 +# login/build は index/image 互換のため意図的に除外 (上のコメント参照)。 +# _NAME_RESOLVABLE_SHORTCUTS = トップレベルシノニムのうち「実在 project なら cd」 +# を許すもの。cli.py の SHORTCUTS 経由で project サブコマンドへ写像される +# 集合 + shell 実装の build を含む。 +# cli.py 側でサブコマンドを追加/削除した際は両リストの更新漏れに注意すること +# (cli.py の _add_project_parser / SHORTCUTS にも対の注記あり)。 +_PROJECT_NAME_SUBCOMMANDS=" up down ps logs scale " +_NAME_RESOLVABLE_SHORTCUTS=" up down ps scale login build " +case "$_resolved_cmd" in + project|container) + if [[ "$_PROJECT_NAME_SUBCOMMANDS" == *" ${2:-} "* ]] \ + && maybe_cd_project "${3:-}"; then + _DEVBASE_ARGS=("${2:-}" "${@:4}") + fi + ;; + *) + if [[ "$_NAME_RESOLVABLE_SHORTCUTS" == *" $_resolved_cmd "* ]] \ + && maybe_cd_project "${2:-}"; then + _DEVBASE_ARGS=("${@:3}") + fi + ;; +esac + case "$_resolved_cmd" in # Python-implemented commands --version|-V) run_python "$@" ;; - init|status|shell-rc|container|ct|env|plugin|pl|snapshot|ss|up|down|login|ps|scale) - run_python "${_resolved_cmd}" "${@:2}" ;; + init|status|shell-rc|project|container|ct|env|plugin|pl|snapshot|ss|up|down|login|ps|scale) + run_python "${_resolved_cmd}" "${_DEVBASE_ARGS[@]}" ;; # Shell-implemented commands - build) shift; cmd_build "$@" ;; + build) cmd_build "${_DEVBASE_ARGS[@]}" ;; # Help and unknown -h|--help|help|"") run_python "--help" ;; *) echo "Error: unknown command '$1'" >&2; exit 1 ;; diff --git a/lib/devbase/cli.py b/lib/devbase/cli.py index f185419..24f499a 100644 --- a/lib/devbase/cli.py +++ b/lib/devbase/cli.py @@ -16,14 +16,24 @@ logger = get_logger("devbase.cli") -# Shortcuts: top-level command -> (group, subcommand) +# Shortcuts: top-level command -> project subcommand +# 委譲先は共有の cmd_project (PLAN06 で container は非推奨化)。 +# NOTE: `build` はここに含めない。配布入口 bin/devbase が `build` を shell の +# cmd_build (devbase-base 依存検出 + 2 段ビルド + --no-cache 対応) に委譲しており、 +# Python の project build (単純な compose build) とは実装が異なるため。Python 側で +# `build` を project build ショートカットとして広告すると wrapper の実経路と乖離する。 +# project build / container build サブコマンド自体は引き続き利用可能。 +# +# 同期注意 (メンテナンス性): SHORTCUTS のキー集合と _add_project_parser の +# `name` positional 付きサブコマンドは bin/devbase の _NAME_RESOLVABLE_SHORTCUTS / +# _PROJECT_NAME_SUBCOMMANDS と対応している。サブコマンドを追加/削除する際は +# wrapper 側 (bin/devbase の該当リスト) の更新漏れに注意すること。 SHORTCUTS = { - 'up': ('container', 'up'), - 'down': ('container', 'down'), - 'login': ('container', 'login'), - 'build': ('container', 'build'), - 'ps': ('container', 'ps'), - 'scale': ('container', 'scale'), + 'up': 'up', + 'down': 'down', + 'login': 'login', + 'ps': 'ps', + 'scale': 'scale', } # Group aliases @@ -35,6 +45,7 @@ # Subcommand map for prefix resolution: {(aliases...): [subcmds]} SUBCMD_MAP = { + ('project',): ['up', 'down', 'ps', 'login', 'logs', 'scale', 'build'], ('container', 'ct'): ['up', 'down', 'ps', 'login', 'logs', 'scale', 'build'], ('env',): ['init', 'sync', 'list', 'set', 'get', 'delete', 'edit', 'project', 'export', 'import'], ('plugin', 'pl'): ['list', 'install', 'uninstall', 'update', 'info', 'sync', 'repo', 'migrate'], @@ -63,6 +74,30 @@ def _require_devbase_root() -> Path: return Path(root) +def _add_login_subparser(sub): + """`login` サブコマンドを登録する (project / container 共通)。 + + 単一 positional `index` の意味は両グループで完全に同一。`[name]` を足すと + `project login 2` を name='2' と誤解釈して index=1 にログインしてしまう曖昧さ + (旧 `container login ` との非互換) が生じるため、project でも name を + 受け付けない。PR2 で project name 解決を導入する際は曖昧さのない `--name` + オプションで対応する方針。 + """ + p = sub.add_parser('login', help='Login to container') + p.add_argument('index', nargs='?', default='1', help='Container index') + + +def _add_build_subparser(sub): + """`build` サブコマンドを登録する (project / container 共通)。 + + 単一 positional `image` の意味は両グループで同一。`[name]` を許すと + `project build web` が name='web', image=None となり image 指定ビルドが + compose build に化けるため、project でも name を受け付けない (login 参照)。 + """ + p = sub.add_parser('build', help='Build container images') + p.add_argument('image', nargs='?', default=None, help='Image name') + + def _add_container_parser(subparsers): """Container group parser""" ct_parser = subparsers.add_parser('container', aliases=['ct'], @@ -72,8 +107,7 @@ def _add_container_parser(subparsers): ct_sub.add_parser('up', help='Start containers') ct_sub.add_parser('down', help='Stop and remove containers') - ct_login = ct_sub.add_parser('login', help='Login to container') - ct_login.add_argument('index', nargs='?', default='1', help='Container index') + _add_login_subparser(ct_sub) ct_ps = ct_sub.add_parser('ps', help='Show container status') ct_ps.add_argument('--all', '-a', action='store_true', help='Show all containers') @@ -85,8 +119,53 @@ def _add_container_parser(subparsers): ct_scale = ct_sub.add_parser('scale', help='Scale containers online') ct_scale.add_argument('new_scale', type=int, help='New number of containers') - ct_build = ct_sub.add_parser('build', help='Build container images') - ct_build.add_argument('image', nargs='?', default=None, help='Image name') + _add_build_subparser(ct_sub) + + +def _add_project_parser(subparsers): + """Project group parser (CWD 非依存のプロジェクト操作)。 + + `container` と同じ subcommand 群に、省略可能な `[name]` positional を加える。 + name によるディレクトリ解決 / COMPOSE_PROJECT_NAME 上書きは PLAN06 Task 2 (PR2) + で wrapper の cd + Python フォールバックとして実装する。PR1 では parser 構造と + name のパースまでを用意する。 + + 例外: `login` / `build` は単一 positional が旧 `container` と同義 (index / image) + であり、`[name]` を足すと `project login 2` / `project build web` が誤解釈される + ため name を受け付けない。両者は project / container で定義が完全に一致するので + `_add_login_subparser` / `_add_build_subparser` に共通化している。 + + 同期注意: ここで `name` positional を持つサブコマンド集合 (up/down/ps/logs/scale) + は bin/devbase の `_PROJECT_NAME_SUBCOMMANDS` と一致させる必要がある。追加/削除時は + wrapper 側リストの更新漏れに注意すること。 + """ + pj_parser = subparsers.add_parser('project', help='Manage projects (CWD-independent)') + pj_sub = pj_parser.add_subparsers(dest='subcommand') + + pj_up = pj_sub.add_parser('up', help='Start containers') + pj_up.add_argument('name', nargs='?', default=None, help='Project name') + + pj_down = pj_sub.add_parser('down', help='Stop and remove containers') + pj_down.add_argument('name', nargs='?', default=None, help='Project name') + + _add_login_subparser(pj_sub) + + pj_ps = pj_sub.add_parser('ps', help='Show container status') + pj_ps.add_argument('name', nargs='?', default=None, help='Project name') + pj_ps.add_argument('--all', '-a', action='store_true', help='Show all containers') + + pj_logs = pj_sub.add_parser('logs', help='Show container logs') + pj_logs.add_argument('name', nargs='?', default=None, help='Project name') + pj_logs.add_argument('--follow', '-f', action='store_true', help='Follow log output') + pj_logs.add_argument('--tail', type=int, default=None, help='Number of lines') + + # NOTE: `[name]` optional + `new_scale` 必須 int の順。値が 1 個なら new_scale に、 + # 2 個なら (name, new_scale) に割り当てられ曖昧にならない (tests/cli 参照)。 + pj_scale = pj_sub.add_parser('scale', help='Scale containers online') + pj_scale.add_argument('name', nargs='?', default=None, help='Project name') + pj_scale.add_argument('new_scale', type=int, help='New number of containers') + + _add_build_subparser(pj_sub) def _add_env_parser(subparsers): @@ -285,20 +364,36 @@ def _add_snapshot_parser(subparsers): def _add_shortcuts(subparsers): - """Top-level shortcut parsers""" + """Top-level shortcut parsers. + + 委譲先の `project` サブコマンドと引数体系を揃えるため、`up` / `down` / `ps` / + `scale` は `project [name]` と同じく省略可能な `[name]` positional を + 受け付ける (`devbase up carmo` ≡ `devbase project up carmo`)。受理した name は + _dispatch でショートカット経由でも下流 (cmd_project → _dispatch_lifecycle) へ + 伝播する。name の実解決は PLAN06 Task 2 (PR2) で実装するため、PR1 では up/scale + も含め name 指定時に未対応 warning を出す (container.py 参照)。 + + `login` は project login と同様に単一 positional を `index` として扱い `[name]` + は受け付けない (曖昧さ回避)。`build` はショートカットに含めない (SHORTCUTS の + 注記参照): bin/devbase が build を shell 実装 (cmd_build) に委譲するため、 + Python 側でトップレベル build を広告すると実経路と乖離する。 + """ login_sc = subparsers.add_parser('login', help='Login to container') login_sc.add_argument('index', nargs='?', default='1', help='Container index') - build_sc = subparsers.add_parser('build', help='Build container images') - build_sc.add_argument('image', nargs='?', default=None, help='Image name') - ps_sc = subparsers.add_parser('ps', help='Show container status') + ps_sc.add_argument('name', nargs='?', default=None, help='Project name') ps_sc.add_argument('--all', '-a', action='store_true', help='Show all containers') - subparsers.add_parser('up', help='Start containers') - subparsers.add_parser('down', help='Stop and remove containers') + up_sc = subparsers.add_parser('up', help='Start containers') + up_sc.add_argument('name', nargs='?', default=None, help='Project name') + + down_sc = subparsers.add_parser('down', help='Stop and remove containers') + down_sc.add_argument('name', nargs='?', default=None, help='Project name') + # `[name]` optional + `new_scale` 必須 int の順 (project scale と同じ規則)。 scale_sc = subparsers.add_parser('scale', help='Scale containers online') + scale_sc.add_argument('name', nargs='?', default=None, help='Project name') scale_sc.add_argument('new_scale', type=int, help='New number of containers') @@ -310,12 +405,13 @@ def _create_parser(): formatter_class=argparse.RawDescriptionHelpFormatter, epilog=( "Shortcuts:\n" - " up container up\n" - " down container down\n" - " login container login\n" - " build container build\n" - " ps container ps\n" - " scale container scale\n" + " up project up\n" + " down project down\n" + " login project login\n" + " ps project ps\n" + " scale project scale\n" + "\n" + "Note: `container` is deprecated; use `project` instead.\n" ) ) @@ -342,6 +438,7 @@ def _create_parser(): help='Print shell RC file path (e.g. source "$(devbase shell-rc)")' ) + _add_project_parser(subparsers) _add_container_parser(subparsers) _add_env_parser(subparsers) _add_plugin_parser(subparsers) @@ -371,8 +468,16 @@ def _resolve_prefix(input_cmd, candidates, preferences=None): def _expand_argv(): """Expand abbreviated command/subcommand names in sys.argv in-place.""" - commands = ['init', 'status', 'shell-rc', 'container', 'ct', 'env', 'plugin', 'pl', - 'snapshot', 'ss', 'up', 'down', 'login', 'build', 'ps', 'scale', 'help'] + # この `commands` リストの並びは _create_parser のグループ登録順と一致させる: + # トップレベル → グループ (各 group の直後にその alias を隣接配置: container/ct, + # plugin/pl, snapshot/ss) → ショートカット。`project` (推奨) を `container` + # (非推奨) より前に置くのは登録順と揃えた意図的な並びで、prefix 解決は + # _resolve_prefix が一意一致のみ採用するため順序に機能的影響はない。 + # `build` はトップレベルショートカットから除外 (SHORTCUTS の注記参照)。 + # bin/devbase が build を shell 実装に委譲するため Python 側には top-level + # build parser が無い。project build / container build は引き続き利用可能。 + commands = ['init', 'status', 'shell-rc', 'project', 'container', 'ct', 'env', 'plugin', 'pl', + 'snapshot', 'ss', 'up', 'down', 'login', 'ps', 'scale', 'help'] repo_subcmds = ['add', 'remove', 'list', 'refresh'] if len(sys.argv) >= 2 and not sys.argv[1].startswith('-'): @@ -418,13 +523,20 @@ def _dispatch(cmd, args): # Resolve group aliases cmd = GROUP_ALIASES.get(cmd, cmd) - # --- Shortcuts (top-level -> container subcommand) --- + # --- Shortcuts (top-level -> project subcommand) --- + # ショートカットは非推奨ではないため、warning を出す cmd_container ではなく + # 共有の cmd_project へ委譲する。 if cmd in SHORTCUTS: - args.subcommand = SHORTCUTS[cmd][1] - from devbase.commands.container import cmd_container - return cmd_container(args) + args.subcommand = SHORTCUTS[cmd] + from devbase.commands.container import cmd_project + return cmd_project(args) + + # --- Project group (推奨) --- + if cmd == 'project': + from devbase.commands.container import cmd_project + return cmd_project(args) - # --- Container group --- + # --- Container group (非推奨: project へ委譲 + warning) --- if cmd == 'container': from devbase.commands.container import cmd_container return cmd_container(args) diff --git a/lib/devbase/commands/container.py b/lib/devbase/commands/container.py index 528a143..cdf9382 100644 --- a/lib/devbase/commands/container.py +++ b/lib/devbase/commands/container.py @@ -81,12 +81,151 @@ def _run_pre_up_hook() -> bool: # ディスパッチャ # --------------------------------------------------------------------------- -def cmd_container(args) -> int: - """サブコマンドディスパッチャ""" +def _projects_dir() -> Optional[Path]: + """$DEVBASE_ROOT/projects を返す。DEVBASE_ROOT 未設定なら None。""" + root = os.environ.get('DEVBASE_ROOT') + if not root: + return None + return Path(root) / 'projects' + + +# 候補一覧に表示するプロジェクト数の上限。多数プロジェクト環境で iterdir 全件を +# 出力すると 1 行が極端に長くなるため、先頭 N 件 + 「... 他 M 件」で truncate する。 +_MAX_PROJECT_CANDIDATES = 20 + + +def _report_unknown_project(name: str, projects_dir: Path) -> None: + """存在しない project name に対するエラーと候補一覧を出力する。 + + 候補が多数の場合は先頭 ``_MAX_PROJECT_CANDIDATES`` 件のみ表示し、残りは + 「... 他 M 件」と省略する。 + """ + logger.error("プロジェクト '%s' が見つかりません (%s 配下に存在しません)。", + name, projects_dir) + try: + candidates = sorted( + p.name for p in projects_dir.iterdir() + if p.is_dir() or p.is_symlink() + ) + except OSError: + candidates = [] + if candidates: + total = len(candidates) + shown = candidates[:_MAX_PROJECT_CANDIDATES] + listing = ', '.join(shown) + if total > _MAX_PROJECT_CANDIDATES: + listing += f', ... 他 {total - _MAX_PROJECT_CANDIDATES} 件' + logger.error("利用可能なプロジェクト: %s", listing) + + +def _load_project_env(env_file: Path) -> None: + """プロジェクトの ``env`` ファイルを os.environ へ反映する (wrapper 同等)。 + + wrapper (bin/devbase) は cd 後に ``source ./env`` で env を読み込むため、 + Python フォールバック経路でも同じ KEY=VALUE を ``os.environ`` に載せて + 変数欠落 (例: project 固有の ``CONTAINER_SCALE``) を防ぐ。 + + env は環境変数定義のみを想定したファイル (bin/devbase 冒頭コメント参照) の + ため、ここでは ``export`` 接頭辞付き / 無しの単純な ``KEY=VALUE`` 行のみを + 解釈する。``#`` コメント・空行は無視し、値の前後のクォートは除去する。shell + の変数展開やコマンド置換は意図的にサポートしない (安全側に倒す)。 + """ + if not env_file.is_file(): + return + try: + lines = env_file.read_text().splitlines() + except OSError as e: + logger.warning("env ファイルを読み込めませんでした (%s): %s", env_file, e) + return + for raw in lines: + line = raw.strip() + if not line or line.startswith('#'): + continue + if line.startswith('export '): + line = line[len('export '):].lstrip() + if '=' not in line: + continue + key, value = line.split('=', 1) + key = key.strip() + if not key: + continue + value = value.strip() + if len(value) >= 2 and value[0] == value[-1] and value[0] in ('"', "'"): + value = value[1:-1] + os.environ[key] = value + + +def _resolve_project_name(project_name: str) -> bool: + """project name を $DEVBASE_ROOT/projects/ へ解決し chdir する。 + + 通常は wrapper (bin/devbase) が起動前に cd 済みのため、ここは + + - `python -m devbase.cli project up ` の直接起動 + - wrapper を経ない経路 (`_ensure_env_files` 等) + + に対する防御的フォールバックとして働く。wrapper が既に対象ディレクトリへ + cd 済みなら chdir は no-op になる (同一パス判定)。 + + chdir 後は wrapper の ``source ./env`` と同等に project の ``env`` を + ``os.environ`` へ反映し、wrapper を経ない直接起動でも環境変数が欠落しない + ようにする (gemini round2 minor 指摘対応)。 + + Returns: + True: 解決成功 (または既に対象ディレクトリにいる) + False: DEVBASE_ROOT 未設定 / 対象が存在しない (呼び出し側で return 1) + """ + projects_dir = _projects_dir() + if projects_dir is None: + logger.error("DEVBASE_ROOT が未設定のため project name '%s' を解決できません。", + project_name) + return False + + target = projects_dir / project_name + if not target.is_dir(): + _report_unknown_project(project_name, projects_dir) + return False + + try: + already_there = target.resolve() == Path.cwd().resolve() + except OSError: + already_there = False + if not already_there: + os.chdir(target) + + # wrapper の `source ./env` と同等に project env を os.environ へ反映する。 + # wrapper 経由なら既に同じ値が載っているため冪等。 + _load_project_env(Path('env')) + + # COMPOSE_PROJECT_NAME を name で上書き (wrapper が設定済みでも冪等)。 + # env 由来の COMPOSE_PROJECT_NAME より name 指定を優先するため env 反映後に行う。 + os.environ['COMPOSE_PROJECT_NAME'] = project_name + return True + + +def _dispatch_lifecycle(args) -> int: + """`project` / `container` 共有のサブコマンドディスパッチャ。 + + `project [name]` の `name` を解決して project_name へ畳み込む。 + `container` 経路には `name` 属性が無いため従来通り None になる。 + + name 指定時は handler 呼び出し前に一括で `$DEVBASE_ROOT/projects/` へ + chdir する (PLAN06 方針 A の Python 側フォールバック)。chdir を各 handler に + 散らさずここで実施するのは、`cmd_down()` / `cmd_login()` / `cmd_logs()` 等が + project_name 引数を取らず、per-handler 実装では down/login/logs で名前解決が + 効かなくなるため。build は wrapper の shell 実装で CWD 実行されるため、この + Python フォールバックの対象外 (name 属性も持たない)。 + """ subcmd = getattr(args, 'subcommand', None) + project_name = getattr(args, 'name', None) or getattr(args, 'project_name', None) + + # name 指定時はディレクトリを解決して chdir する。解決失敗 (DEVBASE_ROOT 未設定 + # / 存在しない name) は候補提示の上でエラー終了する。 + if project_name: + if not _resolve_project_name(project_name): + return 1 handlers = { - 'up': lambda: cmd_up(project_name=getattr(args, 'project_name', None), + 'up': lambda: cmd_up(project_name=project_name, scale=getattr(args, 'scale', None)), 'down': lambda: cmd_down(), 'login': lambda: cmd_login(index=getattr(args, 'index', '1')), @@ -94,7 +233,7 @@ def cmd_container(args) -> int: 'logs': lambda: cmd_logs(follow=getattr(args, 'follow', False), tail=getattr(args, 'tail', None)), 'scale': lambda: cmd_scale(new_scale=getattr(args, 'new_scale', None), - project_name=getattr(args, 'project_name', None)), + project_name=project_name), 'build': lambda: cmd_build(image=getattr(args, 'image', None)), } @@ -106,6 +245,24 @@ def cmd_container(args) -> int: return 1 +def cmd_project(args) -> int: + """`devbase project [name]` ディスパッチャ (推奨エントリ)。""" + return _dispatch_lifecycle(args) + + +def cmd_container(args) -> int: + """`devbase container ` ディスパッチャ。 + + 非推奨: `devbase project` に移行してください (移行期間後に削除予定)。 + 挙動は `cmd_project` と同一で、警告のみ追加する。 + """ + logger.warning( + "`devbase container` は非推奨です。`devbase project` を使用してください " + "(将来のリリースで削除されます)。" + ) + return _dispatch_lifecycle(args) + + # --------------------------------------------------------------------------- # cmd_up (deploy.py の cmd_deploy を移植) # --------------------------------------------------------------------------- diff --git a/tests/cli/test_build_shortcut_consistency.py b/tests/cli/test_build_shortcut_consistency.py new file mode 100644 index 0000000..d49182e --- /dev/null +++ b/tests/cli/test_build_shortcut_consistency.py @@ -0,0 +1,65 @@ +"""bin/devbase の build dispatch と Python 側 build ショートカットの整合性テスト。 + +配布入口 bin/devbase は top-level `build` を shell 実装 (cmd_build: devbase-base +依存検出 + 2 段ビルド + --no-cache 対応) に委譲する。Python の project build は +単純な `compose build` であり実装が異なるため、Python 側が top-level `build` を +`project build` ショートカットとして広告すると、wrapper の実経路と乖離してしまう。 + +このテストは「Python は top-level build ショートカットを持たない / 広告しない」 +ことを固定し、wrapper の build) ケースが shell 経路を保つことを検証する。 +project build / container build サブコマンド自体は引き続き利用可能。 +""" + +from pathlib import Path + +from devbase import cli + + +def test_build_not_in_shortcuts(): + # top-level build は SHORTCUTS から除外されている (wrapper が shell へ委譲するため) + assert "build" not in cli.SHORTCUTS + # 他のショートカットは維持されている + for sc in ("up", "down", "login", "ps", "scale"): + assert sc in cli.SHORTCUTS + + +def test_top_level_build_has_no_python_parser(): + # top-level `build` には Python parser が無く、parse_args はエラー終了する + # (wrapper が build を shell の cmd_build に委譲し Python に渡さないため) + parser = cli._create_parser() + import pytest + + with pytest.raises(SystemExit): + parser.parse_args(["build"]) + + +def test_help_epilog_does_not_advertise_build_shortcut(): + parser = cli._create_parser() + epilog = parser.epilog or "" + # "build project build" のショートカット広告が無いこと + assert "project build" not in epilog + # 残りのショートカット広告は維持 + assert "project up" in epilog + assert "project scale" in epilog + + +def test_project_build_subcommand_still_available(): + # project build / container build サブコマンド自体は削除していない + parser = cli._create_parser() + ns = parser.parse_args(["project", "build", "myimage"]) + assert ns.command == "project" + assert ns.subcommand == "build" + assert ns.image == "myimage" + + +def test_wrapper_routes_build_to_shell_not_python(): + # bin/devbase の dispatch で build は shell の cmd_build に委譲され、 + # Python 用 run_python の case には含まれないことを確認する。 + wrapper = (Path(__file__).resolve().parents[2] / "bin" / "devbase").read_text() + # build は専用の shell ケースへ (PLAN06 Task 2 で name strip 後の _DEVBASE_ARGS + # を渡す形に変更。引数は wrapper 側の name 解決で既にコマンド/名を除去済み)。 + assert "build) cmd_build" in wrapper or "build) cmd_build" in wrapper + # run_python に委譲する case 行に build が紛れ込んでいないこと + for line in wrapper.splitlines(): + if "run_python" in line and "${_resolved_cmd}" in line: + assert "build" not in line diff --git a/tests/cli/test_project_dispatch.py b/tests/cli/test_project_dispatch.py new file mode 100644 index 0000000..bec846b --- /dev/null +++ b/tests/cli/test_project_dispatch.py @@ -0,0 +1,326 @@ +"""PLAN06 Task 1: `project` サブコマンド group / 共有ハンドラ / `container` 非推奨委譲のテスト + +PR1 の範囲は Python レベルのリネーム + 委譲のみ（wrapper の cd / name 解決は PR2）。 +ここでは parser の構造・prefix 解決・dispatch ルーティング・非推奨 warning を検証する。 +""" + +from __future__ import annotations + +import logging +import sys +import types + +import pytest + +from devbase import cli + + +# --------------------------------------------------------------------------- +# parser: project サブコマンド群と [name] positional +# --------------------------------------------------------------------------- + +LIFECYCLE_SUBCMDS = ['up', 'down', 'ps', 'login', 'logs', 'scale', 'build'] + + +@pytest.mark.parametrize('sub', LIFECYCLE_SUBCMDS) +def test_create_parser_accepts_project_subcommands(sub): + parser = cli._create_parser() + argv = ['project', sub] + if sub == 'scale': + argv.append('1') # scale は new_scale (必須) を要求する + args = parser.parse_args(argv) + assert args.command == 'project' + assert args.subcommand == sub + + +def test_project_up_accepts_optional_name(): + parser = cli._create_parser() + with_name = parser.parse_args(['project', 'up', 'carmo']) + assert with_name.subcommand == 'up' + assert with_name.name == 'carmo' + + without_name = parser.parse_args(['project', 'up']) + assert without_name.name is None + + +def test_project_scale_positional_is_unambiguous(): + """`[name]` optional + `new_scale` 必須 int の組合せが曖昧にならない。""" + parser = cli._create_parser() + + only_scale = parser.parse_args(['project', 'scale', '3']) + assert only_scale.name is None + assert only_scale.new_scale == 3 + + name_and_scale = parser.parse_args(['project', 'scale', 'carmo', '3']) + assert name_and_scale.name == 'carmo' + assert name_and_scale.new_scale == 3 + + +# --------------------------------------------------------------------------- +# prefix 解決: project を 3 箇所同期した結果の検証 +# --------------------------------------------------------------------------- + +def test_expand_argv_resolves_project_command_prefix(monkeypatch): + """`devbase pr ...` は一意なので `project` に解決される。""" + monkeypatch.setattr(sys, 'argv', ['devbase', 'pr', 'up']) + cli._expand_argv() + assert sys.argv[1] == 'project' + + +def test_expand_argv_resolves_project_subcommand_prefix(monkeypatch): + """`devbase project u` は `up` に解決される (SUBCMD_MAP に project を追加した結果)。""" + monkeypatch.setattr(sys, 'argv', ['devbase', 'project', 'u']) + cli._expand_argv() + assert sys.argv == ['devbase', 'project', 'up'] + + +# --------------------------------------------------------------------------- +# container.py: 共有 lifecycle dispatcher と非推奨委譲 +# --------------------------------------------------------------------------- + +def _args(**kwargs): + return types.SimpleNamespace(**kwargs) + + +def test_cmd_project_delegates_to_lifecycle(monkeypatch): + from devbase.commands import container + captured = {} + + def fake_lifecycle(args): + captured['args'] = args + return 0 + + monkeypatch.setattr(container, '_dispatch_lifecycle', fake_lifecycle) + args = _args(subcommand='ps') + assert container.cmd_project(args) == 0 + assert captured['args'] is args + + +def test_cmd_container_warns_and_delegates(monkeypatch, caplog): + from devbase.commands import container + monkeypatch.setattr(container, '_dispatch_lifecycle', lambda args: 0) + args = _args(subcommand='ps') + with caplog.at_level(logging.WARNING, logger='devbase.commands.container'): + assert container.cmd_container(args) == 0 + assert any('非推奨' in r.message for r in caplog.records), \ + '`container` は非推奨 warning を出さなければならない' + + +def test_cmd_project_does_not_warn(monkeypatch, caplog): + from devbase.commands import container + monkeypatch.setattr(container, '_dispatch_lifecycle', lambda args: 0) + args = _args(subcommand='ps') + with caplog.at_level(logging.WARNING, logger='devbase.commands.container'): + container.cmd_project(args) + assert not any('非推奨' in r.message for r in caplog.records), \ + '`project` は非推奨 warning を出してはならない' + + +def test_lifecycle_passes_name_to_cmd_up(monkeypatch): + """`project up ` の name は project_name として up に伝播する。""" + from devbase.commands import container + captured = {} + # name 解決 (chdir) は別テストで検証するためここでは no-op 化し、伝播のみ見る。 + monkeypatch.setattr(container, '_resolve_project_name', lambda name: True) + monkeypatch.setattr(container, 'cmd_up', + lambda project_name=None, scale=None: + captured.update(project_name=project_name) or 0) + args = _args(subcommand='up', name='carmo', scale=None) + assert container._dispatch_lifecycle(args) == 0 + assert captured['project_name'] == 'carmo' + + +def test_lifecycle_container_path_has_no_name(monkeypatch): + """container 経路には name 属性が無く、従来通り project_name=None になる。""" + from devbase.commands import container + captured = {} + monkeypatch.setattr(container, 'cmd_up', + lambda project_name=None, scale=None: + captured.update(project_name=project_name) or 0) + args = _args(subcommand='up', scale=None) # name 属性なし + assert container._dispatch_lifecycle(args) == 0 + assert captured['project_name'] is None + + +# --------------------------------------------------------------------------- +# _dispatch_lifecycle: name 解決 (PR2 で wrapper cd の Python フォールバックを実装) +# name 指定時は handler 呼び出し前に _resolve_project_name で chdir する。 +# 解決失敗時は handler を呼ばずに 1 を返す。詳細な解決ロジックは +# test_project_name_resolution.py を参照。 +# --------------------------------------------------------------------------- + +def test_lifecycle_resolves_name_before_handler(monkeypatch): + """name 指定時は handler 前に _resolve_project_name を呼ぶ。""" + from devbase.commands import container + order = [] + monkeypatch.setattr(container, '_resolve_project_name', + lambda name: order.append(('resolve', name)) or True) + monkeypatch.setattr(container, 'cmd_up', + lambda project_name=None, scale=None: + order.append(('up', project_name)) or 0) + args = _args(subcommand='up', name='carmo', scale=None) + assert container._dispatch_lifecycle(args) == 0 + assert order == [('resolve', 'carmo'), ('up', 'carmo')] + + +def test_lifecycle_aborts_when_name_unresolved(monkeypatch): + """name 解決に失敗したら handler を呼ばず 1 を返す。""" + from devbase.commands import container + called = [] + monkeypatch.setattr(container, '_resolve_project_name', lambda name: False) + monkeypatch.setattr(container, 'cmd_up', + lambda project_name=None, scale=None: + called.append('up') or 0) + args = _args(subcommand='up', name='bogus', scale=None) + assert container._dispatch_lifecycle(args) == 1 + assert called == [], '解決失敗時は handler を呼んではならない' + + +def test_lifecycle_no_resolution_without_name(monkeypatch): + """name 未指定なら _resolve_project_name を呼ばない。""" + from devbase.commands import container + resolved = [] + monkeypatch.setattr(container, '_resolve_project_name', + lambda name: resolved.append(name) or True) + monkeypatch.setattr(container, 'cmd_up', lambda project_name=None, scale=None: 0) + args = _args(subcommand='up', scale=None) # name 属性なし + assert container._dispatch_lifecycle(args) == 0 + assert resolved == [] + + +# --------------------------------------------------------------------------- +# cli._dispatch: ルーティング +# --------------------------------------------------------------------------- + +def test_dispatch_project_routes_to_cmd_project(monkeypatch): + from devbase.commands import container + calls = [] + monkeypatch.setattr(container, 'cmd_project', lambda args: calls.append('project') or 0) + args = _args(command='project', subcommand='ps') + assert cli._dispatch('project', args) == 0 + assert calls == ['project'] + + +def test_dispatch_container_routes_to_cmd_container(monkeypatch): + from devbase.commands import container + calls = [] + monkeypatch.setattr(container, 'cmd_container', lambda args: calls.append('container') or 0) + args = _args(command='container', subcommand='ps') + assert cli._dispatch('container', args) == 0 + assert calls == ['container'] + + +def test_dispatch_shortcut_routes_to_cmd_project_not_container(monkeypatch): + """トップレベルショートカット (up 等) は非推奨の container ではなく project へ。""" + from devbase.commands import container + calls = [] + monkeypatch.setattr(container, 'cmd_project', lambda args: calls.append('project') or 0) + monkeypatch.setattr(container, 'cmd_container', lambda args: calls.append('container') or 0) + args = _args(command='up') + assert cli._dispatch('up', args) == 0 + assert calls == ['project'] + + +# --------------------------------------------------------------------------- +# parser: 共通サブコマンド (login / build) の project / container 一致 +# (重複定義を _add_login_subparser / _add_build_subparser に共通化した結果の検証) +# --------------------------------------------------------------------------- + +@pytest.mark.parametrize('group', ['project', 'container']) +def test_login_positional_is_index_in_both_groups(group): + """login は project / container いずれでも単一 positional を index として扱う。""" + parser = cli._create_parser() + args = parser.parse_args([group, 'login', '2']) + assert args.subcommand == 'login' + assert args.index == '2' + # name positional は存在しない (曖昧さ回避) + assert not hasattr(args, 'name') + + +@pytest.mark.parametrize('group', ['project', 'container']) +def test_login_index_defaults_in_both_groups(group): + parser = cli._create_parser() + args = parser.parse_args([group, 'login']) + assert args.index == '1' + + +@pytest.mark.parametrize('group', ['project', 'container']) +def test_build_positional_is_image_in_both_groups(group): + """build は project / container いずれでも単一 positional を image として扱う。""" + parser = cli._create_parser() + args = parser.parse_args([group, 'build', 'web']) + assert args.subcommand == 'build' + assert args.image == 'web' + assert not hasattr(args, 'name') + + +# --------------------------------------------------------------------------- +# top-level ショートカットの [name] 受理と伝播 +# (up/down/ps/scale が project サブコマンドと同様に [name] を受理し、 +# ショートカット経由でも name が _dispatch_lifecycle まで伝播する) +# --------------------------------------------------------------------------- + +def test_shortcut_up_accepts_optional_name(): + parser = cli._create_parser() + with_name = parser.parse_args(['up', 'carmo']) + assert with_name.command == 'up' + assert with_name.name == 'carmo' + + without_name = parser.parse_args(['up']) + assert without_name.name is None + + +def test_shortcut_down_accepts_optional_name(): + parser = cli._create_parser() + args = parser.parse_args(['down', 'carmo']) + assert args.command == 'down' + assert args.name == 'carmo' + + +def test_shortcut_ps_accepts_optional_name(): + parser = cli._create_parser() + args = parser.parse_args(['ps', 'carmo', '--all']) + assert args.command == 'ps' + assert args.name == 'carmo' + assert args.all is True + + +def test_shortcut_scale_positional_is_unambiguous(): + """`scale [name] ` は project scale と同じく曖昧にならない。""" + parser = cli._create_parser() + + only_scale = parser.parse_args(['scale', '3']) + assert only_scale.name is None + assert only_scale.new_scale == 3 + + name_and_scale = parser.parse_args(['scale', 'carmo', '3']) + assert name_and_scale.name == 'carmo' + assert name_and_scale.new_scale == 3 + + +def test_shortcut_up_propagates_name_through_dispatch(monkeypatch): + """`devbase up ` の name がショートカット経由で cmd_up まで伝播する。""" + from devbase.commands import container + captured = {} + monkeypatch.setattr(container, '_resolve_project_name', lambda name: True) + monkeypatch.setattr(container, 'cmd_up', + lambda project_name=None, scale=None: + captured.update(project_name=project_name) or 0) + # ショートカット parser が生成する namespace を再現 (name 属性を持つ) + args = _args(command='up', name='carmo', scale=None) + assert cli._dispatch('up', args) == 0 + assert captured['project_name'] == 'carmo' + + +def test_shortcut_scale_propagates_name_through_dispatch(monkeypatch): + """`devbase scale N` の name がショートカット経由で cmd_scale まで伝播する。""" + from devbase.commands import container + captured = {} + monkeypatch.setattr(container, '_resolve_project_name', lambda name: True) + monkeypatch.setattr(container, 'cmd_scale', + lambda new_scale=None, project_name=None: + captured.update(project_name=project_name, new_scale=new_scale) or 0) + args = _args(command='scale', name='carmo', new_scale=3) + assert cli._dispatch('scale', args) == 0 + assert captured['project_name'] == 'carmo' + assert captured['new_scale'] == 3 diff --git a/tests/cli/test_project_name_resolution.py b/tests/cli/test_project_name_resolution.py new file mode 100644 index 0000000..61b5eb8 --- /dev/null +++ b/tests/cli/test_project_name_resolution.py @@ -0,0 +1,319 @@ +"""PLAN06 Task 2: プロジェクト名解決 (wrapper cd + Python フォールバック) のテスト。 + +検証対象: + - Python `container._resolve_project_name`: $DEVBASE_ROOT/projects/ への + chdir + COMPOSE_PROJECT_NAME 上書き、存在しない name のエラー + 候補提示。 + - wrapper (bin/devbase): project/container サブコマンド及びトップレベルシノニムで + 実在するプロジェクト名のみ cd + argv strip し、login / build / + scale の既存 positional と曖昧にならないこと (存在性ベースの判定)。 + +wrapper テストは実際の `uv run` を避けるため run_python / cmd_build をスタブに +差し替え、DEVBASE_ROOT を一時ディレクトリへ向けた薄いハーネスで dispatch のみ +実行する (wrapper 末尾の DEVBASE_ROOT 自動解決行も sed で除去する)。 +""" + +from __future__ import annotations + +import logging +import os +import subprocess +import sys +from pathlib import Path + +import pytest + +from devbase.commands import container + +REPO_ROOT = Path(__file__).resolve().parents[2] +WRAPPER = REPO_ROOT / "bin" / "devbase" + + +# =========================================================================== +# Python: _resolve_project_name +# =========================================================================== + +@pytest.fixture +def fake_root(tmp_path, monkeypatch): + """projects/carmo を持つ一時 DEVBASE_ROOT を用意し、CWD/環境を復元する。""" + (tmp_path / "projects" / "carmo").mkdir(parents=True) + (tmp_path / "projects" / "shop").mkdir(parents=True) + monkeypatch.setenv("DEVBASE_ROOT", str(tmp_path)) + monkeypatch.delenv("COMPOSE_PROJECT_NAME", raising=False) + origin = Path.cwd() + monkeypatch.chdir(tmp_path) + yield tmp_path + os.chdir(origin) + + +def test_resolve_chdirs_into_project(fake_root): + assert container._resolve_project_name("carmo") is True + assert Path.cwd().resolve() == (fake_root / "projects" / "carmo").resolve() + assert os.environ["COMPOSE_PROJECT_NAME"] == "carmo" + + +def test_resolve_unknown_name_errors_with_candidates(fake_root, caplog): + with caplog.at_level(logging.ERROR, logger="devbase.commands.container"): + assert container._resolve_project_name("nope") is False + messages = " ".join(r.message for r in caplog.records) + assert "nope" in messages + # 候補一覧に既存プロジェクトが提示される + assert "carmo" in messages and "shop" in messages + + +def test_report_unknown_truncates_many_candidates(tmp_path, monkeypatch, caplog): + """候補が上限を超える場合は先頭 N 件 + 「... 他 M 件」に truncate される。""" + projects_dir = tmp_path / "projects" + projects_dir.mkdir() + total = container._MAX_PROJECT_CANDIDATES + 5 + # ゼロ埋めで sorted 順を安定させる (p000, p001, ...)。 + for i in range(total): + (projects_dir / f"p{i:03d}").mkdir() + + monkeypatch.setenv("DEVBASE_ROOT", str(tmp_path)) + with caplog.at_level(logging.ERROR, logger="devbase.commands.container"): + container._report_unknown_project("nope", projects_dir) + + messages = " ".join(r.message for r in caplog.records) + # 先頭 N 件は表示される + assert "p000" in messages + assert f"p{container._MAX_PROJECT_CANDIDATES - 1:03d}" in messages + # 上限超過分は表示されず、省略表記に集約される + assert f"p{container._MAX_PROJECT_CANDIDATES:03d}" not in messages + assert f"... 他 {total - container._MAX_PROJECT_CANDIDATES} 件" in messages + + +def test_report_unknown_no_truncation_when_within_limit(tmp_path, monkeypatch, caplog): + """候補が上限以内なら省略表記は付かず全件表示される。""" + projects_dir = tmp_path / "projects" + projects_dir.mkdir() + for n in ("carmo", "shop"): + (projects_dir / n).mkdir() + + monkeypatch.setenv("DEVBASE_ROOT", str(tmp_path)) + with caplog.at_level(logging.ERROR, logger="devbase.commands.container"): + container._report_unknown_project("nope", projects_dir) + + messages = " ".join(r.message for r in caplog.records) + assert "carmo" in messages and "shop" in messages + assert "他" not in messages + + +def test_resolve_without_devbase_root(tmp_path, monkeypatch, caplog): + monkeypatch.delenv("DEVBASE_ROOT", raising=False) + with caplog.at_level(logging.ERROR, logger="devbase.commands.container"): + assert container._resolve_project_name("carmo") is False + assert any("DEVBASE_ROOT" in r.message for r in caplog.records) + + +def test_resolve_noop_when_already_in_target(fake_root, monkeypatch): + """wrapper が既に cd 済みなら chdir を呼ばない (冪等)。""" + target = fake_root / "projects" / "carmo" + monkeypatch.chdir(target) + + called = [] + monkeypatch.setattr(container.os, "chdir", lambda p: called.append(p)) + assert container._resolve_project_name("carmo") is True + assert called == [], "既に対象ディレクトリにいる場合 chdir は呼ばれない" + assert os.environ["COMPOSE_PROJECT_NAME"] == "carmo" + + +def test_resolve_loads_project_env(fake_root, monkeypatch): + """wrapper を経ない直接起動でも project env が os.environ へ反映される。 + + gemini round2 minor 指摘 (wrapper の `source ./env` 相当) の回帰テスト。 + """ + monkeypatch.delenv("CONTAINER_SCALE", raising=False) + monkeypatch.delenv("CUSTOM_VAR", raising=False) + env_path = fake_root / "projects" / "carmo" / "env" + env_path.write_text( + "# comment line\n" + "\n" + "CONTAINER_SCALE=5\n" + "export CUSTOM_VAR=hello\n" + 'QUOTED="dq value"\n' + "SQUOTED='sq value'\n" + ) + + assert container._resolve_project_name("carmo") is True + assert os.environ["CONTAINER_SCALE"] == "5" + assert os.environ["CUSTOM_VAR"] == "hello" + assert os.environ["QUOTED"] == "dq value" + assert os.environ["SQUOTED"] == "sq value" + # name 指定は env 由来値より優先される + assert os.environ["COMPOSE_PROJECT_NAME"] == "carmo" + + +def test_resolve_env_name_overrides_env_file_compose_project_name(fake_root, monkeypatch): + """env に COMPOSE_PROJECT_NAME があっても name 指定が優先される。""" + monkeypatch.setenv("COMPOSE_PROJECT_NAME", "stale") + env_path = fake_root / "projects" / "carmo" / "env" + env_path.write_text("COMPOSE_PROJECT_NAME=from_env\n") + + assert container._resolve_project_name("carmo") is True + assert os.environ["COMPOSE_PROJECT_NAME"] == "carmo" + + +def test_resolve_missing_env_file_is_noop(fake_root): + """env ファイルが無くても解決は成功する (フォールバックの堅牢性)。""" + assert not (fake_root / "projects" / "carmo" / "env").exists() + assert container._resolve_project_name("carmo") is True + assert os.environ["COMPOSE_PROJECT_NAME"] == "carmo" + + +# =========================================================================== +# wrapper: cd + argv strip + 存在性ベースの曖昧性回避 +# =========================================================================== + +def _run_wrapper(args, devbase_root): + """run_python / cmd_build をスタブ化し wrapper の dispatch だけを実行する。 + + - run_python -> "PWD:" と "PYTHON:" を出力 + - cmd_build -> "PWD:" と "BUILD:" を出力 + 実際の wrapper が DEVBASE_ROOT を自身のパスから再計算してしまうため、その + 代入行 (`DEVBASE_ROOT=...`) も sed で除去し、環境変数で渡した値を使わせる。 + """ + harness = ( + 'run_python() { echo "PWD:$PWD"; echo "PYTHON:$*"; exit 0; }\n' + 'cmd_build() { echo "PWD:$PWD"; echo "BUILD:$*"; exit 0; }\n' + 'ensure_uv() { :; }\n' + 'eval "$(sed -e \'/^run_python()/,/^}/d\' ' + ' -e \'/^ensure_uv()/,/^}/d\' ' + ' -e \'/^cmd_build()/,/^}/d\' ' + ' -e \'/^DEVBASE_ROOT=/d\' "$WRAPPER_PATH")"\n' + ) + env = { + **os.environ, + "DEVBASE_ROOT": str(devbase_root), + "WRAPPER_PATH": str(WRAPPER), + } + return subprocess.run( + ["bash", "-c", harness, "devbase", *args], + capture_output=True, + text=True, + env=env, + cwd=str(REPO_ROOT), + ) + + +@pytest.fixture +def wrapper_root(tmp_path): + (tmp_path / "projects" / "carmo").mkdir(parents=True) + return tmp_path + + +def _pwd(result): + for line in result.stdout.splitlines(): + if line.startswith("PWD:"): + return line[len("PWD:"):] + return None + + +def _python_args(result): + for line in result.stdout.splitlines(): + if line.startswith("PYTHON:"): + return line[len("PYTHON:"):] + return None + + +def _build_args(result): + for line in result.stdout.splitlines(): + if line.startswith("BUILD:"): + return line[len("BUILD:"):] + return None + + +def test_wrapper_project_up_name_cds_and_strips(wrapper_root): + r = _run_wrapper(["project", "up", "carmo"], wrapper_root) + assert "unknown command" not in r.stderr.lower(), r.stderr + assert _pwd(r).endswith("/projects/carmo"), r.stdout + # name は strip され Python へは渡らない + assert _python_args(r) == "project up", r.stdout + + +def test_wrapper_shortcut_up_name_cds_and_strips(wrapper_root): + r = _run_wrapper(["up", "carmo"], wrapper_root) + assert _pwd(r).endswith("/projects/carmo"), r.stdout + assert _python_args(r) == "up", r.stdout + + +def test_wrapper_unknown_name_not_stripped_no_cd(wrapper_root): + """存在しない name は cd せず素通し (Python 側でエラー処理させる)。""" + r = _run_wrapper(["up", "bogus"], wrapper_root) + assert not _pwd(r).endswith("/projects/bogus"), r.stdout + assert _python_args(r) == "up bogus", r.stdout + + +def test_wrapper_build_name_cds_via_shell(wrapper_root): + """build は shell cmd_build 経路。wrapper cd で対象プロジェクトへ移動する。""" + r = _run_wrapper(["build", "carmo"], wrapper_root) + assert _pwd(r).endswith("/projects/carmo"), r.stdout + assert _build_args(r) == "", r.stdout # name は strip + + +def test_wrapper_build_flag_not_treated_as_name(wrapper_root): + """`build --no-cache` のフラグは name とみなさず CWD でビルド。""" + r = _run_wrapper(["build", "--no-cache"], wrapper_root) + assert not _pwd(r).endswith("/projects/"), r.stdout + assert _build_args(r) == "--no-cache", r.stdout + + +def test_wrapper_scale_name_disambiguation(wrapper_root): + """`scale carmo 3` は name+N、`scale 3` は N のみ (存在性で判定)。""" + r1 = _run_wrapper(["scale", "carmo", "3"], wrapper_root) + assert _pwd(r1).endswith("/projects/carmo"), r1.stdout + assert _python_args(r1) == "scale 3", r1.stdout + + r2 = _run_wrapper(["scale", "3"], wrapper_root) + assert not _pwd(r2).endswith("/projects/3"), r2.stdout + assert _python_args(r2) == "scale 3", r2.stdout + + +def test_wrapper_login_index_not_treated_as_name(wrapper_root): + """`login 2` の 2 は index。projects/2 が無いので cd せず素通し。""" + r = _run_wrapper(["login", "2"], wrapper_root) + assert _python_args(r) == "login 2", r.stdout + + # 一方 `login carmo` は実在プロジェクトなので cd + strip (index=1 既定) + r2 = _run_wrapper(["login", "carmo"], wrapper_root) + assert _pwd(r2).endswith("/projects/carmo"), r2.stdout + assert _python_args(r2) == "login", r2.stdout + + +def test_wrapper_project_scale_name_strips_keeps_subcommand(wrapper_root): + r = _run_wrapper(["project", "scale", "carmo", "3"], wrapper_root) + assert _pwd(r).endswith("/projects/carmo"), r.stdout + assert _python_args(r) == "project scale 3", r.stdout + + +def test_wrapper_no_name_uses_cwd(wrapper_root): + """name を渡さなければ cd せず従来通り (引数素通し)。""" + r = _run_wrapper(["project", "up"], wrapper_root) + assert _python_args(r) == "project up", r.stdout + + +def test_wrapper_project_build_keeps_image_positional(wrapper_root): + """`project build carmo` の carmo は image positional。 + + `project build` parser は name を持たず image を取る (cli.py 参照)。実在 + プロジェクト名 carmo が image と衝突しても name strip せず素通しし、Python + 側で image=carmo として解釈させる (codex 指摘の衝突回避)。 + """ + r = _run_wrapper(["project", "build", "carmo"], wrapper_root) + # cd せず (image 解決は Python 側)、carmo を strip しない + assert not _pwd(r).endswith("/projects/carmo"), r.stdout + assert _python_args(r) == "project build carmo", r.stdout + + +def test_wrapper_project_login_keeps_index_positional(wrapper_root): + """`project login carmo` の carmo は index positional として素通しする。 + + `project login` parser は name を持たず index を取る。実在プロジェクト名と + 一致しても name strip せず、Python パーサに委ねる (codex 指摘の衝突回避)。 + """ + r = _run_wrapper(["project", "login", "carmo"], wrapper_root) + assert not _pwd(r).endswith("/projects/carmo"), r.stdout + assert _python_args(r) == "project login carmo", r.stdout + + +if __name__ == "__main__": + sys.exit(pytest.main([__file__, "-v"])) diff --git a/tests/cli/test_wrapper_dispatch.py b/tests/cli/test_wrapper_dispatch.py new file mode 100644 index 0000000..de1e187 --- /dev/null +++ b/tests/cli/test_wrapper_dispatch.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python3 +"""bin/devbase wrapper の command dispatch のテスト。 + +`project` サブコマンドが wrapper の resolve_command 候補と case dispatch に +含まれており、`devbase project ...` が Python 実装へルーティングされることを +検証する (含まれていないと `*)` 節で `unknown command` で終了してしまう)。 + +実際の `uv run` を起動すると環境依存になるため、run_python / ensure_uv を +差し替えた薄いハーネス経由で wrapper の dispatch ロジックだけを実行する。 +""" + +import os +import subprocess +import sys +from pathlib import Path + +import pytest + +REPO_ROOT = Path(__file__).resolve().parents[2] +WRAPPER = REPO_ROOT / "bin" / "devbase" + + +def _run_wrapper(*args): + """run_python を no-op に差し替えて wrapper の dispatch だけを実行する。 + + wrapper を関数定義のみ読み込む形にできないため、`run_python` / + `ensure_uv` を export -f で先に定義し、wrapper 末尾の dispatch を + 別プロセスで評価する。wrapper は自身の run_python を再定義するので、 + `sed` で wrapper の run_python / ensure_uv 定義を取り除いてから評価する。 + """ + harness = ( + 'run_python() { echo "PYTHON:$*"; exit 0; }\n' + 'ensure_uv() { :; }\n' + # wrapper から関数再定義を除いた本体を読み込む + 'eval "$(sed -e \'/^run_python()/,/^}/d\' ' + '-e \'/^ensure_uv()/,/^}/d\' "$WRAPPER_PATH")"\n' + ) + env = { + **os.environ, + "DEVBASE_ROOT": str(REPO_ROOT), + "WRAPPER_PATH": str(WRAPPER), + } + return subprocess.run( + ["bash", "-c", harness, "devbase", *args], + capture_output=True, + text=True, + env=env, + ) + + +class TestWrapperStaticContent: + """静的に project が両所に登録されていることを確認 (回帰防止)。""" + + def test_project_in_resolve_command_list(self): + text = WRAPPER.read_text() + # resolve_command の候補リスト + assert " project " in text.split('local commands="', 1)[1].split('"', 1)[0] + " " + + def test_project_in_dispatch_case(self): + text = WRAPPER.read_text() + # Python-implemented commands の case ラベルに project が含まれる + case_labels = [ + line for line in text.splitlines() + if "run_python " in line and "_resolved_cmd" in line + ] + # 直前行 (case パターン) に project があること + assert any("project|" in line or "|project|" in line + for line in text.splitlines()) + + +class TestWrapperDispatch: + def test_project_reaches_python(self): + result = _run_wrapper("project", "--help") + assert "unknown command" not in result.stderr.lower(), result.stderr + assert "PYTHON:project --help" in result.stdout, result.stdout + + def test_project_subcommand_reaches_python(self): + result = _run_wrapper("project", "up") + assert "unknown command" not in result.stderr.lower(), result.stderr + assert "PYTHON:project up" in result.stdout, result.stdout + + def test_project_prefix_resolves_to_project(self): + # `proj` は project に一意に解決される。 + result = _run_wrapper("proj", "up") + assert "unknown command" not in result.stderr.lower(), result.stderr + assert "PYTHON:project up" in result.stdout, result.stdout + + def test_unknown_command_still_errors(self): + result = _run_wrapper("bogus") + assert "unknown command" in result.stderr.lower() + assert result.returncode != 0 + + +if __name__ == "__main__": + sys.exit(pytest.main([__file__, "-v"]))