homeio

1import { parseComposeFile } from "@/lib/server/modules/docker/compose-parser";
2import {
3    applyWebUiPortOverride,
4    cleanupComposeDataOnUninstall,
5    collectComposeBindMountOwnershipOverrides,
6    collectMaterializationDirectories,
7    normalizeComposeStorageBindings,
8    resolveComposeBindMountOwnershipOverrides,
9    sanitizeStackName,
10} from "@/lib/server/modules/docker/compose-runner";
11import {
12    resolveStoreAppDataRoot,
13    resolveStoreStacksRoot,
14} from "@/lib/server/storage/data-root";
15import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
16import os from "node:os";
17import path from "node:path";
18import { describe, expect, it } from "vitest";
19
20describe("compose runner helpers", () => {
21  it("overrides first numeric host port mapping", () => {
22    const compose = `
23services:
24  app:
25    image: test:latest
26    ports:
27      - "3000:3000"
28`;
29
30    const updated = applyWebUiPortOverride(compose, 3100);
31    expect(updated).toContain(`- "3100:3000"`);
32  });
33
34  it("keeps compose unchanged when no published port mapping exists", () => {
35    const compose = `
36services:
37  app:
38    image: test:latest
39    network_mode: host
40`;
41
42    const updated = applyWebUiPortOverride(compose, 3100);
43    expect(updated).toBe(compose);
44  });
45
46  it("sanitizes stack names", () => {
47    expect(sanitizeStackName("AdGuard Home!")).toBe("adguard-home");
48  });
49
50  it("converts named volumes to bind mounts under DATA/Apps in legacy mode", () => {
51    const compose = `
52services:
53  twofauth:
54    image: 2fauth/2fauth:latest
55    volumes:
56      - "big-bear-2fauth_data:/2fauth"
57      - "./config:/config"
58volumes:
59  big-bear-2fauth_data:
60`;
61
62    const stacksRoot = "/Users/ahmedtabib/Code/home-server/stacks";
63    const appDataRoot = "/Users/ahmedtabib/Code/home-server/DATA/AppData";
64    const normalized = normalizeComposeStorageBindings(
65      compose,
66      stacksRoot,
67      appDataRoot,
68      {
69        appId: "twofauth",
70        strategy: "legacy_named_source",
71      },
72    );
73
74    expect(normalized.composeContent).toContain(
75      '- "/Users/ahmedtabib/Code/home-server/DATA/AppData/big-bear-2fauth_data:/2fauth"',
76    );
77    expect(normalized.composeContent).toContain('- "./config:/config"');
78    expect(normalized.composeContent).not.toContain(
79      "\nvolumes:\n  big-bear-2fauth_data:",
80    );
81    expect(Array.from(normalized.bindMountDirectories)).toContain(
82      "/Users/ahmedtabib/Code/home-server/DATA/AppData/big-bear-2fauth_data",
83    );
84  });
85
86  it("converts named volumes to app-scoped target paths in app_target_path mode", () => {
87    const compose = `
88services:
89  app:
90    image: home-assistant:latest
91    volumes:
92      - "big-bear-home-assistant_config:/config"
93      - "big-bear-home-assistant_media:/var/lib/homeassistant/media"
94volumes:
95  big-bear-home-assistant_config:
96  big-bear-home-assistant_media:
97`;
98
99    const stacksRoot = "/DATA/AppData";
100    const appDataRoot = "/DATA/AppData";
101    const normalized = normalizeComposeStorageBindings(
102      compose,
103      stacksRoot,
104      appDataRoot,
105      {
106        appId: "home-assistant",
107        strategy: "app_target_path",
108      },
109    );
110
111    expect(normalized.composeContent).toContain(
112      '- "/DATA/AppData/home-assistant/config:/config"',
113    );
114    expect(normalized.composeContent).toContain(
115      '- "/DATA/AppData/home-assistant/var/lib/homeassistant/media:/var/lib/homeassistant/media"',
116    );
117    expect(normalized.composeContent).not.toContain(
118      "big-bear-home-assistant_config:",
119    );
120    expect(normalized.composeContent).not.toContain(
121      "big-bear-home-assistant_media:",
122    );
123    expect(Array.from(normalized.bindMountDirectories)).toContain(
124      "/DATA/AppData/home-assistant/config",
125    );
126    expect(Array.from(normalized.bindMountDirectories)).toContain(
127      "/DATA/AppData/home-assistant/var/lib/homeassistant/media",
128    );
129  });
130
131  it("converts long-form named volumes to app-scoped bind mounts in app_target_path mode", () => {
132    const compose = `
133services:
134  cloudflared:
135    image: wisdomsky/cloudflared-web:latest
136    volumes:
137      - type: volume
138        source: cloudflared_config
139        target: /config
140volumes:
141  cloudflared_config:
142`;
143
144    const normalized = normalizeComposeStorageBindings(
145      compose,
146      "/DATA/AppData",
147      "/DATA/AppData",
148      {
149        appId: "cloudflared",
150        strategy: "app_target_path",
151      },
152    );
153
154    expect(normalized.composeContent).toContain("- type: bind");
155    expect(normalized.composeContent).toContain(
156      "source: /DATA/AppData/cloudflared/config",
157    );
158    expect(parseComposeFile(normalized.composeContent)).not.toBeNull();
159    expect(normalized.composeContent).not.toContain("cloudflared_config:");
160    expect(Array.from(normalized.bindMountDirectories)).toContain(
161      "/DATA/AppData/cloudflared/config",
162    );
163  });
164
165  it("rewrites CasaOS app-data bind mounts into app-scoped paths on fresh installs", () => {
166    const compose = `
167services:
168  cloudflared:
169    image: wisdomsky/cloudflared-web:latest
170    volumes:
171      - type: bind
172        source: /DATA/AppData/casaos-cloudflared/config
173        target: /config
174      - "/DATA/AppData/data:/data"
175`;
176
177    const normalized = normalizeComposeStorageBindings(
178      compose,
179      "/DATA/AppData",
180      "/DATA/AppData",
181      {
182        appId: "cloudflared",
183        strategy: "app_target_path",
184      },
185    );
186
187    expect(normalized.composeContent).toContain(
188      "source: /DATA/AppData/cloudflared/config",
189    );
190    expect(normalized.composeContent).toContain(
191      '- "/DATA/AppData/cloudflared/data:/data"',
192    );
193    expect(Array.from(normalized.bindMountDirectories)).toContain(
194      "/DATA/AppData/cloudflared/config",
195    );
196    expect(Array.from(normalized.bindMountDirectories)).toContain(
197      "/DATA/AppData/cloudflared/data",
198    );
199  });
200
201  it("collects app-data ownership overrides for Grafana bind mounts", () => {
202    const compose = `
203services:
204  grafana:
205    image: grafana/grafana:12.1.4
206    volumes:
207      - type: bind
208        source: /DATA/AppData/grafana/data
209        target: /var/lib/grafana
210`;
211
212    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([
213      {
214        directoryPath: "/DATA/AppData/grafana/data",
215        uid: 472,
216        gid: 472,
217      },
218    ]);
219  });
220
221  it("collects app-data ownership overrides for n8n bind mounts", () => {
222    const compose = `
223services:
224  n8n:
225    image: n8nio/n8n:1.123.0
226    volumes:
227      - type: bind
228        source: /DATA/AppData/n8n
229        target: /home/node/.n8n
230`;
231
232    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([
233      {
234        directoryPath: "/DATA/AppData/n8n",
235        uid: 1000,
236        gid: 1000,
237      },
238    ]);
239  });
240
241  it("resolves Grafana ownership overrides with AppID interpolation", () => {
242    const compose = `
243services:
244  grafana:
245    image: grafana/grafana:12.1.4
246    volumes:
247      - type: bind
248        source: /DATA/AppData/$AppID/data
249        target: /var/lib/grafana
250`;
251
252    expect(
253      resolveComposeBindMountOwnershipOverrides(compose, {
254        AppID: "grafana",
255      }),
256    ).toEqual([
257      {
258        directoryPath: "/DATA/AppData/grafana/data",
259        uid: 472,
260        gid: 472,
261      },
262    ]);
263  });
264
265  it("resolves n8n ownership overrides with AppID interpolation", () => {
266    const compose = `
267services:
268  n8n:
269    image: n8nio/n8n:1.123.0
270    volumes:
271      - type: bind
272        source: /DATA/AppData/$AppID
273        target: /home/node/.n8n
274`;
275
276    expect(
277      resolveComposeBindMountOwnershipOverrides(compose, {
278        AppID: "n8n",
279      }),
280    ).toEqual([
281      {
282        directoryPath: "/DATA/AppData/n8n",
283        uid: 1000,
284        gid: 1000,
285      },
286    ]);
287  });
288
289  it("uses explicit numeric service user ownership before image-specific rules", () => {
290    const compose = `
291services:
292  app:
293    image: grafana/grafana:12.1.4
294    user: "1234:5678"
295    volumes:
296      - type: bind
297        source: /DATA/AppData/app/data
298        target: /var/lib/grafana
299`;
300
301    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([
302      {
303        directoryPath: "/DATA/AppData/app/data",
304        uid: 1234,
305        gid: 5678,
306      },
307    ]);
308  });
309
310  it("uses PUID and PGID environment values when service user is not set", () => {
311    const compose = `
312services:
313  app:
314    image: lscr.io/linuxserver/app:latest
315    environment:
316      PUID: "1001"
317      PGID: "1002"
318    volumes:
319      - type: bind
320        source: /DATA/AppData/app/config
321        target: /config
322`;
323
324    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([
325      {
326        directoryPath: "/DATA/AppData/app/config",
327        uid: 1001,
328        gid: 1002,
329      },
330    ]);
331  });
332
333  it("uses list-style PUID and PGID environment values", () => {
334    const compose = `
335services:
336  app:
337    image: lscr.io/linuxserver/app:latest
338    environment:
339      - PUID=1003
340      - PGID=1004
341    volumes:
342      - /DATA/AppData/app/config:/config
343`;
344
345    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([
346      {
347        directoryPath: "/DATA/AppData/app/config",
348        uid: 1003,
349        gid: 1004,
350      },
351    ]);
352  });
353
354  it("includes ownership override directories in materialization targets", () => {
355    const directories = collectMaterializationDirectories(
356      ["/DATA/AppData/grafana/var/lib/grafana"],
357      [
358        {
359          directoryPath: "/DATA/AppData/grafana/data",
360          uid: 472,
361          gid: 472,
362        },
363      ],
364    );
365
366    expect(Array.from(directories)).toEqual([
367      "/DATA/AppData/grafana/var/lib/grafana",
368      "/DATA/AppData/grafana/data",
369    ]);
370  });
371
372  it("does not collect ownership overrides for unrelated bind mounts", () => {
373    const compose = `
374services:
375  app:
376    image: nginx:latest
377    volumes:
378      - /DATA/AppData/nginx/data:/usr/share/nginx/html
379`;
380
381    expect(collectComposeBindMountOwnershipOverrides(compose)).toEqual([]);
382  });
383
384  it("removes the installed stack directory during uninstall cleanup without deleting app data by default", async () => {
385    const stacksRoot = resolveStoreStacksRoot();
386    const appId = `cleanup-test-${Date.now()}`;
387    const stackDir = path.join(stacksRoot, appId);
388    const composePath = path.join(stackDir, "docker-compose.yml");
389    // Use os.tmpdir() so bindDir is outside stackDir — avoids false ENOENT when
390    // the recursive stackDir removal also wipes a nested bindDir (happens in dev
391    // where stacksRoot and appDataRoot both resolve to DATA/AppData).
392    const bindDir = await mkdtemp(path.join(os.tmpdir(), "homeio-test-bind-"));
393
394    try {
395      await mkdir(stackDir, { recursive: true });
396      await writeFile(
397        composePath,
398        `services:
399  app:
400    image: nginx:latest
401    volumes:
402      - "${bindDir}:/data"
403`,
404        "utf8",
405      );
406
407      await cleanupComposeDataOnUninstall({
408        composePath,
409        removeVolumes: false,
410      });
411
412      await expect(
413        rm(stackDir, {
414          recursive: true,
415          force: false,
416        }),
417      ).rejects.toThrow();
418
419      await expect(
420        rm(bindDir, {
421          recursive: true,
422          force: false,
423        }),
424      ).resolves.toBeUndefined();
425    } finally {
426      await rm(bindDir, { recursive: true, force: true });
427    }
428  });
429
430  it("removes long-form app-data bind mount directories during uninstall cleanup when requested", async () => {
431    const stacksRoot = resolveStoreStacksRoot();
432    const appDataRoot = resolveStoreAppDataRoot();
433    const appId = `cleanup-long-form-${Date.now()}`;
434    const stackDir = path.join(stacksRoot, appId);
435    const composePath = path.join(stackDir, "docker-compose.yml");
436    const bindDir = path.join(appDataRoot, appId, "config");
437
438    await mkdir(bindDir, { recursive: true });
439    await mkdir(stackDir, { recursive: true });
440    await writeFile(
441      composePath,
442      `services:
443  app:
444    image: nginx:latest
445    volumes:
446      - type: bind
447        source: ${bindDir}
448        target: /config
449`,
450      "utf8",
451    );
452
453    await cleanupComposeDataOnUninstall({
454      composePath,
455      removeVolumes: true,
456    });
457
458    await expect(
459      rm(stackDir, {
460        recursive: true,
461        force: false,
462      }),
463    ).rejects.toThrow();
464
465    await expect(
466      rm(bindDir, {
467        recursive: true,
468        force: false,
469      }),
470    ).rejects.toThrow();
471  });
472
473  it("removes interpolated AppID app-data bind mount directories during uninstall cleanup when requested", async () => {
474    const stacksRoot = resolveStoreStacksRoot();
475    const appDataRoot = resolveStoreAppDataRoot();
476    const appId = `cleanup-appid-${Date.now()}`;
477    const stackDir = path.join(stacksRoot, appId);
478    const composePath = path.join(stackDir, "docker-compose.yml");
479    const bindDir = path.join(appDataRoot, appId, "data");
480
481    await mkdir(bindDir, { recursive: true });
482    await mkdir(stackDir, { recursive: true });
483    await writeFile(path.join(stackDir, ".env"), "", "utf8");
484    await writeFile(
485      composePath,
486      `services:
487  app:
488    image: grafana/grafana:12.1.4
489    volumes:
490      - type: bind
491        source: ${appDataRoot}/$AppID/data
492        target: /var/lib/grafana
493`,
494      "utf8",
495    );
496
497    await cleanupComposeDataOnUninstall({
498      composePath,
499      removeVolumes: true,
500    });
501
502    await expect(
503      rm(bindDir, {
504        recursive: true,
505        force: false,
506      }),
507    ).rejects.toThrow();
508  });
509});
510