Fix flaky tests related to auto selection of virtual environments (microsoft#3728)

For microsoft#2339

Author: DonJayamanne

news/3 Code Health/2339.md

@@ -0,0 +1 @@
+Fix flaky tests related to auto selection of virtual environments.

src/client/common/process/proc.ts

@@ -167,15 +167,13 @@ export class ProcessService implements IProcessService {
  });
  }
 
- private getDefaultOptions<T extends (ShellOptions | SpawnOptions)>(options: T) : T {
+ private getDefaultOptions<T extends (ShellOptions | SpawnOptions)>(options: T): T {
  const defaultOptions = { ...options };
  const execOptions = defaultOptions as SpawnOptions;
- if (execOptions)
- {
+ if (execOptions) {
  const encoding = execOptions.encoding = typeof execOptions.encoding === 'string' && execOptions.encoding.length > 0 ? execOptions.encoding : DEFAULT_ENCODING;
  delete execOptions.encoding;
  execOptions.encoding = encoding;
- execOptions.token = execOptions.token;
  }
  if (!defaultOptions.env || Object.keys(defaultOptions.env).length === 0) {
  const env = this.env ? this.env : process.env;

src/test/interpreters/locators/workspaceVirtualEnvService.test.ts

@@ -5,50 +5,47 @@
 
 // tslint:disable:no-any max-classes-per-file max-func-body-length no-invalid-this
 import { expect } from 'chai';
-import { spawn } from 'child_process';
+import { exec } from 'child_process';
 import * as path from 'path';
 import { Uri } from 'vscode';
-import { sleep } from '../../../client/common/utils/async';
+import '../../../client/common/extensions';
 import { IInterpreterLocatorService, WORKSPACE_VIRTUAL_ENV_SERVICE } from '../../../client/interpreter/contracts';
 import { IServiceContainer } from '../../../client/ioc/types';
-import { deleteFiles, isPythonVersionInProcess, PYTHON_PATH, rootWorkspaceUri } from '../../common';
+import { deleteFiles, isPythonVersionInProcess, PYTHON_PATH, rootWorkspaceUri, waitForCondition } from '../../common';
 import { IS_MULTI_ROOT_TEST } from '../../constants';
 import { initialize, multirootPath } from '../../initialize';
 
-const timeoutSecs = 120;
+const timeoutMs = 60_000;
 suite('Interpreters - Workspace VirtualEnv Service', function () {
- this.timeout(timeoutSecs * 1000);
+ this.timeout(timeoutMs);
  this.retries(1);
 
  let locator: IInterpreterLocatorService;
- const workspaceUri = IS_MULTI_ROOT_TEST ? Uri.file(path.join(multirootPath, 'workspace3')) : rootWorkspaceUri;
+ const workspaceUri = IS_MULTI_ROOT_TEST ? Uri.file(path.join(multirootPath, 'workspace3')) : rootWorkspaceUri!;
  const workspace4 = Uri.file(path.join(multirootPath, 'workspace4'));
  const venvPrefix = '.venv';
  let serviceContainer: IServiceContainer;
 
  async function waitForInterpreterToBeDetected(envNameToLookFor: string) {
- for (let i = 0; i < timeoutSecs; i += 1) {
+ const predicate = async () => {
  const items = await locator.getInterpreters(workspaceUri);
- if (items.some(item => item.envName === envNameToLookFor && !item.cachedEntry)) {
- return;
- }
- await sleep(500);
- }
- throw new Error(`${envNameToLookFor}, Environment not detected in the workspace ${workspaceUri.fsPath}`);
+ return items.some(item => item.envName === envNameToLookFor && !item.cachedEntry);
+ };
+ await waitForCondition(predicate, timeoutMs, `${envNameToLookFor}, Environment not detected in the workspace ${workspaceUri.fsPath}`);
  }
  async function createVirtualEnvironment(envSuffix: string) {
  // Ensure env is random to avoid conflicts in tests (currupting test data).
  const envName = `${venvPrefix}${envSuffix}${new Date().getTime().toString()}`;
  return new Promise<string>((resolve, reject) => {
- const proc = spawn(PYTHON_PATH, ['-m', 'venv', envName], { cwd: workspaceUri.fsPath });
- let stdErr = '';
- proc.stderr.on('data', data => stdErr += data.toString());
- proc.on('exit', () => {
- if (stdErr.length === 0) {
- return resolve(envName);
+ exec(`${PYTHON_PATH.fileToCommandArgument()} -m venv ${envName}`, { cwd: workspaceUri.fsPath }, (ex, _, stderr) => {
+ if (ex) {
+ return reject(ex);
+ }
+ if (stderr && stderr.length > 0) {
+ reject(new Error(`Failed to create Env ${envName}, ${PYTHON_PATH}, Error: ${stderr}`));
+ } else {
+ resolve(envName);
  }
- const err = new Error(`Failed to create Env ${envName}, ${PYTHON_PATH}, Error: ${stdErr.toString()}`);
- reject(err);
  });
  });
  }
@@ -59,24 +56,23 @@ suite('Interpreters - Workspace VirtualEnv Service', function () {
  }
  serviceContainer = (await initialize()).serviceContainer;
  locator = serviceContainer.get<IInterpreterLocatorService>(IInterpreterLocatorService, WORKSPACE_VIRTUAL_ENV_SERVICE);
+ // This test is required, we need to wait for interpreter listing completes,
+ // before proceeding with other tests.
+ await locator.getInterpreters(workspaceUri);
 
  await deleteFiles(path.join(workspaceUri.fsPath, `${venvPrefix}*`));
- // https://github.com/Microsoft/vscode-python/issues/3239
- this.skip();
  });
 
  suiteTeardown(() => deleteFiles(path.join(workspaceUri.fsPath, `${venvPrefix}*`)));
  teardown(() => deleteFiles(path.join(workspaceUri.fsPath, `${venvPrefix}*`)));
 
  test('Detect Virtual Environment', async () => {
  const envName = await createVirtualEnvironment('one');
-
  await waitForInterpreterToBeDetected(envName);
  });
 
  test('Detect a new Virtual Environment', async () => {
  const env1 = await createVirtualEnvironment('first');
-
  await waitForInterpreterToBeDetected(env1);
 
  // Ensure second environment in our workspace folder is detected when created.