paperclip/server/src/__tests__/claude-local-adapter-environment.test.ts
Devin Foley 9b99d30330
Add dedicated environment settings page and test-in-environment (#4798)
## Thinking Path

> - Paperclip orchestrates AI agents for zero-human companies
> - Agents run inside environments (local, SSH, E2B sandbox)
> - Operators need to configure and manage these environments
> - But environment settings were buried inside the general company
settings page, making them hard to find
> - Additionally, when testing an agent from the configuration form, the
test always ran locally regardless of which environment was selected
> - This PR moves environments into a dedicated top-level company
settings section and wires the "Test Environment" button to run inside
the selected environment
> - The benefit is operators can find and manage environments more
easily, and the test button now validates the actual environment the
agent will use

## What Changed

- Added a dedicated `CompanyEnvironments` settings page with its own
route and sidebar entry
- Updated `CompanySettingsSidebar` and `CompanySettingsNav` to include
the new environments section
- Modified the agent test route (`POST /agents/:id/test`) to accept an
optional `environmentId` parameter
- Updated all adapter `test.ts` handlers to resolve and use the
specified execution target environment
- Added `resolveTestExecutionTarget` to `execution-target.ts` for remote
environment test resolution with cwd fallback
- Moved the "Test Environment" button and its feedback display into the
`NewAgent` page footer for better UX flow

## Verification

- `pnpm test` — all existing and new tests pass
- `pnpm typecheck` — clean
- Manual: navigate to Company Settings, confirm "Environments" appears
as a top-level section
- Manual: configure an agent with a non-local environment, click "Test
Environment", confirm the test runs inside that environment

## Risks

- Low risk. UI-only routing change for the settings page. The
test-in-environment change adds an optional parameter with a local
fallback, so existing behavior is preserved when no environment is
specified.

## Model Used

Codex GPT 5.4 high via Paperclip.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-29 15:56:13 -07:00

221 lines
6.7 KiB
TypeScript

import { afterEach, describe, expect, it } from "vitest";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { testEnvironment } from "@paperclipai/adapter-claude-local/server";
const ORIGINAL_ANTHROPIC = process.env.ANTHROPIC_API_KEY;
const ORIGINAL_BEDROCK = process.env.CLAUDE_CODE_USE_BEDROCK;
const ORIGINAL_BEDROCK_URL = process.env.ANTHROPIC_BEDROCK_BASE_URL;
afterEach(() => {
if (ORIGINAL_ANTHROPIC === undefined) {
delete process.env.ANTHROPIC_API_KEY;
} else {
process.env.ANTHROPIC_API_KEY = ORIGINAL_ANTHROPIC;
}
if (ORIGINAL_BEDROCK === undefined) {
delete process.env.CLAUDE_CODE_USE_BEDROCK;
} else {
process.env.CLAUDE_CODE_USE_BEDROCK = ORIGINAL_BEDROCK;
}
if (ORIGINAL_BEDROCK_URL === undefined) {
delete process.env.ANTHROPIC_BEDROCK_BASE_URL;
} else {
process.env.ANTHROPIC_BEDROCK_BASE_URL = ORIGINAL_BEDROCK_URL;
}
});
describe("claude_local environment diagnostics", () => {
it("returns a warning (not an error) when ANTHROPIC_API_KEY is set in host environment", async () => {
delete process.env.CLAUDE_CODE_USE_BEDROCK;
delete process.env.ANTHROPIC_BEDROCK_BASE_URL;
process.env.ANTHROPIC_API_KEY = "sk-test-host";
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd: process.cwd(),
},
});
expect(result.status).toBe("warn");
expect(
result.checks.some(
(check) =>
check.code === "claude_anthropic_api_key_overrides_subscription" &&
check.level === "warn",
),
).toBe(true);
expect(result.checks.some((check) => check.level === "error")).toBe(false);
});
it("returns a warning (not an error) when ANTHROPIC_API_KEY is set in adapter env", async () => {
delete process.env.ANTHROPIC_API_KEY;
delete process.env.CLAUDE_CODE_USE_BEDROCK;
delete process.env.ANTHROPIC_BEDROCK_BASE_URL;
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd: process.cwd(),
env: {
ANTHROPIC_API_KEY: "sk-test-config",
},
},
});
expect(result.status).toBe("warn");
expect(
result.checks.some(
(check) =>
check.code === "claude_anthropic_api_key_overrides_subscription" &&
check.level === "warn",
),
).toBe(true);
expect(result.checks.some((check) => check.level === "error")).toBe(false);
});
it("returns bedrock auth info when CLAUDE_CODE_USE_BEDROCK is set in host environment", async () => {
delete process.env.ANTHROPIC_API_KEY;
process.env.CLAUDE_CODE_USE_BEDROCK = "1";
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd: process.cwd(),
},
});
expect(
result.checks.some(
(check) =>
check.code === "claude_bedrock_auth" && check.level === "info",
),
).toBe(true);
expect(
result.checks.some(
(check) => check.code === "claude_subscription_mode_possible",
),
).toBe(false);
expect(result.checks.some((check) => check.level === "error")).toBe(false);
});
it("returns bedrock auth info when CLAUDE_CODE_USE_BEDROCK is set in adapter env", async () => {
delete process.env.ANTHROPIC_API_KEY;
delete process.env.CLAUDE_CODE_USE_BEDROCK;
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd: process.cwd(),
env: {
CLAUDE_CODE_USE_BEDROCK: "1",
},
},
});
expect(
result.checks.some(
(check) =>
check.code === "claude_bedrock_auth" && check.level === "info",
),
).toBe(true);
expect(
result.checks.some(
(check) => check.code === "claude_subscription_mode_possible",
),
).toBe(false);
expect(result.checks.some((check) => check.level === "error")).toBe(false);
});
it("bedrock auth takes precedence over missing ANTHROPIC_API_KEY", async () => {
delete process.env.ANTHROPIC_API_KEY;
process.env.CLAUDE_CODE_USE_BEDROCK = "1";
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd: process.cwd(),
},
});
const codes = result.checks.map((c) => c.code);
expect(codes).toContain("claude_bedrock_auth");
expect(codes).not.toContain("claude_subscription_mode_possible");
expect(codes).not.toContain("claude_anthropic_api_key_overrides_subscription");
});
it("creates a missing working directory when cwd is absolute", async () => {
const cwd = path.join(
os.tmpdir(),
`paperclip-claude-local-cwd-${Date.now()}-${Math.random().toString(16).slice(2)}`,
"workspace",
);
await fs.rm(path.dirname(cwd), { recursive: true, force: true });
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
cwd,
},
});
expect(result.checks.some((check) => check.code === "claude_cwd_valid")).toBe(true);
expect(result.checks.some((check) => check.level === "error")).toBe(false);
const stats = await fs.stat(cwd);
expect(stats.isDirectory()).toBe(true);
await fs.rm(path.dirname(cwd), { recursive: true, force: true });
});
it("defaults remote probes to the environment remote cwd when adapter cwd is unset", async () => {
const result = await testEnvironment({
companyId: "company-1",
adapterType: "claude_local",
config: {
command: process.execPath,
},
executionTarget: {
kind: "remote",
transport: "sandbox",
providerKey: "test-provider",
remoteCwd: "/srv/paperclip/workspace",
runner: {
execute: async () => ({
exitCode: 0,
signal: null,
timedOut: false,
stdout: "",
stderr: "",
pid: null,
startedAt: new Date().toISOString(),
}),
},
},
environmentName: "Linux Box",
});
expect(result.checks.some((check) => check.code === "claude_cwd_valid")).toBe(true);
expect(
result.checks.some(
(check) =>
check.code === "claude_cwd_valid" &&
check.message === "Working directory is valid: /srv/paperclip/workspace",
),
).toBe(true);
expect(result.checks.some((check) => check.code === "claude_cwd_invalid")).toBe(false);
});
});