temp: disable build association using Feature Flag (#139)

* Add temporary feature flag to disable build association

* Test featureflag in regression test

---------

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

Author: bryanbcook

PublishTestPlanResultsV1/services/AdoWrapper.ts

@@ -7,6 +7,7 @@ import { ITestApi } from "azure-devops-node-api/TestApi";
 import * as fs from "fs";
 import path from "path";
 import { ILogger, getLogger } from "./Logger";
+import FeatureFlags, { FeatureFlag } from "./FeatureFlags";
 
 interface AdoResponseHeaders {
   "x-ms-continuationtoken"? : string;
@@ -151,6 +152,11 @@ export class AdoWrapper {
       configurationIds: []
     };
 
+    // temp: disable build id association when test plan is different project than pipeline
+    if (FeatureFlags.isFeatureEnabled(FeatureFlag.DisableBuildAssociation)) {
+      testRun.build = undefined;
+    }
+
     return await this.testApi.createTestRun(testRun, projectId);
   }
 

PublishTestPlanResultsV1/services/FeatureFlags.ts

@@ -3,6 +3,7 @@ import { getLogger, ILogger } from "./Logger";
 export class FeatureFlag {
   static DisplayTelemetry : string = "displaytelemetry";
   static DisplayTelemetryErrors : string = "displaytelemetryerrors";
+  static DisableBuildAssociation : string = "disablebuildassociation";
 }
 
 export class FeatureFlags {

PublishTestPlanResultsV1/test/AdoWrapper.specs.ts

@@ -4,6 +4,7 @@ import path from "path";
 import * as Contracts from 'azure-devops-node-api/interfaces/TestInterfaces'
 import * as testUtil from './testUtil';
 import { AdoWrapper } from "../services/AdoWrapper";
+import { FeatureFlag } from "../services/FeatureFlags";
 
 describe("AdoWrapper", () => {
 
@@ -43,6 +44,7 @@ describe("AdoWrapper", () => {
 
   afterEach(() => {
     sinon.restore();
+    testUtil.clearData();
   })
 
   context('Integration Tests', () => {
@@ -158,6 +160,37 @@ describe("AdoWrapper", () => {
     expect(result.length).eq(20);
   })
 
+  context("Create Test Run", () => {
+
+    it(`Should disable build association when ${FeatureFlag.DisableBuildAssociation} feature flag is enabled`, async () => {
+      // arrange
+      const createTestRunStub = stubCreateTestRun(<Contracts.TestRun>{ id: 123 });
+      testUtil.setFeatureFlag(FeatureFlag.DisableBuildAssociation, "true");
+      testUtil.loadData();
+
+      // act
+      await subject.createTestRun(projectId, parseInt(planId), [1,2,3], "buildId");
+
+      // assert
+      let testRun = createTestRunStub.getCall(0).args[1] as Contracts.TestRun;
+      expect(testRun.build).to.be.undefined;
+    });
+
+    it(`Should include build association when ${FeatureFlag.DisableBuildAssociation} feature flag is not provided`, async () => {
+      // arrange
+      const createTestRunStub = stubCreateTestRun(<Contracts.TestRun>{ id: 123 });
+      testUtil.loadData();
+      
+      // act
+      await subject.createTestRun(projectId, parseInt(planId), [1,2,3], "buildId");
+
+      // assert
+      let testRun = createTestRunStub.getCall(0).args[1] as Contracts.TestRun;
+      expect(testRun.build).not.to.be.undefined;
+      expect(testRun.build?.id).to.be.eq("buildId");
+    });
+  });
+
   // it("Should create a testrun", async function () {
   //   // arrange
   //   // this.timeout(10000);
@@ -321,4 +354,18 @@ describe("AdoWrapper", () => {
     });
   }
 
+  function stubCreateTestRun(testRun : Contracts.TestRun) : sinon.SinonStub {
+    const createTestRunStub = sinon.stub(subject.testApi.rest, "create");
+    createTestRunStub.callsFake( (url, testRun, options?) => {
+
+      let response : any = {
+        result : testRun,
+        headers : {}
+      }
+
+      return Promise.resolve(response);
+    });
+    return createTestRunStub;
+  }
+
 })

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

@@ -40,16 +40,16 @@ parameters:
     testResultsFile: '$(Build.SourcesDirectory)/examples/dotnet/xUnitResults/TestResults-adotestplan-prj.xml'
     projectName: 'ADO Test Automation'
     testplan: 'Plan w Duplicates'
-    buildId: 2436
     expectedResults:
       - outcome: Passed
         count: 1
+    featureFlags: 'DisableBuildAssociation'
   - name: TestDuplicates_wTestOutcomeSettingEnabled
     format: xunit
     testResultsFile: '$(Build.SourcesDirectory)/examples/dotnet/xUnitResults/TestResults-adotestplan-prj.xml'
     projectName: 'ADO Test Automation'
     testplan: 'Plan w Duplicates and TestOutcome Setting Enabled'
-    buildId: 2436
+    buildId: 2436 # TODO: remove when 137 is fixed
     expectedResults:
       - outcome: Passed
         count: 2        
@@ -110,7 +110,7 @@ steps:
         -failTaskOnMissingResultsFile ''
         -failTaskOnMissingTests ''
         -failTaskOnUnmatchedTestCases ''
-        -featureFlags 'DisplayTelemetry,DisplayTelemetryErrors'
+        -featureFlags '${{ iif(ne(test.featureFlags,''), test.featureFlags, 'DisplayTelemetry,DisplayTelemetryErrors') }}'
         -DryRun ''
 
   - ${{ if ne(test.expectedResults, '') }}: