Opensandbox (#6657)

* Opensandbox (#6651)

* volumn manager

* feat: opensandbox volumn

* perf: action (#6654)

* perf: action

* doc

* doc

* deploy tml

* update template
This commit is contained in:
Archer
2026-03-26 18:25:57 +08:00
committed by GitHub
parent d0f96723ea
commit cc3a91d009
114 changed files with 1966 additions and 953 deletions
@@ -0,0 +1,286 @@
/**
* API 测试 - 使用 app.request() 直接测试 Hono 路由
* 无需启动服务或配置 CODE_SANDBOX_URL
*/
import { describe, it, expect, beforeAll } from 'vitest';
import { app, poolReady } from '../../src/index';
import { config } from '../../src/config';
/** 构造请求 headers,自动带上 auth(如果配置了 token */
function headers(extra: Record<string, string> = {}): Record<string, string> {
const h: Record<string, string> = { ...extra };
if (config.token) {
h['Authorization'] = `Bearer ${config.token}`;
}
return h;
}
describe('API Routes', () => {
beforeAll(async () => {
await poolReady;
}, 30000);
// ===== Health =====
it('GET /health 返回 200', async () => {
const res = await app.request('/health');
expect(res.status).toBe(200);
const data = await res.json();
expect(data.status).toBe('ok');
});
// ===== JS =====
it('POST /sandbox/js 正常执行', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'async function main(v) { return { hello: v.name } }',
variables: { name: 'world' }
})
});
const data = await res.json();
expect(data.success).toBe(true);
expect(data.data.codeReturn.hello).toBe('world');
});
it('POST /sandbox/js 忽略额外参数', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'async function main(v) { return { ok: true } }',
variables: {}
})
});
const data = await res.json();
expect(data.success).toBe(true);
});
it('POST /sandbox/js 安全拦截', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'async function main() { require("child_process"); return {} }',
variables: {}
})
});
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toContain('not allowed');
});
// ===== Python =====
it('POST /sandbox/python 正常执行', async () => {
const res = await app.request('/sandbox/python', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'def main(variables):\n return {"hello": variables["name"]}',
variables: { name: 'world' }
})
});
const data = await res.json();
expect(data.success).toBe(true);
expect(data.data.codeReturn.hello).toBe('world');
});
it('POST /sandbox/python 安全拦截', async () => {
const res = await app.request('/sandbox/python', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'import os\ndef main(v):\n return {}',
variables: {}
})
});
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toContain('not in the allowlist');
});
// ===== Modules =====
it('GET /sandbox/modules 返回可用模块列表', async () => {
const res = await app.request('/sandbox/modules', {
headers: headers()
});
expect(res.status).toBe(200);
const data = await res.json();
expect(data.success).toBe(true);
expect(data.data.js).toEqual(config.jsAllowedModules);
expect(data.data.builtinGlobals).toContain('SystemHelper.httpRequest');
expect(data.data.python).toEqual(config.pythonAllowedModules);
});
});
// ===== 错误处理安全 =====
describe('API 错误处理安全', () => {
beforeAll(async () => {
await poolReady;
}, 30000);
it('JS 执行异常不泄露堆栈', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({
code: 'async function main() { null.x; }',
variables: {}
})
});
const data = await res.json();
expect(data.success).toBe(false);
// 错误信息不应包含宿主进程的真实文件路径(如 node_modules、/src/pool/
const msg = data.message || '';
expect(msg).not.toContain('node_modules');
expect(msg).not.toContain('/src/pool/');
expect(msg).not.toContain('process-pool');
});
it('无效 JSON body 返回 400', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: 'this is not json'
});
// Hono 解析 JSON 失败会抛异常,被 catch 捕获返回报错
// 或者 zod 校验失败返回 400
expect([400, 200]).toContain(res.status);
const data = await res.json();
if (res.status === 400) {
expect(data.success).toBe(false);
expect(data.message).toMatch(/invalid|validation/i);
} else {
// catch 分支
expect(data.success).toBe(false);
console.log(data, 123213213);
expect(data.message).toContain('is not valid JSON');
}
});
});
// ===== Zod 校验失败(有效 JSON 但 schema 不匹配) =====
describe('API Zod 校验失败', () => {
beforeAll(async () => {
await poolReady;
}, 30000);
it('JS: code 为数字返回 400', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({ code: 123, variables: {} })
});
expect(res.status).toBe(400);
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toMatch(/Invalid request/i);
});
it('JS: 缺少 code 字段返回 400', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({ variables: {} })
});
expect(res.status).toBe(400);
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toMatch(/Invalid request/i);
});
it('JS: code 为空字符串返回 400', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({ code: '', variables: {} })
});
expect(res.status).toBe(400);
const data = await res.json();
expect(data.success).toBe(false);
});
it('Python: code 为数字返回 400', async () => {
const res = await app.request('/sandbox/python', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({ code: 123, variables: {} })
});
expect(res.status).toBe(400);
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toMatch(/Invalid request/i);
});
it('Python: 缺少 code 字段返回 400', async () => {
const res = await app.request('/sandbox/python', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: JSON.stringify({ variables: {} })
});
expect(res.status).toBe(400);
const data = await res.json();
expect(data.success).toBe(false);
expect(data.message).toMatch(/Invalid request/i);
});
it('Python: 无效 JSON body 返回错误', async () => {
const res = await app.request('/sandbox/python', {
method: 'POST',
headers: headers({ 'Content-Type': 'application/json' }),
body: 'this is not json'
});
const data = await res.json();
expect(data.success).toBe(false);
});
});
/**
* Auth 测试
* 默认 SANDBOX_TOKEN 为空,auth 中间件不启用。
* 设置 SANDBOX_TOKEN=xxx 运行可测试鉴权逻辑。
*/
describe.skipIf(!config.token)('API Auth (requires SANDBOX_TOKEN)', () => {
it('无 Token 返回 401', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
code: 'async function main() { return {} }',
variables: {}
})
});
expect(res.status).toBe(401);
});
it('错误 Token 返回 401', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer wrong-token'
},
body: JSON.stringify({
code: 'async function main() { return {} }',
variables: {}
})
});
expect(res.status).toBe(401);
});
it('正确 Token 返回 200', async () => {
const res = await app.request('/sandbox/js', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${config.token}`
},
body: JSON.stringify({
code: 'async function main() { return { ok: true } }',
variables: {}
})
});
const data = await res.json();
expect(data.success).toBe(true);
});
});