@uarlouski/testrail-mcp-server 1.1.0 → 1.3.0

package/test/tools/add_results.test.ts

@@ -0,0 +1,94 @@
+import { jest, describe, test, expect, beforeEach } from '@jest/globals';
+import { addResultsTool } from '../../src/tools/add_results.js';
+import { TestRailClient } from '../../src/client/testrail.js';
+import { Result } from '../../src/types/testrail.js';
+
+describe('add_results tool', () => {
+    let mockClient: jest.Mocked<TestRailClient>;
+    let addResultsMock: jest.Mock<(runId: number, results: Array<Record<string, any>>) => Promise<Result[]>>;
+
+    const mockResults: Result[] = [
+        {
+            id: 1,
+            test_id: 100,
+            status_id: 1,
+            comment: 'Test passed',
+            defects: null
+        },
+        {
+            id: 2,
+            test_id: 101,
+            status_id: 5,
+            comment: 'Test failed',
+            defects: 'BUG-123'
+        }
+    ];
+
+    beforeEach(() => {
+        addResultsMock = jest.fn<(runId: number, results: Array<Record<string, any>>) => Promise<Result[]>>().mockResolvedValue(mockResults);
+
+        mockClient = {
+            addResults: addResultsMock
+        } as unknown as jest.Mocked<TestRailClient>;
+    });
+
+    test('exports correct tool definition', () => {
+        expect(addResultsTool.name).toBe('add_results');
+        expect(addResultsTool.description).toBeDefined();
+        expect(addResultsTool.parameters).toBeDefined();
+    });
+
+    test('handler calls addResults with correct arguments', async () => {
+        const args = {
+            run_id: 50,
+            results: [
+                {
+                    test_id: 100,
+                    status_id: 1,
+                    comment: 'Test passed'
+                },
+                {
+                    test_id: 101,
+                    status_id: 5,
+                    comment: 'Test failed',
+                    defects: 'BUG-123'
+                }
+            ]
+        };
+
+        const result = await addResultsTool.handler(args, mockClient);
+
+        expect(result).toBeDefined();
+        expect(mockClient.addResults).toHaveBeenCalledWith(50, args.results);
+
+        expect(result.success).toBe(true);
+        expect(result.added_count).toBe(2);
+        expect(result.results).toHaveLength(2);
+    });
+
+    test('handler works with single result', async () => {
+        const singleResult = [mockResults[0]];
+        addResultsMock.mockResolvedValue(singleResult);
+
+        const args = {
+            run_id: 50,
+            results: [
+                {
+                    test_id: 100,
+                    status_id: 1,
+                    comment: 'Test passed'
+                }
+            ]
+        };
+
+        const result = await addResultsTool.handler(args, mockClient);
+
+        expect(result.success).toBe(true);
+        expect(result.added_count).toBe(1);
+    });
+
+    test('handler returns error on failure', async () => {
+        addResultsMock.mockRejectedValue(new Error('API Error'));
+        await expect(addResultsTool.handler({ run_id: 50, results: [] }, mockClient)).rejects.toThrow('API Error');
+    });
+});

package/test/tools/add_run.test.ts

