ci: e2e test (#142)

chihiro-adachi · web-flow · commit 2ac9cb349776 · 2025-12-01T16:48:28.000+09:00
diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
@@ -0,0 +1,70 @@
+name: e2e
+
+on:
+  push:
+    branches:
+      - main
+      - "renovate/**"
+  workflow_dispatch:
+
+concurrency:
+  group: e2e
+  cancel-in-progress: false
+
+jobs:
+  e2e-test:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        runtime: [docker, npm]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version-file: .node-version
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      # Docker runtime setup
+      - name: Set up Docker Buildx
+        if: matrix.runtime == 'docker'
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3
+
+      - name: Build Docker image
+        if: matrix.runtime == 'docker'
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          tags: kintone-mcp-server:e2e
+          load: true
+        env:
+          DOCKER_BUILD_SUMMARY: false
+
+      # npm runtime setup
+      - name: Install @kintone/mcp-server
+        if: matrix.runtime == 'npm'
+        run: |
+          pnpm build
+          pnpm add -g .
+
+      # E2E test execution
+      - name: Run E2E tests
+        env:
+          RUNTIME: ${{ matrix.runtime }}
+          APP_ID: ${{ secrets.E2E_APP_ID }}
+          KINTONE_BASE_URL: ${{ secrets.E2E_KINTONE_BASE_URL }}
+          KINTONE_USERNAME: ${{ secrets.E2E_KINTONE_USERNAME }}
+          KINTONE_PASSWORD: ${{ secrets.E2E_KINTONE_PASSWORD }}
+        run: |
+          pnpm test:e2e
diff --git a/e2e/client.ts b/e2e/client.ts
@@ -0,0 +1,78 @@
+import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
+import type { ProvidedConfig } from "../src/config/types/config.js";
+import { Client } from "@modelcontextprotocol/sdk/client";
+
+export const createClient = async (transport: StdioClientTransport) => {
+  const client = new Client({
+    name: "e2e-client",
+    version: "1.0.0",
+  });
+  await client.connect(transport);
+  return client;
+};
+
+export type Runtime = "docker" | "npm";
+
+export const createTransport = (
+  runtime: Runtime,
+  config: ProvidedConfig,
+): StdioClientTransport => {
+  switch (runtime) {
+    case "docker":
+      return createDockerTransport(config);
+    case "npm":
+      return createNpmTransport(config);
+    default:
+      throw new Error(`Unknown runtime: ${runtime}`);
+  }
+};
+
+export const createDockerTransport = (config: ProvidedConfig) => {
+  return new StdioClientTransport({
+    command: "docker",
+    args: [
+      "run",
+      "-i",
+      "--rm",
+      // -eフラグを展開
+      // e.g. "-e", "KINTONE_BASE_URL", "-e", "KINTONE_API_TOKEN", ...
+      ...Object.keys(config).flatMap((key) => ["-e", key]),
+      "kintone-mcp-server:e2e",
+    ],
+    env: {
+      PATH: "/usr/local/bin:/usr/bin:/bin",
+      ...config,
+    },
+  });
+};
+
+const ENV_TO_CLI_ARG = {
+  KINTONE_BASE_URL: "--base-url",
+  KINTONE_USERNAME: "--username",
+  KINTONE_PASSWORD: "--password",
+  KINTONE_API_TOKEN: "--api-token",
+  KINTONE_BASIC_AUTH_USERNAME: "--basic-auth-username",
+  KINTONE_BASIC_AUTH_PASSWORD: "--basic-auth-password",
+  HTTPS_PROXY: "--proxy",
+  KINTONE_PFX_FILE_PATH: "--pfx-file-path",
+  KINTONE_PFX_FILE_PASSWORD: "--pfx-file-password",
+  KINTONE_ATTACHMENTS_DIR: "--attachments-dir",
+} as const;
+
+const isEnvKey = (key: string): key is keyof typeof ENV_TO_CLI_ARG =>
+  key in ENV_TO_CLI_ARG;
+
+export const createNpmTransport = (config: ProvidedConfig) => {
+  const args: string[] = ["kintone-mcp-server"];
+
+  for (const [envKey, value] of Object.entries(config)) {
+    if (value !== undefined && isEnvKey(envKey)) {
+      args.push(ENV_TO_CLI_ARG[envKey], value);
+    }
+  }
+
+  return new StdioClientTransport({
+    command: "npx",
+    args,
+  });
+};
diff --git a/e2e/config.ts b/e2e/config.ts
@@ -0,0 +1,6 @@
+import z from "zod";
+
+export const testConfigSchema = z.object({
+  APP_ID: z.string(),
+  RUNTIME: z.enum(["docker", "npm"]),
+});
diff --git a/e2e/install.test.ts b/e2e/install.test.ts
@@ -0,0 +1,91 @@
+import { describe, it, expect, beforeAll, afterAll } from "vitest";
+import type { Client } from "@modelcontextprotocol/sdk/client";
+import { createClient, createTransport } from "./client";
+import { configSchema } from "../src/config/schema";
+import { testConfigSchema } from "./config";
+import type { ProvidedConfig } from "../src/config/types/config";
+
+describe("MCP Server Installation E2E Tests", () => {
+  const mcpConfig = configSchema.parse(process.env);
+
+  const config: ProvidedConfig = {
+    KINTONE_BASE_URL: mcpConfig.KINTONE_BASE_URL,
+    KINTONE_USERNAME: mcpConfig.KINTONE_USERNAME,
+    KINTONE_PASSWORD: mcpConfig.KINTONE_PASSWORD,
+  };
+
+  const testConfig = testConfigSchema.parse(process.env);
+
+  const appId = testConfig.APP_ID;
+  const runtime = testConfig.RUNTIME;
+
+  let client: Client;
+
+  beforeAll(async () => {
+    const transport = createTransport(runtime, config);
+    client = await createClient(transport);
+  });
+
+  afterAll(async () => {
+    await client.close();
+  });
+
+  describe("Tool List Verification", () => {
+    it("should list all kintone tools correctly", async () => {
+      // Act
+      const tools = await client.listTools();
+      const toolNames = tools.tools.map((tool) => tool.name);
+
+      // Assert
+      expect(tools.tools).toBeInstanceOf(Array);
+      expect(tools.tools.length).toBeGreaterThan(0);
+
+      // 特定のツールが含まれていることを確認
+      expect(toolNames).toContain("kintone-get-app");
+
+      // すべてのツールがkintoneプレフィックスを持つことを確認
+      tools.tools.forEach((tool) => {
+        expect(tool).toHaveProperty("name");
+        expect(tool).toHaveProperty("description");
+        expect(tool).toHaveProperty("inputSchema");
+        expect(tool.name).toMatch(/^kintone-/);
+      });
+    });
+  });
+
+  describe("Tool Execution Verification", () => {
+    it("should execute kintone-get-app tool correctly", async () => {
+      // Act
+      const result = await client.callTool({
+        name: "kintone-get-app",
+        arguments: {
+          appId: appId,
+        },
+      });
+
+      // Assert
+      expect(result).not.toHaveProperty("isError");
+      expect(result).toHaveProperty("content");
+      expect(result).toHaveProperty("structuredContent");
+
+      // content配列の検証
+      expect(result.content).toBeInstanceOf(Array);
+      expect((result.content as unknown[]).length).toBeGreaterThan(0);
+      expect((result.content as unknown[])[0]).toHaveProperty("type", "text");
+      expect((result.content as unknown[])[0]).toHaveProperty("text");
+
+      // structuredContentの検証
+      const structuredContent = result.structuredContent as Record<
+        string,
+        unknown
+      >;
+      expect(structuredContent).toHaveProperty("appId", appId);
+      expect(structuredContent).toHaveProperty("name");
+      expect(structuredContent).toHaveProperty("description");
+      expect(structuredContent).toHaveProperty("createdAt");
+      expect(structuredContent).toHaveProperty("creator");
+      expect(structuredContent).toHaveProperty("modifiedAt");
+      expect(structuredContent).toHaveProperty("modifier");
+    });
+  });
+});
diff --git a/package.json b/package.json
@@ -54,6 +54,7 @@
     "start": "node dist/index.js",
     "test": "vitest",
     "test:coverage": "vitest --coverage",
+    "test:e2e": "vitest --config vitest.config.e2e.ts",
     "test:watch": "vitest --watch",
     "typecheck": "tsc -noEmit "
   },
