@skyramp/mcp 0.3.2-rc.pom-3 → 0.3.2

package/build/tools/generate-tests/generateMockRestTool.d.ts

@@ -1,17 +1,34 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { TestType } from "../../types/TestTypes.js";
+import { MockProtocol } from "../../types/TestTypes.js";
+export { MockProtocol } from "../../types/TestTypes.js";
 import { TestGenerationService } from "../../services/TestGenerationService.js";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+export declare const MOCK_PROTOCOL_EXAMPLES = "\n<example protocol=\"rest\">\nGenerate a REST mock for one HTTP endpoint. Required fields: protocol=\"rest\", endpointURL, method. Use apiSchema with an empty method only when intentionally generating all schema methods.\n{\n  \"protocol\": \"rest\",\n  \"endpointURL\": \"http://payment-service:5001/orders/:order_id/payment_authorizations\",\n  \"method\": \"PUT\",\n  \"requestAware\": true,\n  \"requestData\": \"{\"payment_method_id\":\"pm_123\"}\",\n  \"responseData\": \"{\"accepted\":true}\",\n  \"responseStatusCode\": \"200\"\n}\n</example>\n\n<example protocol=\"rest-traffic-simulation\">\nGenerate a REST mock with traffic simulation (latency + drop rate). minLatency/maxLatency inject a random delay per response; dropRate drops a percentage of requests.\n{\n  \"protocol\": \"rest\",\n  \"endpointURL\": \"http://payment-service:5001/payments\",\n  \"method\": \"POST\",\n  \"responseData\": \"{\"status\":\"ok\"}\",\n  \"minLatency\": 500,\n  \"maxLatency\": 1000,\n  \"dropRate\": 10\n}\n</example>\n\n<example protocol=\"rest-conditional\">\nGenerate a conditional REST mock that selects a response based on request data. Use \"when\" to match request fields and \"requestSchema\" to validate the request body. Multiple mocks for the same endpoint+method are evaluated in order; the first matching \"when\" wins.\n{\n  \"protocol\": \"rest\",\n  \"endpointURL\": \"http://payment-service:5001/api/v1/orders\",\n  \"method\": \"POST\",\n  \"when\": {\"request.body.payment.method\": \"card\"},\n  \"requestSchema\": \"{\"type\":\"object\",\"required\":[\"orderId\",\"payment\"]}\",\n  \"responseData\": \"{\"status\":\"confirmed\"}\",\n  \"responseStatusCode\": \"201\",\n  \"noMatchStatusCode\": 404,\n  \"validationFailureStatusCode\": 422\n}\n</example>\n\n<example protocol=\"grpc\">\nGenerate a gRPC mock. Required fields: protocol=\"grpc\", endpointURL as host:port, protoPath, grpcServiceName. method is the RPC method name; omit or leave empty to generate all service methods. use responseData for successful protobuf-shaped responses, or grpcStatusCode/grpcStatusMessage for gRPC status errors.\n{\n  \"protocol\": \"grpc\",\n  \"endpointURL\": \"profile-service:50051\",\n  \"protoPath\": \"/repo/proto/profiles.proto\",\n  \"grpcServiceName\": \"ProfileService\",\n  \"method\": \"GetProfile\",\n  \"responseData\": \"{\"eligible\":true}\"\n}\n</example>\n\n<example protocol=\"grpc-traffic-simulation\">\nGenerate a gRPC mock with traffic simulation. Same latency/drop fields as REST.\n{\n  \"protocol\": \"grpc\",\n  \"endpointURL\": \"profile-service:50051\",\n  \"protoPath\": \"/repo/proto/profiles.proto\",\n  \"grpcServiceName\": \"ProfileService\",\n  \"method\": \"GetProfile\",\n  \"responseData\": \"{\"eligible\":true}\",\n  \"minLatency\": 200,\n  \"maxLatency\": 800,\n  \"dropRate\": 5\n}\n</example>\n\n<example protocol=\"grpc-status-error\">\nGenerate a gRPC status error mock. Do not provide responseData with grpcStatusCode.\n{\n  \"protocol\": \"grpc\",\n  \"endpointURL\": \"profile-service:50051\",\n  \"protoPath\": \"/repo/proto/profiles.proto\",\n  \"grpcServiceName\": \"ProfileService\",\n  \"method\": \"GetProfile\",\n  \"grpcStatusCode\": 5,\n  \"grpcStatusMessage\": \"profile not found\"\n}\n</example>\n\n<example protocol=\"kafka-producer\">\nGenerate a Kafka producer validation mock. Required fields: protocol=\"kafka\", endpointURL as broker host:port, kafkaTopic, and requestData. Do not pass method or responseData. Traffic simulation (minLatency/maxLatency/dropRate) is NOT supported for Kafka.\n{\n  \"protocol\": \"kafka\",\n  \"endpointURL\": \"broker:9092\",\n  \"kafkaTopic\": \"events\",\n  \"requestData\": \"{\"name\":\"order.created\"}\"\n}\n</example>\n\n<example protocol=\"kafka-consumer\">\nGenerate a Kafka consumer message mock. Required fields: protocol=\"kafka\", endpointURL as broker host:port, kafkaTopic, and responseData. Do not pass method or requestData. Traffic simulation (minLatency/maxLatency/dropRate) is NOT supported for Kafka.\n{\n  \"protocol\": \"kafka\",\n  \"endpointURL\": \"broker:9092\",\n  \"kafkaTopic\": \"events\",\n  \"responseData\": \"{\"accepted\":true}\"\n}\n</example>";
 type MockParams = {
+    protocol?: MockProtocol;
     endpointURL?: string;
+    protoPath?: string;
+    grpcServiceName?: string;
+    protobufExtraFiles?: string[];
+    protobufExtraImportPath?: string[];
+    kafkaTopic?: string;
     method?: string;
     apiSchema?: string;
     responseData?: string;
     responseStatusCode?: string;
+    grpcStatusCode?: number;
+    grpcStatusMessage?: string;
     requestData?: string;
     formParams?: string;
     requestAware?: boolean;
+    minLatency?: number;
+    maxLatency?: number;
+    dropRate?: number;
     trace?: string;
+    when?: Record<string, unknown>;
+    requestSchema?: string;
+    noMatchStatusCode?: number;
+    validationFailureStatusCode?: number;
     mockPort?: number;
     optionalFields?: boolean;
     language?: string;
@@ -28,14 +45,113 @@ type MockParams = {
     k8sContext?: string;
     prompt?: string;
 };
+export type TrafficConfigOptions = {
+    minLatency?: number;
+    maxLatency?: number;
+    dropRate?: number;
+};
+export declare function validateTrafficConfig(params: {
+    minLatency?: number;
+    maxLatency?: number;
+    dropRate?: number;
+}): string | null;
+export declare function buildTrafficConfigOptions(params: {
+    minLatency?: number;
+    maxLatency?: number;
+    dropRate?: number;
+}): TrafficConfigOptions;
 export declare class MockGenerationService extends TestGenerationService {
-    protected getTestType(): TestType;
+    protected getTestType(): "mock";
     generateTest(params: MockParams & Record<string, any>): Promise<CallToolResult>;
     private buildReorganizationInstructions;
+    protected validateInputs(params: MockParams & Record<string, any>): CallToolResult;
     protected buildGenerationOptions(params: MockParams): {
-        uri: string | undefined;
         method: string | undefined;
-        apiSchema: string[];
+        url: string | undefined;
+        protoPath: string | undefined;
+        service: string | undefined;
+        grpcStatusCode: number | undefined;
+        grpcStatusMessage: string | undefined;
+        extraFiles: string[];
+        extraImports: string[];
+        when: Record<string, unknown> | undefined;
+        requestSchema: string | undefined;
+        noMatchStatusCode: number;
+        validationFailureStatusCode: number;
+        minLatency?: number;
+        maxLatency?: number;
+        dropRate?: number;
+        responseData: string;
+        protocol: MockProtocol;
+        language: string;
+        framework: string;
+        output: string | undefined;
+        outputDir: string;
+        force: boolean;
+        deployDashboard: boolean | undefined;
+        runtime: string | undefined;
+        dockerNetwork: string | undefined;
+        dockerWorkerPort: string;
+        k8sNamespace: string | undefined;
+        k8sConfig: string | undefined;
+        k8sContext: string | undefined;
+        entrypoint: string;
+    } | {
+        method: string | undefined;
+        url: string | undefined;
+        protoPath: string | undefined;
+        service: string | undefined;
+        grpcStatusCode: number | undefined;
+        grpcStatusMessage: string | undefined;
+        extraFiles: string[];
+        extraImports: string[];
+        when: Record<string, unknown> | undefined;
+        requestSchema: string | undefined;
+        noMatchStatusCode: number;
+        validationFailureStatusCode: number;
+        minLatency?: number;
+        maxLatency?: number;
+        dropRate?: number;
+        responseData?: undefined;
+        protocol: MockProtocol;
+        language: string;
+        framework: string;
+        output: string | undefined;
+        outputDir: string;
+        force: boolean;
+        deployDashboard: boolean | undefined;
+        runtime: string | undefined;
+        dockerNetwork: string | undefined;
+        dockerWorkerPort: string;
+        k8sNamespace: string | undefined;
+        k8sConfig: string | undefined;
+        k8sContext: string | undefined;
+        entrypoint: string;
+    } | {
+        url: string | undefined;
+        topic: string | undefined;
+        requestData: string | undefined;
+        responseData: string;
+        protocol: MockProtocol;
+        language: string;
+        framework: string;
+        output: string | undefined;
+        outputDir: string;
+        force: boolean;
+        deployDashboard: boolean | undefined;
+        runtime: string | undefined;
+        dockerNetwork: string | undefined;
+        dockerWorkerPort: string;
+        k8sNamespace: string | undefined;
+        k8sConfig: string | undefined;
+        k8sContext: string | undefined;
+        entrypoint: string;
+    } | {
+        url: string | undefined;
+        topic: string | undefined;
+        requestData: string | undefined;
+        responseData?: undefined;
+        protocol: MockProtocol;
         language: string;
         framework: string;
         output: string | undefined;
@@ -48,17 +164,74 @@ export declare class MockGenerationService extends TestGenerationService {
         k8sNamespace: string | undefined;
         k8sConfig: string | undefined;
         k8sContext: string | undefined;
+        entrypoint: string;
+    } | {
+        method: string;
+        uri: string | undefined;
+        apiSchema: string[];
         requestData: string | undefined;
-        responseData: string | undefined;
         responseStatusCode: string | undefined;
         formParams: string | undefined;
         requestAware: boolean | undefined;
         traceFilePath: string | undefined;
+        mockPort: number;
+        optionalFields: boolean;
+        when: Record<string, unknown> | undefined;
+        requestSchema: string | undefined;
+        noMatchStatusCode: number | undefined;
+        validationFailureStatusCode: number | undefined;
+        minLatency?: number;
+        maxLatency?: number;
+        dropRate?: number;
+        responseData: string;
+        protocol: MockProtocol;
+        language: string;
+        framework: string;
+        output: string | undefined;
+        outputDir: string;
+        force: boolean;
+        deployDashboard: boolean | undefined;
+        runtime: string | undefined;
+        dockerNetwork: string | undefined;
+        dockerWorkerPort: string;
+        k8sNamespace: string | undefined;
+        k8sConfig: string | undefined;
+        k8sContext: string | undefined;
         entrypoint: string;
+    } | {
+        method: string;
+        uri: string | undefined;
+        apiSchema: string[];
+        requestData: string | undefined;
+        responseStatusCode: string | undefined;
+        formParams: string | undefined;
+        requestAware: boolean | undefined;
+        traceFilePath: string | undefined;
         mockPort: number;
         optionalFields: boolean;
+        when: Record<string, unknown> | undefined;
+        requestSchema: string | undefined;
+        noMatchStatusCode: number | undefined;
+        validationFailureStatusCode: number | undefined;
+        minLatency?: number;
+        maxLatency?: number;
+        dropRate?: number;
+        responseData?: undefined;
+        protocol: MockProtocol;
+        language: string;
+        framework: string;
+        output: string | undefined;
+        outputDir: string;
+        force: boolean;
+        deployDashboard: boolean | undefined;
+        runtime: string | undefined;
+        dockerNetwork: string | undefined;
+        dockerWorkerPort: string;
+        k8sNamespace: string | undefined;
+        k8sConfig: string | undefined;
+        k8sContext: string | undefined;
+        entrypoint: string;
     };
     protected executeGeneration(generateOptions: any): Promise<string>;
 }
 export declare function registerMockTool(server: McpServer): void;
-export {};