@uarlouski/testrail-mcp-server 1.1.0

package/test/tools/update_case.test.ts

@@ -0,0 +1,108 @@
+import { jest, describe, test, expect, beforeEach } from '@jest/globals';
+import { updateCaseTool } from '../../src/tools/update_case.js';
+import { TestRailClient } from '../../src/client/testrail.js';
+import { Case } from '../../src/types/testrail.js';
+
+describe('update_case tool', () => {
+    let mockClient: jest.Mocked<TestRailClient>;
+    let updateCaseMock: jest.Mock<(caseId: string, fields: Record<string, any>) => Promise<Case>>;
+
+    const mockUpdatedCase: Case = {
+        id: 123,
+        title: 'Updated Title',
+        section_id: 1,
+        template_id: 1,
+        type_id: 1,
+        priority_id: 2,
+        milestone_id: null,
+        refs: null,
+        created_by: 1,
+        created_on: 1700000000,
+        updated_by: 1,
+        updated_on: 1700000001,
+        estimate: null,
+        estimate_forecast: null,
+        suite_id: 1,
+        display_order: 1,
+        is_deleted: 0,
+        labels: [],
+    };
+
+    beforeEach(() => {
+        updateCaseMock = jest.fn<(caseId: string, fields: Record<string, any>) => Promise<Case>>()
+            .mockResolvedValue(mockUpdatedCase);
+
+        mockClient = {
+            updateCase: updateCaseMock
+        } as unknown as jest.Mocked<TestRailClient>;
+    });
+
+    test('exports correct tool definition', () => {
+        expect(updateCaseTool.name).toBe('update_case');
+        expect(updateCaseTool.description).toContain('Update');
+        expect(updateCaseTool.parameters).toBeDefined();
+        expect(updateCaseTool.parameters.case_id).toBeDefined();
+        expect(updateCaseTool.parameters.fields).toBeDefined();
+    });
+
+    test('handler updates case and returns success response', async () => {
+        const result = await updateCaseTool.handler(
+            { case_id: '123', fields: { title: 'Updated Title' } },
+            mockClient
+        );
+
+        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(123);
+        expect(parsed.message).toContain('C123');
+        expect(mockClient.updateCase).toHaveBeenCalledWith('123', { title: 'Updated Title' });
+    });
+
+    test('strips C prefix from case_id', async () => {
+        await updateCaseTool.handler(
+            { case_id: 'C456', fields: { title: 'New Title' } },
+            mockClient
+        );
+
+        expect(mockClient.updateCase).toHaveBeenCalledWith('456', { title: 'New Title' });
+    });
+
+    test('handles lowercase c prefix', async () => {
+        await updateCaseTool.handler(
+            { case_id: 'c789', fields: { priority_id: 3 } },
+            mockClient
+        );
+
+        expect(mockClient.updateCase).toHaveBeenCalledWith('789', { priority_id: 3 });
+    });
+
+    test('passes multiple fields correctly', async () => {
+        const fields = {
+            title: 'New Title',
+            priority_id: 2,
+            custom_automation_priority: 1,
+            refs: 'JIRA-123',
+        };
+
+        await updateCaseTool.handler({ case_id: '123', fields }, mockClient);
+
+        expect(mockClient.updateCase).toHaveBeenCalledWith('123', fields);
+    });
+
+    test('handler returns error on failure', async () => {
+        updateCaseMock.mockRejectedValue(new Error('API Error'));
+
+        const result = await updateCaseTool.handler(
+            { case_id: '123', fields: { title: 'Test' } },
+            mockClient
+        );
+
+        expect(result).toEqual({
+            content: [{ type: 'text', text: 'Error: API Error' }],
+            isError: true
+        });
+    });
+});

package/test/tools/update_cases.test.ts

