@openpalm/lib 0.9.9 → 0.10.2

package/src/control-plane/extends-support.test.ts

@@ -0,0 +1,105 @@
+/**
+ * Verify that Compose `extends` is supported as an optional addon pattern.
+ *
+ * This is a narrow smoke test proving the canonical compose resolution
+ * works when an addon uses Compose `extends` to inherit from a base service.
+ */
+import { describe, test, expect, beforeAll, afterAll } from "bun:test";
+import { mkdirSync, writeFileSync, rmSync, existsSync } from "node:fs";
+import { join } from "node:path";
+import { tmpdir } from "node:os";
+
+describe("compose extends support", () => {
+  let fixtureDir: string;
+  const skipDockerAssertions = process.env.CI === "true";
+
+  beforeAll(() => {
+    fixtureDir = join(tmpdir(), `openpalm-extends-test-${Date.now()}`);
+    mkdirSync(join(fixtureDir, "stack/addons/extended-addon"), { recursive: true });
+
+    // Write a minimal core compose
+    writeFileSync(
+      join(fixtureDir, "stack/core.compose.yml"),
+      [
+        "services:",
+        "  base-service:",
+        "    image: alpine:latest",
+        "    environment:",
+        "      BASE_VAR: base-value",
+        "",
+      ].join("\n")
+    );
+
+    // Write an addon that uses `extends`
+    writeFileSync(
+      join(fixtureDir, "stack/addons/extended-addon/compose.yml"),
+      [
+        "services:",
+        "  extended-service:",
+        "    extends:",
+        "      service: base-service",
+        `      file: ${join(fixtureDir, "stack/core.compose.yml")}`,
+        "    environment:",
+        "      ADDON_VAR: addon-value",
+        "",
+      ].join("\n")
+    );
+  });
+
+  afterAll(() => {
+    if (fixtureDir && existsSync(fixtureDir)) {
+      rmSync(fixtureDir, { recursive: true, force: true });
+    }
+  });
+
+  test("fixture files exist", () => {
+    expect(existsSync(join(fixtureDir, "stack/core.compose.yml"))).toBe(true);
+    expect(existsSync(join(fixtureDir, "stack/addons/extended-addon/compose.yml"))).toBe(true);
+  });
+
+  test("extends addon composes correctly with discoverStackOverlays", async () => {
+    const { discoverStackOverlays } = await import("./config-persistence.js");
+    const overlays = discoverStackOverlays(join(fixtureDir, "stack"));
+
+    expect(overlays.length).toBe(2);
+    expect(overlays[0]).toContain("core.compose.yml");
+    expect(overlays[1]).toContain("extended-addon/compose.yml");
+  });
+
+  test.skipIf(skipDockerAssertions)("extends addon passes docker compose config preflight (requires Docker)", async () => {
+    // This test validates that Compose `extends` actually merges correctly.
+    // Skipped when Docker is unavailable.
+    const { checkDocker, composePreflight } = await import("./docker.js");
+    const dockerCheck = await checkDocker();
+    if (!dockerCheck.ok) {
+      console.log("  [skip] Docker not available — extends preflight test skipped");
+      return;
+    }
+
+    const { discoverStackOverlays } = await import("./config-persistence.js");
+    const files = discoverStackOverlays(join(fixtureDir, "stack"));
+
+    const result = await composePreflight({ files });
+    expect(result.ok).toBe(true);
+  });
+
+  test.skipIf(skipDockerAssertions)("extends addon resolves services correctly via compose config (requires Docker)", async () => {
+    const { checkDocker, composeConfigServices } = await import("./docker.js");
+    const dockerCheck = await checkDocker();
+    if (!dockerCheck.ok) {
+      console.log("  [skip] Docker not available — extends service discovery test skipped");
+      return;
+    }
+
+    const { discoverStackOverlays } = await import("./config-persistence.js");
+    const files = discoverStackOverlays(join(fixtureDir, "stack"));
+
+    const result = await composeConfigServices({ files });
+    if (result.ok) {
+      // When Docker is available, the resolved service list should include
+      // both the base service and the extended service
+      expect(result.services).toContain("base-service");
+      expect(result.services).toContain("extended-service");
+    }
+  });
+});

