@elisra-devops/docgen-data-provider 1.103.0 → 1.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elisra-devops/docgen-data-provider",
-  "version": "1.103.0",
+  "version": "1.104.0",
   "description": "A document generator data provider, aimed to retrive data from azure devops",
   "repository": {
     "type": "git",

package/src/modules/ResultDataProvider.ts

@@ -826,6 +826,13 @@ export default class ResultDataProvider {
       }
 
       const preloadedStepXmlCount = stepsXmlByTestCase.size;
+      const latestWorkItemMapStats = await this.enrichMewpTestCaseMapsFromLatestWorkItems(
+        projectName,
+        [...allTestCaseIds],
+        stepsXmlByTestCase,
+        testCaseTitleMap,
+        testCaseDescriptionMap
+      );
       const fallbackStepLoadStats = await this.enrichMewpStepsXmlMapFromWorkItems(
         projectName,
         [...allTestCaseIds],
@@ -833,7 +840,11 @@ export default class ResultDataProvider {
       );
       logger.info(
         `MEWP internal validation steps source summary: testCases=${allTestCaseIds.size} ` +
-          `fromSuitePayload=${preloadedStepXmlCount} fromWorkItemFallback=${fallbackStepLoadStats.loadedFromFallback} ` +
+          `fromSuitePayload=${preloadedStepXmlCount} ` +
+          `fromLatestWorkItem=${latestWorkItemMapStats.stepsLoadedFromLatest} ` +
+          `titleFromLatest=${latestWorkItemMapStats.titleLoadedFromLatest} ` +
+          `descriptionFromLatest=${latestWorkItemMapStats.descriptionLoadedFromLatest} ` +
+          `fromWorkItemFallback=${fallbackStepLoadStats.loadedFromFallback} ` +
           `stepsXmlAvailable=${stepsXmlByTestCase.size} unresolved=${fallbackStepLoadStats.unresolvedCount}`
       );
 
@@ -1744,6 +1755,81 @@ export default class ResultDataProvider {
     return map;
   }
 
+  private async enrichMewpTestCaseMapsFromLatestWorkItems(
+    projectName: string,
+    testCaseIds: number[],
+    stepsXmlByTestCase: Map<number, string>,
+    testCaseTitleMap: Map<number, string>,
+    testCaseDescriptionMap: Map<number, string>
+  ): Promise<{ stepsLoadedFromLatest: number; titleLoadedFromLatest: number; descriptionLoadedFromLatest: number }> {
+    const uniqueIds = [...new Set(testCaseIds)]
+      .map((id) => Number(id))
+      .filter((id) => Number.isFinite(id) && id > 0);
+
+    if (uniqueIds.length === 0) {
+      return {
+        stepsLoadedFromLatest: 0,
+        titleLoadedFromLatest: 0,
+        descriptionLoadedFromLatest: 0,
+      };
+    }
+
+    let stepsLoadedFromLatest = 0;
+    let titleLoadedFromLatest = 0;
+    let descriptionLoadedFromLatest = 0;
+
+    try {
+      const latestWorkItems = await this.fetchWorkItemsByIds(projectName, uniqueIds, false);
+      for (const workItem of latestWorkItems || []) {
+        const id = Number(workItem?.id || 0);
+        if (!Number.isFinite(id) || id <= 0) continue;
+
+        const fields = workItem?.fields || {};
+        const latestStepsXml = this.extractStepsXmlFromFieldsMap(fields);
+        if (latestStepsXml) {
+          const previous = String(stepsXmlByTestCase.get(id) || '');
+          if (previous !== latestStepsXml) {
+            stepsLoadedFromLatest += 1;
+          }
+          stepsXmlByTestCase.set(id, latestStepsXml);
+        }
+
+        const latestTitle = this.toMewpComparableText(
+          this.getFieldValueByName(fields, 'System.Title') ?? this.getFieldValueByName(fields, 'Title')
+        );
+        if (latestTitle) {
+          const previous = String(testCaseTitleMap.get(id) || '');
+          if (previous !== latestTitle) {
+            titleLoadedFromLatest += 1;
+          }
+          testCaseTitleMap.set(id, latestTitle);
+        }
+
+        const latestDescription = this.toMewpComparableText(
+          this.getFieldValueByName(fields, 'System.Description') ??
+            this.getFieldValueByName(fields, 'Description')
+        );
+        if (latestDescription) {
+          const previous = String(testCaseDescriptionMap.get(id) || '');
+          if (previous !== latestDescription) {
+            descriptionLoadedFromLatest += 1;
+          }
+          testCaseDescriptionMap.set(id, latestDescription);
+        }
+      }
+    } catch (error: any) {
+      logger.warn(
+        `MEWP internal validation: failed to load latest test-case fields: ${error?.message || error}`
+      );
+    }
+
+    return {
+      stepsLoadedFromLatest,
+      titleLoadedFromLatest,
+      descriptionLoadedFromLatest,
+    };
+  }
+
   private extractMewpTestCaseId(runResult: any): number {
     const testCaseId = Number(runResult?.testCaseId || runResult?.testCase?.id || 0);
     return Number.isFinite(testCaseId) ? testCaseId : 0;

package/src/tests/modules/ResultDataProvider.test.ts

@@ -3505,6 +3505,100 @@ describe('ResultDataProvider', () => {
         })
       );
     });
