@camunda/e2e-test-suite 0.0.389 → 0.0.390

package/dist/tests/8.9/orchestration-cluster-mcp-server/mcp-user-task-tools.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/8.9/orchestration-cluster-mcp-server/mcp-user-task-tools.spec.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _8_9_1 = require("../../../fixtures/8.9");
+const UtilitiesPage_1 = require("../../../pages/8.9/UtilitiesPage");
+const _setup_1 = require("../../../test-setup.js");
+const apiHelpers_1 = require("../../../utils/apiHelpers");
+const userTaskHelpers_1 = require("../../../utils/userTaskHelpers");
+const users_1 = require("../../../utils/users");
+const test_1 = require("@playwright/test");
+const testUser = (0, users_1.getTestUser)('fourteenthUser');
+let authToken;
+let toolsInstanceKey;
+_8_9_1.test.describe.configure({ mode: 'parallel' });
+_8_9_1.test.describe('Orchestration Cluster MCP Server - User Task Tools @tasklistV2', () => {
+    const clusterName = 'Agentic Orchestration Cluster';
+    _8_9_1.test.beforeAll(async () => {
+        authToken = await (0, apiHelpers_1.authSaasAPI)(undefined, 'agentic_cluster');
+        const [testFileProcessKey, toolsProcessKey] = await Promise.all([
+            (0, apiHelpers_1.deployProcess)('./resources/mcp_server_saas/mcp_user_task_test_file.bpmn', authToken, 'saas', 'agentic_cluster'),
+            (0, apiHelpers_1.deployProcess)('./resources/mcp_server_saas/mcp_user_task_tools.bpmn', authToken, 'saas', 'agentic_cluster'),
+        ]);
+        if (testFileProcessKey == null || toolsProcessKey == null) {
+            throw new Error('Failed to deploy user task tools processes');
+        }
+        // Create test instance which will create a user task
+        const testInstanceKey = await (0, apiHelpers_1.createProcessInstance)(String(testFileProcessKey), authToken, 'saas', 'agentic_cluster');
+        // Get the user task key created by the test instance (with retry logic)
+        const testUserTaskKey = await (0, userTaskHelpers_1.getUserTaskKeyByProcessInstanceKey)(testInstanceKey, authToken, 'saas', 'agentic_cluster');
+        console.log('Creating tools instance with variables:', {
+            testFileProcessKey,
+            testUserTaskKey,
+        });
+        // Create tools instance with required variables
+        toolsInstanceKey = await (0, apiHelpers_1.createProcessInstance)(String(toolsProcessKey), authToken, 'saas', 'agentic_cluster', { testFileProcessKey, testUserTaskKey });
+    });
+    _8_9_1.test.beforeEach(async ({ page, loginPage }, testInfo) => {
+        await (0, UtilitiesPage_1.loginWithRetry)(page, loginPage, testUser, (testInfo.workerIndex + 1) * 1000);
+    });
+    _8_9_1.test.afterEach(async ({ page }, testInfo) => {
+        await (0, _setup_1.captureScreenshot)(page, testInfo);
+        await (0, _setup_1.captureFailureVideo)(page, testInfo);
+    });
+    const userTaskToolTests = [
+        {
+            name: 'searchUserTasks - search user tasks with filters such as processDefinitionKey',
+            variable: 'mcpResultSearchUserTasks',
+            assertions: [
+                {
+                    text: 'totalItems',
+                    description: 'search response contains totalItems field',
+                },
+                {
+                    text: 'userTaskKey',
+                    description: 'search response contains userTaskKey field',
+                },
+                {
+                    text: 'processDefinitionKey',
+                    description: 'search response contains processDefinitionKey field',
+                },
+            ],
+        },
+        {
+            name: 'getUserTask - retrieve a user task by key',
+            variable: 'mcpResultGetUserTask',
+            assertions: [
+                {
+                    text: 'userTaskKey',
+                    description: 'response contains userTaskKey field',
+                },
+                {
+                    text: 'processInstanceKey',
+                    description: 'response contains processInstanceKey field',
+                },
+                {
+                    text: 'assignee',
+                    description: 'response contains assignee field',
+                },
+            ],
+        },
+        {
+            name: 'assignUserTask - update the assignment of a user task',
+            variable: 'mcpResultAssignUserTask',
+            assertions: [
+                {
+                    text: 'mcpUser',
+                    description: 'response reflects the assignee value mcpUser',
+                },
+            ],
+        },
+        {
+            name: 'searchUserTaskVariables - search variables scoped to a specific user task',
+            variable: 'mcpResultSearchUserTaskVariables',
+            assertions: [
+                {
+                    text: 'totalItems',
+                    description: 'search response contains totalItems field',
+                },
+                {
+                    text: 'items',
+                    description: 'search response contains items array',
+                },
+            ],
+        },
+    ];
+    for (const testCase of userTaskToolTests) {
+        (0, _8_9_1.test)(testCase.name, async ({ page, homePage, appsPage, operateHomePage, operateProcessesPage, operateProcessInstancePage, }) => {
+            _8_9_1.test.slow();
+            await _8_9_1.test.step('Navigate to completed process in Operate', async () => {
+                await page.goto('/');
+                await homePage.clickClusters();
+                await appsPage.clickOperate(clusterName);
+                await (0, test_1.expect)(operateHomePage.operateBanner).toBeVisible({
+                    timeout: 60000,
+                });
+                await operateHomePage.clickProcessesTab();
+                await operateProcessesPage.clickProcessCompletedCheckbox();
+                await operateProcessesPage.applyMoreFilters('Process Instance Key(s)', String(toolsInstanceKey));
+                await operateProcessesPage.clickProcessInstanceLink('MCP User Task Tools');
+                await operateProcessInstancePage.assertProcessCompleteStatusWithRetry();
+            });
+            for (const assertion of testCase.assertions) {
+                await _8_9_1.test.step(assertion.description, async () => {
+                    await operateProcessInstancePage.assertProcessVariableContainsText(testCase.variable, assertion.text);
+                });
+            }
+        });
+    }
+});

