switch rewrite to be behind an experiment

Eleanor Boyd (eleanorjboyd) · May 25, 2023 · May 16, 2023 · May 16, 2023 · May 16, 2023 · May 16, 2023
commit b0d84727763c882b62b9beb7c9bf7e3bff37fd08
diff --git a/src/client/common/experiments/groups.ts b/src/client/common/experiments/groups.ts
@@ -14,3 +14,7 @@ export enum TerminalEnvVarActivation {
 export enum ShowFormatterExtensionPrompt {
     experiment = 'pythonPromptNewFormatterExt',
 }
+// Experiment to enable the new testing rewrite.
+export enum EnableTestAdapterRewrite {
+    experiment = 'pythonTestAdapter',
+}
diff --git a/src/client/testing/testController/common/utils.ts b/src/client/testing/testController/common/utils.ts
@@ -1,6 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import { EnableTestAdapterRewrite } from '../../../common/experiments/groups';
+import { IExperimentService } from '../../../common/types';
+import { IServiceContainer } from '../../../ioc/types';
+
 export function fixLogLines(content: string): string {
     const lines = content.split(/\r?\n/g);
     return `${lines.join('\r\n')}\r\n`;
@@ -50,3 +54,8 @@ export function jsonRPCContent(headers: Map<string, string>, rawData: string): I
         remainingRawData,
     };
 }
+
+export function pythonTestAdapterRewriteEnabled(serviceContainer: IServiceContainer): boolean {
+    const experiment = serviceContainer.get<IExperimentService>(IExperimentService);
+    return experiment.inExperimentSync(EnableTestAdapterRewrite.experiment);
+}
diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts
@@ -44,6 +44,8 @@ import { PytestTestDiscoveryAdapter } from './pytest/pytestDiscoveryAdapter';
 import { PytestTestExecutionAdapter } from './pytest/pytestExecutionAdapter';
 import { WorkspaceTestAdapter } from './workspaceTestAdapter';
 import { ITestDebugLauncher } from '../common/types';
+import { pythonTestAdapterRewriteEnabled } from './common/utils';
+import { IServiceContainer } from '../../ioc/types';
 
 // Types gymnastics to make sure that sendTriggerTelemetry only accepts the correct types.
 type EventPropertyType = IEventNamePropertyMapping[EventName.UNITTEST_DISCOVERY_TRIGGER];
@@ -93,6 +95,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
         @inject(IPythonExecutionFactory) private readonly pythonExecFactory: IPythonExecutionFactory,
         @inject(ITestDebugLauncher) private readonly debugLauncher: ITestDebugLauncher,
         @inject(ITestOutputChannel) private readonly testOutputChannel: ITestOutputChannel,
+        @inject(IServiceContainer) private readonly serviceContainer: IServiceContainer,
     ) {
         this.refreshCancellation = new CancellationTokenSource();
 
@@ -242,11 +245,11 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
             const settings = this.configSettings.getSettings(uri);
             traceVerbose(`Testing: Refreshing test data for ${uri.fsPath}`);
             const rewriteTestingEnabled = process.env.ENABLE_PYTHON_TESTING_REWRITE;
-            if (settings.testing.pytestEnabled) {
+            if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) {
                 // Ensure we send test telemetry if it gets disabled again
                 this.sendTestDisabledTelemetry = true;
+                // ** experiment to roll out NEW test discovery mechanism
                 if (rewriteTestingEnabled) {
-                    // ** rewriteTestingEnabled set to true to use NEW test discovery mechanism
                     const workspace = this.workspaceService.getWorkspaceFolder(uri);
                     traceVerbose(`Discover tests for workspace name: ${workspace?.name} - uri: ${uri.fsPath}`);
                     const testAdapter =
@@ -265,8 +268,8 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
             } else if (settings.testing.unittestEnabled) {
                 // ** Ensure we send test telemetry if it gets disabled again
                 this.sendTestDisabledTelemetry = true;
-                if (rewriteTestingEnabled) {
-                    // ** rewriteTestingEnabled set to true to use NEW test discovery mechanism
+                // ** experiment to roll out NEW test discovery mechanism
+                if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) {
                     const workspace = this.workspaceService.getWorkspaceFolder(uri);
                     traceVerbose(`Discover tests for workspace name: ${workspace?.name} - uri: ${uri.fsPath}`);
                     const testAdapter =
@@ -392,12 +395,12 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
                     const settings = this.configSettings.getSettings(workspace.uri);
                     if (testItems.length > 0) {
                         const rewriteTestingEnabled = process.env.ENABLE_PYTHON_TESTING_REWRITE;
-                        if (settings.testing.pytestEnabled) {
+                        if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) {
                             sendTelemetryEvent(EventName.UNITTEST_RUN, undefined, {
                                 tool: 'pytest',
                                 debugging: request.profile?.kind === TestRunProfileKind.Debug,
                             });
-                            // ** rewriteTestingEnabled set to true to use NEW test discovery mechanism
+                            // ** experiment to roll out NEW test discovery mechanism
                             if (rewriteTestingEnabled) {
                                 const testAdapter =
                                     this.testAdapters.get(workspace.uri) ||
@@ -428,8 +431,8 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
                                 tool: 'unittest',
                                 debugging: request.profile?.kind === TestRunProfileKind.Debug,
                             });
-                            // ** rewriteTestingEnabled set to true to use NEW test discovery mechanism
-                            if (rewriteTestingEnabled) {
+                            // ** experiment to roll out NEW test discovery mechanism
+                            if (pythonTestAdapterRewriteEnabled(this.serviceContainer)) {
                                 const testAdapter =
                                     this.testAdapters.get(workspace.uri) ||
                                     (this.testAdapters.values().next().value as WorkspaceTestAdapter);