Switch to sinon.restore (#17078)

* Switch to sinon.restore.

* Tweak 1

* Tweak 2

* Improve reliability of virtual env tests and disable poetry watcher tests.

Author: karthiknadig

news/3 Code Health/17088.md

@@ -0,0 +1 @@
+Improve reliability of virtual env tests and disable poetry watcher tests.

src/test/common/experiments/service.unit.test.ts

@@ -179,6 +179,7 @@ suite('Experimentation service', () => {
 
         teardown(() => {
             telemetryEvents = [];
+            sinon.restore();
         });
 
         test('If the opt-in and opt-out arrays are empty, return the value from the experimentation framework for a given experiment', async () => {

src/test/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.unit.test.ts

@@ -28,8 +28,7 @@ suite('File System Watching Locator Tests', () => {
     });
 
     teardown(() => {
-        inExperimentStub.restore();
-        watchLocationStub.restore();
+        sinon.restore();
     });
 
     class TestWatcher extends FSWatchingLocator {

src/test/pythonEnvironments/base/locators/lowLevel/poetryLocator.testvirtualenvs.ts

@@ -18,7 +18,10 @@ suite('Poetry Watcher', async () => {
     let shellExecute: sinon.SinonStub;
     const testPoetryDir = path.join(TEST_LAYOUT_ROOT, 'poetry');
     const project1 = path.join(testPoetryDir, 'project1');
-    suiteSetup(async () => {
+    suiteSetup(async function () {
+        // Skipping these test see https://github.com/microsoft/vscode-python/issues/17087
+        this.skip();
+
         shellExecute = sinon.stub(externalDependencies, 'shellExecute');
         shellExecute.callsFake((command: string, options: ShellOptions) => {
             // eslint-disable-next-line default-case

src/test/pythonEnvironments/base/locators/lowLevel/watcherTestUtils.ts

@@ -154,7 +154,9 @@ export function testLocatorWatcher(
         return items.some((item) => externalDeps.arePathsSame(item.executablePath, executable));
     }
 
-    suiteSetup(() => venvs.cleanUp());
+    suiteSetup(async () => {
+        await venvs.cleanUp();
+    });
 
     setup(() => {
         inExperimentStub = sinon.stub(externalDeps, 'inExperiment');
@@ -163,16 +165,18 @@ export function testLocatorWatcher(
 
     async function setupLocator(onChanged: (e: PythonEnvsChangedEvent) => Promise<void>) {
         locator = options?.arg ? await createLocatorFactoryFunc(options.arg) : await createLocatorFactoryFunc();
+        locator.onChanged(onChanged);
         await getEnvs(locator.iterEnvs()); // Force the FS watcher to start.
         // Wait for watchers to get ready
         await sleep(1000);
-        locator.onChanged(onChanged);
     }
 
     teardown(async () => {
+        sinon.restore();
+        if (locator) {
+            await locator.dispose();
+        }
         await venvs.cleanUp();
-        locator.dispose();
-        inExperimentStub.restore();
     });
 
     test('Detect a new environment', async () => {

src/test/pythonEnvironments/base/locators/lowLevel/windowsStoreLocator.test.ts

@@ -117,7 +117,7 @@ suite('Windows Store Locator', async () => {
     }
 
     teardown(async () => {
-        inExperimentStub.restore();
+        sinon.restore();
         await windowsStoreEnvs.cleanUp();
         await locator.dispose();
     });