package/dist/utils/apiHelpers.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="node" />
 import { APIRequestContext, APIResponse, Response, Page } from '@playwright/test';
 import { Serializable } from 'playwright-core/types/structs';
+export declare function getApiRequestContext(): Promise<APIRequestContext>;
 export declare function assertResponseStatus(response: APIResponse | Response, status: number): Promise<void>;
 export declare function sendRequestAndAssertResponse(request: APIRequestContext, url: string, requestBody?: string | Buffer | Serializable, maxRetries?: number): Promise<void>;
+export declare function buildZeebeApiUrl(resourcePath: string, environmentOverride?: 'saas' | 'sm', clusterType?: string): string;
 export declare function authAPI(environment: 'saas'): Promise<string>;
 export declare function authAPI(environment: 'sm'): Promise<string>;
 export declare function authAPI(environment: 'saas', audience?: string): Promise<string>;

package/dist/utils/apiHelpers.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCollectionScope = exports.createSingleProcessReport = exports.createDashboard = exports.createCollection = exports.getOptimizeCoockie = exports.createGlobalClusterVariable = exports.createStringClusterVariable = exports.createJsonClusterVariable = exports.createProcessInstance = exports.deployProcess = exports.validateMcpServerHealth = exports.authC8runAPI = exports.authSmAPI = exports.authSaasAPI = exports.authAPI = exports.sendRequestAndAssertResponse = exports.assertResponseStatus = void 0;
+exports.updateCollectionScope = exports.createSingleProcessReport = exports.createDashboard = exports.createCollection = exports.getOptimizeCoockie = exports.createGlobalClusterVariable = exports.createStringClusterVariable = exports.createJsonClusterVariable = exports.createProcessInstance = exports.deployProcess = exports.validateMcpServerHealth = exports.authC8runAPI = exports.authSmAPI = exports.authSaasAPI = exports.authAPI = exports.buildZeebeApiUrl = exports.sendRequestAndAssertResponse = exports.assertResponseStatus = exports.getApiRequestContext = void 0;
 const test_1 = require("@playwright/test");
 const sleep_1 = require("./sleep");
 const fs_1 = __importDefault(require("fs"));
