Haitao Pan
87bf91d655
postgresql_deploy_mode defaults to compose (Docker) and the admin password is generated via a /root password-file lookup, both of which fail on a native macOS deploy (no Docker, /root not writable). The role already ships a native path (macos.yml, Homebrew postgresql@16). In the script's Darwin block, set postgresql_deploy_mode=native and pass postgresql_admin_password directly (highest-precedence extra-var, bypassing the /root lookup). Linux unchanged. Documents TC-MAC-017.
176 lines
14 KiB
Markdown
176 lines
14 KiB
Markdown
# macOS 兼容性部署测试用例
|
||
|
||
本文档记录了在 macOS (Darwin) 环境下进行 `setup-ai-workspace-all-in-one.sh` 全自动部署时遇到的跨平台兼容性问题及修复方案。
|
||
|
||
## 核心背景
|
||
|
||
原脚本和 Ansible Playbooks 是为 Debian/Ubuntu Linux 设计的，强依赖 `root` 权限、`apt` 包管理器、系统目录（`/usr/local/sbin`、`/etc/systemd`）及默认用户路径（`/home/ubuntu`）。在 macOS 无提权模式下部署，触发了大量权限与路径异常。
|
||
|
||
---
|
||
|
||
## TC-MAC-001: TTYD 二进制与路径异常
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `setup-ai-workspace-all-in-one.sh` |
|
||
| **触发报错** | 脚本尝试下载 ttyd 二进制写入 `/usr/local/bin/ttyd`，无权限且架构不匹配 |
|
||
| **修复方案** | Darwin 下拦截二进制下载，改用 `brew install ttyd`；使用 `command -v ttyd` 动态解析路径 |
|
||
|
||
## TC-MAC-002: 全局提权 (Sudo) 阻塞
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `setup-ai-workspace-all-in-one.sh` → Ansible Playbook |
|
||
| **触发报错** | `sudo: a password is required` |
|
||
| **修复方案** | Darwin 下注入 `--extra-vars "ansible_become=false"` 取消自动提权 |
|
||
|
||
## TC-MAC-003: 默认用户组分配失败
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `setup-xworkspace-console.yaml` |
|
||
| **触发报错** | `chown` 找不到 `ubuntu` 组 |
|
||
| **修复方案** | 条件渲染：`"{{ 'staff' if ansible_os_family == 'Darwin' else 'ubuntu' }}"` |
|
||
|
||
## TC-MAC-004: 写死绝对路径 (Hardcoded Paths)
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `setup-xworkspace-console.yaml` 头部变量区 |
|
||
| **触发报错** | `cd /home/ubuntu/xworkspace-console/dashboard: No such file or directory` |
|
||
| **修复方案** | 将 `xworkspace_console_home` 重构为 `{{ ansible_env.HOME }}`, 所有派生目录链式求值 |
|
||
|
||
## TC-MAC-005: 模板引擎渲染异常 (Undefined Variable)
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `console.plist.j2` |
|
||
| **触发报错** | `AnsibleUndefinedVariable: 'nodejs_version' is undefined` |
|
||
| **修复方案** | 移除 NVM 环境初始化和 `nodejs_version` 依赖，直接追加 `/opt/homebrew/bin` 至 PATH |
|
||
|
||
## TC-MAC-006: NPM 全局助手脚本安装拒绝
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/ai_agent_runtime/tasks/nodejs.yml` |
|
||
| **触发报错** | `chown failed: [Errno 1] Operation not permitted: '/usr/local/sbin/...'` |
|
||
| **修复方案** | macOS 下安装路径降级至 `~/.local/bin`，前置创建目录，关闭 `become` |
|
||
|
||
## TC-MAC-007: Playwright 硬编码关联调用失败
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/ai_agent_runtime/tasks/nodejs.yml` |
|
||
| **触发报错** | `[Errno 13] Permission denied: '/usr/local/sbin/ai-workspace-manage-npm-global-package'` |
|
||
| **修复方案** | 所有 `cmd` 中统一使用条件路径语句 |
|
||
|
||
## TC-MAC-008: Apt 浏览器安装崩溃
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/ai_agent_runtime/tasks/browser.yml` |
|
||
| **触发报错** | `[Errno 2] No such file or directory: b'update'`（macOS 无 apt） |
|
||
| **修复方案** | 增加 `when: ansible_os_family != 'Darwin'`；补充 macOS Chrome 探测路径；环境变量脚本路径改为用户目录 |
|
||
|
||
## TC-MAC-009: Playwright 环境变量挂载目录缺失
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/ai_agent_runtime/tasks/browser.yml` |
|
||
| **触发报错** | `Destination directory ~/.local/state/ai-workspace/env does not exist` |
|
||
| **修复方案** | 前置创建 env 目录；变量增加 `default(ansible_env.HOME)` 容错 |
|
||
|
||
## TC-MAC-010: Agent Skills 角色硬编码路径与用户
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/agent_skills/defaults/main.yml`、`roles/agent_skills/tasks/main.yml` |
|
||
| **触发报错** | `[Errno 45] Operation not supported: b'/home/ubuntu'` |
|
||
| **修复方案** | defaults 全部改为 `ansible_env.USER/HOME`；apt rsync 安装增加 Darwin 跳过 |
|
||
|
||
## TC-MAC-011: Chromium 版本检查路径含空格
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/ai_agent_runtime/tasks/verify.yml` |
|
||
| **触发报错** | `No such file or directory: b'/Applications/Google'`（路径含空格被拆分） |
|
||
| **修复方案** | `ansible.builtin.command` 改用 `argv` 列表形式传参，避免空格截断 |
|
||
|
||
## TC-MAC-012: XWorkMate Bridge 基础目录写入系统路径被拒
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `setup-ai-workspace-all-in-one.sh` → `roles/vhosts/xworkmate_bridge`（变量 `xworkmate_bridge_base_dir`） |
|
||
| **触发报错** | `TASK [roles/vhosts/xworkmate_bridge/ : Ensure xworkmate-bridge base directory exists]` → `There was an issue creating /opt/cloud-neutral as requested: [Errno 13] Permission denied: b'/opt/cloud-neutral'` |
|
||
| **根因** | `xworkmate_bridge_base_dir` 默认硬编码为 `/opt/cloud-neutral/xworkmate-bridge`，macOS 以 `ansible_become=false` 运行，无权写入 `/opt`；且 `/opt` 并非 macOS 标准目录。该 base dir 同时被 `config.yaml`、launchd plist 的 `WorkingDirectory` 引用 |
|
||
| **目录策略** | Linux 保持 `/opt/cloud-neutral/xworkmate-bridge`；macOS 改用 Apple 标准的用户级应用数据目录 `~/Library/Application Support/cloud-neutral/xworkmate-bridge` |
|
||
| **修复方案** | 双层：①`setup-ai-workspace-all-in-one.sh` 的 Darwin 分支注入 `-e xworkmate_bridge_base_dir="$HOME/Library/Application Support/cloud-neutral/xworkmate-bridge"`（`curl \| bash` 拉取的是本仓库脚本，playbooks 来自独立仓库，故脚本侧 `-e` 是该路径下唯一可生效的修复点）；②role `defaults/main.yml` 将默认值改为按 `ansible_os_family` 的三元表达式，使离线/本地 playbook 路径亦正确 |
|
||
| **生效前提** | `curl \| bash` 从 GitHub `main` 拉取脚本，修复必须先 push 到 `ai-workspace-lab/xworkspace-console` 的 `main`；否则远端仍是旧脚本（extra-vars 优先级最高，若 `-e` 已执行则绝不会回落到 `/opt`，由此可判定执行的是未修复的远端脚本） |
|
||
|
||
## TC-MAC-013: Vault standalone 目录写入系统路径被拒
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/vhosts/vault/tasks/main.yml`、`roles/vhosts/vault/vars/main.yml`、`roles/vhosts/vault/tasks/macos.yml` |
|
||
| **触发报错** | `TASK [roles/vhosts/vault/ : Ensure standalone Vault directories exist]` → `[Errno 13] Permission denied: b'/etc/vault.d'`、`b'/opt/vault'` |
|
||
| **根因** | “Ensure standalone Vault directories exist” 任务以 `owner: root` 创建 `/etc/vault.d` 与 `/opt/vault/data`，且**缺失** vault 角色其余 standalone 任务都带的 `ansible_os_family != 'Darwin'` 守卫。macOS 以 `become=false` 运行，既无权写 `/etc`、`/opt`，`owner: root` 的 chown 也无法完成。与 bridge 不同（其目录 owner 为服务用户，可由 `-e` 修复），该任务的 `owner: root` 为硬编码，无法用 extra-vars 覆盖，必须改 role 逻辑 |
|
||
| **目录策略** | Linux 保持 `/etc/vault.d`、`/opt/vault/data`；macOS 改用 Apple 标准 `~/Library/Application Support/vault`、`~/Library/Application Support/vault/data`；二进制路径 macOS 取 `/opt/homebrew/bin/vault`（brew 安装位置），免去需 sudo 的 `/usr/local/bin` 软链依赖 |
|
||
| **修复方案** | role 位于独立 playbooks 仓库，无法从本仓库直接提交；沿用脚本既有的“克隆后打补丁”机制（参见 `patch_playbook_user_systemd`），在 `setup-ai-workspace-all-in-one.sh` 新增 `patch_playbook_vault_macos()`，仅在 Darwin 下对克隆出的 vault 角色：①给目录创建任务追加 `ansible_os_family != 'Darwin'` 守卫；②把 `vault_config_dir`/`vault_data_dir`/`vault_binary_path` 改为按 OS 的三元表达式；③在 `macos.yml` 前置创建用户属主的数据目录（含 launchd 日志目录 `~/.local/state/xworkspace`）。该补丁对 `curl \| bash` 与本地执行两条路径均生效，幂等，且不改动 Linux 行为 |
|
||
|
||
## TC-MAC-014: common 角色 Linux 基线（timedatectl 等）在 macOS 失败
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/vhosts/common/tasks/main.yml` |
|
||
| **触发报错** | `TASK [common : Base | set timezone]` → `[Errno 2] No such file or directory: b'timedatectl'`（macOS 无 systemd 的 `timedatectl`） |
|
||
| **根因** | `common` 角色的 `Base | *` 系列任务是 Linux 服务器基线：`timedatectl` 设时区、改写 `/etc/hostname`、`/etc/hosts`、设主机名、加固 SSH、配置 fail2ban、调文件句柄上限、放行防火墙端口。全部 `become: true` 且依赖 Linux 专有工具/路径，在 macOS（`become=false`）下会逐条失败，`set timezone` 只是第一个 |
|
||
| **修复方案** | 经评估这些基线对 macOS 本机开发部署既不适用也无权限执行，故在 `setup-ai-workspace-all-in-one.sh` 新增 `patch_playbook_common_macos()`（同样走克隆后打补丁），仅在 Darwin 下为整个 `Base | *` 块追加 `ansible_os_family != 'Darwin'` 守卫（共 9 处：7 个任务追加 `when`，2 个已有 `when` 列表追加该条件）。`import_tasks` 的 `when` 会传播到子任务，因此 ssh 加固/fail2ban/limits/firewall 子任务一并跳过。幂等、YAML 合法、Linux 行为不变 |
|
||
| **备注** | 用户仅点名 `set timezone`，但其后的 Base 任务会以相同原因连环失败，故一并守卫以避免逐个往返 |
|
||
|
||
## TC-MAC-015: Vault 管理员初始化脚本在 macOS 缺依赖/缺 PATH
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/vhosts/vault/tasks/main.yml`（Bootstrap 任务）、`roles/vhosts/vault/files/init_vault_admin.sh`、`roles/vhosts/vault/tasks/macos.yml` |
|
||
| **触发报错** | `TASK [vault : Bootstrap Vault admin userpass auth]` 失败（`no_log: true` 隐藏详情）。vault 此时已起（健康检查已过），失败发生在执行 `init_vault_admin.sh` |
|
||
| **根因** | 脚本 `require_cmd vault/jq/curl/base64`。macOS 默认**不带 jq**，而安装 jq 的 “Install standalone Vault dependencies”（apt）任务带 `!= 'Darwin'` 守卫被跳过 → jq 缺失；同时 `ansible.builtin.script` 使用最小 PATH，未含 Homebrew 的 `/opt/homebrew/bin`，即使已 `brew install` 的 `vault`/`jq` 也可能找不到 |
|
||
| **修复方案** | 扩展 `patch_playbook_vault_macos()`：①在 `macos.yml` 增加 `brew install jq`（`creates: /opt/homebrew/bin/jq`）；②给 Bootstrap 任务追加 `environment: PATH: "/opt/homebrew/bin:/usr/local/bin:{{ ansible_env.PATH }}"`，确保脚本能找到 brew 安装的 vault/jq。脚本本身已自带 macOS 适配（`base64 -D` 探测）。补丁幂等、YAML 合法、Linux 不变 |
|
||
| **备注** | 若仍失败，可临时将该任务 `no_log` 关掉以查看 `init_vault_admin.sh` 的真实 stderr 再定位 |
|
||
|
||
## TC-MAC-016: Vault 管理员初始化非幂等（re-run 报 missing entityID）
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/vhosts/vault/files/init_vault_admin.sh` |
|
||
| **触发报错** | `Error writing data to identity/mfa/method/totp/admin-generate ... Code: 400 ... * missing entityID`，并伴随 `A login request was issued that is subject to MFA validation` |
|
||
| **根因** | 脚本通过“以该用户登录”来获取 `entity_id`（`auth/userpass/login/<user>`）。但脚本随后又创建了 userpass 的 login-MFA enforcement。dev 模式 Vault 在多次部署之间持续运行（launchd 常驻），因此**第二次及以后**的部署中该登录被 MFA 拦截，返回的不是完整 token 而是 MFA 待校验响应，`entity_id` 为空 → `admin-generate` 报 `missing entityID`。这是 re-run 幂等性缺陷，非 macOS 特有（Linux 第二次跑同样会中招） |
|
||
| **修复方案** | 不再依赖会被 MFA 拦截的登录：改为通过 userpass 的 identity **entity-alias** 解析 `entity_id`——遍历 `identity/entity-alias/id` 找到 name==用户、mount_accessor==userpass accessor 的别名取其 `canonical_id`；首次运行（无别名）则显式创建 entity + entity-alias。移除随之不再需要的 `vault token revoke`。幂等、向后兼容（能识别旧版本登录隐式创建的 entity）。已在真实 playbooks 仓库 `init_vault_admin.sh` 修复；clone 路径由 `patch_playbook_vault_macos()` 同步打补丁 |
|
||
| **定位手段** | 该任务 `no_log: true` 隐藏了错误；临时改 `no_log: false` + register + 将 stdout/stderr 写入挂载目录文件，直接读取得到真实报错 |
|
||
|
||
## TC-MAC-017: PostgreSQL 在 macOS 误用 compose 模式
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **触发文件** | `roles/vhosts/postgres/tasks/compose.yml`、`roles/vhosts/postgres/defaults/main.yml` |
|
||
| **触发报错** | `TASK [postgres : Materialize PostgreSQL admin password]` 失败（`no_log: true`）。assert `postgresql_admin_password | length > 0` 为空 |
|
||
| **根因** | `postgresql_deploy_mode` 默认 `compose`。compose.yml 走 Docker 路径（检查/安装 apt 版 docker），且 `postgresql_admin_password` 默认经 `lookup('password', '/root/.ai_workspace_postgres_password ...')` 生成——macOS 无权写 `/root`，lookup 失败 → 密码为空 → assert 失败。该角色其实已备 `native`+`macos.yml`（Homebrew postgresql@16）路径，但默认未在 macOS 切换过去 |
|
||
| **目录/模式策略** | macOS 部署 `postgresql_deploy_mode=native`（→ `macos.yml`，brew 安装）；Linux 部署保持默认 `compose` |
|
||
| **修复方案** | 在 `setup-ai-workspace-all-in-one.sh` 的 Darwin 分支注入 `-e postgresql_deploy_mode=native`，并以 `append_secret_var postgresql_admin_password=$UNIFIED_AUTH_TOKEN` 直接提供密码（extra-vars 优先级最高，彻底绕过 `/root` 的 password lookup）。Linux 分支不变 |
|
||
|
||
---
|
||
|
||
## 修复维度总结
|
||
|
||
| 维度 | 涉及用例 |
|
||
|------|---------|
|
||
| 组件获取方式替换 (brew vs binary) | TC-001 |
|
||
| 权限收缩 (become: false) | TC-002, TC-006, TC-007, TC-008, TC-009 |
|
||
| 用户组适配 (staff vs ubuntu) | TC-003, TC-010 |
|
||
| 目录路径降级 ($HOME vs /home/ubuntu, /opt, /etc) | TC-004, TC-006, TC-009, TC-010, TC-012, TC-013 |
|
||
| 克隆后补丁注入 (post-clone patch) | TC-013, TC-014 |
|
||
| Linux 基线整体跳过 (skip Linux baseline on Darwin) | TC-014 |
|
||
| brew 补依赖 + PATH 注入 (jq via brew, Homebrew on PATH) | TC-015 |
|
||
| 包管理器绕过 (skip apt on Darwin) | TC-008, TC-010 |
|
||
| 模板变量解耦 (remove nvm/nodejs_version) | TC-005 |
|
||
| 路径空格兼容 (argv vs string) | TC-011 |
|