File size: 13,328 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | import { spawn, type ChildProcess } from "node:child_process";
import fs from "node:fs/promises";
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
import { prepareRestartScript, runRestartScript } from "./restart-helper.js";
vi.mock("node:child_process", () => ({
spawn: vi.fn(),
}));
describe("restart-helper", () => {
const originalPlatform = process.platform;
const originalGetUid = process.getuid;
async function prepareAndReadScript(env: Record<string, string>, gatewayPort = 18789) {
const scriptPath = await prepareRestartScript(env, gatewayPort);
expect(scriptPath).toBeTruthy();
const content = await fs.readFile(scriptPath!, "utf-8");
return { scriptPath: scriptPath!, content };
}
async function cleanupScript(scriptPath: string) {
await fs.unlink(scriptPath);
}
function expectWindowsRestartWaitOrdering(content: string, port = 18789) {
const endCommand = 'schtasks /End /TN "';
const pollAttemptsInit = "set /a attempts=0";
const pollLabel = ":wait_for_port_release";
const pollAttemptIncrement = "set /a attempts+=1";
const pollNetstatCheck = `netstat -ano | findstr /R /C:":${port} .*LISTENING" >nul`;
const forceKillLabel = ":force_kill_listener";
const forceKillCommand = "taskkill /F /PID %%P >nul 2>&1";
const portReleasedLabel = ":port_released";
const runCommand = 'schtasks /Run /TN "';
const endIndex = content.indexOf(endCommand);
const attemptsInitIndex = content.indexOf(pollAttemptsInit, endIndex);
const pollLabelIndex = content.indexOf(pollLabel, attemptsInitIndex);
const pollAttemptIncrementIndex = content.indexOf(pollAttemptIncrement, pollLabelIndex);
const pollNetstatCheckIndex = content.indexOf(pollNetstatCheck, pollAttemptIncrementIndex);
const forceKillLabelIndex = content.indexOf(forceKillLabel, pollNetstatCheckIndex);
const forceKillCommandIndex = content.indexOf(forceKillCommand, forceKillLabelIndex);
const portReleasedLabelIndex = content.indexOf(portReleasedLabel, forceKillCommandIndex);
const runIndex = content.indexOf(runCommand, portReleasedLabelIndex);
expect(endIndex).toBeGreaterThanOrEqual(0);
expect(attemptsInitIndex).toBeGreaterThan(endIndex);
expect(pollLabelIndex).toBeGreaterThan(attemptsInitIndex);
expect(pollAttemptIncrementIndex).toBeGreaterThan(pollLabelIndex);
expect(pollNetstatCheckIndex).toBeGreaterThan(pollAttemptIncrementIndex);
expect(forceKillLabelIndex).toBeGreaterThan(pollNetstatCheckIndex);
expect(forceKillCommandIndex).toBeGreaterThan(forceKillLabelIndex);
expect(portReleasedLabelIndex).toBeGreaterThan(forceKillCommandIndex);
expect(runIndex).toBeGreaterThan(portReleasedLabelIndex);
expect(content).not.toContain("timeout /t 3 /nobreak >nul");
}
beforeEach(() => {
vi.resetAllMocks();
});
afterEach(() => {
Object.defineProperty(process, "platform", { value: originalPlatform });
process.getuid = originalGetUid;
});
describe("prepareRestartScript", () => {
it("creates a systemd restart script on Linux", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
});
expect(scriptPath.endsWith(".sh")).toBe(true);
expect(content).toContain("#!/bin/sh");
expect(content).toContain("systemctl --user restart 'openclaw-gateway.service'");
// Script should self-cleanup
expect(content).toContain('rm -f "$0"');
await cleanupScript(scriptPath);
});
it("uses OPENCLAW_SYSTEMD_UNIT override for systemd scripts", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
OPENCLAW_SYSTEMD_UNIT: "custom-gateway",
});
expect(content).toContain("systemctl --user restart 'custom-gateway.service'");
await cleanupScript(scriptPath);
});
it("creates a launchd restart script on macOS", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 501;
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
});
expect(scriptPath.endsWith(".sh")).toBe(true);
expect(content).toContain("#!/bin/sh");
expect(content).toContain("launchctl kickstart -k 'gui/501/ai.openclaw.gateway'");
// Should clear disabled state and fall back to bootstrap when kickstart fails.
expect(content).toContain("launchctl enable 'gui/501/ai.openclaw.gateway'");
expect(content).toContain("launchctl bootstrap 'gui/501'");
expect(content).toContain('rm -f "$0"');
await cleanupScript(scriptPath);
});
it("uses OPENCLAW_LAUNCHD_LABEL override on macOS", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 501;
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
OPENCLAW_LAUNCHD_LABEL: "com.custom.openclaw",
});
expect(content).toContain("launchctl kickstart -k 'gui/501/com.custom.openclaw'");
await cleanupScript(scriptPath);
});
it("creates a schtasks restart script on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
});
expect(scriptPath.endsWith(".bat")).toBe(true);
expect(content).toContain("@echo off");
expect(content).toContain('schtasks /End /TN "OpenClaw Gateway"');
expect(content).toContain('schtasks /Run /TN "OpenClaw Gateway"');
expectWindowsRestartWaitOrdering(content);
// Batch self-cleanup
expect(content).toContain('del "%~f0"');
await cleanupScript(scriptPath);
});
it("uses OPENCLAW_WINDOWS_TASK_NAME override on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "default",
OPENCLAW_WINDOWS_TASK_NAME: "OpenClaw Gateway (custom)",
});
expect(content).toContain('schtasks /End /TN "OpenClaw Gateway (custom)"');
expect(content).toContain('schtasks /Run /TN "OpenClaw Gateway (custom)"');
expectWindowsRestartWaitOrdering(content);
await cleanupScript(scriptPath);
});
it("uses passed gateway port for port polling on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const customPort = 9999;
const { scriptPath, content } = await prepareAndReadScript(
{
OPENCLAW_PROFILE: "default",
},
customPort,
);
expect(content).toContain(`netstat -ano | findstr /R /C:":${customPort} .*LISTENING" >nul`);
expect(content).toContain(
`for /f "tokens=5" %%P in ('netstat -ano ^| findstr /R /C:":${customPort} .*LISTENING"') do (`,
);
expectWindowsRestartWaitOrdering(content, customPort);
await cleanupScript(scriptPath);
});
it("uses custom profile in service names", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "production",
});
expect(content).toContain("openclaw-gateway-production.service");
await cleanupScript(scriptPath);
});
it("uses custom profile in macOS launchd label", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 502;
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "staging",
});
expect(content).toContain("gui/502/ai.openclaw.staging");
await cleanupScript(scriptPath);
});
it("uses custom profile in Windows task name", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "production",
});
expect(content).toContain('schtasks /End /TN "OpenClaw Gateway (production)"');
expectWindowsRestartWaitOrdering(content);
await cleanupScript(scriptPath);
});
it("returns null for unsupported platforms", async () => {
Object.defineProperty(process, "platform", { value: "aix" });
const scriptPath = await prepareRestartScript({});
expect(scriptPath).toBeNull();
});
it("returns null when script creation fails", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const writeFileSpy = vi
.spyOn(fs, "writeFile")
.mockRejectedValueOnce(new Error("simulated write failure"));
const scriptPath = await prepareRestartScript({
OPENCLAW_PROFILE: "default",
});
expect(scriptPath).toBeNull();
writeFileSpy.mockRestore();
});
it("escapes single quotes in profile names for shell scripts", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const { scriptPath, content } = await prepareAndReadScript({
OPENCLAW_PROFILE: "it's-a-test",
});
// Single quotes should be escaped with '\'' pattern
expect(content).not.toContain("it's");
expect(content).toContain("it'\\''s");
await cleanupScript(scriptPath);
});
it("expands HOME in plist path instead of leaving literal $HOME", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 501;
const { scriptPath, content } = await prepareAndReadScript({
HOME: "/Users/testuser",
OPENCLAW_PROFILE: "default",
});
// The plist path must contain the resolved home dir, not literal $HOME
expect(content).toMatch(/[\\/]Users[\\/]testuser[\\/]Library[\\/]LaunchAgents[\\/]/);
expect(content).not.toContain("$HOME");
await cleanupScript(scriptPath);
});
it("prefers env parameter HOME over process.env.HOME for plist path", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 502;
const { scriptPath, content } = await prepareAndReadScript({
HOME: "/Users/envhome",
OPENCLAW_PROFILE: "default",
});
expect(content).toMatch(/[\\/]Users[\\/]envhome[\\/]Library[\\/]LaunchAgents[\\/]/);
await cleanupScript(scriptPath);
});
it("shell-escapes the label in the plist path on macOS", async () => {
Object.defineProperty(process, "platform", { value: "darwin" });
process.getuid = () => 501;
const { scriptPath, content } = await prepareAndReadScript({
HOME: "/Users/testuser",
OPENCLAW_LAUNCHD_LABEL: "ai.openclaw.it's-a-test",
});
// The plist path must also shell-escape the label to prevent injection
expect(content).toContain("ai.openclaw.it'\\''s-a-test.plist");
await cleanupScript(scriptPath);
});
it("rejects unsafe batch profile names on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const scriptPath = await prepareRestartScript({
OPENCLAW_PROFILE: "test&whoami",
});
expect(scriptPath).toBeNull();
});
});
describe("runRestartScript", () => {
it("spawns the script as a detached process on Linux", async () => {
Object.defineProperty(process, "platform", { value: "linux" });
const scriptPath = "/tmp/fake-script.sh";
const mockChild = { unref: vi.fn() };
vi.mocked(spawn).mockReturnValue(mockChild as unknown as ChildProcess);
await runRestartScript(scriptPath);
expect(spawn).toHaveBeenCalledWith("/bin/sh", [scriptPath], {
detached: true,
stdio: "ignore",
windowsHide: true,
});
expect(mockChild.unref).toHaveBeenCalled();
});
it("uses cmd.exe on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const scriptPath = "C:\\Temp\\fake-script.bat";
const mockChild = { unref: vi.fn() };
vi.mocked(spawn).mockReturnValue(mockChild as unknown as ChildProcess);
await runRestartScript(scriptPath);
expect(spawn).toHaveBeenCalledWith("cmd.exe", ["/d", "/s", "/c", scriptPath], {
detached: true,
stdio: "ignore",
windowsHide: true,
});
expect(mockChild.unref).toHaveBeenCalled();
});
it("quotes cmd.exe /c paths with metacharacters on Windows", async () => {
Object.defineProperty(process, "platform", { value: "win32" });
const scriptPath = "C:\\Temp\\me&(ow)\\fake-script.bat";
const mockChild = { unref: vi.fn() };
vi.mocked(spawn).mockReturnValue(mockChild as unknown as ChildProcess);
await runRestartScript(scriptPath);
expect(spawn).toHaveBeenCalledWith("cmd.exe", ["/d", "/s", "/c", `"${scriptPath}"`], {
detached: true,
stdio: "ignore",
windowsHide: true,
});
});
});
});
|