@@ -0,0 +1,83 @@
+import { jest } from '@jest/globals';
+import { addRunTool } from '../../src/tools/add_run.js';
+import { TestRailClient } from '../../src/client/testrail.js';
+
+describe('add_run tool', () => {
+    let client: TestRailClient;
+    let addRunMock: any;
+
+    beforeEach(() => {
+        addRunMock = jest.fn();
+        client = {
+            addRun: addRunMock,
+            getCase: jest.fn(),
+        } as any as TestRailClient;
+    });
+
+    test('should wrap client result including only required fields and forcing include_all to false', async () => {
+        const run = {
+            id: 1,
+            name: 'Test Run',
+            description: null,
+            suite_id: 10,
+            project_id: 1,
+            is_completed: false,
+            passed_count: 0,
+            blocked_count: 0,
+            untested_count: 5,
+            retest_count: 0,
+            failed_count: 0,
+            url: 'https://testrail.io/runs/view/1'
+        };
+        addRunMock.mockResolvedValue(run);
+
+        const mockCase = { suite_id: 10 };
+        (client.getCase as jest.Mock<any>).mockResolvedValue(mockCase);
+
+        const result = await addRunTool.handler({ project_id: '1', name: 'Test Run', case_ids: [1] }, client);
+
+        expect(client.getCase).toHaveBeenCalledWith('1');
+        expect(addRunMock).toHaveBeenCalledWith('1', { name: 'Test Run', case_ids: [1], suite_id: 10, include_all: false });
+        expect(result).toEqual(run);
+    });
+
+    test('should wrap client result handling optional fields', async () => {
+        const run = {
+            id: 1,
+            name: 'Test Run',
+            description: 'Description',
+            suite_id: 10,
+            project_id: 1,
+            is_completed: false,
+            passed_count: 0,
+            blocked_count: 0,
+            untested_count: 3,
+            retest_count: 0,
+            failed_count: 0,
+            url: 'https://testrail.io/runs/view/1'
+        };
+        addRunMock.mockResolvedValue(run);
+
+        const mockCase = { suite_id: 10 };
+        (client.getCase as jest.Mock<any>).mockResolvedValue(mockCase);
+
+        const args = {
+            project_id: '1',
+            name: 'Test Run',
+            description: 'Description',
+            case_ids: [1, 2, 3]
+        };
+
+        const result = await addRunTool.handler(args, client);
+
+        expect(client.getCase).toHaveBeenCalledWith('1');
+        expect(addRunMock).toHaveBeenCalledWith('1', {
+            name: 'Test Run',
+            description: 'Description',
+            case_ids: [1, 2, 3],
+            suite_id: 10,
+            include_all: false
+        });
+        expect(result).toEqual(run);
+    });
+});

package/test/tools/create_case.test.ts

@@ -53,12 +53,9 @@ describe('create_case tool', () => {
         );
 
         expect(result).toBeDefined();
-        expect(result.content[0].type).toBe('text');
-
-        const parsed = JSON.parse(result.content[0].text);
-        expect(parsed.success).toBe(true);
-        expect(parsed.case_id).toBe(456);
-        expect(parsed.message).toContain('C456');
+        expect(result.success).toBe(true);
+        expect(result.case_id).toBe(456);
+        expect(result.message).toContain('C456');
         expect(mockClient.createCase).toHaveBeenCalledWith('1', { title: 'New Test Case' });
     });
 
@@ -91,17 +88,14 @@ describe('create_case tool', () => {
         expect(mockClient.createCase).toHaveBeenCalledWith('10', { title: 'Simple Test' });
     });
 
-    test('handler returns error on failure', async () => {
+    test('handler throws error on failure', async () => {
         createCaseMock.mockRejectedValue(new Error('API Error'));
 
-        const result = await createCaseTool.handler(
-            { section_id: '1', title: 'Test' },
-            mockClient
-        );
-
-        expect(result).toEqual({
-            content: [{ type: 'text', text: 'Error: API Error' }],
-            isError: true
-        });
+        await expect(
+            createCaseTool.handler(
+                { section_id: '1', title: 'Test' },
+                mockClient
+            )
+        ).rejects.toThrow('API Error');
     });
 });

package/test/tools/get_case.test.ts

