@better-openclaw/core 1.0.9 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-openclaw/core",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "private": false,
   "description": "Core logic for better-openclaw: schemas, service registry, resolver, composer, validators and more",
   "packageManager": "pnpm@9.15.4",

package/src/generate.ts

@@ -4,11 +4,12 @@ import {
 	resolvedWithOnlyServices,
 } from "./bare-metal-partition.js";
 import { composeMultiFile } from "./composer.js";
+import { StackConfigError, ValidationError } from "./errors.js";
 import { generateBareMetalInstall } from "./generators/bare-metal-install.js";
 import { generateCaddyfile } from "./generators/caddy.js";
 import { generateEnvFiles } from "./generators/env.js";
-import { generateTraefikConfig } from "./generators/traefik.js";
 import { generateGrafanaConfig, generateGrafanaDashboard } from "./generators/grafana.js";
+import { generateHealthCheck } from "./generators/health-check.js";
 import { generateN8nWorkflows } from "./generators/n8n-workflows.js";
 import { generateNativeInstallScripts } from "./generators/native-services.js";
 import { generatePostgresInit } from "./generators/postgres-init.js";
@@ -16,6 +17,7 @@ import { generatePrometheusConfig } from "./generators/prometheus.js";
 import { generateReadme } from "./generators/readme.js";
 import { generateScripts } from "./generators/scripts.js";
 import { generateSkillFiles } from "./generators/skills.js";
+import { generateTraefikConfig } from "./generators/traefik.js";
 import { migrateConfig } from "./migrations.js";
 import { resolve } from "./resolver.js";
 import type {
@@ -25,7 +27,6 @@ import type {
 	Platform,
 	ResolverInput,
 } from "./types.js";
-import { StackConfigError, ValidationError } from "./errors.js";
 import { validate } from "./validator.js";
 
 /** Resolver/compose only support linux image platforms; normalize for bare-metal (windows/macos). */
@@ -103,7 +104,9 @@ export function generate(rawInput: GenerationInput): GenerationResult {
 		generateSecrets: input.generateSecrets,
 	});
 	if (!validation.valid) {
-		throw new ValidationError(`Validation failed: ${validation.errors.map((e) => e.message).join("; ")}`);
+		throw new ValidationError(
+			`Validation failed: ${validation.errors.map((e) => e.message).join("; ")}`,
+		);
 	}
 
 	// 4. Generate all files
@@ -154,6 +157,15 @@ export function generate(rawInput: GenerationInput): GenerationResult {
 		files[path] = content;
 	}
 