diff --git a/tsconfig.json b/tsconfig.json
@@ -113,6 +113,8 @@
   "exclude": [
     "**/*.test.ts",
     "**/__tests__/**/*",
+    "e2e",
+    "vitest.config*.ts",
     "node_modules",
     "dist"
   ]
diff --git a/vitest.config.e2e.ts b/vitest.config.e2e.ts
@@ -0,0 +1,17 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    // e2eフォルダのテストのみ実行
+    include: ["e2e/**/*.test.ts"],
+    exclude: ["**/node_modules/**", "**/dist/**", "**/build/**"],
+    // 実環境を利用するため、並列実行を無効化して順次実行
+    fileParallelism: false,
+    pool: "forks",
+    poolOptions: {
+      forks: {
+        singleFork: true,
+      },
+    },
+  },
+});
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    exclude: ["**/node_modules/**", "**/dist/**", "**/build/**", "e2e/**"],
+  },
+});

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,8 @@`
`113`	`113`	`"exclude": [`
`114`	`114`	`"*/.test.ts",`
`115`	`115`	`"/__tests__//*",`
	`116`	`+ "e2e",`
	`117`	`+ "vitest.config*.ts",`
`116`	`118`	`"node_modules",`
`117`	`119`	`"dist"`
`118`	`120`	`]`