fix(testmanagement): wrap rich-text fields in <p> so TM renders special chars

TM's v2 API entity-encodes <, > and & in step/result, preconditions and
description on write, and the TM UI renders those fields as rich text only
when the value is HTML-wrapped — bare text is displayed literally, so a
plain ">" surfaced to users as "&gt;" (PMAA-185, FD 1709260, TM-26634).

Per the TM team, external API content must be wrapped in <p> tags. Wrap
those fields on createTestCase and updateTestCase when the value is not
already HTML and contains an encodable character; all other payloads are
sent unchanged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Author: SavioBS629

src/tools/testmanagement-utils/create-testcase.ts

@@ -9,6 +9,7 @@ import {
 } from "./TCG-utils/api.js";
 import { BrowserStackConfig } from "../../lib/types.js";
 import { getTMBaseURL } from "../../lib/tm-base-url.js";
+import { wrapRichText, wrapTestCaseSteps } from "./rich-text.js";
 import logger from "../../logger.js";
 
 interface TestCaseStep {
@@ -324,6 +325,18 @@ export async function createTestCase(
     new Set([...(testCaseParams.tags ?? []), "MCP Generated"]),
   );
 
+  // Rich-text fields must be HTML-wrapped or the TM UI shows entity-encoded
+  // text literally (PMAA-185); see rich-text.ts.
+  testCaseParams.test_case_steps = wrapTestCaseSteps(
+    testCaseParams.test_case_steps,
+  );
+  if (testCaseParams.preconditions !== undefined) {
+    testCaseParams.preconditions = wrapRichText(testCaseParams.preconditions);
+  }
+  if (testCaseParams.description !== undefined) {
+    testCaseParams.description = wrapRichText(testCaseParams.description);
+  }
+
   if (
     testCaseParams.priority !== undefined ||
     testCaseParams.case_type !== undefined

src/tools/testmanagement-utils/rich-text.ts

@@ -0,0 +1,28 @@
+// TM's v2 API treats step/result, preconditions and description as rich-text
+// fields: its write-time sanitizer entity-encodes <, > and & in text nodes
+// (preserving allowed tags like <p>), and the TM UI renders the stored value
+// as rich text only when it is HTML-wrapped — bare text is displayed
+// literally, so a bare ">" surfaces to users as "&gt;" (PMAA-185).
+// Per the TM team, external API content must be wrapped in <p> tags to opt
+// into rich-text rendering. Quotes are not entity-encoded, so only values
+// containing <, > or & need the wrap; everything else is left untouched.
+
+const LOOKS_LIKE_HTML = /^\s*<[a-z][^>]*>/i;
+const HAS_ENCODABLE_CHARS = /[<>&]/;
+
+export function wrapRichText(text: string): string {
+  if (LOOKS_LIKE_HTML.test(text) || !HAS_ENCODABLE_CHARS.test(text)) {
+    return text;
+  }
+  return `<p>${text}</p>`;
+}
+
+export function wrapTestCaseSteps<T extends { step: string; result: string }>(
+  steps: T[],
+): T[] {
+  return steps.map((s) => ({
+    ...s,
+    step: wrapRichText(s.step),
+    result: wrapRichText(s.result),
+  }));
+}

src/tools/testmanagement-utils/update-testcase.ts

@@ -10,6 +10,7 @@ import {
 import { BrowserStackConfig } from "../../lib/types.js";
 import { getTMBaseURL } from "../../lib/tm-base-url.js";
 import { getBrowserStackAuth } from "../../lib/get-auth.js";
+import { wrapRichText, wrapTestCaseSteps } from "./rich-text.js";
 import logger from "../../logger.js";
 
 export interface TestCaseUpdateRequest {
@@ -177,12 +178,14 @@ export async function updateTestCase(
   const testCaseBody: Record<string, any> = {};
 
   if (params.name !== undefined) testCaseBody.name = params.name;
+  // Rich-text fields must be HTML-wrapped or the TM UI shows entity-encoded
+  // text literally (PMAA-185); see rich-text.ts.
   if (params.description !== undefined)
-    testCaseBody.description = params.description;
+    testCaseBody.description = wrapRichText(params.description);
   if (params.preconditions !== undefined)
-    testCaseBody.preconditions = params.preconditions;
+    testCaseBody.preconditions = wrapRichText(params.preconditions);
   if (params.test_case_steps !== undefined)
-    testCaseBody.test_case_steps = params.test_case_steps;
+    testCaseBody.test_case_steps = wrapTestCaseSteps(params.test_case_steps);
   if (params.owner !== undefined) testCaseBody.owner = params.owner;
   if (params.status !== undefined) testCaseBody.status = params.status;
   if (params.tags !== undefined) testCaseBody.tags = params.tags;

tests/tools/richText.test.ts

@@ -0,0 +1,62 @@
+import { describe, it, expect } from 'vitest';
+import {
+  wrapRichText,
+  wrapTestCaseSteps,
+} from '../../src/tools/testmanagement-utils/rich-text';
+
+describe('wrapRichText', () => {
+  it('wraps bare text containing > in <p> tags', () => {
+    expect(wrapRichText('Navigate to Settings > Users')).toBe(
+      '<p>Navigate to Settings > Users</p>',
+    );
+  });
+
+  it('wraps bare text containing < in <p> tags', () => {
+    expect(wrapRichText('if a < b then pass')).toBe(
+      '<p>if a < b then pass</p>',
+    );
+  });
+
+  it('wraps bare text containing & in <p> tags', () => {
+    expect(wrapRichText('Q&A section loads')).toBe('<p>Q&A section loads</p>');
+  });
+
+  it('leaves text without <, > or & untouched', () => {
+    expect(wrapRichText('Click "Save" then \'Confirm\'')).toBe(
+      'Click "Save" then \'Confirm\'',
+    );
+  });
+
+  it('leaves already-HTML content untouched', () => {
+    expect(wrapRichText('<p>Settings &gt; Users</p>')).toBe(
+      '<p>Settings &gt; Users</p>',
+    );
+    expect(wrapRichText('  <ul><li>A &amp; B</li></ul>')).toBe(
+      '  <ul><li>A &amp; B</li></ul>',
+    );
+  });
+
+  it('wraps text starting with < that is not a tag', () => {
+    expect(wrapRichText('< 5 items are shown')).toBe(
+      '<p>< 5 items are shown</p>',
+    );
+  });
+});
+
+describe('wrapTestCaseSteps', () => {
+  it('wraps step and result independently and preserves other keys', () => {
+    expect(
+      wrapTestCaseSteps([
+        { step: 'Go to A > B', result: 'B page loads' },
+        { step: 'Click Save', result: 'Count > 0' },
+      ]),
+    ).toEqual([
+      { step: '<p>Go to A > B</p>', result: 'B page loads' },
+      { step: 'Click Save', result: '<p>Count > 0</p>' },
+    ]);
+  });
+
+  it('returns an empty array unchanged', () => {
+    expect(wrapTestCaseSteps([])).toEqual([]);
+  });
+});