@@ -17,6 +17,7 @@ async function getApiRequestContext() {
     }
     return apiRequestContext;
 }
+exports.getApiRequestContext = getApiRequestContext;
 // ---- Common HTTP helpers ----
 async function assertResponseStatus(response, status) {
     (0, test_1.expect)(response.status()).toBe(status);
@@ -117,6 +118,7 @@ function buildZeebeApiUrl(resourcePath, environmentOverride, clusterType) {
     const pathWithPrefix = environment === 'sm' ? `${contextPath}${normalizedPath}` : normalizedPath;
     return `${baseUrl}${pathWithPrefix}`;
 }
+exports.buildZeebeApiUrl = buildZeebeApiUrl;
 async function authAPI(environment, audience = process.env.ZEEBE_API_TOKEN_AUDIENCE) {
     apiRequestContext = await getApiRequestContext();
     if (environment === 'saas') {

package/dist/utils/userTaskHelpers.d.ts

@@ -0,0 +1 @@
+export declare function getUserTaskKeyByProcessInstanceKey(processInstanceKey: string, authToken?: string, environment?: 'saas' | 'sm', clusterType?: string, maxRetries?: number, retryDelayMs?: number): Promise<string>;

package/dist/utils/userTaskHelpers.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserTaskKeyByProcessInstanceKey = void 0;
+const test_1 = require("@playwright/test");
+const apiHelpers_1 = require("./apiHelpers");
+const sleep_1 = require("./sleep");
+async function getUserTaskKeyByProcessInstanceKey(processInstanceKey, authToken, environment, clusterType, maxRetries = 10, retryDelayMs = 2000) {
+    const apiRequestContext = await (0, apiHelpers_1.getApiRequestContext)();
+    const url = (0, apiHelpers_1.buildZeebeApiUrl)('/v2/user-tasks/search', environment, clusterType);
+    let lastError = null;
+    // Retry logic to wait for user task to be indexed
+    for (let attempt = 1; attempt <= maxRetries; attempt++) {
+        try {
+            const response = await apiRequestContext.post(url, {
+                headers: {
+                    Authorization: authToken ?? '',
+                },
+                data: {
+                    filter: {
+                        processInstanceKey: String(processInstanceKey),
+                    },
+                },
+            });
+            (0, test_1.expect)(response.status()).toBe(200);
+            const responseBody = await response.json();
+            if (responseBody?.items && responseBody.items.length > 0) {
+                const userTaskKey = responseBody.items[0]?.userTaskKey;
+                if (userTaskKey != null) {
+                    console.log(`Found user task key ${userTaskKey} for process instance ${processInstanceKey} on attempt ${attempt}`);
+                    return String(userTaskKey);
+                }
+            }
+            lastError = new Error(`No user tasks found for processInstanceKey: ${processInstanceKey}`);
+        }
+        catch (error) {
+            lastError = error;
+        }
+        // Wait before retrying (except on last attempt)
+        if (attempt < maxRetries) {
+            console.log(`User task not found yet for process instance ${processInstanceKey}, retrying in ${retryDelayMs}ms (attempt ${attempt}/${maxRetries})...`);
+            await (0, sleep_1.sleep)(retryDelayMs);
+        }
+    }
+    throw new Error(`Failed to find user task after ${maxRetries} attempts: ${lastError?.message}`);
+}
+exports.getUserTaskKeyByProcessInstanceKey = getUserTaskKeyByProcessInstanceKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/e2e-test-suite",
-  "version": "0.0.389",
+  "version": "0.0.390",
   "description": "End-to-end test helpers for Camunda 8",
   "repository": {
     "type": "git",