@@ -0,0 +1,88 @@
+import { jest, describe, test, expect, beforeEach } from '@jest/globals';
+import { updateCasesTool } from '../../src/tools/update_cases.js';
+import { TestRailClient } from '../../src/client/testrail.js';
+import { Case } from '../../src/types/testrail.js';
+
+describe('update_cases tool', () => {
+    let mockClient: jest.Mocked<TestRailClient>;
+    let updateCasesMock: jest.Mock<(caseIds: number[], fields: Record<string, any>) => Promise<Case[]>>;
+
+    const mockUpdatedCases: Case[] = [
+        {
+            id: 1, title: 'Test Case 1', section_id: 1, template_id: 1, type_id: 1,
+            priority_id: 3, milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
+            updated_by: 1, updated_on: 1700000001, estimate: null, estimate_forecast: null,
+            suite_id: 1, display_order: 1, is_deleted: 0, labels: []
+        },
+        {
+            id: 2, title: 'Test Case 2', section_id: 1, template_id: 1, type_id: 1,
+            priority_id: 3, milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
+            updated_by: 1, updated_on: 1700000001, estimate: null, estimate_forecast: null,
+            suite_id: 1, display_order: 2, is_deleted: 0, labels: []
+        },
+        {
+            id: 3, title: 'Test Case 3', section_id: 1, template_id: 1, type_id: 1,
+            priority_id: 3, milestone_id: null, refs: null, created_by: 1, created_on: 1700000000,
+            updated_by: 1, updated_on: 1700000001, estimate: null, estimate_forecast: null,
+            suite_id: 1, display_order: 3, is_deleted: 0, labels: []
+        },
+    ];
+
+    beforeEach(() => {
+        updateCasesMock = jest.fn<(caseIds: number[], fields: Record<string, any>) => Promise<Case[]>>()
+            .mockResolvedValue(mockUpdatedCases);
+
+        mockClient = {
+            updateCases: updateCasesMock
+        } as unknown as jest.Mocked<TestRailClient>;
+    });
+
+    test('exports correct tool definition', () => {
+        expect(updateCasesTool.name).toBe('update_cases');
+        expect(updateCasesTool.description).toContain('Bulk');
+        expect(updateCasesTool.parameters).toBeDefined();
+        expect(updateCasesTool.parameters.case_ids).toBeDefined();
+        expect(updateCasesTool.parameters.fields).toBeDefined();
+    });
+
+    test('handler updates cases and returns success response', async () => {
+        const result = await updateCasesTool.handler(
+            { case_ids: [1, 2, 3], fields: { priority_id: 3 } },
+            mockClient
+        );
+
+        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.updated_count).toBe(3);
+        expect(parsed.case_ids).toEqual([1, 2, 3]);
+        expect(parsed.message).toContain('3 test cases');
+    });
+
+    test('passes case_ids and fields correctly', async () => {
+        const fields = { priority_id: 2, type_id: 1 };
+
+        await updateCasesTool.handler(
+            { case_ids: [10, 20, 30], fields },
+            mockClient
+        );
+
+        expect(mockClient.updateCases).toHaveBeenCalledWith([10, 20, 30], fields);
+    });
+
+    test('handler returns error on failure', async () => {
+        updateCasesMock.mockRejectedValue(new Error('API Error'));
+
+        const result = await updateCasesTool.handler(
+            { case_ids: [1, 2], fields: { priority_id: 2 } },
+            mockClient
+        );
+
+        expect(result).toEqual({
+            content: [{ type: 'text', text: 'Error: API Error' }],
+            isError: true
+        });
+    });
+});

package/test/utils/mapper.test.ts

