@provartesting/provardx-cli 1.4.7 → 1.5.0-beta.1

package/lib/mcp/schemas/common.d.ts

@@ -0,0 +1,20 @@
+/** Stable error shape returned in every isError=true response */
+export interface ErrorResponse {
+    error_code: string;
+    message: string;
+    retryable: boolean;
+    details?: Record<string, unknown>;
+    requestId: string;
+}
+/** Single validation finding produced by the PO / TC validators */
+export interface ValidationIssue {
+    rule_id: string;
+    severity: 'ERROR' | 'WARNING' | 'INFO';
+    message: string;
+    applies_to: string;
+    suggestion?: string;
+    line_number?: number;
+}
+export declare function makeError(code: string, message: string, requestId: string, retryable?: boolean, details?: Record<string, unknown>): ErrorResponse;
+/** Generate a correlation ID for each tool invocation */
+export declare function makeRequestId(): string;

package/lib/mcp/schemas/common.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/* eslint-disable camelcase */
+import { randomUUID } from 'node:crypto';
+export function makeError(code, message, requestId, retryable = false, details) {
+    return { error_code: code, message, retryable, details, requestId };
+}
+/** Generate a correlation ID for each tool invocation */
+export function makeRequestId() {
+    return randomUUID();
+}
+//# sourceMappingURL=common.js.map

package/lib/mcp/schemas/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/mcp/schemas/common.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,8BAA8B;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAqBzC,MAAM,UAAU,SAAS,CACvB,IAAY,EACZ,OAAe,EACf,SAAiB,EACjB,SAAS,GAAG,KAAK,EACjB,OAAiC;IAEjC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACtE,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,aAAa;IAC3B,OAAO,UAAU,EAAE,CAAC;AACtB,CAAC"}

package/lib/mcp/security/pathPolicy.d.ts

@@ -0,0 +1,19 @@
+export declare class PathPolicyError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+/**
+ * Asserts that filePath is within at least one of allowedPaths.
+ *
+ * Throws PathPolicyError with code:
+ * - PATH_TRAVERSAL  — path contains `..` segments
+ * - PATH_NOT_ALLOWED — resolved path is outside all allowed roots
+ *
+ * When allowedPaths is empty, all paths are permitted (unrestricted mode).
+ *
+ * Symlinks are resolved via fs.realpathSync so that a symlink inside an allowed
+ * directory pointing to a location outside it cannot bypass containment.
+ * If the path does not yet exist (e.g. an output file to be created), the parent
+ * directory is resolved instead and the basename re-attached.
+ */
+export declare function assertPathAllowed(filePath: string, allowedPaths: string[]): void;

package/lib/mcp/security/pathPolicy.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+export class PathPolicyError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.name = 'PathPolicyError';
+        this.code = code;
+    }
+}
+/**
+ * Asserts that filePath is within at least one of allowedPaths.
+ *
+ * Throws PathPolicyError with code:
+ * - PATH_TRAVERSAL  — path contains `..` segments
+ * - PATH_NOT_ALLOWED — resolved path is outside all allowed roots
+ *
+ * When allowedPaths is empty, all paths are permitted (unrestricted mode).
+ *
+ * Symlinks are resolved via fs.realpathSync so that a symlink inside an allowed
+ * directory pointing to a location outside it cannot bypass containment.
+ * If the path does not yet exist (e.g. an output file to be created), the parent
+ * directory is resolved instead and the basename re-attached.
+ */
+export function assertPathAllowed(filePath, allowedPaths) {
+    // Check the original path for `..` segments before any normalization resolves them away
+    const rawSegments = filePath.split(/[/\\]+/).filter((s) => s.length > 0);
+    if (rawSegments.some((s) => s === '..')) {
+        throw new PathPolicyError('PATH_TRAVERSAL', `Path traversal detected: ${filePath}`);
+    }
+    // Resolve symlinks so a symlink inside an allowed dir that points outside cannot bypass
+    // the containment check. Fall back to lexical resolution when the path doesn't exist yet.
+    let resolved;
+    try {
+        resolved = fs.realpathSync(filePath);
+    }
+    catch {
+        // Path doesn't exist — resolve the parent (which should exist) to catch symlinks there
+        const parent = path.dirname(path.resolve(filePath));
+        try {
+            resolved = path.join(fs.realpathSync(parent), path.basename(filePath));
+        }
+        catch {
+            resolved = path.resolve(filePath);
+        }
+    }
+    const resolvedAllowed = allowedPaths.map((p) => {
+        try {
+            return fs.realpathSync(p);
+        }
+        catch {
+            return path.resolve(path.normalize(p));
+        }
+    });
+    if (resolvedAllowed.length > 0 &&
+        !resolvedAllowed.some((base) => resolved === base || resolved.startsWith(base + path.sep))) {
+        throw new PathPolicyError('PATH_NOT_ALLOWED', `Path "${resolved}" is not within allowed paths: [${resolvedAllowed.join(', ')}]`);
+    }
+}
+//# sourceMappingURL=pathPolicy.js.map

