@bryan-thompson/inspector-assessment-client 1.5.0 → 1.7.0

package/lib/services/assessment/TestDataGenerator.js

@@ -0,0 +1,669 @@
+/**
+ * Smart Test Data Generator for MCP Tool Testing
+ * Generates realistic, context-aware test data based on parameter schemas
+ *
+ * Supports optional Claude Code integration for intelligent test generation
+ * when ClaudeCodeBridge is provided.
+ */
+export class TestDataGenerator {
+    // Optional Claude Code bridge for intelligent test generation
+    static claudeBridge = null;
+    /**
+     * Set the Claude Code bridge for intelligent test generation
+     * Call this once during initialization if Claude integration is enabled
+     */
+    static setClaudeBridge(bridge) {
+        this.claudeBridge = bridge;
+    }
+    /**
+     * Check if Claude Code integration is available and enabled
+     */
+    static isClaudeEnabled() {
+        return (this.claudeBridge !== null &&
+            this.claudeBridge.isFeatureEnabled("intelligentTestGeneration"));
+    }
+    // Realistic data pools for different types - using values that are more likely to exist
+    static REALISTIC_DATA = {
+        urls: [
+            "https://www.google.com", // Public, always accessible
+            "https://api.github.com/users/octocat", // Public API endpoint that exists
+            "https://jsonplaceholder.typicode.com/posts/1", // Test API that always works
+            "https://httpbin.org/get", // HTTP testing service
+            "https://example.com", // RFC 2606 reserved domain for examples
+            "https://www.wikipedia.org", // Public, stable site
+            "https://api.openweathermap.org/data/2.5/weather?q=London", // Public API
+        ],
+        emails: [
+            "admin@example.com", // Common admin email
+            "support@example.com", // Common support email
+            "info@example.com", // Common info email
+            "test@test.com", // Generic test email
+            "user@domain.com", // Generic user email
+            "noreply@example.com", // Common no-reply format
+            "hello@world.com", // Simple, memorable
+        ],
+        names: [
+            "Default", // Common default name
+            "Admin", // Common admin user
+            "Test User", // Clear test user
+            "Sample Item", // Generic sample
+            "Example Project", // Clear example
+            "Demo Application", // Common demo name
+            "Main", // Common main/primary name
+        ],
+        ids: [
+            "1", // Simple numeric ID that often exists
+            "123", // Common test ID
+            "550e8400-e29b-41d4-a716-446655440000", // Valid UUID v4 (replaces "test")
+            "default", // Common default ID
+            "main", // Common main ID
+            "264051cd-48ab-80ff-864e-d1aa9bc41429", // Valid UUID from realistic data
+            "00000000-0000-0000-0000-000000000000", // Nil UUID (often used as placeholder)
+            "admin", // Common admin ID
+            "user1", // Common user ID pattern
+        ],
+        paths: [
+            "/tmp/test.txt", // Common temp file path (usually writable)
+            "/home", // Common home directory
+            "./README.md", // Often exists in projects
+            "./package.json", // Common in Node projects
+            "./src", // Common source directory
+            "./test", // Common test directory
+            "./config", // Common config directory
+            "/var/log", // Common log directory (readable)
+            "/etc", // Common config directory (readable)
+        ],
+        queries: [
+            "test", // Simple search term
+            "hello", // Common greeting
+            "*", // Wildcard that matches everything
+            "name", // Common field name
+            "id:1", // Common ID search
+            "status:active", // Common status filter
+            "type:user", // Common type filter
+            "limit:10", // Common pagination
+            '{"match_all": {}}', // Elasticsearch match all
+        ],
+        numbers: [0, 1, 10, 100, 1000, 5, 50, 200, 404, 500],
+        booleans: [true, false],
+        jsonObjects: [
+            { message: "Hello World" }, // Simple message object
+            { status: "ok", code: 200 }, // Common status response
+            { data: [], total: 0 }, // Empty result set
+            { id: 1, name: "Test" }, // Simple entity
+            { success: true }, // Common success response
+            { error: false }, // Common no-error response
+            { results: [] }, // Common empty results
+            {}, // Empty object (often valid)
+        ],
+        arrays: [
+            [], // Empty array (often valid)
+            [1], // Single item
+            ["a", "b", "c"], // Simple string array
+            [1, 2, 3], // Simple number array
+            [{ id: 1 }, { id: 2 }], // Simple object array
+            ["test"], // Single test item
+            [true, false], // Boolean array
+        ],
+        timestamps: [
+            new Date().toISOString(), // Current time (always valid)
+            new Date(Date.now() - 86400000).toISOString(), // Yesterday
+            new Date(Date.now() + 86400000).toISOString(), // Tomorrow
+            "2024-01-01T00:00:00Z", // New Year 2024
+            "2023-12-31T23:59:59Z", // End of 2023
+            new Date(0).toISOString(), // Unix epoch
+            "2024-06-15T12:00:00Z", // Midday mid-year
+        ],
+    };
+    /**
+     * Generate multiple test scenarios for a tool
+     * Uses Claude Code if available for intelligent generation,
+     * otherwise falls back to schema-based generation.
+     */
+    static generateTestScenarios(tool) {
+        const scenarios = [];
+        // Always include at least one happy path scenario
+        scenarios.push(this.generateHappyPathScenario(tool));
+        // Add edge cases based on tool complexity
+        const edgeCases = this.generateEdgeCaseScenarios(tool);
+        scenarios.push(...edgeCases);
+        // Add boundary value scenarios for numeric inputs
+        const boundaryScenarios = this.generateBoundaryScenarios(tool);
+        scenarios.push(...boundaryScenarios);
+        // Add one error scenario to test error handling
+        scenarios.push(this.generateErrorScenario(tool));
+        return scenarios;
+    }
+    /**
+     * Generate test scenarios with optional Claude enhancement
+     * This async version tries Claude first if enabled, then falls back to schema-based.
+     */
+    static async generateTestScenariosAsync(tool) {
+        // Try Claude-enhanced generation first
+        if (this.isClaudeEnabled() && this.claudeBridge) {
+            try {
+                const claudeParams = await this.claudeBridge.generateTestParameters(tool);
+                if (claudeParams && claudeParams.length > 0) {
+                    console.log(`[TestDataGenerator] Using Claude-generated params for ${tool.name}`);
+                    // Convert Claude params to TestScenario format
+                    const claudeScenarios = claudeParams.map((params, index) => ({
+                        name: this.getClaudeScenarioName(index),
+                        description: `Claude-generated test case ${index + 1} for ${tool.name}`,
+                        params,
+                        expectedBehavior: "Should execute successfully with valid response",
+                        category: this.getClaudeScenarioCategory(index),
+                        source: "claude-generated",
+                    }));
+                    // Add one error scenario (Claude focuses on valid inputs)
+                    claudeScenarios.push({
+                        ...this.generateErrorScenario(tool),
+                        source: "schema-based",
+                    });
+                    return claudeScenarios;
+                }
+            }
+            catch (error) {
+                console.warn(`[TestDataGenerator] Claude generation failed for ${tool.name}, falling back to schema-based:`, error);
+            }
+        }
+        // Fall back to schema-based generation
+        return this.generateTestScenarios(tool).map((scenario) => ({
+            ...scenario,
+            source: "schema-based",
+        }));
+    }
+    /**
+     * Get scenario name based on index for Claude-generated scenarios
+     */
+    static getClaudeScenarioName(index) {
+        const names = [
+            "Happy Path - Typical Usage",
+            "Edge Case - Boundary Values",
+            "Minimal Input - Required Fields Only",
+            "Comprehensive - All Fields Populated",
+            "Variant - Alternative Valid Input",
+        ];
+        return names[index] || `Test Case ${index + 1}`;
+    }
+    /**
+     * Get scenario category based on index for Claude-generated scenarios
+     */
+    static getClaudeScenarioCategory(index) {
+        const categories = [
+            "happy_path",
+            "edge_case",
+            "boundary",
+            "happy_path",
+            "edge_case",
+        ];
+        return categories[index] || "happy_path";
+    }
+    /**
+     * Generate a happy path scenario with realistic data
+     */
+    static generateHappyPathScenario(tool) {
+        const params = this.generateRealisticParams(tool, "typical");
+        return {
+            name: "Happy Path - Typical Usage",
+            description: `Test ${tool.name} with typical, valid inputs`,
+            params,
+            expectedBehavior: "Should execute successfully and return valid response",
+            category: "happy_path",
+        };
+    }
+    /**
+     * Generate edge case scenarios
+     */
+    static generateEdgeCaseScenarios(tool) {
+        const scenarios = [];
+        // Empty values scenario (where applicable)
+        const emptyParams = this.generateRealisticParams(tool, "empty");
+        if (Object.keys(emptyParams).length > 0) {
+            scenarios.push({
+                name: "Edge Case - Empty Values",
+                description: "Test with empty but valid values",
+                params: emptyParams,
+                expectedBehavior: "Should handle empty values gracefully",
+                category: "edge_case",
+            });
+        }
+        // Maximum values scenario
+        const maxParams = this.generateRealisticParams(tool, "maximum");
+        scenarios.push({
+            name: "Edge Case - Maximum Values",
+            description: "Test with maximum/large values",
+            params: maxParams,
+            expectedBehavior: "Should handle large inputs without issues",
+            category: "edge_case",
+        });
+        // Special characters scenario (for string inputs)
+        if (this.hasStringInputs(tool)) {
+            const specialParams = this.generateRealisticParams(tool, "special");
+            scenarios.push({
+                name: "Edge Case - Special Characters",
+                description: "Test with special characters and unicode",
+                params: specialParams,
+                expectedBehavior: "Should properly handle special characters",
+                category: "edge_case",
+            });
+        }
+        return scenarios;
+    }
+    /**
+     * Generate boundary value scenarios
+     */
+    static generateBoundaryScenarios(tool) {
+        const scenarios = [];
+        if (!tool.inputSchema || tool.inputSchema.type !== "object") {
+            return scenarios;
+        }
+        const properties = tool.inputSchema.properties || {};
+        // OPTIMIZATION: Check if any fields have boundary constraints before generating tests
+        // This prevents running boundary tests on tools that don't define min/max constraints
+        let hasBoundaries = false;
+        for (const [_key, schema] of Object.entries(properties)) {
+            const schemaObj = schema;
+            if (schemaObj.minimum !== undefined ||
+                schemaObj.maximum !== undefined ||
+                schemaObj.minLength !== undefined ||
+                schemaObj.maxLength !== undefined) {
+                hasBoundaries = true;
+                break;
+            }
+        }
+        // Early return if no boundaries defined - saves 0-4 test scenarios per tool
+        if (!hasBoundaries) {
+            return scenarios;
+        }
+        for (const [key, schema] of Object.entries(properties)) {
+            const schemaObj = schema;
+            // Test numeric boundaries
+            if (schemaObj.type === "number" || schemaObj.type === "integer") {
+                if (schemaObj.minimum !== undefined) {
+                    const params = this.generateRealisticParams(tool, "typical");
+                    params[key] = schemaObj.minimum;
+                    scenarios.push({
+                        name: `Boundary - ${key} at minimum`,
+                        description: `Test ${key} at its minimum value`,
+                        params,
+                        expectedBehavior: "Should accept minimum value",
+                        category: "boundary",
+                    });
+                }
+                if (schemaObj.maximum !== undefined) {
+                    const params = this.generateRealisticParams(tool, "typical");
+                    params[key] = schemaObj.maximum;
+                    scenarios.push({
+                        name: `Boundary - ${key} at maximum`,
+                        description: `Test ${key} at its maximum value`,
+                        params,
+                        expectedBehavior: "Should accept maximum value",
+                        category: "boundary",
+                    });
+                }
+            }
+            // Test string length boundaries
+            if (schemaObj.type === "string") {
+                if (schemaObj.minLength !== undefined) {
+                    const params = this.generateRealisticParams(tool, "typical");
+                    params[key] = "a".repeat(schemaObj.minLength);
+                    scenarios.push({
+                        name: `Boundary - ${key} at min length`,
+                        description: `Test ${key} at minimum length`,
+                        params,
+                        expectedBehavior: "Should accept minimum length string",
+                        category: "boundary",
+                    });
+                }
+                if (schemaObj.maxLength !== undefined) {
+                    const params = this.generateRealisticParams(tool, "typical");
+                    params[key] = "a".repeat(schemaObj.maxLength);
+                    scenarios.push({
+                        name: `Boundary - ${key} at max length`,
+                        description: `Test ${key} at maximum length`,
+                        params,
+                        expectedBehavior: "Should accept maximum length string",
+                        category: "boundary",
+                    });
+                }
+            }
+        }
+        return scenarios;
+    }
+    /**
+     * Generate an error scenario
+     */
+    static generateErrorScenario(tool) {
+        const params = {};
+        if (tool.inputSchema &&
+            tool.inputSchema.type === "object" &&
+            tool.inputSchema.properties) {
+            // Intentionally provide wrong types
+            for (const [key, schema] of Object.entries(tool.inputSchema.properties)) {
+                const schemaObj = schema;
+                switch (schemaObj.type) {
+                    case "string":
+                        params[key] = 123; // Wrong type
+                        break;
+                    case "number":
+                    case "integer":
+                        params[key] = "not_a_number"; // Wrong type
+                        break;
+                    case "boolean":
+                        params[key] = "not_a_boolean"; // Wrong type
+                        break;
+                    case "array":
+                        params[key] = "not_an_array"; // Wrong type
+                        break;
+                    case "object":
+                        params[key] = "not_an_object"; // Wrong type
+                        break;
+                    default:
+                        params[key] = null;
+                }
+                // Only set one wrong parameter to make the error clear
+                break;
+            }
+        }
+        return {
+            name: "Error Case - Invalid Type",
+            description: "Test error handling with invalid parameter types",
+            params,
+            expectedBehavior: "Should return clear error about invalid parameter type",
+            category: "error_case",
+        };
+    }
+    /**
+     * Generate realistic parameters based on schema and variant
+     */
+    static generateRealisticParams(tool, variant) {
+        const params = {};
+        if (!tool.inputSchema || tool.inputSchema.type !== "object") {
+            return params;
+        }
+        const properties = tool.inputSchema.properties || {};
+        for (const [key, schema] of Object.entries(properties)) {
+            params[key] = this.generateRealisticValue(key, schema, variant);
+        }
+        return params;
+    }
+    /**
+     * Generate a realistic value based on field name and schema
+     */
+    static generateRealisticValue(fieldName, schema, variant) {
+        const lowerFieldName = fieldName.toLowerCase();
+        switch (schema.type) {
+            case "string":
+                // Check for enums first
+                if (schema.enum && schema.enum.length > 0) {
+                    return variant === "typical"
+                        ? schema.enum[0]
+                        : schema.enum[schema.enum.length - 1];
+                }
+                // Context-aware string generation
+                if (lowerFieldName.includes("url") ||
+                    lowerFieldName.includes("link") ||
+                    lowerFieldName.includes("endpoint")) {
+                    return variant === "empty"
+                        ? ""
+                        : variant === "maximum"
+                            ? "https://very-long-domain-name-for-testing-maximum-length.example.com/path/to/resource?param1=value1&param2=value2"
+                            : variant === "special"
+                                ? "https://example.com/path?special=!@#$%^&*()"
+                                : this.REALISTIC_DATA.urls[Math.floor(Math.random() * this.REALISTIC_DATA.urls.length)];
+                }
+                if (lowerFieldName.includes("email") ||
+                    lowerFieldName.includes("mail")) {
+                    return variant === "empty"
+                        ? ""
+                        : variant === "maximum"
+                            ? "very.long.email.address.for.testing@subdomain.example-company.co.uk"
+                            : variant === "special"
+                                ? "user+tag@example.com"
+                                : this.REALISTIC_DATA.emails[Math.floor(Math.random() * this.REALISTIC_DATA.emails.length)];
+                }
+                if (lowerFieldName.includes("path") ||
+                    lowerFieldName.includes("file") ||
+                    lowerFieldName.includes("directory") ||
+                    lowerFieldName.includes("folder")) {
+                    return variant === "empty"
+                        ? ""
+                        : variant === "maximum"
+                            ? "/very/long/path/to/deeply/nested/directory/structure/for/testing/file.txt"
+                            : variant === "special"
+                                ? "./path/with spaces/and-special#chars.txt"
+                                : this.REALISTIC_DATA.paths[Math.floor(Math.random() * this.REALISTIC_DATA.paths.length)];
+                }
+                if (lowerFieldName.includes("query") ||
+                    lowerFieldName.includes("search") ||
+                    lowerFieldName.includes("filter")) {
+                    return variant === "empty"
+                        ? "test" // Use "test" instead of "" to ensure search tools have valid input
+                        : variant === "maximum"
+                            ? "very long search query with many terms for testing maximum input length handling"
+                            : variant === "special"
+                                ? 'search with "quotes" and special: characters!'
+                                : this.REALISTIC_DATA.queries[Math.floor(Math.random() * this.REALISTIC_DATA.queries.length)];
+                }
+                if (lowerFieldName.includes("id") ||
+                    lowerFieldName.includes("key") ||
+                    lowerFieldName.includes("identifier")) {
+                    // Check if this field requires UUID format based on common patterns
+                    const requiresUuid = lowerFieldName.includes("uuid") ||
+                        lowerFieldName.includes("page_id") ||
+                        lowerFieldName.includes("database_id") ||
+                        lowerFieldName.includes("user_id") ||
+                        lowerFieldName.includes("block_id") ||
+                        lowerFieldName.includes("comment_id") ||
+                        lowerFieldName.includes("workspace_id") ||
+                        lowerFieldName.includes("notion") ||
+                        // Check schema description for UUID hints
+                        (schema.description &&
+                            (schema.description.toLowerCase().includes("uuid") ||
+                                schema.description
+                                    .toLowerCase()
+                                    .includes("universally unique")));
+                    if (requiresUuid) {
+                        // Always return a valid UUID for UUID-required fields
+                        return variant === "empty"
+                            ? "00000000-0000-0000-0000-000000000000" // Nil UUID
+                            : "550e8400-e29b-41d4-a716-446655440000"; // Valid UUID v4
+                    }
+                    return variant === "empty"
+                        ? "1" // Minimal non-empty ID to avoid creating invalid entities
+                        : variant === "maximum"
+                            ? "very_long_identifier_string_for_testing_maximum_length_handling_in_system"
+                            : this.REALISTIC_DATA.ids[Math.floor(Math.random() * this.REALISTIC_DATA.ids.length)];
+                }
+                if (lowerFieldName.includes("name") ||
+                    lowerFieldName.includes("title") ||
+                    lowerFieldName.includes("label")) {
+                    return variant === "empty"
+                        ? "a" // Minimal non-empty value to avoid breaking search functionality
+                        : variant === "maximum"
+                            ? "Very Long Name For Testing Maximum String Length Handling In The System"
+                            : variant === "special"
+                                ? "Name with Special™ Characters® and Émojis 🎉"
+                                : this.REALISTIC_DATA.names[Math.floor(Math.random() * this.REALISTIC_DATA.names.length)];
+                }
+                if (lowerFieldName.includes("date") ||
+                    lowerFieldName.includes("time")) {
+                    return variant === "empty" ? "" : this.REALISTIC_DATA.timestamps[0];
+                }
+                // Default string value - try to be contextual
+                return variant === "empty"
+                    ? ""
+                    : variant === "maximum"
+                        ? "x".repeat(100)
+                        : variant === "special"
+                            ? 'Special chars: !@#$%^&*()_+-=[]{}|;:",.<>?/~`'
+                            : "test"; // Simple, generic test value that often works
+            case "number":
+            case "integer":
+                if (variant === "maximum") {
+                    return schema.maximum || 999999;
+                }
+                if (variant === "empty") {
+                    return schema.minimum || 0;
+                }
+                // Context-aware number generation
+                if (lowerFieldName.includes("port")) {
+                    return 8080;
+                }
+                if (lowerFieldName.includes("timeout") ||
+                    lowerFieldName.includes("delay")) {
+                    return 5000; // milliseconds
+                }
+                if (lowerFieldName.includes("count") ||
+                    lowerFieldName.includes("limit")) {
+                    return 10;
+                }
+                if (lowerFieldName.includes("page") ||
+                    lowerFieldName.includes("offset")) {
+                    return 0;
+                }
+                if (lowerFieldName.includes("size") ||
+                    lowerFieldName.includes("length")) {
+                    return 100;
+                }
+                return schema.minimum || 1;
+            case "boolean":
+                return variant === "empty" ? false : true;
+            case "array":
+                if (variant === "empty") {
+                    // For mutation tools with array inputs, empty arrays are valid but useless for testing
+                    // Generate one minimal item instead to make the test meaningful
+                    const isMutationField = lowerFieldName.includes("entities") ||
+                        lowerFieldName.includes("relations") ||
+                        lowerFieldName.includes("observations") ||
+                        lowerFieldName.includes("documents");
+                    if (isMutationField && schema.items) {
+                        // Generate one minimal item even for "empty" variant
+                        const item = this.generateValueFromSchema(schema.items, "empty");
+                        return [item];
+                    }
+                    return [];
+                }
+                if (variant === "maximum") {
+                    // Generate multiple items
+                    const count = 10;
+                    if (schema.items) {
+                        return Array(count)
+                            .fill(0)
+                            .map(() => this.generateValueFromSchema(schema.items, variant));
+                    }
+                    return Array(count)
+                        .fill(0)
+                        .map((_, i) => `item_${i}`);
+                }
+                // Typical variant - generate realistic array
+                if (schema.items) {
+                    // Generate 1-2 items based on schema.items
+                    const item = this.generateValueFromSchema(schema.items, variant);
+                    return [item];
+                }
+                // Context-aware array generation (fallback for simple arrays without schema.items)
+                if (lowerFieldName.includes("tag") ||
+                    lowerFieldName.includes("label")) {
+                    return ["tag1", "tag2", "tag3"];
+                }
+                if (lowerFieldName.includes("id")) {
+                    return ["id_1", "id_2", "id_3"];
+                }
+                return this.REALISTIC_DATA.arrays[1];
+            case "object":
+                // Don't return empty object for "empty" variant
+                // Let it fall through to generate minimal object properties
+                // This avoids creating objects with no required fields
+                if (variant === "maximum") {
+                    return this.REALISTIC_DATA.jsonObjects[4]; // deeply nested
+                }
+                // Context-aware object generation
+                if (lowerFieldName.includes("config") ||
+                    lowerFieldName.includes("settings")) {
+                    return variant === "empty"
+                        ? { enabled: false }
+                        : { enabled: true, timeout: 5000, retries: 3 };
+                }
+                if (lowerFieldName.includes("metadata") ||
+                    lowerFieldName.includes("meta")) {
+                    return variant === "empty"
+                        ? { version: "1.0.0" }
+                        : {
+                            created: new Date().toISOString(),
+                            version: "1.0.0",
+                            author: "test",
+                        };
+                }
+                if (lowerFieldName.includes("filter") ||
+                    lowerFieldName.includes("query")) {
+                    return variant === "empty"
+                        ? { limit: 1 }
+                        : { status: "active", type: "user", limit: 10 };
+                }
+                return variant === "empty"
+                    ? { id: 1 }
+                    : this.REALISTIC_DATA.jsonObjects[0];
+            default:
+                // Return safe default instead of null to prevent tool crashes
+                return "test";
+        }
+    }
+    /**
+     * Check if tool has string inputs
+     */
+    static hasStringInputs(tool) {
+        if (!tool.inputSchema || tool.inputSchema.type !== "object") {
+            return false;
+        }
+        const properties = tool.inputSchema.properties || {};
+        for (const schema of Object.values(properties)) {
+            if (schema.type === "string") {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Generate a single realistic value for backward compatibility
+     */
+    static generateSingleValue(fieldName, schema) {
+        return this.generateRealisticValue(fieldName, schema, "typical");
+    }
+    /**
+     * Generate value from JSON schema definition
+     */
+    static generateValueFromSchema(schema, variant) {
+        if (!schema || !schema.type) {
+            // Return safe default instead of null to prevent tool crashes
+            return "test";
+        }
+        switch (schema.type) {
+            case "object": {
+                const obj = {};
+                if (schema.properties) {
+                    for (const [key, propSchema] of Object.entries(schema.properties)) {
+                        obj[key] = this.generateRealisticValue(key, propSchema, variant);
+                    }
+                }
+                return obj;
+            }
+            case "array":
+                if (schema.items) {
+                    const item = this.generateValueFromSchema(schema.items, variant);
+                    return [item];
+                }
+                return [];
+            case "string":
+                return variant === "empty" ? "" : "test";
+            case "number":
+            case "integer":
+                return variant === "empty" ? 0 : 1;
+            case "boolean":
+                return variant === "empty" ? false : true;
+            default:
+                // Return safe default instead of null to prevent tool crashes
+                return "test";
+        }
+    }
+}