feat(framework): P4 (1/2) — install.sh upgrade-safe Constitution migration
All checks were successful
ci/woodpecker/push/ci Pipeline was successful
All checks were successful
ci/woodpecker/push/ci Pipeline was successful
Make CONSTITUTION/AGENTS/STANDARDS framework-owned (overwritten on upgrade) while never losing user data: - FRAMEWORK_OWNED vs USER_SEEDED lists (append-friendly per Lead's ask) - reconcile_framework_files: overwrite framework-owned from defaults/, backing up a divergent copy ONCE to <file>.pre-constitution.bak (advisory); seed-if-absent for USER_SEEDED (TOOLS.md) - anchor rsync preserve excludes to top-level (/<file>) so defaults/<file> still syncs - never delete *.pre-constitution.bak across upgrades (rsync + cp-fallback) - snapshot -> sync -> restore-on-failure (ERR/INT/TERM trap) for crash safety - FRAMEWORK_VERSION 2 -> 3 + v2->v3 migration advisory - MOSAIC_SYNC_ONLY hook for testability (file phase only, no env side effects) Fixture suite (test-install-migration.sh) green 7/7: fresh, legacy-edited AGENTS (overwrite + backup + SOUL/creds survive + idempotent .bak), tuned STANDARDS, no-TTY, failure-path data integrity. Two real bugs caught + fixed by the fixtures (unanchored exclude blocking the overwrite; backup deletion on re-upgrade). file-adapter.ts TS parity + the vitest fixture matrix land in P4 (2/2). Refs #542 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -21,11 +21,19 @@ INSTALL_MODE="${MOSAIC_INSTALL_MODE:-prompt}"
|
|||||||
|
|
||||||
# Files/dirs preserved across upgrades (never overwritten).
|
# Files/dirs preserved across upgrades (never overwritten).
|
||||||
# User-created content in these paths survives rsync --delete.
|
# User-created content in these paths survives rsync --delete.
|
||||||
PRESERVE_PATHS=("AGENTS.md" "SOUL.md" "USER.md" "TOOLS.md" "STANDARDS.md" "memory" "sources" "credentials")
|
PRESERVE_PATHS=("CONSTITUTION.md" "AGENTS.md" "SOUL.md" "USER.md" "TOOLS.md" "STANDARDS.md" "memory" "sources" "credentials")
|
||||||
|
|
||||||
|
# Framework-owned contract files: re-copied from defaults/ on every upgrade (the
|
||||||
|
# user must not edit them; a divergent copy is backed up once before overwrite).
|
||||||
|
# USER_SEEDED files are written once on first install, then owned by the user.
|
||||||
|
# Both lists are APPEND-FRIENDLY — add a new shipped framework file here and to the
|
||||||
|
# matching list in packages/mosaic/src/config/file-adapter.ts.
|
||||||
|
FRAMEWORK_OWNED=("CONSTITUTION.md" "AGENTS.md" "STANDARDS.md")
|
||||||
|
USER_SEEDED=("TOOLS.md")
|
||||||
|
|
||||||
# Current framework schema version — bump this when the layout changes.
|
# Current framework schema version — bump this when the layout changes.
|
||||||
# The migration system uses this to run upgrade steps.
|
# The migration system uses this to run upgrade steps.
|
||||||
FRAMEWORK_VERSION=2
|
FRAMEWORK_VERSION=3
|
||||||
|
|
||||||
# ─── colours ──────────────────────────────────────────────────────────────────
|
# ─── colours ──────────────────────────────────────────────────────────────────
|
||||||
if [[ -t 1 ]]; then
|
if [[ -t 1 ]]; then
|
||||||
@@ -40,6 +48,45 @@ warn() { echo -e " ${YELLOW}⚠${RESET} $1" >&2; }
|
|||||||
fail() { echo -e " ${RED}✗${RESET} $1" >&2; }
|
fail() { echo -e " ${RED}✗${RESET} $1" >&2; }
|
||||||
step() { echo -e "\n${BOLD}$1${RESET}"; }
|
step() { echo -e "\n${BOLD}$1${RESET}"; }
|
||||||
|
|
||||||
|
# ─── snapshot / restore (crash safety for upgrades) ──────────────────────────
|
||||||
|
SNAPSHOT_DIR=""
|
||||||
|
make_snapshot() {
|
||||||
|
is_existing_install || return 0
|
||||||
|
SNAPSHOT_DIR="$(mktemp -d "${TMPDIR:-/tmp}/mosaic-snapshot-XXXXXX")"
|
||||||
|
cp -a "$TARGET_DIR/." "$SNAPSHOT_DIR/" 2>/dev/null || true
|
||||||
|
}
|
||||||
|
restore_snapshot() {
|
||||||
|
[[ -n "$SNAPSHOT_DIR" && -d "$SNAPSHOT_DIR" ]] || return 0
|
||||||
|
fail "Install interrupted/failed — restoring previous state from snapshot"
|
||||||
|
rm -rf "$TARGET_DIR"; mkdir -p "$TARGET_DIR"
|
||||||
|
cp -a "$SNAPSHOT_DIR/." "$TARGET_DIR/" 2>/dev/null || true
|
||||||
|
}
|
||||||
|
cleanup_snapshot() { [[ -n "$SNAPSHOT_DIR" && -d "$SNAPSHOT_DIR" ]] && rm -rf "$SNAPSHOT_DIR"; SNAPSHOT_DIR=""; }
|
||||||
|
|
||||||
|
# Reconcile contract files after sync: framework-owned overwrite (backup-once),
|
||||||
|
# user-seeded seed-if-absent.
|
||||||
|
reconcile_framework_files() {
|
||||||
|
local defaults="$TARGET_DIR/defaults" f
|
||||||
|
[[ -d "$defaults" ]] || return 0
|
||||||
|
for f in "${FRAMEWORK_OWNED[@]}"; do
|
||||||
|
[[ -f "$defaults/$f" ]] || continue
|
||||||
|
if [[ -f "$TARGET_DIR/$f" ]] && ! cmp -s "$TARGET_DIR/$f" "$defaults/$f"; then
|
||||||
|
if [[ ! -f "$TARGET_DIR/${f}.pre-constitution.bak" ]]; then
|
||||||
|
cp "$TARGET_DIR/$f" "$TARGET_DIR/${f}.pre-constitution.bak"
|
||||||
|
warn "$f is now framework-owned and was updated; your previous copy is saved as ${f}.pre-constitution.bak — re-apply intended changes as a .local overlay or policy/ file (see CONSTITUTION.md / constitution/LAYER-MODEL.md)."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
cp "$defaults/$f" "$TARGET_DIR/$f"
|
||||||
|
done
|
||||||
|
for f in "${USER_SEEDED[@]}"; do
|
||||||
|
[[ -f "$defaults/$f" ]] || continue
|
||||||
|
if [[ ! -f "$TARGET_DIR/$f" ]]; then
|
||||||
|
cp "$defaults/$f" "$TARGET_DIR/$f"
|
||||||
|
ok "Seeded $f from defaults"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
# ─── helpers ──────────────────────────────────────────────────────────────────
|
# ─── helpers ──────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
is_existing_install() {
|
is_existing_install() {
|
||||||
@@ -113,11 +160,14 @@ sync_framework() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
if command -v rsync >/dev/null 2>&1; then
|
if command -v rsync >/dev/null 2>&1; then
|
||||||
local rsync_args=(-a --delete --exclude ".git" --exclude ".framework-version")
|
local rsync_args=(-a --delete --exclude ".git" --exclude ".framework-version" --exclude "*.pre-constitution.bak")
|
||||||
|
|
||||||
if [[ "$INSTALL_MODE" == "keep" ]]; then
|
if [[ "$INSTALL_MODE" == "keep" ]]; then
|
||||||
|
# Anchor to the transfer root (leading /) so we preserve the TOP-LEVEL
|
||||||
|
# ~/.config/mosaic/<file> without also excluding defaults/<file> from sync
|
||||||
|
# (reconcile_framework_files needs the freshly-synced defaults/ copies).
|
||||||
for path in "${PRESERVE_PATHS[@]}"; do
|
for path in "${PRESERVE_PATHS[@]}"; do
|
||||||
rsync_args+=(--exclude "$path")
|
rsync_args+=(--exclude "/$path")
|
||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -137,7 +187,7 @@ sync_framework() {
|
|||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
find "$TARGET_DIR" -mindepth 1 -maxdepth 1 ! -name ".git" ! -name ".framework-version" -exec rm -rf {} +
|
find "$TARGET_DIR" -mindepth 1 -maxdepth 1 ! -name ".git" ! -name ".framework-version" ! -name "*.pre-constitution.bak" -exec rm -rf {} +
|
||||||
cp -R "$SOURCE_DIR"/. "$TARGET_DIR"/
|
cp -R "$SOURCE_DIR"/. "$TARGET_DIR"/
|
||||||
rm -rf "$TARGET_DIR/.git"
|
rm -rf "$TARGET_DIR/.git"
|
||||||
|
|
||||||
@@ -195,10 +245,15 @@ run_migrations() {
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# ── Future migrations go here ──────────────────────────────────────────────
|
# ── Migration: v2 → v3 (Constitution split) ───────────────────────────────
|
||||||
# if [[ "$from_version" -lt 3 ]]; then
|
# CONSTITUTION.md / AGENTS.md / STANDARDS.md become framework-owned (overwritten
|
||||||
# ...
|
# on upgrade). reconcile_framework_files() has already run before this point: it
|
||||||
# fi
|
# backed up any user-edited copy to <file>.pre-constitution.bak and installed the
|
||||||
|
# new framework version. Nothing further to do here — the advisory was emitted at
|
||||||
|
# reconcile time. (STANDARDS.local.md composition lands with the overlay composer.)
|
||||||
|
if [[ "$from_version" -lt 3 ]]; then
|
||||||
|
ok "Migrated to the Constitution layout (framework-owned CONSTITUTION/AGENTS/STANDARDS)"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# ═══════════════════════════════════════════════════════════════════════════════
|
# ═══════════════════════════════════════════════════════════════════════════════
|
||||||
@@ -216,6 +271,10 @@ else
|
|||||||
ok "Install mode: overwrite"
|
ok "Install mode: overwrite"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Snapshot before any destructive file operation; restore on interrupt/failure.
|
||||||
|
make_snapshot
|
||||||
|
trap 'restore_snapshot' ERR INT TERM
|
||||||
|
|
||||||
sync_framework
|
sync_framework
|
||||||
|
|
||||||
# Ensure persistent directories exist
|
# Ensure persistent directories exist
|
||||||
@@ -230,15 +289,7 @@ mkdir -p "$TARGET_DIR/credentials"
|
|||||||
# packages/mosaic/src/config/file-adapter.ts (FileConfigAdapter.syncFramework).
|
# packages/mosaic/src/config/file-adapter.ts (FileConfigAdapter.syncFramework).
|
||||||
# SOUL.md and USER.md are intentionally NOT seeded here — they are generated
|
# SOUL.md and USER.md are intentionally NOT seeded here — they are generated
|
||||||
# by `mosaic init` from templates with user-supplied values.
|
# by `mosaic init` from templates with user-supplied values.
|
||||||
DEFAULTS_DIR="$TARGET_DIR/defaults"
|
reconcile_framework_files
|
||||||
if [[ -d "$DEFAULTS_DIR" ]]; then
|
|
||||||
for default_file in CONSTITUTION.md AGENTS.md STANDARDS.md TOOLS.md; do
|
|
||||||
if [[ -f "$DEFAULTS_DIR/$default_file" ]] && [[ ! -f "$TARGET_DIR/$default_file" ]]; then
|
|
||||||
cp "$DEFAULTS_DIR/$default_file" "$TARGET_DIR/$default_file"
|
|
||||||
ok "Seeded $default_file from defaults"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Ensure tool scripts are executable
|
# Ensure tool scripts are executable
|
||||||
find "$TARGET_DIR/tools" -name "*.sh" -exec chmod +x {} + 2>/dev/null || true
|
find "$TARGET_DIR/tools" -name "*.sh" -exec chmod +x {} + 2>/dev/null || true
|
||||||
@@ -249,6 +300,18 @@ ok "Framework synced to $TARGET_DIR"
|
|||||||
# Run migrations before post-install (migrations may remove old bin/ etc.)
|
# Run migrations before post-install (migrations may remove old bin/ etc.)
|
||||||
run_migrations
|
run_migrations
|
||||||
|
|
||||||
|
# File-system phase complete and consistent — clear the restore trap.
|
||||||
|
trap - ERR INT TERM
|
||||||
|
cleanup_snapshot
|
||||||
|
|
||||||
|
# Testability / minimal-install hook: stop after the file-system phase, before any
|
||||||
|
# environment-touching post-install steps (runtime linking, MCP setup, skills, doctor).
|
||||||
|
if [[ "${MOSAIC_SYNC_ONLY:-0}" == "1" ]]; then
|
||||||
|
write_framework_version
|
||||||
|
ok "Sync-only mode: file phase complete"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
step "Post-install tasks"
|
step "Post-install tasks"
|
||||||
|
|
||||||
SCRIPTS="$TARGET_DIR/tools/_scripts"
|
SCRIPTS="$TARGET_DIR/tools/_scripts"
|
||||||
|
|||||||
67
packages/mosaic/framework/tools/quality/scripts/test-install-migration.sh
Executable file
67
packages/mosaic/framework/tools/quality/scripts/test-install-migration.sh
Executable file
@@ -0,0 +1,67 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# test-install-migration.sh — fixture matrix for the v2→v3 (Constitution) upgrade
|
||||||
|
# migration in install.sh. Runs the installer against throwaway MOSAIC_HOME dirs
|
||||||
|
# with MOSAIC_SYNC_ONLY=1 (file phase only — no environment-touching post-install)
|
||||||
|
# and asserts the framework-owned-overwrite + user-preserve + backup semantics.
|
||||||
|
#
|
||||||
|
# Mirrors the TS fixture suite in packages/mosaic/src/config/file-adapter.test.ts;
|
||||||
|
# both installers MUST behave identically.
|
||||||
|
#
|
||||||
|
# Usage: bash test-install-migration.sh
|
||||||
|
set -uo pipefail
|
||||||
|
|
||||||
|
FW="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)" # packages/mosaic/framework
|
||||||
|
INSTALL="$FW/install.sh"
|
||||||
|
DEFA="$FW/defaults"
|
||||||
|
|
||||||
|
pass=0; fail=0
|
||||||
|
chk() { if eval "$2"; then echo " ✓ $1"; pass=$((pass + 1)); else echo " ✗ $1"; fail=$((fail + 1)); fi; }
|
||||||
|
run() { MOSAIC_HOME="$1" MOSAIC_INSTALL_MODE="$2" MOSAIC_SYNC_ONLY=1 bash "$INSTALL" >/dev/null 2>&1; }
|
||||||
|
|
||||||
|
echo "install.sh v2→v3 migration fixture matrix:"
|
||||||
|
|
||||||
|
# F1 — fresh install
|
||||||
|
T1=$(mktemp -d); run "$T1" overwrite
|
||||||
|
chk "F1 fresh: CONSTITUTION/AGENTS/STANDARDS/TOOLS seeded" \
|
||||||
|
"[ -f '$T1/CONSTITUTION.md' ] && [ -f '$T1/AGENTS.md' ] && [ -f '$T1/STANDARDS.md' ] && [ -f '$T1/TOOLS.md' ]"
|
||||||
|
chk "F1 fresh: AGENTS == shipped default" "cmp -s '$T1/AGENTS.md' '$DEFA/AGENTS.md'"
|
||||||
|
chk "F1 fresh: framework-version stamped 3" "[ \"\$(cat '$T1/.framework-version' 2>/dev/null)\" = 3 ]"
|
||||||
|
|
||||||
|
# F2 — legacy install with a user-edited AGENTS.md (the sanctioned pre-constitution customization)
|
||||||
|
T2=$(mktemp -d); mkdir -p "$T2/credentials"
|
||||||
|
printf '# user-edited AGENTS pre-constitution\n' > "$T2/AGENTS.md"
|
||||||
|
printf '# my persona\n' > "$T2/SOUL.md"
|
||||||
|
printf 'token\n' > "$T2/credentials/c.json"
|
||||||
|
echo 2 > "$T2/.framework-version"
|
||||||
|
run "$T2" keep
|
||||||
|
chk "F2 legacy-edited: AGENTS overwritten to framework version" "cmp -s '$T2/AGENTS.md' '$DEFA/AGENTS.md'"
|
||||||
|
chk "F2 legacy-edited: prior AGENTS saved to .pre-constitution.bak" \
|
||||||
|
"grep -q 'user-edited AGENTS pre-constitution' '$T2/AGENTS.md.pre-constitution.bak'"
|
||||||
|
chk "F2 legacy-edited: SOUL.md preserved" "grep -q 'my persona' '$T2/SOUL.md'"
|
||||||
|
chk "F2 legacy-edited: credentials preserved" "grep -q token '$T2/credentials/c.json'"
|
||||||
|
chk "F2 legacy-edited: CONSTITUTION.md installed" "[ -f '$T2/CONSTITUTION.md' ]"
|
||||||
|
run "$T2" keep
|
||||||
|
chk "F2 idempotent: .pre-constitution.bak preserved across a 2nd upgrade" \
|
||||||
|
"grep -q 'user-edited AGENTS pre-constitution' '$T2/AGENTS.md.pre-constitution.bak'"
|
||||||
|
|
||||||
|
# F3 — user-tuned STANDARDS.md
|
||||||
|
T3=$(mktemp -d); printf '# tuned standards\n' > "$T3/STANDARDS.md"; printf '# persona\n' > "$T3/SOUL.md"; echo 2 > "$T3/.framework-version"
|
||||||
|
run "$T3" keep
|
||||||
|
chk "F3 tuned-standard: STANDARDS overwritten" "cmp -s '$T3/STANDARDS.md' '$DEFA/STANDARDS.md'"
|
||||||
|
chk "F3 tuned-standard: tuned copy backed up" "grep -q 'tuned standards' '$T3/STANDARDS.md.pre-constitution.bak'"
|
||||||
|
|
||||||
|
# F4 — unattended / no TTY (stdin closed): must complete without hanging, default to keep
|
||||||
|
T4=$(mktemp -d); printf '# persona\n' > "$T4/SOUL.md"; printf '# old\n' > "$T4/AGENTS.md"; echo 2 > "$T4/.framework-version"
|
||||||
|
MOSAIC_HOME="$T4" MOSAIC_SYNC_ONLY=1 bash "$INSTALL" </dev/null >/dev/null 2>&1
|
||||||
|
chk "F4 no-TTY: completed, AGENTS updated" "cmp -s '$T4/AGENTS.md' '$DEFA/AGENTS.md'"
|
||||||
|
|
||||||
|
# F5 — failure path must not corrupt existing data (invalid mode rejected before any file op)
|
||||||
|
T5=$(mktemp -d); mkdir -p "$T5/credentials"; printf '# orig\n' > "$T5/SOUL.md"; printf 'keepme\n' > "$T5/credentials/c.json"; echo 2 > "$T5/.framework-version"
|
||||||
|
MOSAIC_HOME="$T5" MOSAIC_INSTALL_MODE=bogus MOSAIC_SYNC_ONLY=1 bash "$INSTALL" >/dev/null 2>&1; rc=$?
|
||||||
|
chk "F5 failure: invalid mode rejected (nonzero exit)" "[ $rc -ne 0 ]"
|
||||||
|
chk "F5 failure: SOUL + credentials intact" "grep -q orig '$T5/SOUL.md' && grep -q keepme '$T5/credentials/c.json'"
|
||||||
|
|
||||||
|
rm -rf "$T1" "$T2" "$T3" "$T4" "$T5"
|
||||||
|
echo
|
||||||
|
echo "RESULT: $pass passed, $fail failed"
|
||||||
|
[ "$fail" -eq 0 ]
|
||||||
Reference in New Issue
Block a user