package/lib/mcp/security/pathPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathPolicy.js","sourceRoot":"","sources":["../../../src/mcp/security/pathPolicy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxB,IAAI,CAAS;IAC7B,YAAmB,IAAY,EAAE,OAAe;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAgB,EAAE,YAAsB;IACxE,wFAAwF;IACxF,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CAAC,gBAAgB,EAAE,4BAA4B,QAAQ,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,wFAAwF;IACxF,0FAA0F;IAC1F,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,uFAAuF;QACvF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpD,IAAI,CAAC;YACH,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzE,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC7C,IAAI,CAAC;YACH,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IACE,eAAe,CAAC,MAAM,GAAG,CAAC;QAC1B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAC1F,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,kBAAkB,EAClB,SAAS,QAAQ,mCAAmC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAClF,CAAC;IACJ,CAAC;AACH,CAAC"}

package/lib/mcp/server.d.ts

@@ -0,0 +1,5 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export interface ServerConfig {
+    allowedPaths: string[];
+}
+export declare function createProvarMcpServer(config: ServerConfig): McpServer;

package/lib/mcp/server.js

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { createRequire } from 'node:module';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { z } from 'zod';
+import { log } from './logging/logger.js';
+const requireJson = createRequire(import.meta.url);
+const SERVER_VERSION = requireJson('../../package.json').version;
+import { registerProjectInspect } from './tools/projectInspect.js';
+import { registerPageObjectGenerate } from './tools/pageObjectGenerate.js';
+import { registerPageObjectValidate } from './tools/pageObjectValidate.js';
+import { registerTestCaseGenerate } from './tools/testCaseGenerate.js';
+import { registerTestCaseValidate } from './tools/testCaseValidate.js';
+import { registerTestSuiteValidate } from './tools/testSuiteValidate.js';
+import { registerTestPlanValidate } from './tools/testPlanValidate.js';
+import { registerProjectValidateFromPath } from './tools/projectValidateFromPath.js';
+import { registerAllPropertiesTools } from './tools/propertiesTools.js';
+import { registerAllQualityHubTools } from './tools/qualityHubTools.js';
+import { registerAllAutomationTools } from './tools/automationTools.js';
+import { registerAllDefectTools } from './tools/defectTools.js';
+import { registerAllAntTools } from './tools/antTools.js';
+import { registerAllRcaTools } from './tools/rcaTools.js';
+import { registerAllTestPlanTools } from './tools/testPlanTools.js';
+export function createProvarMcpServer(config) {
+    log('info', 'Creating Provar MCP server', { allowedPaths: config.allowedPaths });
+    const server = new McpServer({
+        name: 'provar-mcp',
+        version: SERVER_VERSION,
+    });
+    // ── Sanity-check tool ────────────────────────────────────────────────────────
+    server.tool('provardx.ping', 'Sanity-check tool. Echoes back a message with a timestamp. Use this to verify the MCP server is reachable before calling other tools.', {
+        message: z.string().optional().default('ping').describe('Optional message to echo back'),
+    }, ({ message }) => {
+        const result = { pong: message, ts: new Date().toISOString(), server: `provar-mcp@${SERVER_VERSION}` };
+        return {
+            content: [{ type: 'text', text: JSON.stringify(result) }],
+            structuredContent: result,
+        };
+    });
+    // ── Provar tools ─────────────────────────────────────────────────────────────
+    registerProjectInspect(server, config);
+    registerPageObjectGenerate(server, config);
+    registerPageObjectValidate(server, config);
+    registerTestCaseGenerate(server, config);
+    registerTestCaseValidate(server, config);
+    registerTestSuiteValidate(server);
+    registerTestPlanValidate(server);
+    registerProjectValidateFromPath(server, config);
+    registerAllPropertiesTools(server, config);
+    registerAllQualityHubTools(server);
+    registerAllAutomationTools(server, config);
+    registerAllDefectTools(server);
+    registerAllAntTools(server, config);
+    registerAllRcaTools(server);
+    registerAllTestPlanTools(server, config);
+    return server;
+}
+//# sourceMappingURL=server.js.map

package/lib/mcp/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/mcp/server.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,MAAM,cAAc,GAAY,WAAW,CAAC,oBAAoB,CAAyB,CAAC,OAAO,CAAC;AAClG,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,+BAA+B,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAMpE,MAAM,UAAU,qBAAqB,CAAC,MAAoB;IACxD,GAAG,CAAC,MAAM,EAAE,4BAA4B,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAEjF,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,CAAC,IAAI,CACT,eAAe,EACf,uIAAuI,EACvI;QACE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;KACzF,EACD,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,cAAc,cAAc,EAAE,EAAE,CAAC;QACvG,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAClE,iBAAiB,EAAE,MAAM;SAC1B,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,gFAAgF;IAChF,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAClC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACjC,+BAA+B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/mcp/tools/antTools.d.ts

@@ -0,0 +1,21 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { ServerConfig } from '../server.js';
+import { type ValidationIssue } from '../schemas/common.js';
+export declare function registerAntGenerate(server: McpServer, config: ServerConfig): void;
+export declare function registerAntValidate(server: McpServer, config: ServerConfig): void;
+export interface AntValidationResult {
+    is_valid: boolean;
+    validity_score: number;
+    provar_home: string | null;
+    project_path: string | null;
+    results_path: string | null;
+    web_browser: string | null;
+    test_environment: string | null;
+    fileset_count: number;
+    error_count: number;
+    warning_count: number;
+    issues: ValidationIssue[];
+}
+/** Pure function — exported for unit testing */
+export declare function validateAntXml(xmlContent: string): AntValidationResult;
+export declare function registerAllAntTools(server: McpServer, config: ServerConfig): void;