+
+    it('should prefer latest test-case revision fields (title/description/steps) in internal validation flow', async () => {
+      jest.spyOn(resultDataProvider as any, 'fetchTestPlanName').mockResolvedValueOnce('Plan A');
+      jest.spyOn(resultDataProvider as any, 'fetchMewpScopedTestData').mockResolvedValueOnce([
+        {
+          testPointsItems: [{ testCaseId: 777, testCaseName: 'TC 777 (snapshot)' }],
+          testCasesItems: [
+            {
+              workItem: {
+                id: 777,
+                workItemFields: [
+                  { key: 'System.Title', value: 'TC 777 (snapshot title)' },
+                  {
+                    key: 'Microsoft.VSTS.TCM.Steps',
+                    value:
+                      '<steps><step id="2" type="ActionStep"><parameterizedString isformatted="true">Action</parameterizedString><parameterizedString isformatted="true">SR0001</parameterizedString></step></steps>',
+                  },
+                  { key: 'System.Description', value: '<p>Snapshot description</p>' },
+                ],
+              },
+            },
+          ],
+        },
+      ]);
+      jest.spyOn(resultDataProvider as any, 'fetchMewpL2Requirements').mockResolvedValueOnce([
+        {
+          workItemId: 9777,
+          requirementId: 'SR7777',
+          baseKey: 'SR7777',
+          title: 'Req 7777',
+          responsibility: 'ESUK',
+          linkedTestCaseIds: [777],
+          areaPath: 'MEWP\\Customer Requirements\\Level 2',
+        },
+      ]);
+      jest.spyOn(resultDataProvider as any, 'buildLinkedRequirementsByTestCase').mockResolvedValueOnce(
+        new Map([
+          [
+            777,
+            {
+              baseKeys: new Set(['SR7777']),
+              fullCodes: new Set(['SR7777']),
+            },
+          ],
+        ])
+      );
+      const fetchWorkItemsByIdsSpy = jest
+        .spyOn(resultDataProvider as any, 'fetchWorkItemsByIds')
+        .mockResolvedValueOnce([
+          {
+            id: 777,
+            fields: {
+              'System.Title': 'TC 777 (latest title)',
+              'System.Description':
+                '<p><b><u>Trial specific assumptions, constraints, dependencies and requirements</u></b></p><p>SR7777</p>',
+              'Microsoft.VSTS.TCM.Steps':
+                '<steps><step id="2" type="ActionStep"><parameterizedString isformatted="true">Action</parameterizedString><parameterizedString isformatted="true">SR7777</parameterizedString></step></steps>',
+            },
+          },
+        ]);
+      jest.spyOn((resultDataProvider as any).testStepParserHelper, 'parseTestSteps').mockImplementation(
+        async (...args: any[]) => [
+          {
+            stepId: '1',
+            stepPosition: '1',
+            action: 'Action',
+            expected: String(args?.[0] || '').includes('SR7777') ? 'SR7777' : 'SR0001',
+            isSharedStepTitle: false,
+          },
+        ]
+      );
+
+      const result = await (resultDataProvider as any).getMewpInternalValidationFlatResults(
+        '123',
+        mockProjectName,
+        [1]
+      );
+
+      expect(fetchWorkItemsByIdsSpy).toHaveBeenCalledWith(mockProjectName, [777], false);
+      expect((resultDataProvider as any).testStepParserHelper.parseTestSteps).toHaveBeenCalledWith(
+        expect.stringContaining('SR7777'),
+        expect.any(Map)
+      );
+      expect(result.rows).toHaveLength(1);
+      expect(result.rows[0]).toEqual(
+        expect.objectContaining({
+          'Test Case ID': 777,
+          'Test Case Title': 'TC 777 (latest title)',
+          'Mentioned but Not Linked': '',
+          'Linked but Not Mentioned': '',
+          'Validation Status': 'Pass',
+        })
+      );
+    });
   });
 
   describe('buildLinkedRequirementsByTestCase', () => {