+	// Health check scripts (dynamic, stack-specific)
+	const healthCheckFiles = generateHealthCheck(resolved, {
+		projectName: input.projectName,
+		deploymentType: input.deploymentType,
+	});
+	for (const [path, content] of Object.entries(healthCheckFiles)) {
+		files[path] = content;
+	}
+
 	// n8n workflows
 	const n8nWorkflows = generateN8nWorkflows(resolved);
 	for (const [path, content] of Object.entries(n8nWorkflows)) {

package/src/generators/caddy.test.ts

@@ -0,0 +1,56 @@
+import { describe, expect, it } from "vitest";
+import { generate } from "../generate.js";
+
+describe("generateCaddyfile (via generate)", () => {
+	const baseInput = {
+		projectName: "caddy-test",
+		services: ["redis", "n8n"],
+		skillPacks: [] as string[],
+		proxy: "caddy" as const,
+		domain: "example.com",
+		gpu: false,
+		platform: "linux/amd64" as const,
+		deployment: "local" as const,
+		generateSecrets: true,
+		openclawVersion: "latest",
+	};
+
+	it("generates Caddyfile when proxy is caddy", () => {
+		const result = generate(baseInput);
+
+		expect(result.files).toHaveProperty("caddy/Caddyfile");
+		expect(result.files["caddy/Caddyfile"]!.length).toBeGreaterThan(0);
+	});
+
+	it("does not generate Caddyfile when proxy is none", () => {
+		const result = generate({
+			...baseInput,
+			proxy: "none",
+		});
+
+		expect(result.files).not.toHaveProperty("caddy/Caddyfile");
+	});
+
+	it("Caddyfile contains the domain", () => {
+		const result = generate(baseInput);
+		const caddyfile = result.files["caddy/Caddyfile"]!;
+
+		expect(caddyfile).toContain("example.com");
+	});
+
+	it("Caddyfile includes reverse proxy directives for services with exposed ports", () => {
+		const result = generate(baseInput);
+		const caddyfile = result.files["caddy/Caddyfile"]!;
+
+		// Should reference n8n since it has exposed ports
+		expect(caddyfile).toContain("n8n");
+	});
+
+	it("Caddyfile includes TLS configuration", () => {
+		const result = generate(baseInput);
+		const caddyfile = result.files["caddy/Caddyfile"]!;
+
+		// Caddy auto-enables TLS, so should reference HTTPS or TLS
+		expect(caddyfile.length).toBeGreaterThan(50);
+	});
+});

package/src/generators/env.test.ts

@@ -0,0 +1,73 @@
+import { describe, expect, it } from "vitest";
+import { generate } from "../generate.js";
+
+describe("generateEnvFiles (via generate)", () => {
+	const baseInput = {
+		projectName: "env-test",
+		services: ["redis"],
+		skillPacks: [] as string[],
+		proxy: "none" as const,
+		gpu: false,
+		platform: "linux/amd64" as const,
+		deployment: "local" as const,
+		generateSecrets: true,
+		openclawVersion: "latest",
+	};
+
+	it("generates .env and .env.example files", () => {
+		const result = generate(baseInput);
+
+		expect(result.files).toHaveProperty(".env");
+		expect(result.files).toHaveProperty(".env.example");
+	});
+
+	it(".env.example has empty values for secrets", () => {
+		const result = generate(baseInput);
+		const envExample = result.files[".env.example"]!;
+
+		// .env.example should have placeholder empty values for secrets
+		expect(envExample).toContain("REDIS_PASSWORD=");
+	});
+
+	it(".env has populated secret values when generateSecrets is true", () => {
+		const result = generate(baseInput);
+		const env = result.files[".env"]!;
+
+		// Find REDIS_PASSWORD line and check it has a value
+		const redisLine = env.split("\n").find((l) => l.startsWith("REDIS_PASSWORD="));
+		expect(redisLine).toBeDefined();
+		// Value should not be empty
+		const value = redisLine!.split("=")[1];
+		expect(value!.length).toBeGreaterThan(0);
+	});
+
+	it("env files contain service-specific variables", () => {
+		const result = generate({
+			...baseInput,
+			services: ["redis", "postgresql", "n8n"],
+		});
+		const env = result.files[".env"]!;
+
+		expect(env).toContain("REDIS_PASSWORD");
+		expect(env).toContain("POSTGRES_PASSWORD");
+	});
+
+	it("env files group variables by service with comments", () => {
+		const result = generate(baseInput);
+		const envExample = result.files[".env.example"]!;
+
+		// Should have comment sections
+		expect(envExample).toContain("#");
+	});
+
+	it(".env references domain when proxy is set", () => {
+		const result = generate({
+			...baseInput,
+			proxy: "caddy",
+			domain: "example.com",
+		});
+		const env = result.files[".env"]!;
+
+		expect(env).toContain("example.com");
+	});
+});

package/src/generators/health-check.test.ts

@@ -0,0 +1,118 @@
+import { describe, expect, it } from "vitest";
+import { generate } from "../generate.js";
+
+describe("generateHealthCheck (via generate)", () => {
+	const baseInput = {
+		projectName: "health-test",
+		services: ["redis", "postgresql"],
+		skillPacks: [] as string[],
+		proxy: "none" as const,
+		gpu: false,
+		platform: "linux/amd64" as const,
+		deployment: "local" as const,
+		generateSecrets: true,
+		openclawVersion: "latest",
+	};
+
+	it("generates health-check.sh and health-check.ps1", () => {
+		const result = generate(baseInput);
+
+		expect(result.files).toHaveProperty("scripts/health-check.sh");
+		expect(result.files).toHaveProperty("scripts/health-check.ps1");
+	});
+
+	it("health-check.sh contains project name", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh).toContain("health-test");
+	});
+
+	it("health-check.sh contains service-specific checks for each resolved service", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh).toContain("redis");
+		expect(sh).toContain("postgresql");
+	});
+
+	it("health-check.sh includes port checks for exposed ports", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		// Redis exposes port 6379, PostgreSQL exposes 5432
+		expect(sh).toContain("6379");
+		expect(sh).toContain("5432");
+	});
+
+	it("health-check.sh has usage/help docs", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh).toContain("--quick");
+		expect(sh).toContain("--json");
+		expect(sh).toContain("--verbose");
+	});
+
+	it("health-check.sh starts with shebang", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh.startsWith("#!/usr/bin/env bash")).toBe(true);
+	});
+
+	it("health-check.ps1 contains project name", () => {
+		const result = generate(baseInput);
+		const ps1 = result.files["scripts/health-check.ps1"]!;
+
+		expect(ps1).toContain("health-test");
+	});
+
+	it("health-check.ps1 contains service checks", () => {
+		const result = generate(baseInput);
+		const ps1 = result.files["scripts/health-check.ps1"]!;
+
+		expect(ps1).toContain("redis");
+		expect(ps1).toContain("postgresql");
+	});
+
+	it("health-check.ps1 includes PowerShell-style parameters", () => {
+		const result = generate(baseInput);
+		const ps1 = result.files["scripts/health-check.ps1"]!;
+
+		expect(ps1).toContain("[switch]$Quick");
+		expect(ps1).toContain("[switch]$Json");
+	});
+
+	it("health check scripts include all resolved services including dependencies", () => {
+		const result = generate({
+			...baseInput,
+			services: ["postiz"], // postiz depends on redis and postgresql
+		});
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh).toContain("postiz");
+		// Dependencies should be auto-resolved and included
+		expect(sh).toContain("redis");
+		expect(sh).toContain("postgresql");
+	});
+
+	it("health check script includes health check commands when service defines one", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		// Redis has a healthcheck command (redis-cli ping)
+		expect(sh).toContain("check_health_cmd");
+	});
+
+	it("health check scripts contain the phase structure", () => {
+		const result = generate(baseInput);
+		const sh = result.files["scripts/health-check.sh"]!;
+
+		expect(sh).toContain("Phase 1");
+		expect(sh).toContain("phase_environment");
+		expect(sh).toContain("check_container");
+		expect(sh).toContain("check_port");
+		expect(sh).toContain("phase_logs");
+	});
+});