github-actions[bot]
ebee7d71b9
Created by Github action <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22715?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. --> Co-authored-by: github-actions <github-actions@twenty.com>
263 lines
8.7 KiB
Plaintext
263 lines
8.7 KiB
Plaintext
---
|
||
title: 测试
|
||
description: Vitest 设置、针对真实 Twenty 服务器的集成测试、类型检查，以及使用 GitHub Actions 的 CI。
|
||
icon: flask
|
||
---
|
||
|
||
该 SDK 提供可编程的 API，使你可以在测试代码中构建、部署、安装和卸载你的应用。 结合 [Vitest](https://vitest.dev/) 和类型化 API 客户端，你可以编写集成测试，在真实的 Twenty 服务器上验证你的应用端到端运行是否正常。
|
||
|
||
## 使用 npm 包
|
||
|
||
可以在应用中安装并使用任意 npm 包。 逻辑函数和前端组件都通过 [esbuild](https://esbuild.github.io/) 打包，所有依赖都会被内联到输出中——运行时不需要 `node_modules`。
|
||
|
||
### 安装包
|
||
|
||
```bash filename="Terminal"
|
||
yarn add axios
|
||
```
|
||
|
||
然后在代码中导入它：
|
||
|
||
```ts src/logic-functions/fetch-data.ts
|
||
import { defineLogicFunction } from 'twenty-sdk/define';
|
||
import axios from 'axios';
|
||
|
||
const handler = async (): Promise<any> => {
|
||
const { data } = await axios.get('https://api.example.com/data');
|
||
|
||
return { data };
|
||
};
|
||
|
||
export default defineLogicFunction({
|
||
universalIdentifier: '...',
|
||
name: 'fetch-data',
|
||
description: 'Fetches data from an external API',
|
||
timeoutSeconds: 10,
|
||
handler,
|
||
});
|
||
```
|
||
|
||
前端组件同样适用：
|
||
|
||
```tsx src/front-components/chart.tsx
|
||
import { defineFrontComponent } from 'twenty-sdk/define';
|
||
import { format } from 'date-fns';
|
||
|
||
const DateWidget = () => {
|
||
return <p>Today is {format(new Date(), 'MMMM do, yyyy')}</p>;
|
||
};
|
||
|
||
export default defineFrontComponent({
|
||
universalIdentifier: '...',
|
||
name: 'date-widget',
|
||
component: DateWidget,
|
||
});
|
||
```
|
||
|
||
### 打包的工作原理
|
||
|
||
构建步骤使用 esbuild 为每个逻辑函数和每个前端组件生成一个自包含文件。 所有导入的包都会被内联到打包产物中。
|
||
|
||
**逻辑函数** 运行在 Node.js 环境中。 Node 内置模块（`fs`、`path`、`crypto`、`http` 等） 可用且无需安装。
|
||
|
||
**前端组件** 运行在 Web Worker 中。 Node 内置模块不可用——仅可使用浏览器 API 以及可在浏览器环境中运行的 npm 包。
|
||
|
||
两个环境都将 `twenty-client-sdk/core` 和 `twenty-client-sdk/metadata` 作为预置模块提供 — 这些模块不会被打包，而是在运行时由服务器解析。
|
||
|
||
## 设置
|
||
|
||
脚手架生成的应用已包含 Vitest。 如果你手动进行设置，请安装这些依赖：
|
||
|
||
```bash filename="Terminal"
|
||
yarn add -D vitest vite-tsconfig-paths
|
||
```
|
||
|
||
在应用根目录下创建一个 `vitest.config.ts`：
|
||
|
||
```ts vitest.config.ts
|
||
import tsconfigPaths from 'vite-tsconfig-paths';
|
||
import { defineConfig } from 'vitest/config';
|
||
|
||
const TWENTY_API_URL = process.env.TWENTY_API_URL ?? 'http://localhost:2020';
|
||
const TWENTY_API_KEY = process.env.TWENTY_API_KEY ?? '<the pre-seeded local dev key>';
|
||
|
||
// Make env vars available to globalSetup (test.env only applies to workers)
|
||
process.env.TWENTY_API_URL = TWENTY_API_URL;
|
||
process.env.TWENTY_API_KEY = TWENTY_API_KEY;
|
||
|
||
export default defineConfig({
|
||
plugins: [
|
||
tsconfigPaths({
|
||
projects: ['tsconfig.spec.json'],
|
||
ignoreConfigErrors: true,
|
||
}),
|
||
],
|
||
test: {
|
||
testTimeout: 120_000,
|
||
hookTimeout: 120_000,
|
||
fileParallelism: false,
|
||
include: ['src/**/*.integration-test.ts'],
|
||
globalSetup: ['src/__tests__/global-setup.ts'],
|
||
env: {
|
||
TWENTY_API_URL,
|
||
TWENTY_API_KEY,
|
||
},
|
||
},
|
||
});
|
||
```
|
||
|
||
创建一个全局设置文件，用于验证服务器是否可访问，写入 SDK 的测试配置文件（`~/.twenty/config.test.json`），并在测试运行前同步应用：
|
||
|
||
```ts src/__tests__/global-setup.ts
|
||
import * as fs from 'fs';
|
||
import * as os from 'os';
|
||
import * as path from 'path';
|
||
|
||
import { appDevOnce, appUninstall } from 'twenty-sdk/cli';
|
||
|
||
const APP_PATH = process.cwd();
|
||
const CONFIG_DIR = path.join(os.homedir(), '.twenty');
|
||
|
||
export async function setup() {
|
||
const apiUrl = process.env.TWENTY_API_URL!;
|
||
const apiKey = process.env.TWENTY_API_KEY!;
|
||
|
||
// Verify the server is running
|
||
const response = await fetch(`${apiUrl}/healthz`);
|
||
if (!response.ok) {
|
||
throw new Error(`Twenty server is not reachable at ${apiUrl}.`);
|
||
}
|
||
|
||
// Write the SDK's test config (the CLI reads config.test.json when NODE_ENV=test)
|
||
fs.mkdirSync(CONFIG_DIR, { recursive: true });
|
||
fs.writeFileSync(
|
||
path.join(CONFIG_DIR, 'config.test.json'),
|
||
JSON.stringify({
|
||
remotes: { local: { apiUrl, apiKey } },
|
||
defaultRemote: 'local',
|
||
}, null, 2),
|
||
);
|
||
|
||
// Start from a clean slate, then sync the app
|
||
await appUninstall({ appPath: APP_PATH }).catch(() => {});
|
||
|
||
const result = await appDevOnce({ appPath: APP_PATH });
|
||
if (!result.success) {
|
||
throw new Error(`Dev sync failed: ${result.error?.message}`);
|
||
}
|
||
}
|
||
|
||
export async function teardown() {
|
||
await appUninstall({ appPath: APP_PATH });
|
||
}
|
||
```
|
||
|
||
## 可编程的 SDK API
|
||
|
||
子路径 `twenty-sdk/cli` 导出了可直接在测试代码中调用的函数：
|
||
|
||
| 函数 | 描述 |
|
||
| -------------- | ----------------------------------- |
|
||
| `appBuild` | 构建应用，并可选地打包为 tar 包 |
|
||
| `appDeploy` | 将 tar 包上传到服务器 |
|
||
| `appDevOnce` | 构建并同步应用一次（与 `yarn twenty apply` 相同） |
|
||
| `appInstall` | 在活动工作区安装该应用 |
|
||
| `appUninstall` | 从活动工作区卸载该应用 |
|
||
|
||
每个函数都会返回一个结果对象，包含 `success: boolean`，以及 `data` 或 `error` 之一。
|
||
|
||
## 编写集成测试
|
||
|
||
下面是一个完整示例：构建、部署并安装该应用，然后验证它出现在工作区中：
|
||
|
||
```ts src/__tests__/app-install.integration-test.ts
|
||
import { APPLICATION_UNIVERSAL_IDENTIFIER } from 'src/application-config';
|
||
import { appBuild, appDeploy, appInstall, appUninstall } from 'twenty-sdk/cli';
|
||
import { MetadataApiClient } from 'twenty-client-sdk/metadata';
|
||
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
|
||
|
||
const APP_PATH = process.cwd();
|
||
|
||
describe('App installation', () => {
|
||
beforeAll(async () => {
|
||
const buildResult = await appBuild({
|
||
appPath: APP_PATH,
|
||
tarball: true,
|
||
onProgress: (message: string) => console.log(`[build] ${message}`),
|
||
});
|
||
|
||
if (!buildResult.success) {
|
||
throw new Error(`Build failed: ${buildResult.error?.message}`);
|
||
}
|
||
|
||
const deployResult = await appDeploy({
|
||
tarballPath: buildResult.data.tarballPath!,
|
||
onProgress: (message: string) => console.log(`[deploy] ${message}`),
|
||
});
|
||
|
||
if (!deployResult.success) {
|
||
throw new Error(`Deploy failed: ${deployResult.error?.message}`);
|
||
}
|
||
|
||
const installResult = await appInstall({ appPath: APP_PATH });
|
||
|
||
if (!installResult.success) {
|
||
throw new Error(`Install failed: ${installResult.error?.message}`);
|
||
}
|
||
});
|
||
|
||
afterAll(async () => {
|
||
await appUninstall({ appPath: APP_PATH });
|
||
});
|
||
|
||
it('should find the installed app in the workspace', async () => {
|
||
const metadataClient = new MetadataApiClient();
|
||
|
||
const result = await metadataClient.query({
|
||
findManyApplications: {
|
||
id: true,
|
||
name: true,
|
||
universalIdentifier: true,
|
||
},
|
||
});
|
||
|
||
const installedApp = result.findManyApplications.find(
|
||
(app: { universalIdentifier: string }) =>
|
||
app.universalIdentifier === APPLICATION_UNIVERSAL_IDENTIFIER,
|
||
);
|
||
|
||
expect(installedApp).toBeDefined();
|
||
});
|
||
});
|
||
```
|
||
|
||
## 运行测试
|
||
|
||
确保你的本地 Twenty 服务器正在运行，然后：
|
||
|
||
```bash filename="Terminal"
|
||
yarn test
|
||
```
|
||
|
||
或者在开发期间使用监听模式：
|
||
|
||
```bash filename="Terminal"
|
||
yarn test:watch
|
||
```
|
||
|
||
## 类型检查
|
||
|
||
你也可以在不运行测试的情况下对应用进行类型检查：
|
||
|
||
```bash filename="Terminal"
|
||
yarn twenty dev:typecheck
|
||
```
|
||
|
||
这会针对你的应用的 `tsconfig.json` 运行 `tsc --noEmit`，并报告所有类型错误。 脚手架生成的应用还会提供一个 `yarn typecheck` 脚本，它也会覆盖测试文件（`tsconfig.spec.json`）。
|
||
|
||
## 使用 GitHub Actions 进行 CI
|
||
|
||
脚手架工具会在 `.github/workflows/ci.yml` 生成一个开箱即用的工作流。 在每次向 `main` 推送代码以及每个拉取请求上，它都会在 runner 中启动一个临时的 Twenty 服务器（通过 `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test` action），然后运行 `yarn lint`、`yarn typecheck`、`yarn test:unit` 和 `yarn test`，并将 `TWENTY_API_URL` / `TWENTY_API_KEY` 指向该服务器。 无需任何机密信息，你可以在工作流顶部通过 `TWENTY_VERSION` 环境变量固定服务器版本。
|
||
|
||
完整的脚手架工作流（`ci.yml` 和 `cd.yml` 部署流水线）的演练说明，请参见 [发布 → 自动化 CI/CD](/l/zh/developers/extend/apps/operations/publishing#automated-cicd-scaffolded-workflows)。
|