File size: 11,899 Bytes
eb3f11e | 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 | import fs from "node:fs/promises";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import * as service from "../../daemon/service.js";
import {
createMockGatewayService,
mockSystemAccountHome,
} from "../../daemon/service.test-helpers.js";
import { writePackageRoot } from "../../infra/package-update-steps.test-support.js";
import { CONTROL_PLANE_UPDATE_SENTINEL_META_ENV } from "../../infra/update-control-plane-sentinel.js";
import { pkgQueryResult } from "../../infra/update-freebsd-pkg-ownership.test-support.js";
import * as updateRunner from "../../infra/update-runner.js";
import * as exec from "../../process/exec.js";
import { withTestDir } from "../../test-helpers/temp-dir.js";
import { withEnvAsync } from "../../test-utils/env.js";
import { withMockedPlatform } from "../../test-utils/vitest-spies.js";
import * as shared from "./shared.js";
import { updateGitInstall } from "./update-command-git.js";
import { prepareUpdateCommand, resolveUpdateCommandAdmissionEnv } from "./update-command-run.js";
import { resolveManagedServicePackageUpdatePlan } from "./update-command-service-plan.js";
import { resolveUpdateCommandTarget } from "./update-command-target.js";
afterEach(() => vi.restoreAllMocks());
async function withPackageRoots(
run: (base: string, requested: string, managed: string) => Promise<void>,
) {
await withTestDir({ prefix: "openclaw-update-pkg-" }, async (base) => {
const requested = path.join(base, "requested", "lib", "node_modules", "openclaw");
const managed = path.join(base, "managed", "lib", "node_modules", "openclaw");
await writePackageRoot(requested, "1.0.0");
await writePackageRoot(managed, "1.0.0");
await withEnvAsync(
{
HOME: base,
OPENCLAW_HOME: undefined,
OPENCLAW_PROFILE: undefined,
OPENCLAW_STATE_DIR: undefined,
OPENCLAW_CONFIG_PATH: undefined,
OPENCLAW_SUPERVISOR_MODE: undefined,
OPENCLAW_UPDATE_POST_CORE: undefined,
OPENCLAW_UPDATE_RUN_ID: undefined,
[CONTROL_PLANE_UPDATE_SENTINEL_META_ENV]: undefined,
},
async () => {
mockSystemAccountHome();
await withMockedPlatform("freebsd", () => run(base, requested, managed));
},
);
});
}
describe("FreeBSD pkg update admission", () => {
it.each(["owned", "unknown", "unowned"])(
"admits the requested root before package-manager probes (%s)",
async (ownership) => {
await withPackageRoots(async (_base, root) => {
const command = vi.spyOn(exec, "runCommandWithTimeout").mockResolvedValue({
stdout: `${path.dirname(root)}\n`,
stderr: "",
code: 0,
signal: null,
killed: false,
termination: "exit",
});
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(
ownership === "owned" ? `${root}/package.json\n` : "",
ownership === "unknown" ? { code: 1 } : {},
),
);
const admission = shared.resolveGlobalManager({
root,
installKind: "package",
timeoutMs: 1000,
});
if (ownership === "unowned") {
await expect(admission).resolves.toBe("npm");
expect(command).toHaveBeenCalled();
} else {
await expect(admission).rejects.toMatchObject({
reason: ownership === "owned" ? "pkg-owned-install" : "pkg-ownership-unavailable",
});
expect(command).not.toHaveBeenCalled();
}
});
},
);
it("reuses completed admission after a long confirmation without timing out path inspection", async () => {
await withPackageRoots(async (_base, root) => {
vi.spyOn(shared, "resolveUpdateRoot").mockResolvedValue(root);
vi.spyOn(service, "resolveGatewayService").mockReturnValue(createMockGatewayService());
const query = vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(pkgQueryResult());
const prepared = await prepareUpdateCommand({ dryRun: true });
vi.spyOn(Date, "now").mockReturnValue(Date.now() + 60_000);
await expect(
resolveUpdateCommandAdmissionEnv({
root,
opts: { dryRun: true },
pkgOwnership: prepared.pkgOwnership,
}),
).resolves.toBeDefined();
expect(query).toHaveBeenCalledTimes(1);
});
});
it("rechecks the selected Git root after its mutation preparation finishes", async () => {
await withPackageRoots(async (_base, root) => {
let claimed = false;
const query = vi
.spyOn(exec, "runCommandBuffered")
.mockImplementation(async () => pkgQueryResult(claimed ? `${root}/package.json\n` : ""));
const publish = vi.fn();
vi.spyOn(updateRunner, "runGatewayUpdate").mockImplementation(async (options) => {
await options?.beforeGitMutation?.({});
publish();
return { status: "ok", mode: "git", root, steps: [], durationMs: 0 };
});
await expect(
updateGitInstall({
root,
switchToGit: false,
installKind: "git",
timeoutMs: 1000,
startedAt: Date.now(),
progress: {},
channel: "dev",
tag: "dev",
beforeGitMutation: async () => {
claimed = true;
},
getManagedServiceEnv: () => undefined,
getSnapshotSource: async () => ({ config: {}, env: process.env }),
allowGatewayServiceRepair: false,
allowGatewayActivation: false,
}),
).rejects.toMatchObject({ reason: "pkg-owned-install" });
expect(query).toHaveBeenCalledTimes(2);
expect(publish).not.toHaveBeenCalled();
});
});
it("refuses a selected pkg-owned Git destination before checkout or manager effects", async () => {
await withPackageRoots(async (_base, requested, selected) => {
vi.spyOn(shared, "resolveGitInstallDir").mockReturnValue(selected);
const manager = vi
.spyOn(shared, "resolveGlobalManager")
.mockRejectedValue(new Error("unexpected manager admission"));
const checkout = vi
.spyOn(shared, "ensureGitCheckout")
.mockRejectedValue(new Error("unexpected checkout mutation"));
const getSnapshotSource = vi.fn(async () => ({ config: {}, env: process.env }));
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${selected}/package.json\n`),
);
await expect(
updateGitInstall({
root: requested,
switchToGit: true,
installKind: "package",
timeoutMs: 1000,
startedAt: Date.now(),
progress: {},
channel: "dev",
tag: "dev",
getManagedServiceEnv: () => undefined,
getSnapshotSource,
allowGatewayServiceRepair: false,
allowGatewayActivation: false,
}),
).rejects.toMatchObject({ reason: "pkg-owned-install" });
expect(manager).not.toHaveBeenCalled();
expect(checkout).not.toHaveBeenCalled();
expect(getSnapshotSource).not.toHaveBeenCalled();
});
});
it.each([
{ name: "ordinary update", opts: {} },
{ name: "no restart", opts: { restart: false } },
{ name: "dry run", opts: { dryRun: true } },
{ name: "package-to-Git switch", opts: { channel: "dev" } },
])(
"refuses the invoking pkg root before service planning or state writes: $name",
async ({ opts }) => {
await withPackageRoots(async (base, root) => {
vi.spyOn(shared, "resolveUpdateRoot").mockResolvedValue(root);
const readCommand = vi.fn();
vi.spyOn(service, "resolveGatewayService").mockReturnValue(
createMockGatewayService({ readCommand }),
);
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${root}/package.json\n`),
);
await expect(prepareUpdateCommand(opts)).rejects.toMatchObject({
reason: "pkg-owned-install",
});
expect(readCommand).not.toHaveBeenCalled();
await expect(fs.stat(path.join(base, ".openclaw"))).rejects.toMatchObject({
code: "ENOENT",
});
});
},
);
it.each(["state", "profile"])(
"does not let a non-default %s bypass pkg ownership",
async (selector) => {
await withPackageRoots(async (base, root) => {
vi.spyOn(shared, "resolveUpdateRoot").mockResolvedValue(root);
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${root}/package.json\n`),
);
await withEnvAsync(
selector === "state"
? { OPENCLAW_STATE_DIR: path.join(base, "custom-state") }
: { OPENCLAW_PROFILE: "alternate" },
async () => {
await expect(prepareUpdateCommand({ restart: false })).rejects.toMatchObject({
reason: "pkg-owned-install",
});
},
);
});
},
);
it.each(["requested", "managed"])(
"refuses the %s pkg root before applying a service root/runtime redirect",
async (owner) => {
await withPackageRoots(async (_base, requested, managed) => {
const readCommand = vi.fn(async () => ({
programArguments: [
"/fixture/bin/node",
path.join(managed, "dist", "index.js"),
"gateway",
"run",
],
}));
vi.spyOn(service, "resolveGatewayService").mockReturnValue(
createMockGatewayService({ readCommand }),
);
const owned = owner === "requested" ? requested : managed;
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${owned}/package.json\n`),
);
await expect(
resolveManagedServicePackageUpdatePlan({ root: requested }),
).rejects.toMatchObject({ reason: "pkg-owned-install" });
expect(readCommand).toHaveBeenCalledTimes(owner === "requested" ? 0 : 1);
});
},
);
it("checks pkg ownership before reading admission environment from a service", async () => {
await withPackageRoots(async (_base, root) => {
const readCommand = vi.fn();
const isAbsent = vi.fn();
vi.spyOn(service, "resolveGatewayService").mockReturnValue(
createMockGatewayService({ readCommand, isAbsent }),
);
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${root}/package.json\n`),
);
await expect(
resolveUpdateCommandAdmissionEnv({ root, opts: { restart: false } }),
).rejects.toMatchObject({ reason: "pkg-owned-install" });
expect(readCommand).not.toHaveBeenCalled();
expect(isAbsent).not.toHaveBeenCalled();
});
});
it("checks a precomputed service redirect before admitting its target", async () => {
await withPackageRoots(async (_base, root, managed) => {
vi.spyOn(shared, "resolveUpdateRoot").mockResolvedValue(root);
vi.spyOn(service, "resolveGatewayService").mockReturnValue(createMockGatewayService());
vi.spyOn(exec, "runCommandBuffered").mockResolvedValue(
pkgQueryResult(`${managed}/package.json\n`),
);
const prepared = await prepareUpdateCommand({ dryRun: true });
prepared.servicePlan = {
rootRedirect: { root: managed, previousRoot: root },
nodeRunner: "/fixture/bin/node",
};
const enter = vi.fn(async () => {
throw new Error("Package ownership must precede executor admission");
});
await expect(
resolveUpdateCommandTarget(
{ dryRun: true },
{ triageTarget: { env: process.env } },
undefined,
prepared,
{ enter },
1000,
),
).rejects.toMatchObject({ reason: "pkg-owned-install" });
expect(enter).not.toHaveBeenCalled();
});
});
});
|