@azure-devops/mcp 2.2.2 → 2.3.0-nightly.20251204

package/dist/tools/test-plans.js

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
+import { SuiteExpand } from "azure-devops-node-api/interfaces/TestPlanInterfaces.js";
 import { z } from "zod";
 const Test_Plan_Tools = {
     create_test_plan: "testplan_create_test_plan",
@@ -9,6 +10,7 @@ const Test_Plan_Tools = {
     test_results_from_build_id: "testplan_show_test_results_from_build_id",
     list_test_cases: "testplan_list_test_cases",
     list_test_plans: "testplan_list_test_plans",
+    list_test_suites: "testplan_list_test_suites",
     create_test_suite: "testplan_create_test_suite",
 };
 function configureTestPlanTools(server, _, connectionProvider) {
@@ -18,13 +20,22 @@ function configureTestPlanTools(server, _, connectionProvider) {
         includePlanDetails: z.boolean().default(false).describe("Include detailed information about each test plan."),
         continuationToken: z.string().optional().describe("Token to continue fetching test plans from a previous request."),
     }, async ({ project, filterActivePlans, includePlanDetails, continuationToken }) => {
-        const owner = ""; //making owner an empty string untill we can figure out how to get owner id
-        const connection = await connectionProvider();
-        const testPlanApi = await connection.getTestPlanApi();
-        const testPlans = await testPlanApi.getTestPlans(project, owner, continuationToken, includePlanDetails, filterActivePlans);
-        return {
-            content: [{ type: "text", text: JSON.stringify(testPlans, null, 2) }],
-        };
+        try {
+            const owner = ""; //making owner an empty string untill we can figure out how to get owner id
+            const connection = await connectionProvider();
+            const testPlanApi = await connection.getTestPlanApi();
+            const testPlans = await testPlanApi.getTestPlans(project, owner, continuationToken, includePlanDetails, filterActivePlans);
+            return {
+                content: [{ type: "text", text: JSON.stringify(testPlans, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error listing test plans: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
     server.tool(Test_Plan_Tools.create_test_plan, "Creates a new test plan in the project.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project where the test plan will be created."),
@@ -35,20 +46,29 @@ function configureTestPlanTools(server, _, connectionProvider) {
         endDate: z.string().optional().describe("The end date of the test plan"),
         areaPath: z.string().optional().describe("The area path for the test plan"),
     }, async ({ project, name, iteration, description, startDate, endDate, areaPath }) => {
-        const connection = await connectionProvider();
-        const testPlanApi = await connection.getTestPlanApi();
-        const testPlanToCreate = {
-            name,
-            iteration,
-            description,
-            startDate: startDate ? new Date(startDate) : undefined,
-            endDate: endDate ? new Date(endDate) : undefined,
-            areaPath,
-        };
-        const createdTestPlan = await testPlanApi.createTestPlan(testPlanToCreate, project);
-        return {
-            content: [{ type: "text", text: JSON.stringify(createdTestPlan, null, 2) }],
-        };
+        try {
+            const connection = await connectionProvider();
+            const testPlanApi = await connection.getTestPlanApi();
+            const testPlanToCreate = {
+                name,
+                iteration,
+                description,
+                startDate: startDate ? new Date(startDate) : undefined,
+                endDate: endDate ? new Date(endDate) : undefined,
+                areaPath,
+            };
+            const createdTestPlan = await testPlanApi.createTestPlan(testPlanToCreate, project);
+            return {
+                content: [{ type: "text", text: JSON.stringify(createdTestPlan, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error creating test plan: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
     server.tool(Test_Plan_Tools.create_test_suite, "Creates a new test suite in a test plan.", {
         project: z.string().describe("Project ID or project name"),
@@ -56,20 +76,29 @@ function configureTestPlanTools(server, _, connectionProvider) {
         parentSuiteId: z.number().describe("ID of the parent suite under which the new suite will be created, if not given by user this can be id of a root suite of the test plan"),
         name: z.string().describe("Name of the child test suite"),
     }, async ({ project, planId, parentSuiteId, name }) => {
-        const connection = await connectionProvider();
-        const testPlanApi = await connection.getTestPlanApi();
-        const testSuiteToCreate = {
-            name,
-            parentSuite: {
-                id: parentSuiteId,
-                name: "",
-            },
-            suiteType: 2,
-        };
-        const createdTestSuite = await testPlanApi.createTestSuite(testSuiteToCreate, project, planId);
-        return {
-            content: [{ type: "text", text: JSON.stringify(createdTestSuite, null, 2) }],
-        };
+        try {
+            const connection = await connectionProvider();
+            const testPlanApi = await connection.getTestPlanApi();
+            const testSuiteToCreate = {
+                name,
+                parentSuite: {
+                    id: parentSuiteId,
+                    name: "",
+                },
+                suiteType: 2,
+            };
+            const createdTestSuite = await testPlanApi.createTestSuite(testSuiteToCreate, project, planId);
+            return {
+                content: [{ type: "text", text: JSON.stringify(createdTestSuite, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error creating test suite: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
     server.tool(Test_Plan_Tools.add_test_cases_to_suite, "Adds existing test cases to a test suite.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
@@ -77,14 +106,23 @@ function configureTestPlanTools(server, _, connectionProvider) {
         suiteId: z.number().describe("The ID of the test suite."),
         testCaseIds: z.string().or(z.array(z.string())).describe("The ID(s) of the test case(s) to add. "),
     }, async ({ project, planId, suiteId, testCaseIds }) => {
-        const connection = await connectionProvider();
-        const testApi = await connection.getTestApi();
-        // If testCaseIds is an array, convert it to comma-separated string
-        const testCaseIdsString = Array.isArray(testCaseIds) ? testCaseIds.join(",") : testCaseIds;
-        const addedTestCases = await testApi.addTestCasesToSuite(project, planId, suiteId, testCaseIdsString);
-        return {
-            content: [{ type: "text", text: JSON.stringify(addedTestCases, null, 2) }],
-        };
+        try {
+            const connection = await connectionProvider();
+            const testApi = await connection.getTestApi();
+            // If testCaseIds is an array, convert it to comma-separated string
+            const testCaseIdsString = Array.isArray(testCaseIds) ? testCaseIds.join(",") : testCaseIds;
+            const addedTestCases = await testApi.addTestCasesToSuite(project, planId, suiteId, testCaseIdsString);
+            return {
+                content: [{ type: "text", text: JSON.stringify(addedTestCases, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error adding test cases to suite: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
     server.tool(Test_Plan_Tools.create_test_case, "Creates a new test case work item.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
@@ -98,61 +136,70 @@ function configureTestPlanTools(server, _, connectionProvider) {
         iterationPath: z.string().optional().describe("The iteration path for the test case."),
         testsWorkItemId: z.number().optional().describe("Optional work item id that will be set as a Microsoft.VSTS.Common.TestedBy-Reverse link to the test case."),
     }, async ({ project, title, steps, priority, areaPath, iterationPath, testsWorkItemId }) => {
-        const connection = await connectionProvider();
-        const witClient = await connection.getWorkItemTrackingApi();
-        let stepsXml;
-        if (steps) {
-            stepsXml = convertStepsToXml(steps);
-        }
-        // Create JSON patch document for work item
-        const patchDocument = [];
-        patchDocument.push({
-            op: "add",
-            path: "/fields/System.Title",
-            value: title,
-        });
-        if (testsWorkItemId) {
+        try {
+            const connection = await connectionProvider();
+            const witClient = await connection.getWorkItemTrackingApi();
+            let stepsXml;
+            if (steps) {
+                stepsXml = convertStepsToXml(steps);
+            }
+            // Create JSON patch document for work item
+            const patchDocument = [];
             patchDocument.push({
                 op: "add",
-                path: "/relations/-",
-                value: {
-                    rel: "Microsoft.VSTS.Common.TestedBy-Reverse",
-                    url: `${connection.serverUrl}/${project}/_apis/wit/workItems/${testsWorkItemId}`,
-                },
+                path: "/fields/System.Title",
+                value: title,
             });
+            if (testsWorkItemId) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/relations/-",
+                    value: {
+                        rel: "Microsoft.VSTS.Common.TestedBy-Reverse",
+                        url: `${connection.serverUrl}/${project}/_apis/wit/workItems/${testsWorkItemId}`,
+                    },
+                });
+            }
+            if (stepsXml) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/fields/Microsoft.VSTS.TCM.Steps",
+                    value: stepsXml,
+                });
+            }
+            if (priority) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/fields/Microsoft.VSTS.Common.Priority",
+                    value: priority,
+                });
+            }
+            if (areaPath) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/fields/System.AreaPath",
+                    value: areaPath,
+                });
+            }
+            if (iterationPath) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/fields/System.IterationPath",
+                    value: iterationPath,
+                });
+            }
+            const workItem = await witClient.createWorkItem({}, patchDocument, project, "Test Case");
+            return {
+                content: [{ type: "text", text: JSON.stringify(workItem, null, 2) }],
+            };
         }
-        if (stepsXml) {
-            patchDocument.push({
-                op: "add",
-                path: "/fields/Microsoft.VSTS.TCM.Steps",
-                value: stepsXml,
-            });
-        }
-        if (priority) {
-            patchDocument.push({
-                op: "add",
-                path: "/fields/Microsoft.VSTS.Common.Priority",
-                value: priority,
-            });
-        }
-        if (areaPath) {
-            patchDocument.push({
-                op: "add",
-                path: "/fields/System.AreaPath",
-                value: areaPath,
-            });
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error creating test case: ${errorMessage}` }],
+                isError: true,
+            };
         }
-        if (iterationPath) {
-            patchDocument.push({
-                op: "add",
-                path: "/fields/System.IterationPath",
-                value: iterationPath,
-            });
-        }
-        const workItem = await witClient.createWorkItem({}, patchDocument, project, "Test Case");
-        return {
-            content: [{ type: "text", text: JSON.stringify(workItem, null, 2) }],
-        };
     });
     server.tool(Test_Plan_Tools.update_test_case_steps, "Update an existing test case work item.", {
         id: z.number().describe("The ID of the test case work item to update."),
@@ -160,48 +207,134 @@ function configureTestPlanTools(server, _, connectionProvider) {
             .string()
             .describe("The steps to reproduce the test case. Make sure to format each step as '1. Step one|Expected result one\n2. Step two|Expected result two. USE '|' as the delimiter between step and expected result. DO NOT use '|' in the description of the step or expected result."),
     }, async ({ id, steps }) => {
-        const connection = await connectionProvider();
-        const witClient = await connection.getWorkItemTrackingApi();
-        let stepsXml;
-        if (steps) {
-            stepsXml = convertStepsToXml(steps);
-        }
-        // Create JSON patch document for work item
-        const patchDocument = [];
-        if (stepsXml) {
-            patchDocument.push({
-                op: "add",
-                path: "/fields/Microsoft.VSTS.TCM.Steps",
-                value: stepsXml,
-            });
+        try {
+            const connection = await connectionProvider();
+            const witClient = await connection.getWorkItemTrackingApi();
+            let stepsXml;
+            if (steps) {
+                stepsXml = convertStepsToXml(steps);
+            }
+            // Create JSON patch document for work item
+            const patchDocument = [];
+            if (stepsXml) {
+                patchDocument.push({
+                    op: "add",
+                    path: "/fields/Microsoft.VSTS.TCM.Steps",
+                    value: stepsXml,
+                });
+            }
+            const workItem = await witClient.updateWorkItem({}, patchDocument, id);
+            return {
+                content: [{ type: "text", text: JSON.stringify(workItem, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error updating test case steps: ${errorMessage}` }],
+                isError: true,
+            };
         }
-        const workItem = await witClient.updateWorkItem({}, patchDocument, id);
-        return {
-            content: [{ type: "text", text: JSON.stringify(workItem, null, 2) }],
-        };
     });
     server.tool(Test_Plan_Tools.list_test_cases, "Gets a list of test cases in the test plan.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
         planid: z.number().describe("The ID of the test plan."),
         suiteid: z.number().describe("The ID of the test suite."),
     }, async ({ project, planid, suiteid }) => {
-        const connection = await connectionProvider();
-        const coreApi = await connection.getTestPlanApi();
-        const testcases = await coreApi.getTestCaseList(project, planid, suiteid);
-        return {
-            content: [{ type: "text", text: JSON.stringify(testcases, null, 2) }],
-        };
+        try {
+            const connection = await connectionProvider();
+            const coreApi = await connection.getTestPlanApi();
+            const testcases = await coreApi.getTestCaseList(project, planid, suiteid);
+            return {
+                content: [{ type: "text", text: JSON.stringify(testcases, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error listing test cases: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
     server.tool(Test_Plan_Tools.test_results_from_build_id, "Gets a list of test results for a given project and build ID.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
         buildid: z.number().describe("The ID of the build."),
     }, async ({ project, buildid }) => {
-        const connection = await connectionProvider();
-        const coreApi = await connection.getTestResultsApi();
-        const testResults = await coreApi.getTestResultDetailsForBuild(project, buildid);
-        return {
-            content: [{ type: "text", text: JSON.stringify(testResults, null, 2) }],
-        };
+        try {
+            const connection = await connectionProvider();
+            const coreApi = await connection.getTestResultsApi();
+            const testResults = await coreApi.getTestResultDetailsForBuild(project, buildid);
+            return {
+                content: [{ type: "text", text: JSON.stringify(testResults, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error fetching test results: ${errorMessage}` }],
+                isError: true,
+            };
+        }
+    });
+    server.tool(Test_Plan_Tools.list_test_suites, "Retrieve a paginated list of test suites from an Azure DevOps project and Test Plan Id.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        planId: z.number().describe("The ID of the test plan."),
+        continuationToken: z.string().optional().describe("Token to continue fetching test plans from a previous request."),
+    }, async ({ project, planId, continuationToken }) => {
+        try {
+            const connection = await connectionProvider();
+            const testPlanApi = await connection.getTestPlanApi();
+            const expand = SuiteExpand.Children;
+            const testSuites = await testPlanApi.getTestSuitesForPlan(project, planId, expand, continuationToken);
+            // The API returns a flat list where the root suite is first, followed by all nested suites
+            // We need to build a proper hierarchy by creating a map and assembling the tree
+            // Create a map of all suites by ID for quick lookup
+            const suiteMap = new Map();
+            testSuites.forEach((suite) => {
+                suiteMap.set(suite.id, {
+                    id: suite.id,
+                    name: suite.name,
+                    parentSuiteId: suite.parentSuite?.id,
+                    children: [],
+                });
+            });
+            // Build the hierarchy by linking children to parents
+            const roots = [];
+            suiteMap.forEach((suite) => {
+                if (suite.parentSuiteId && suiteMap.has(suite.parentSuiteId)) {
+                    // This is a child suite, add it to its parent's children array
+                    const parent = suiteMap.get(suite.parentSuiteId);
+                    parent.children.push(suite);
+                }
+                else {
+                    // This is a root suite (no parent or parent not in map)
+                    roots.push(suite);
+                }
+            });
+            // Clean up the output - remove parentSuiteId and empty children arrays
+            const cleanSuite = (suite) => {
+                const cleaned = {
+                    id: suite.id,
+                    name: suite.name,
+                };
+                if (suite.children && suite.children.length > 0) {
+                    cleaned.children = suite.children.map((child) => cleanSuite(child));
+                }
+                return cleaned;
+            };
+            const result = roots.map((root) => cleanSuite(root));
+            return {
+                content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error listing test suites: ${errorMessage}` }],
+                isError: true,
+            };
+        }
     });
 }
 /*