Detect syncTestOutcomeAcrossSuites (#136)

Co-authored-by: bryan cook <3217452+bryancook@users.noreply.github.com>

Author: bryanbcook

PublishTestPlanResultsV1/context/TestResultContext.ts

@@ -2,6 +2,7 @@ import { TestConfiguration, TestPlan, TestPoint } from "azure-devops-node-api/in
 import { TestResultContextParameters } from "./TestResultContextParameters";
 import { TestResultContextBuilder } from "./TestResultContextBuilder";
 import { configAlias } from "./configAlias";
+import { TestPoint2 } from "../services/AdoWrapper";
 
 export class TestResultContext {
 
@@ -17,13 +18,17 @@ export class TestResultContext {
 
   private readonly supportedTestConfigs: Map<string, TestConfiguration>;
   private readonly testPoints: Map<number, TestPoint>;
+  private readonly testCases: Set<string>;
+  private readonly syncOutcomeAcrossSuites: boolean = false;
 
   constructor(projectId: string, projectName: string, testPlan: TestPlan) {
     this.projectId = projectId;
     this.projectName = projectName;
     this.testPlan = testPlan;
     this.supportedTestConfigs = new Map<string, TestConfiguration>();
     this.testPoints = new Map<number, TestPoint>();
+    this.testCases = new Set<string>();
+    this.syncOutcomeAcrossSuites = this.testPlan.testOutcomeSettings?.syncOutcomeAcrossSuites ?? false;
   }
 
   addConfig(config: TestConfiguration) {
@@ -54,6 +59,22 @@ export class TestResultContext {
   }
 
   addTestPoint(point: TestPoint) {
+    
+    // as performance optimization, we can exclude test points that are duplicate test case references
+    // when the test plan has the "sync outcome across suites" option enabled
+    if (this.syncOutcomeAcrossSuites) {
+      // logic to handle duplicate test points
+      const testCaseId = (point as TestPoint2).testCaseReference.id;
+      if (testCaseId) {
+        if (this.testCases.has(testCaseId.toString())) {
+          // skip adding this test point as it's a duplicate reference to the same test case
+          return;
+        }
+        // add the test case ID to the set to track it
+        this.testCases.add(testCaseId.toString());
+      }
+    }
+
     this.testPoints.set(point.id, point);
   }
 
@@ -91,4 +112,8 @@ export class TestResultContext {
   hasConfig(name: string): boolean {
     return this.supportedTestConfigs.has(name);
   }
+
+  hasSyncTestOutcomeEnabled() : boolean {
+    return this.syncOutcomeAcrossSuites;
+  }
 }

PublishTestPlanResultsV1/context/TestResultContextBuilder.ts

@@ -64,6 +64,13 @@ export class TestResultContextBuilder {
     let points = await this.getTestPoints(projectId, testPlan, testConfigFilterId);
     ctx.addTestPoints(points);
     this.log.info(`Available Test Points: ${points.length}`);
+    if (ctx.hasSyncTestOutcomeEnabled()) {
+      this.log.info(`Test Plan has 'sync outcomes across suites' enabled. Duplicate test case references will be removed.`);
+      let uniqueTestLength = ctx.getTestPoints().length;
+      if (points.length != uniqueTestLength) {
+        this.log.info(`Removed ${points.length - uniqueTestLength} duplicate test case reference(s).`);
+      }
+    }
 
     return ctx;
   }

PublishTestPlanResultsV1/test/TestResultContextBuilder.specs.ts

@@ -256,6 +256,48 @@ describe("TestResultContextBuilder", () => {
         expect((points[3] as TestPoint2).testCaseReference.name).to.eq("Test Case 4");
       });
     });
+
+    context("Sync outcomes across test suites enabled", () => {
+      it("Should not include duplicate test points that reference the same test case", async () => {
+        // arrange
+        setupTestPlans([
+          newTestPlan(1, "ValidPlan", undefined, true /*sync outcomes across suites*/)
+        ]);
+        setupTestPoints([
+          newTestPoint(1, "Test Case 1", "1", "150"),
+          newTestPoint(2, "Test Case 1 - duplicate", "1", "150"),
+          newTestPoint(3, "Test Case 2", "1", "151"),
+        ]);
+
+        // act
+        var result = await subject.build();
+
+        // assert
+        let points = result.getTestPoints();
+        expect(points.length).to.eq(2);
+      });
+    });
+
+    context("Sync outcomes across test suites not set", () => {
+      it("Should not duplicate test points that reference the same test case", async () => {
+        // arrange
+        setupTestPlans([
+          newTestPlan(1, "ValidPlan")
+        ]);
+        setupTestPoints([
+          newTestPoint(1, "Test Case 1", "1", "150"),
+          newTestPoint(2, "Test Case 1 - duplicate", "1", "150"),
+          newTestPoint(3, "Test Case 2", "1", "151"),
+        ]);
+
+        // act
+        var result = await subject.build();
+
+        // assert
+        let points = result.getTestPoints();
+        expect(points.length).to.eq(3);
+      });
+    });
   })
 
   context("Load Test Case Meta", () => {

PublishTestPlanResultsV1/test/testUtil.ts

@@ -100,12 +100,15 @@ export function newTestConfig(id : number = 0, name : string = "DefaultConfig")
   return <TestConfiguration>{ id: id, name: name};
 }
 
-export function newTestPlan(id : number = 0, name? : string, endDate? : Date) : TestPlan {
+export function newTestPlan(id : number = 0, name? : string, endDate? : Date, syncOutcomeAcrossSuites? : boolean) : TestPlan {
   return <TestPlan> { 
     id: id, 
     name: name, 
     endDate: endDate, 
-    rootSuite: newShallowReference(id.toString(), name as string)
+    rootSuite: newShallowReference(id.toString(), name as string),
+    testOutcomeSettings: {
+      syncOutcomeAcrossSuites: syncOutcomeAcrossSuites
+    }
   };
 }
 

devops/pipelines/marketplace-extension/regression-test.yml

@@ -52,7 +52,7 @@ parameters:
     buildId: 2436
     expectedResults:
       - outcome: Passed
-        count: 2        
+        count: 1        
 
 steps:
 - pwsh: |