-
Notifications
You must be signed in to change notification settings - Fork 1
[EVAL] feat: Improve terminal reuse logic to prevent proliferation #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // npx vitest run src/integrations/terminal/__tests__/Terminal.spec.ts | ||
|
|
||
| import * as vscode from "vscode" | ||
| import { Terminal } from "../Terminal" | ||
| import { TerminalProcess } from "../TerminalProcess" | ||
| import { vi } from "vitest" | ||
|
|
||
| // Mock dependencies | ||
| vi.mock("vscode", () => ({ | ||
| window: { | ||
| createTerminal: vi.fn().mockReturnValue({ | ||
| shellIntegration: { | ||
| cwd: { fsPath: "/initial/cwd" }, | ||
| }, | ||
| sendText: vi.fn(), | ||
| exitStatus: undefined, | ||
| }), | ||
| }, | ||
| ThemeIcon: vi.fn(), | ||
| })) | ||
|
|
||
| vi.mock("p-wait-for", () => ({ | ||
| default: vi.fn().mockResolvedValue(true), | ||
| })) | ||
|
|
||
| vi.mock("../TerminalProcess") | ||
| vi.mock("../../../utils/path", () => ({ | ||
| arePathsEqual: vi.fn((a, b) => a === b), | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The mock for |
||
| })) | ||
|
|
||
| describe("Terminal", () => { | ||
| describe("runCommand", () => { | ||
| let terminal: Terminal | ||
| let mockRun: any | ||
| let mockProcess: any | ||
|
|
||
| beforeEach(() => { | ||
| terminal = new Terminal(1, undefined, "/initial/cwd") | ||
| mockRun = vi.fn() | ||
| mockProcess = { | ||
| run: mockRun, | ||
| on: vi.fn(), | ||
| once: vi.fn(), | ||
| emit: vi.fn(), | ||
| } | ||
| vi.mocked(TerminalProcess).mockImplementation((): any => { | ||
| return mockProcess | ||
| }) | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| vi.clearAllMocks() | ||
| }) | ||
|
|
||
| it("should prepend cd command if requestedCwd differs from currentCwd", async () => { | ||
| terminal.requestedCwd = "/requested/cwd" | ||
| vi.spyOn(terminal, "getCurrentWorkingDirectory").mockReturnValue("/initial/cwd") | ||
|
|
||
| const callbacks = { | ||
| onLine: vi.fn(), | ||
| onCompleted: vi.fn(), | ||
| onShellExecutionStarted: vi.fn(), | ||
| onShellExecutionComplete: vi.fn(), | ||
| } | ||
|
|
||
| terminal.runCommand("ls", callbacks) | ||
|
|
||
| // Wait for the async operation to complete | ||
| await vi.waitFor(() => { | ||
| expect(mockProcess.command).toBe('cd "/requested/cwd" && ls') | ||
| expect(mockRun).toHaveBeenCalledWith('cd "/requested/cwd" && ls') | ||
| }) | ||
| }) | ||
|
|
||
| it("should not prepend cd command if requestedCwd is the same as currentCwd", async () => { | ||
| terminal.requestedCwd = "/initial/cwd" | ||
| vi.spyOn(terminal, "getCurrentWorkingDirectory").mockReturnValue("/initial/cwd") | ||
| const callbacks = { | ||
| onLine: vi.fn(), | ||
| onCompleted: vi.fn(), | ||
| onShellExecutionStarted: vi.fn(), | ||
| onShellExecutionComplete: vi.fn(), | ||
| } | ||
|
|
||
| terminal.runCommand("ls", callbacks) | ||
|
|
||
| // Wait for the async operation to complete | ||
| await vi.waitFor(() => { | ||
| expect(mockProcess.command).toBe("ls") | ||
| expect(mockRun).toHaveBeenCalledWith("ls") | ||
| }) | ||
| }) | ||
|
|
||
| it("should not prepend cd command if requestedCwd is not set", async () => { | ||
| vi.spyOn(terminal, "getCurrentWorkingDirectory").mockReturnValue("/initial/cwd") | ||
| const callbacks = { | ||
| onLine: vi.fn(), | ||
| onCompleted: vi.fn(), | ||
| onShellExecutionStarted: vi.fn(), | ||
| onShellExecutionComplete: vi.fn(), | ||
| } | ||
|
|
||
| terminal.runCommand("ls", callbacks) | ||
|
|
||
| // Wait for the async operation to complete | ||
| await vi.waitFor(() => { | ||
| expect(mockProcess.command).toBe("ls") | ||
| expect(mockRun).toHaveBeenCalledWith("ls") | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The path quoting here is insufficient to prevent shell injection. If
requestedCwdcontains a double quote or other shell metacharacters (e.g.,"/tmp/test"ing"or/tmp/test;rm -rf /), the command could be broken or exploited. Consider using a shell escaping function or switching to a safer approach like using the terminal's built-incdcommand through shell integration APIs if available, or properly escaping the path using a library designed for shell escaping.