mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 22:48:27 +00:00
refactor(exec): unify wrapper resolution and split approvals tests
This commit is contained in:
Peter Steinberger
283
src/infra/exec-approvals-config.test.ts
Normal file
283
src/infra/exec-approvals-config.test.ts
Normal file
@@ -0,0 +1,283 @@
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { makeTempDir } from "./exec-approvals-test-helpers.js";
|
||||
import {
|
||||
isSafeBinUsage,
|
||||
matchAllowlist,
|
||||
normalizeExecApprovals,
|
||||
normalizeSafeBins,
|
||||
resolveExecApprovals,
|
||||
resolveExecApprovalsFromFile,
|
||||
type ExecApprovalsAgent,
|
||||
type ExecAllowlistEntry,
|
||||
type ExecApprovalsFile,
|
||||
} from "./exec-approvals.js";
|
||||
|
||||
describe("exec approvals wildcard agent", () => {
|
||||
it("merges wildcard allowlist entries with agent entries", () => {
|
||||
const dir = makeTempDir();
|
||||
const prevOpenClawHome = process.env.OPENCLAW_HOME;
|
||||
|
||||
try {
|
||||
process.env.OPENCLAW_HOME = dir;
|
||||
const approvalsPath = path.join(dir, ".openclaw", "exec-approvals.json");
|
||||
fs.mkdirSync(path.dirname(approvalsPath), { recursive: true });
|
||||
fs.writeFileSync(
|
||||
approvalsPath,
|
||||
JSON.stringify(
|
||||
{
|
||||
version: 1,
|
||||
agents: {
|
||||
"*": { allowlist: [{ pattern: "/bin/hostname" }] },
|
||||
main: { allowlist: [{ pattern: "/usr/bin/uname" }] },
|
||||
},
|
||||
},
|
||||
null,
|
||||
2,
|
||||
),
|
||||
);
|
||||
|
||||
const resolved = resolveExecApprovals("main");
|
||||
expect(resolved.allowlist.map((entry) => entry.pattern)).toEqual([
|
||||
"/bin/hostname",
|
||||
"/usr/bin/uname",
|
||||
]);
|
||||
} finally {
|
||||
if (prevOpenClawHome === undefined) {
|
||||
delete process.env.OPENCLAW_HOME;
|
||||
} else {
|
||||
process.env.OPENCLAW_HOME = prevOpenClawHome;
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe("exec approvals node host allowlist check", () => {
|
||||
// These tests verify the allowlist satisfaction logic used by the node host path
|
||||
// The node host checks: matchAllowlist() || isSafeBinUsage() for each command segment
|
||||
// Using hardcoded resolution objects for cross-platform compatibility
|
||||
|
||||
it("matches exact and wildcard allowlist patterns", () => {
|
||||
const cases: Array<{
|
||||
resolution: { rawExecutable: string; resolvedPath: string; executableName: string };
|
||||
entries: ExecAllowlistEntry[];
|
||||
expectedPattern: string | null;
|
||||
}> = [
|
||||
{
|
||||
resolution: {
|
||||
rawExecutable: "python3",
|
||||
resolvedPath: "/usr/bin/python3",
|
||||
executableName: "python3",
|
||||
},
|
||||
entries: [{ pattern: "/usr/bin/python3" }],
|
||||
expectedPattern: "/usr/bin/python3",
|
||||
},
|
||||
{
|
||||
// Simulates symlink resolution:
|
||||
// /opt/homebrew/bin/python3 -> /opt/homebrew/opt/python@3.14/bin/python3.14
|
||||
resolution: {
|
||||
rawExecutable: "python3",
|
||||
resolvedPath: "/opt/homebrew/opt/python@3.14/bin/python3.14",
|
||||
executableName: "python3.14",
|
||||
},
|
||||
entries: [{ pattern: "/opt/**/python*" }],
|
||||
expectedPattern: "/opt/**/python*",
|
||||
},
|
||||
{
|
||||
resolution: {
|
||||
rawExecutable: "unknown-tool",
|
||||
resolvedPath: "/usr/local/bin/unknown-tool",
|
||||
executableName: "unknown-tool",
|
||||
},
|
||||
entries: [{ pattern: "/usr/bin/python3" }, { pattern: "/opt/**/node" }],
|
||||
expectedPattern: null,
|
||||
},
|
||||
];
|
||||
for (const testCase of cases) {
|
||||
const match = matchAllowlist(testCase.entries, testCase.resolution);
|
||||
expect(match?.pattern ?? null).toBe(testCase.expectedPattern);
|
||||
}
|
||||
});
|
||||
|
||||
it("does not treat unknown tools as safe bins", () => {
|
||||
const resolution = {
|
||||
rawExecutable: "unknown-tool",
|
||||
resolvedPath: "/usr/local/bin/unknown-tool",
|
||||
executableName: "unknown-tool",
|
||||
};
|
||||
const safe = isSafeBinUsage({
|
||||
argv: ["unknown-tool", "--help"],
|
||||
resolution,
|
||||
safeBins: normalizeSafeBins(["jq", "curl"]),
|
||||
});
|
||||
expect(safe).toBe(false);
|
||||
});
|
||||
|
||||
it("satisfies via safeBins even when not in allowlist", () => {
|
||||
const resolution = {
|
||||
rawExecutable: "jq",
|
||||
resolvedPath: "/usr/bin/jq",
|
||||
executableName: "jq",
|
||||
};
|
||||
// Not in allowlist
|
||||
const entries: ExecAllowlistEntry[] = [{ pattern: "/usr/bin/python3" }];
|
||||
const match = matchAllowlist(entries, resolution);
|
||||
expect(match).toBeNull();
|
||||
|
||||
// But is a safe bin with non-file args
|
||||
const safe = isSafeBinUsage({
|
||||
argv: ["jq", ".foo"],
|
||||
resolution,
|
||||
safeBins: normalizeSafeBins(["jq"]),
|
||||
});
|
||||
// Safe bins are disabled on Windows (PowerShell parsing/expansion differences).
|
||||
if (process.platform === "win32") {
|
||||
expect(safe).toBe(false);
|
||||
return;
|
||||
}
|
||||
expect(safe).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("exec approvals default agent migration", () => {
|
||||
it("migrates legacy default agent entries to main", () => {
|
||||
const file: ExecApprovalsFile = {
|
||||
version: 1,
|
||||
agents: {
|
||||
default: { allowlist: [{ pattern: "/bin/legacy" }] },
|
||||
},
|
||||
};
|
||||
const resolved = resolveExecApprovalsFromFile({ file });
|
||||
expect(resolved.allowlist.map((entry) => entry.pattern)).toEqual(["/bin/legacy"]);
|
||||
expect(resolved.file.agents?.default).toBeUndefined();
|
||||
expect(resolved.file.agents?.main?.allowlist?.[0]?.pattern).toBe("/bin/legacy");
|
||||
});
|
||||
|
||||
it("prefers main agent settings when both main and default exist", () => {
|
||||
const file: ExecApprovalsFile = {
|
||||
version: 1,
|
||||
agents: {
|
||||
main: { ask: "always", allowlist: [{ pattern: "/bin/main" }] },
|
||||
default: { ask: "off", allowlist: [{ pattern: "/bin/legacy" }] },
|
||||
},
|
||||
};
|
||||
const resolved = resolveExecApprovalsFromFile({ file });
|
||||
expect(resolved.agent.ask).toBe("always");
|
||||
expect(resolved.allowlist.map((entry) => entry.pattern)).toEqual(["/bin/main", "/bin/legacy"]);
|
||||
expect(resolved.file.agents?.default).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("normalizeExecApprovals handles string allowlist entries (#9790)", () => {
|
||||
function getMainAllowlistPatterns(file: ExecApprovalsFile): string[] | undefined {
|
||||
const normalized = normalizeExecApprovals(file);
|
||||
return normalized.agents?.main?.allowlist?.map((entry) => entry.pattern);
|
||||
}
|
||||
|
||||
function expectNoSpreadStringArtifacts(entries: ExecAllowlistEntry[]) {
|
||||
for (const entry of entries) {
|
||||
expect(entry).toHaveProperty("pattern");
|
||||
expect(typeof entry.pattern).toBe("string");
|
||||
expect(entry.pattern.length).toBeGreaterThan(0);
|
||||
expect(entry).not.toHaveProperty("0");
|
||||
}
|
||||
}
|
||||
|
||||
it("converts bare string entries to proper ExecAllowlistEntry objects", () => {
|
||||
// Simulates a corrupted or legacy config where allowlist contains plain
|
||||
// strings (e.g. ["ls", "cat"]) instead of { pattern: "..." } objects.
|
||||
const file = {
|
||||
version: 1,
|
||||
agents: {
|
||||
main: {
|
||||
mode: "allowlist",
|
||||
allowlist: ["things", "remindctl", "memo", "which", "ls", "cat", "echo"],
|
||||
},
|
||||
},
|
||||
} as unknown as ExecApprovalsFile;
|
||||
|
||||
const normalized = normalizeExecApprovals(file);
|
||||
const entries = normalized.agents?.main?.allowlist ?? [];
|
||||
|
||||
// Spread-string corruption would create numeric keys — ensure none exist.
|
||||
expectNoSpreadStringArtifacts(entries);
|
||||
|
||||
expect(entries.map((e) => e.pattern)).toEqual([
|
||||
"things",
|
||||
"remindctl",
|
||||
"memo",
|
||||
"which",
|
||||
"ls",
|
||||
"cat",
|
||||
"echo",
|
||||
]);
|
||||
});
|
||||
|
||||
it("preserves proper ExecAllowlistEntry objects unchanged", () => {
|
||||
const file: ExecApprovalsFile = {
|
||||
version: 1,
|
||||
agents: {
|
||||
main: {
|
||||
allowlist: [{ pattern: "/usr/bin/ls" }, { pattern: "/usr/bin/cat", id: "existing-id" }],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const normalized = normalizeExecApprovals(file);
|
||||
const entries = normalized.agents?.main?.allowlist ?? [];
|
||||
|
||||
expect(entries).toHaveLength(2);
|
||||
expect(entries[0]?.pattern).toBe("/usr/bin/ls");
|
||||
expect(entries[1]?.pattern).toBe("/usr/bin/cat");
|
||||
expect(entries[1]?.id).toBe("existing-id");
|
||||
});
|
||||
|
||||
it("sanitizes mixed and malformed allowlist shapes", () => {
|
||||
const cases: Array<{
|
||||
name: string;
|
||||
allowlist: unknown;
|
||||
expectedPatterns: string[] | undefined;
|
||||
}> = [
|
||||
{
|
||||
name: "mixed entries",
|
||||
allowlist: ["ls", { pattern: "/usr/bin/cat" }, "echo"],
|
||||
expectedPatterns: ["ls", "/usr/bin/cat", "echo"],
|
||||
},
|
||||
{
|
||||
name: "empty strings dropped",
|
||||
allowlist: ["", " ", "ls"],
|
||||
expectedPatterns: ["ls"],
|
||||
},
|
||||
{
|
||||
name: "malformed objects dropped",
|
||||
allowlist: [{ pattern: "/usr/bin/ls" }, {}, { pattern: 123 }, { pattern: " " }, "echo"],
|
||||
expectedPatterns: ["/usr/bin/ls", "echo"],
|
||||
},
|
||||
{
|
||||
name: "non-array dropped",
|
||||
allowlist: "ls",
|
||||
expectedPatterns: undefined,
|
||||
},
|
||||
];
|
||||
|
||||
for (const testCase of cases) {
|
||||
const patterns = getMainAllowlistPatterns({
|
||||
version: 1,
|
||||
agents: {
|
||||
main: { allowlist: testCase.allowlist } as ExecApprovalsAgent,
|
||||
},
|
||||
});
|
||||
expect(patterns, testCase.name).toEqual(testCase.expectedPatterns);
|
||||
if (patterns) {
|
||||
const entries = normalizeExecApprovals({
|
||||
version: 1,
|
||||
agents: {
|
||||
main: { allowlist: testCase.allowlist } as ExecApprovalsAgent,
|
||||
},
|
||||
}).agents?.main?.allowlist;
|
||||
expectNoSpreadStringArtifacts(entries ?? []);
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user