Import packages/plugin/tests/workspace-file-reasons.test.ts
This commit is contained in:
parent
8f6d5dd640
commit
897c0560ec
|
|
@ -0,0 +1,108 @@
|
|||
import { mkdir, mkdtemp, open, rm, symlink, writeFile } from 'node:fs/promises'
|
||||
import { tmpdir } from 'node:os'
|
||||
import { join } from 'node:path'
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest'
|
||||
import { HarnessRemoteBridge } from '../src/harness-remote-bridge.js'
|
||||
import type { LocalTypertGateway } from '../src/typert-gateway-contract.js'
|
||||
|
||||
const directories: string[] = []
|
||||
afterEach(async () => {
|
||||
await Promise.all(directories.splice(0).map(directory => rm(directory, { recursive: true, force: true })))
|
||||
})
|
||||
|
||||
function gateway(dispatch: LocalTypertGateway['dispatch']): LocalTypertGateway {
|
||||
return {
|
||||
invoke: async () => undefined,
|
||||
dispatch,
|
||||
open: async () => (async function* () { return })(),
|
||||
failure: () => ({ code: 'internal', message: 'Request failed.', details: {} }),
|
||||
supportsCarrier: true,
|
||||
}
|
||||
}
|
||||
|
||||
async function fixture() {
|
||||
const base = await mkdtemp(join(tmpdir(), 'dsh-workspace-reason-'))
|
||||
directories.push(base)
|
||||
const root = join(base, 'root')
|
||||
const outside = join(base, 'outside')
|
||||
await mkdir(root)
|
||||
await mkdir(outside)
|
||||
await mkdir(join(root, 'sub'))
|
||||
await writeFile(join(root, 'inside.txt'), 'inside')
|
||||
await writeFile(join(root, 'sub', 'nested.txt'), 'nested')
|
||||
await writeFile(join(outside, 'secret.txt'), 'secret')
|
||||
await symlink(join(outside, 'secret.txt'), join(root, 'link.txt'))
|
||||
await symlink(outside, join(root, 'dirlink'), process.platform === 'win32' ? 'junction' : 'dir')
|
||||
const big = await open(join(root, 'big.bin'), 'w')
|
||||
await big.truncate(5 * 1024 * 1024)
|
||||
await big.close()
|
||||
const alias = join(base, 'alias')
|
||||
await symlink(root, alias, process.platform === 'win32' ? 'junction' : 'dir')
|
||||
return { root, alias, outside }
|
||||
}
|
||||
|
||||
function bridgeFor(root: string, dispatch: LocalTypertGateway['dispatch']) {
|
||||
return new HarnessRemoteBridge(
|
||||
gateway(dispatch),
|
||||
vi.fn(async () => undefined),
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
async sessionId => sessionId === 's1' ? root : undefined,
|
||||
)
|
||||
}
|
||||
|
||||
describe('workspace file denial reasons', () => {
|
||||
it('classifies each containment rule without exposing paths or file contents', async () => {
|
||||
const { root, outside } = await fixture()
|
||||
const dispatch = vi.fn(async () => ({ ok: true as const, value: { text: 'inside' } }))
|
||||
const bridge = bridgeFor(root, dispatch)
|
||||
const call = (endpoint: string, args: Record<string, unknown>) => bridge.call({ endpoint, payload: { args } })
|
||||
|
||||
await expect(call('workspaceFiles/read', { workspaceFileScopeId: 's1', path: 'inside.txt' }))
|
||||
.resolves.toMatchObject({ ok: true })
|
||||
|
||||
const scenarios = [
|
||||
{ name: 'missing scope', endpoint: 'workspaceFiles/read', args: { path: 'inside.txt' }, code: 'WORKSPACE_UNAVAILABLE', reason: 'scope-missing' },
|
||||
{ name: 'unknown session', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 'missing', path: 'inside.txt' }, code: 'WORKSPACE_UNAVAILABLE', reason: 'authority-unavailable' },
|
||||
{ name: 'parent traversal', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 's1', path: '../outside/secret.txt' }, code: 'WORKSPACE_PATH_DENIED', reason: 'outside-root' },
|
||||
{ name: 'absolute outside', endpoint: 'workspaceFiles/stat', args: { workspaceFileScopeId: 's1', path: join(outside, 'secret.txt') }, code: 'WORKSPACE_PATH_DENIED', reason: 'outside-root' },
|
||||
{ name: 'symlink target', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 's1', path: 'link.txt' }, code: 'WORKSPACE_PATH_DENIED', reason: 'symlink' },
|
||||
{ name: 'symlink ancestor', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 's1', path: 'dirlink/secret.txt' }, code: 'WORKSPACE_PATH_DENIED', reason: 'symlink' },
|
||||
{ name: 'directory as file', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 's1', path: 'sub' }, code: 'WORKSPACE_PATH_DENIED', reason: 'not-regular-file' },
|
||||
{ name: 'missing file', endpoint: 'workspaceFiles/read', args: { workspaceFileScopeId: 's1', path: 'sub/missing.txt' }, code: 'WORKSPACE_PATH_DENIED', reason: 'not-found' },
|
||||
{ name: 'oversized readAll', endpoint: 'workspaceFiles/readAll', args: { workspaceFileScopeId: 's1', path: 'big.bin' }, code: 'WORKSPACE_TOO_LARGE', reason: 'too-large' },
|
||||
]
|
||||
|
||||
for (const scenario of scenarios) {
|
||||
const before = dispatch.mock.calls.length
|
||||
await expect(call(scenario.endpoint, scenario.args)).rejects.toMatchObject({
|
||||
code: scenario.code,
|
||||
details: { reason: scenario.reason },
|
||||
})
|
||||
expect(dispatch.mock.calls.length, scenario.name).toBe(before)
|
||||
}
|
||||
})
|
||||
|
||||
it('uses the canonical root when the session path is reached through a symlink', async () => {
|
||||
const { alias, outside } = await fixture()
|
||||
const dispatch = vi.fn(async () => ({ ok: true as const, value: { text: 'inside' } }))
|
||||
const bridge = bridgeFor(alias, dispatch)
|
||||
await expect(bridge.call({ endpoint: 'workspaceFiles/read', payload: { args: { workspaceFileScopeId: 's1', path: 'sub/nested.txt' } } }))
|
||||
.resolves.toMatchObject({ ok: true })
|
||||
await expect(bridge.call({ endpoint: 'workspaceFiles/read', payload: { args: { workspaceFileScopeId: 's1', path: join(outside, 'secret.txt') } } }))
|
||||
.rejects.toMatchObject({ code: 'WORKSPACE_PATH_DENIED', details: { reason: 'outside-root' } })
|
||||
})
|
||||
|
||||
it('keeps baseFile traversal inside the same containment rules', async () => {
|
||||
const { root } = await fixture()
|
||||
const dispatch = vi.fn(async () => ({ ok: true as const, value: { text: 'inside' } }))
|
||||
const bridge = bridgeFor(root, dispatch)
|
||||
await expect(bridge.call({
|
||||
endpoint: 'workspaceFiles/readBytes',
|
||||
payload: { args: { workspaceFileScopeId: 's1', path: '../outside/secret.txt', options: { baseFile: 'inside.txt' } } },
|
||||
})).rejects.toMatchObject({ code: 'WORKSPACE_PATH_DENIED', details: { reason: 'outside-root' } })
|
||||
expect(dispatch).not.toHaveBeenCalled()
|
||||
})
|
||||
})
|
||||
Loading…
Reference in New Issue