@@ -12,13 +12,13 @@ describe('get_case tool', () => {
     let getCaseFieldsMock: jest.Mock<() => Promise<CaseField[]>>;
 
     const mockCaseFields: CaseField[] = [
-        { id: 1, name: 'is_automated', system_name: 'custom_is_automated', label: 'Is Automated', type_id: 1, template_ids: [], include_all: true, is_active: true, display_order: 1, description: null, configs: [] },
-        { id: 2, name: 'refs', system_name: 'custom_refs', label: 'Defects', type_id: 1, template_ids: [], include_all: true, is_active: true, display_order: 2, description: null, configs: [] },
-        { id: 3, name: 'case_automation_priority', system_name: 'custom_case_automation_priority', label: 'Automation Priority', type_id: 6, template_ids: [], include_all: true, is_active: true, display_order: 3, description: null, configs: [{ context: { is_global: true, project_ids: null }, options: { items: '2, P0\n3, P1\n4, P2\n5, P3\n6, P4' } }] },
-        { id: 4, name: 'preconds', system_name: 'custom_preconds', label: 'Preconditions', type_id: 1, template_ids: [], include_all: true, is_active: true, display_order: 4, description: null, configs: [] },
-        { id: 5, name: 'steps', system_name: 'custom_steps', label: 'Steps', type_id: 1, template_ids: [1], include_all: false, is_active: true, display_order: 5, description: null, configs: [] },
-        { id: 6, name: 'expected', system_name: 'custom_expected', label: 'Expected', type_id: 1, template_ids: [1], include_all: false, is_active: true, display_order: 6, description: null, configs: [] },
-        { id: 7, name: 'steps_separated', system_name: 'custom_steps_separated', label: 'Steps Separated', type_id: 1, template_ids: [2], include_all: false, is_active: true, display_order: 7, description: null, configs: [] },
+        { id: 1, name: 'is_automated', system_name: 'custom_is_automated', label: 'Is Automated', type_id: 1, template_ids: [], include_all: true, is_active: true, description: null, configs: [] },
+        { id: 2, name: 'refs', system_name: 'custom_refs', label: 'Defects', type_id: 1, template_ids: [], include_all: true, is_active: true, description: null, configs: [] },
+        { id: 3, name: 'case_automation_priority', system_name: 'custom_case_automation_priority', label: 'Automation Priority', type_id: 6, template_ids: [], include_all: true, is_active: true, description: null, configs: [{ options: { items: '2, P0\n3, P1\n4, P2\n5, P3\n6, P4' } }] },
+        { id: 4, name: 'preconds', system_name: 'custom_preconds', label: 'Preconditions', type_id: 1, template_ids: [], include_all: true, is_active: true, description: null, configs: [] },
+        { id: 5, name: 'steps', system_name: 'custom_steps', label: 'Steps', type_id: 1, template_ids: [1], include_all: false, is_active: true, description: null, configs: [] },
+        { id: 6, name: 'expected', system_name: 'custom_expected', label: 'Expected', type_id: 1, template_ids: [1], include_all: false, is_active: true, description: null, configs: [] },
+        { id: 7, name: 'steps_separated', system_name: 'custom_steps_separated', label: 'Steps Separated', type_id: 1, template_ids: [2], include_all: false, is_active: true, description: null, configs: [] },
     ];
 
     beforeEach(() => {
@@ -39,7 +39,7 @@ describe('get_case tool', () => {
 
     test('exports correct tool definition', () => {
         expect(getCaseTool.name).toBe('get_case');
-        expect(getCaseTool.description).toBe('Get a test case from TestRail by ID');
+        expect(getCaseTool.description).toBe('Get detailed information about a test case including its custom fields');
         expect(getCaseTool.parameters).toBeDefined();
     });
 
@@ -51,15 +51,10 @@ describe('get_case tool', () => {
             priority_id: 3,
             milestone_id: null,
             refs: 'JIRA-123',
-            created_by: 1,
             created_on: 1700000000,
-            updated_by: 1,
             updated_on: 1700000000,
             estimate: null,
-            estimate_forecast: null,
             suite_id: 1,
-            display_order: 1,
-            is_deleted: 0,
             custom_refs: null,
             custom_case_automation_priority: null,
             custom_is_automated: null,
@@ -79,7 +74,7 @@ describe('get_case tool', () => {
         };
 
         const mockSection: Section = {
-            id: 456, name: 'My Section', description: null, parent_id: null, depth: 0, display_order: 1, suite_id: 1
+            id: 456, name: 'My Section', description: null, parent_id: null, suite_id: 1
         };
 
         const mockCaseTypes: CaseType[] = [
@@ -88,7 +83,7 @@ describe('get_case tool', () => {
         ];
 
         const mockPriorities: Priority[] = [
-            { id: 3, name: 'High', priority: 3, short_name: 'High', is_default: false }
+            { id: 3, name: 'High', is_default: false }
         ];
 
         getCaseMock.mockResolvedValue(mockCase);
@@ -99,23 +94,16 @@ describe('get_case tool', () => {
         const result = await getCaseTool.handler({ case_id: 'C123' }, mockClient);
 
         expect(result).toBeDefined();
-        if ('content' in result) {
-            expect(result.content[0].type).toBe('text');
-            const parsed = JSON.parse(result.content[0].text);
-
-            expect(parsed).toEqual({
-                id: 123,
-                title: 'My Case',
-                section: 'My Section',
-                type: 'Functional',
-                priority: 'High',
-                labels: ['tag1'],
-                references: 'JIRA-123',
-                updated_on: 1700000000
-            });
-        } else {
-            throw new Error('Result should have content');
-        }
+        expect(result).toEqual({
+            id: 123,
+            title: 'My Case',
+            section: 'My Section',
+            type: 'Functional',
+            priority: 'High',
+            labels: ['tag1'],
+            references: 'JIRA-123',
+            updated_on: 1700000000
+        });
 
         expect(mockClient.getCase).toHaveBeenCalledWith('123');
         expect(mockClient.getSection).toHaveBeenCalledWith('456');
@@ -125,76 +113,73 @@ describe('get_case tool', () => {
 
 
 
-    test('handler returns error on failure', async () => {
+    test('handler throws error on failure', async () => {
         getCaseMock.mockRejectedValue(new Error('API Error'));
 
-        const result = await getCaseTool.handler({ case_id: '123' }, mockClient);
-
-        expect(result).toEqual({
-            content: [{ type: 'text', text: 'Error: API Error' }],
-            isError: true
-        });
+        await expect(
+            getCaseTool.handler({ case_id: '123' }, mockClient)
+        ).rejects.toThrow('API Error');
     });
 
     test('handler returns "Unknown" when caseType is not found', async () => {
         const mockCase: Case = {
             id: 123, title: 'My Case', template_id: 1,
             section_id: 456, type_id: 999, priority_id: 3,
-            milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
-            updated_by: 1, updated_on: 1700000000, estimate: null, estimate_forecast: null,
-            suite_id: 1, display_order: 1, is_deleted: 0, labels: []
+            milestone_id: null, refs: null, created_on: 1700000000,
+            updated_on: 1700000000, estimate: null,
+            suite_id: 1, labels: []
         };
 
         getCaseMock.mockResolvedValue(mockCase);
-        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, depth: 0, display_order: 1, suite_id: 1 });
+        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, suite_id: 1 });
         getCaseTypesMock.mockResolvedValue([{ id: 1, name: 'Automated', is_default: false }]);
-        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', priority: 3, short_name: 'High', is_default: false }]);
+        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', is_default: false }]);
 
         const result = await getCaseTool.handler({ case_id: '123' }, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
+        // result is now a plain object
 
-        expect(parsed.type).toBe('Unknown');
-        expect(parsed.priority).toBe('High');
+        expect(result.type).toBe('Unknown');
+        expect(result.priority).toBe('High');
     });
 
     test('handler returns "Unknown" when priority is not found', async () => {
         const mockCase: Case = {
             id: 123, title: 'My Case', template_id: 1,
             section_id: 456, type_id: 1, priority_id: 999,
-            milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
-            updated_by: 1, updated_on: 1700000000, estimate: null, estimate_forecast: null,
-            suite_id: 1, display_order: 1, is_deleted: 0, labels: []
+            milestone_id: null, refs: null, created_on: 1700000000,
+            updated_on: 1700000000, estimate: null,
+            suite_id: 1, labels: []
         };
 
         getCaseMock.mockResolvedValue(mockCase);
-        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, depth: 0, display_order: 1, suite_id: 1 });
+        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, suite_id: 1 });
         getCaseTypesMock.mockResolvedValue([{ id: 1, name: 'Automated', is_default: false }]);
-        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', priority: 3, short_name: 'High', is_default: false }]);
+        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', is_default: false }]);
 
         const result = await getCaseTool.handler({ case_id: '123' }, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
+        // result is now a plain object
 
-        expect(parsed.type).toBe('Automated');
-        expect(parsed.priority).toBe('Unknown');
+        expect(result.type).toBe('Automated');
+        expect(result.priority).toBe('Unknown');
     });
 
     test('handler uses empty array when labels is undefined', async () => {
         const mockCase: Case = {
             id: 123, title: 'My Case', template_id: 1,
             section_id: 456, type_id: 1, priority_id: 3,
-            milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
-            updated_by: 1, updated_on: 1700000000, estimate: null, estimate_forecast: null,
-            suite_id: 1, display_order: 1, is_deleted: 0, labels: undefined as any
+            milestone_id: null, refs: null, created_on: 1700000000,
+            updated_on: 1700000000, estimate: null,
+            suite_id: 1, labels: undefined as any
         };
 
         getCaseMock.mockResolvedValue(mockCase);
-        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, depth: 0, display_order: 1, suite_id: 1 });
+        getSectionMock.mockResolvedValue({ id: 456, name: 'Section', description: null, parent_id: null, suite_id: 1 });
         getCaseTypesMock.mockResolvedValue([{ id: 1, name: 'Automated', is_default: false }]);
-        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', priority: 3, short_name: 'High', is_default: false }]);
+        getPrioritiesMock.mockResolvedValue([{ id: 3, name: 'High', is_default: false }]);
 
         const result = await getCaseTool.handler({ case_id: '123' }, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
+        // result is now a plain object
 
-        expect(parsed.labels).toEqual([]);
+        expect(result.labels).toEqual([]);
     });
 });

package/test/tools/get_case_fields.test.ts

@@ -17,9 +17,8 @@ describe('get_case_fields tool', () => {
             template_ids: [],
             include_all: true,
             is_active: true,
-            display_order: 1,
             description: 'Whether test is automated',
-            configs: [{ context: { is_global: true, project_ids: null }, options: { is_required: false } }]
+            configs: [{ options: { is_required: false } }]
         },
         {
             id: 2,
@@ -30,9 +29,8 @@ describe('get_case_fields tool', () => {
             template_ids: [],
             include_all: true,
             is_active: true,
-            display_order: 2,
             description: 'Priority for automation',
-            configs: [{ context: { is_global: true, project_ids: null }, options: { items: '1, P0\n2, P1\n3, P2', is_required: true } }]
+            configs: [{ options: { items: '1, P0\n2, P1\n3, P2', is_required: true } }]
         },
         {
             id: 3,
@@ -43,7 +41,6 @@ describe('get_case_fields tool', () => {
             template_ids: [],
             include_all: true,
             is_active: false,
-            display_order: 3,
             description: null,
             configs: []
         },
@@ -56,9 +53,8 @@ describe('get_case_fields tool', () => {
             template_ids: [],
             include_all: true,
             is_active: true,
-            display_order: 4,
             description: 'Test components',
-            configs: [{ context: { is_global: true, project_ids: null }, options: { items: '1, UI\n2, API\n3, Database' } }]
+            configs: [{ options: { items: '1, UI\n2, API\n3, Database' } }]
         }
     ];
 
@@ -80,76 +76,11 @@ describe('get_case_fields tool', () => {
         const result = await getCaseFieldsTool.handler({}, mockClient);
 
         expect(result).toBeDefined();
-        expect(result.content[0].type).toBe('text');
-
-        const parsed = JSON.parse(result.content[0].text);
-        expect(parsed.fields).toHaveLength(11); // 8 system fields + 3 active custom fields
+        expect(result.fields).toBeDefined();
+        expect(result.fields.length).toBeGreaterThan(0);
         expect(mockClient.getCaseFields).toHaveBeenCalled();
     });
 
-    test('returns only essential schema fields', async () => {
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
-
-        const field = parsed.fields[0];
-        expect(Object.keys(field).sort()).toEqual(['is_required', 'label', 'system_name', 'type']);
-    });
-
-    test('returns correct field types', async () => {
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
-
-        const checkboxField = parsed.fields.find((f: any) => f.system_name === 'custom_is_automated');
-        expect(checkboxField.type).toBe('Checkbox');
-
-        const dropdownField = parsed.fields.find((f: any) => f.system_name === 'custom_automation_priority');
-        expect(dropdownField.type).toBe('Dropdown');
-
-        const multiSelectField = parsed.fields.find((f: any) => f.system_name === 'custom_components');
-        expect(multiSelectField.type).toBe('Multi-select');
-    });
-
-    test('parses dropdown options correctly', async () => {
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
-
-        const dropdownField = parsed.fields.find((f: any) => f.system_name === 'custom_automation_priority');
-        expect(dropdownField.options).toEqual(['P0', 'P1', 'P2']);
-
-        const multiSelectField = parsed.fields.find((f: any) => f.system_name === 'custom_components');
-        expect(multiSelectField.options).toEqual(['UI', 'API', 'Database']);
-    });
-
-    test('identifies required fields', async () => {
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
-
-        const optionalField = parsed.fields.find((f: any) => f.system_name === 'custom_is_automated');
-        expect(optionalField.is_required).toBe(false);
-
-        const requiredField = parsed.fields.find((f: any) => f.system_name === 'custom_automation_priority');
-        expect(requiredField.is_required).toBe(true);
-    });
-
-    test('filters out inactive fields', async () => {
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
-
-        const inactiveField = parsed.fields.find((f: any) => f.system_name === 'custom_inactive_field');
-        expect(inactiveField).toBeUndefined();
-    });
-
-    test('handler returns error on failure', async () => {
-        getCaseFieldsMock.mockRejectedValue(new Error('API Error'));
-
-        const result = await getCaseFieldsTool.handler({}, mockClient);
-
-        expect(result).toEqual({
-            content: [{ type: 'text', text: 'Error: API Error' }],
-            isError: true
-        });
-    });
-
     test('includes template_ids for template-specific fields', async () => {
         const templateSpecificFields: CaseField[] = [
             {
@@ -161,7 +92,6 @@ describe('get_case_fields tool', () => {
                 template_ids: [1, 2],
                 include_all: false,
                 is_active: true,
-                display_order: 5,
                 description: 'Test steps',
                 configs: []
             }
@@ -170,9 +100,8 @@ describe('get_case_fields tool', () => {
         getCaseFieldsMock.mockResolvedValue(templateSpecificFields);
 
         const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
 
-        const stepsField = parsed.fields.find((f: any) => f.system_name === 'custom_steps');
+        const stepsField = result.fields.find((f: any) => f.system_name === 'custom_steps');
         expect(stepsField.template_ids).toEqual([1, 2]);
     });
 
@@ -187,7 +116,6 @@ describe('get_case_fields tool', () => {
                 template_ids: [],
                 include_all: true,
                 is_active: true,
-                display_order: 6,
                 description: null,
                 configs: []
             }
@@ -196,9 +124,8 @@ describe('get_case_fields tool', () => {
         getCaseFieldsMock.mockResolvedValue(unknownTypeFields);
 
         const result = await getCaseFieldsTool.handler({}, mockClient);
-        const parsed = JSON.parse(result.content[0].text);
 
-        const unknownField = parsed.fields.find((f: any) => f.system_name === 'custom_unknown_type');
+        const unknownField = result.fields.find((f: any) => f.system_name === 'custom_unknown_type');
         expect(unknownField.type).toBe('Unknown (999)');
     });
 });