|
| 1 | +// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; |
| 5 | +import type fs from "node:fs"; |
| 6 | + |
| 7 | +interface FsEntry { |
| 8 | + type: "file" | "dir"; |
| 9 | + content?: string; |
| 10 | +} |
| 11 | + |
| 12 | +const store = new Map<string, FsEntry>(); |
| 13 | +const mockExeca = vi.fn(); |
| 14 | + |
| 15 | +vi.mock("node:os", () => ({ |
| 16 | + homedir: () => "/fakehome", |
| 17 | +})); |
| 18 | + |
| 19 | +vi.mock("node:crypto", () => ({ |
| 20 | + randomUUID: () => "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", |
| 21 | +})); |
| 22 | + |
| 23 | +vi.mock("node:fs", async (importOriginal) => { |
| 24 | + const original = await importOriginal<typeof fs>(); |
| 25 | + return { |
| 26 | + ...original, |
| 27 | + existsSync: (p: string) => store.has(p), |
| 28 | + mkdirSync: vi.fn((p: string) => { |
| 29 | + store.set(p, { type: "dir" }); |
| 30 | + }), |
| 31 | + readFileSync: (p: string) => { |
| 32 | + const entry = store.get(p); |
| 33 | + return entry?.type === "file" ? (entry.content ?? "") : throwFsError(p); |
| 34 | + }, |
| 35 | + writeFileSync: vi.fn((p: string, data: string) => { |
| 36 | + store.set(p, { type: "file", content: data }); |
| 37 | + }), |
| 38 | + readdirSync: (p: string) => { |
| 39 | + const prefix = p.endsWith("/") ? p : `${p}/`; |
| 40 | + const entries = new Set<string>(); |
| 41 | + for (const key of store.keys()) { |
| 42 | + const [first] = key.slice(prefix.length).split("/"); |
| 43 | + key.startsWith(prefix) && first !== undefined && first !== "" && entries.add(first); |
| 44 | + } |
| 45 | + entries.size === 0 && !store.has(p) && throwFsError(p); |
| 46 | + return [...entries].sort(); |
| 47 | + }, |
| 48 | + }; |
| 49 | +}); |
| 50 | + |
| 51 | +vi.mock("execa", () => ({ |
| 52 | + execa: (...args: unknown[]) => mockExeca(...args), |
| 53 | +})); |
| 54 | + |
| 55 | +vi.mock("./ssrf.js", () => ({ |
| 56 | + validateEndpointUrl: vi.fn(async (url: string) => ({ url, pinnedUrl: url })), |
| 57 | +})); |
| 58 | + |
| 59 | +const { validateEndpointUrl } = await import("./ssrf.js"); |
| 60 | +const mockedValidateEndpoint = vi.mocked(validateEndpointUrl); |
| 61 | +const { metrics } = await import("../observability/metrics.js"); |
| 62 | +const { actionApply, actionPlan } = await import("./runner.js"); |
| 63 | + |
| 64 | +const stdoutChunks: string[] = []; |
| 65 | + |
| 66 | +function throwFsError(path: string): never { |
| 67 | + throw new Error(`ENOENT: ${path}`); |
| 68 | +} |
| 69 | + |
| 70 | +function captureStdout(): void { |
| 71 | + vi.spyOn(process.stdout, "write").mockImplementation((chunk: string | Uint8Array) => { |
| 72 | + stdoutChunks.push(String(chunk)); |
| 73 | + return true; |
| 74 | + }); |
| 75 | +} |
| 76 | + |
| 77 | +function minimalBlueprint(): Record<string, unknown> { |
| 78 | + return { |
| 79 | + version: "1.0", |
| 80 | + components: { |
| 81 | + inference: { |
| 82 | + profiles: { |
| 83 | + default: { |
| 84 | + provider_type: "openai", |
| 85 | + provider_name: "my-provider", |
| 86 | + endpoint: "https://api.example.com/v1", |
| 87 | + model: "gpt-4", |
| 88 | + credential_env: "MY_API_KEY", |
| 89 | + }, |
| 90 | + }, |
| 91 | + }, |
| 92 | + sandbox: { |
| 93 | + image: "openclaw", |
| 94 | + name: "test-sandbox", |
| 95 | + forward_ports: [18789], |
| 96 | + }, |
| 97 | + policy: { additions: {} }, |
| 98 | + }, |
| 99 | + }; |
| 100 | +} |
| 101 | + |
| 102 | +describe("runner metrics", () => { |
| 103 | + beforeEach(() => { |
| 104 | + store.clear(); |
| 105 | + stdoutChunks.length = 0; |
| 106 | + vi.clearAllMocks(); |
| 107 | + vi.stubEnv("NEMOCLAW_METRICS_ENABLED", "true"); |
| 108 | + metrics.reset(); |
| 109 | + }); |
| 110 | + |
| 111 | + afterEach(() => { |
| 112 | + vi.restoreAllMocks(); |
| 113 | + vi.unstubAllEnvs(); |
| 114 | + metrics.reset(); |
| 115 | + }); |
| 116 | + |
| 117 | + it("records blueprint and endpoint validation metrics for successful plans", async () => { |
| 118 | + captureStdout(); |
| 119 | + mockExeca.mockResolvedValue({ exitCode: 0 }); |
| 120 | + |
| 121 | + await actionPlan("default", minimalBlueprint()); |
| 122 | + |
| 123 | + const output = metrics.renderPrometheus(); |
| 124 | + expect(output).toContain( |
| 125 | + 'blueprint_execution_total{action="plan",profile="default",status="success"} 1', |
| 126 | + ); |
| 127 | + expect(output).toContain( |
| 128 | + 'blueprint_execution_duration_seconds_count{action="plan",profile="default",status="success"} 1', |
| 129 | + ); |
| 130 | + expect(output).toContain( |
| 131 | + 'api_validation_total{kind="endpoint_url",source="blueprint",status="success"} 1', |
| 132 | + ); |
| 133 | + }); |
| 134 | + |
| 135 | + it("records blueprint and endpoint validation metrics for failed plans", async () => { |
| 136 | + captureStdout(); |
| 137 | + mockExeca.mockResolvedValue({ exitCode: 0 }); |
| 138 | + mockedValidateEndpoint.mockRejectedValueOnce(new Error("SSRF blocked")); |
| 139 | + |
| 140 | + await expect(actionPlan("default", minimalBlueprint())).rejects.toThrow("SSRF blocked"); |
| 141 | + |
| 142 | + const output = metrics.renderPrometheus(); |
| 143 | + expect(output).toContain( |
| 144 | + 'blueprint_execution_total{action="plan",profile="default",status="error"} 1', |
| 145 | + ); |
| 146 | + expect(output).toContain( |
| 147 | + 'api_validation_total{kind="endpoint_url",source="blueprint",status="error"} 1', |
| 148 | + ); |
| 149 | + }); |
| 150 | + |
| 151 | + it("records sandbox lifecycle metrics during apply", async () => { |
| 152 | + captureStdout(); |
| 153 | + mockExeca.mockResolvedValue({ exitCode: 0, stdout: "", stderr: "" }); |
| 154 | + |
| 155 | + await actionApply("default", minimalBlueprint()); |
| 156 | + |
| 157 | + const output = metrics.renderPrometheus(); |
| 158 | + expect(output).toContain( |
| 159 | + 'blueprint_execution_total{action="apply",profile="default",status="success"} 1', |
| 160 | + ); |
| 161 | + expect(output).toContain('sandbox_lifecycle_total{operation="create",status="success"} 1'); |
| 162 | + expect(output).toContain( |
| 163 | + 'sandbox_lifecycle_duration_seconds_count{operation="create",status="success"} 1', |
| 164 | + ); |
| 165 | + }); |
| 166 | +}); |
0 commit comments