@@ -0,0 +1,112 @@
+import { jest, describe, test, expect } from '@jest/globals';
+import { Case, CaseField } from '../../src/types/testrail.js';
+import { processCustomFields } from '../../src/utils/mapper.js';
+
+describe('processCustomFields', () => {
+
+    // Mock CaseField array simulating TestRail API response
+    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: [] },
+    ];
+
+    test('maps custom fields using field metadata', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 1,
+            section_id: 0, type_id: 0, priority_id: 0,
+            custom_is_automated: true,
+            custom_refs: 'DEF-123',
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.is_automated).toBe(true);
+        expect(result.defects).toBe('DEF-123');
+    });
+
+    test('maps fields using value mapping from config', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 1,
+            section_id: 0, type_id: 0, priority_id: 0,
+            custom_case_automation_priority: 2,
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.automation_priority).toBe('P0');
+    });
+
+    test('includes only template-specific fields for template 1', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 1,
+            custom_steps: 'Step 1...',
+            custom_expected: 'Expectation...',
+            custom_steps_separated: [{ content: 'Should not appear' }], // Template 2 field
+            section_id: 0, type_id: 0, priority_id: 0,
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.steps).toBe('Step 1...');
+        expect(result.expected).toBe('Expectation...');
+        expect(result.steps_separated).toBeUndefined(); // Not included for template 1
+    });
+
+    test('includes only template-specific fields for template 2', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 2,
+            custom_steps: 'Should not appear', // Template 1 field
+            custom_steps_separated: [{ content: 'Step 1' }],
+            section_id: 0, type_id: 0, priority_id: 0,
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.steps_separated).toEqual([{ content: 'Step 1' }]);
+        expect(result.steps).toBeUndefined(); // Not included for template 2
+    });
+
+    test('keeps unknown fields as-is when no mapping found', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 999,
+            custom_unknown_field: 'some value',
+            section_id: 0, type_id: 0, priority_id: 0,
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.custom_unknown_field).toBe('some value'); // Kept as-is with original key
+    });
+
+    test('throws error when testCase is null', () => {
+        expect(() => processCustomFields(null as any, mockCaseFields)).toThrow('Test case is undefined or null');
+    });
+
+    test('throws error when testCase is undefined', () => {
+        expect(() => processCustomFields(undefined as any, mockCaseFields)).toThrow('Test case is undefined or null');
+    });
+
+    test('returns original value when dropdown option is not found', () => {
+        const input: Case = {
+            id: 1, title: 'Foo', template_id: 1,
+            section_id: 0, type_id: 0, priority_id: 0,
+            custom_case_automation_priority: 999, // Unknown option ID
+            display_order: 1, suite_id: 1, created_by: 1, created_on: 1, updated_by: 1, updated_on: 1,
+            is_deleted: 0, refs: null, labels: [],
+        } as unknown as Case;
+
+        const result = processCustomFields(input, mockCaseFields);
+        expect(result.automation_priority).toBe(999); // Falls back to original value
+    });
+});
+

package/test/utils/sanitizer.test.ts

@@ -0,0 +1,59 @@
+import { describe, test, expect } from '@jest/globals';
+import { sanitizeValue } from '../../src/utils/sanitizer.js';
+
+describe('sanitizeValue', () => {
+    test('strips style attributes from string values', () => {
+        const input = '<p style="color: red; font-size: 14px;">Hello</p>';
+        expect(sanitizeValue(input)).toBe('<p>Hello</p>');
+    });
+
+    test('strips multiple style attributes', () => {
+        const input = '<div style="margin: 10px;"><span style="font-weight: bold;">Text</span></div>';
+        expect(sanitizeValue(input)).toBe('<div><span>Text</span></div>');
+    });
+
+    test('handles single quotes in style', () => {
+        const input = "<p style='color: blue;'>Text</p>";
+        expect(sanitizeValue(input)).toBe('<p>Text</p>');
+    });
+
+    test('preserves other attributes', () => {
+        const input = '<a href="http://example.com" style="color: blue;" class="link">Link</a>';
+        expect(sanitizeValue(input)).toBe('<a href="http://example.com" class="link">Link</a>');
+    });
+
+    test('returns unchanged text without styles', () => {
+        const input = '<p>No styles here</p>';
+        expect(sanitizeValue(input)).toBe('<p>No styles here</p>');
+    });
+    test('sanitizes string values', () => {
+        const input = '<p style="color: red;">Hello</p>';
+        expect(sanitizeValue(input)).toBe('<p>Hello</p>');
+    });
+
+    test('sanitizes nested objects', () => {
+        const input = {
+            content: '<div style="margin: 10px;">Step 1</div>',
+            expected: '<p style="color: green;">Result</p>'
+        };
+        const result = sanitizeValue(input);
+        expect(result.content).toBe('<div>Step 1</div>');
+        expect(result.expected).toBe('<p>Result</p>');
+    });
+
+    test('sanitizes arrays', () => {
+        const input = [
+            { content: '<span style="font-size: 12px;">Item 1</span>' },
+            { content: '<span style="font-size: 14px;">Item 2</span>' }
+        ];
+        const result = sanitizeValue(input);
+        expect(result[0].content).toBe('<span>Item 1</span>');
+        expect(result[1].content).toBe('<span>Item 2</span>');
+    });
+
+    test('preserves non-string values', () => {
+        expect(sanitizeValue(42)).toBe(42);
+        expect(sanitizeValue(true)).toBe(true);
+        expect(sanitizeValue(null)).toBe(null);
+    });
+});

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "types": [
+            "node",
+            "jest"
+        ]
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.test.ts"
+    ]
+}