package/src/control-plane/home.ts

@@ -0,0 +1,133 @@
+/**
+ * Home directory layout for the OpenPalm control plane (v0.10.0+).
+ *
+ * Replaces the XDG three-tier model with a single ~/.openpalm/ root:
+ *   config/  — user-editable, non-secret configuration
+ *   vault/   — secrets boundary (user.env, system.env)
+ *   data/    — service-managed persistent data
+ *   logs/    — consolidated audit/debug output
+ *
+ * Cache and rollback data live in ~/.cache/openpalm/ (ephemeral).
+ */
+import { mkdirSync } from "node:fs";
+import { homedir, tmpdir } from "node:os";
+import { resolve as resolvePath } from "node:path";
+
+// ── Path Resolution ──────────────────────────────────────────────────
+
+export function resolveHome(): string {
+  const home = homedir();
+  if (home) return home;
+
+  return tmpdir();
+}
+
+export function resolveOpenPalmHome(): string {
+  const raw = process.env.OP_HOME;
+  if (raw) return resolvePath(raw);
+  return `${resolveHome()}/.openpalm`;
+}
+
+export function resolveConfigDir(): string {
+  return `${resolveOpenPalmHome()}/config`;
+}
+
+export function resolveVaultDir(): string {
+  return `${resolveOpenPalmHome()}/vault`;
+}
+
+export function resolveDataDir(): string {
+  return `${resolveOpenPalmHome()}/data`;
+}
+
+export function resolveLogsDir(): string {
+  return `${resolveOpenPalmHome()}/logs`;
+}
+
+export function resolveCacheHome(): string {
+  return `${resolveHome()}/.cache/openpalm`;
+}
+
+export function resolveRollbackDir(): string {
+  return `${resolveCacheHome()}/rollback`;
+}
+
+export function resolveRegistryDir(): string {
+  return `${resolveOpenPalmHome()}/registry`;
+}
+
+export function resolveRegistryAddonsDir(): string {
+  return `${resolveRegistryDir()}/addons`;
+}
+
+export function resolveRegistryAutomationsDir(): string {
+  return `${resolveRegistryDir()}/automations`;
+}
+
+export function resolveStackDir(): string {
+  return `${resolveOpenPalmHome()}/stack`;
+}
+
+export function resolveBackupsDir(): string {
+  return `${resolveOpenPalmHome()}/backups`;
+}
+
+export function resolveWorkspaceDir(): string {
+  return `${resolveOpenPalmHome()}/data/workspace`;
+}
+
+// ── Directory Setup ──────────────────────────────────────────────────
+
+/**
+ * Create the full ~/.openpalm/ directory tree and cache directories.
+ */
+export function ensureHomeDirs(): void {
+  const home = resolveOpenPalmHome();
+  const cache = resolveCacheHome();
+
+  for (const dir of [
+    // config/ — user-editable, non-secret
+    `${home}/config`,
+    `${home}/config/automations`,
+    `${home}/config/assistant`,
+    `${home}/config/guardian`,
+
+    // vault/ — secrets boundary
+    `${home}/vault`,
+    `${home}/vault/stack`,
+    `${home}/vault/user`,
+
+    // data/ — service-managed persistent data
+    `${home}/data`,
+    `${home}/data/assistant`,
+    `${home}/data/admin`,
+    `${home}/data/memory`,
+    `${home}/data/guardian`,
+    `${home}/data/stash`,
+
+    // stack/ — compose files
+    `${home}/stack`,
+    `${home}/stack/addons`,
+
+    // registry/ — available catalog
+    `${home}/registry`,
+    `${home}/registry/addons`,
+    `${home}/registry/automations`,
+
+    // backups/ — user backups
+    `${home}/backups`,
+
+    // data/workspace/ — shared assistant workspace (compose: $OP_HOME/data/workspace:/work)
+    `${home}/data/workspace`,
+
+    // logs/ — consolidated audit/debug
+    `${home}/logs`,
+    `${home}/logs/opencode`,
+
+    // cache/ — ephemeral, regenerable
+    cache,
+    `${cache}/rollback`,
+  ]) {
+    mkdirSync(dir, { recursive: true });
+  }
+}