Merge branch 'main' into crucial-elephant

Author: eleanorjboyd

.github/instructions/testing-workflow.instructions.md

@@ -602,3 +602,7 @@ envConfig.inspect
 - Never create "documentation tests" that just `assert.ok(true)` — if mocking limitations prevent testing, either test a different layer that IS mockable, or skip the test entirely with a clear explanation (1)
 - When stubbing vscode APIs in tests via wrapper modules (e.g., `workspaceApis`), the production code must also use those wrappers — sinon cannot stub properties directly on the vscode namespace like `workspace.workspaceFolders`, so both production and test code must reference the same stubbable wrapper functions (4)
 - **Before writing tests**, check if the function under test calls VS Code APIs directly (e.g., `commands.executeCommand`, `window.createTreeView`, `workspace.getConfiguration`). If so, FIRST update the production code to use wrapper functions from `src/common/*.apis.ts` (create the wrapper if it doesn't exist), THEN write tests that stub those wrappers. This prevents CI failures where sinon cannot stub the vscode namespace (4)
+- **Async initialization in `setImmediate` must have error handling**: When extension activation uses `setImmediate(async () => {...})` for async manager registration, wrap it in try-catch with proper error logging. Unhandled errors cause silent failures where managers never register, making smoke/E2E tests hang forever (1)
+- **Never skip tests to hide infrastructure problems**: If tests require native binaries (like `pet`), the CI workflow must build/download them. Skipping tests when infrastructure is missing gives false confidence. Build from source (like vscode-python does) rather than skipping. Tests should fail clearly when something is wrong (2)
+- **No retries for masking flakiness**: Mocha `retries` should not be used to mask test flakiness. If a test is flaky, fix the root cause. Retries hide real issues and slow down CI (1)
+- **pet binary is required for environment manager registration**: The smoke/E2E/integration tests require the `pet` binary from `microsoft/python-environment-tools` to be built and placed in `python-env-tools/bin/`. Without it, `waitForApiReady()` will timeout because managers never register. CI must build pet from source using `cargo build --release --package pet` (2)

.github/workflows/pr-check.yml

@@ -88,6 +88,49 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Checkout Python Environment Tools
+        uses: actions/checkout@v4
+        with:
+          repository: 'microsoft/python-environment-tools'
+          path: 'python-env-tools-src'
+          sparse-checkout: |
+            crates
+            Cargo.toml
+            Cargo.lock
+          sparse-checkout-cone-mode: false
+
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust build
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            python-env-tools-src/target
+          key: ${{ runner.os }}-cargo-pet-${{ hashFiles('python-env-tools-src/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-pet-
+
+      - name: Build Python Environment Tools
+        run: cargo build --release --package pet
+        working-directory: python-env-tools-src
+
+      - name: Copy pet binary (Unix)
+        if: runner.os != 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet python-env-tools/bin/
+          chmod +x python-env-tools/bin/pet
+
+      - name: Copy pet binary (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet.exe python-env-tools/bin/
+        shell: bash
+
       - name: Install Node
         uses: actions/setup-node@v4
         with:
@@ -138,6 +181,49 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Checkout Python Environment Tools
+        uses: actions/checkout@v4
+        with:
+          repository: 'microsoft/python-environment-tools'
+          path: 'python-env-tools-src'
+          sparse-checkout: |
+            crates
+            Cargo.toml
+            Cargo.lock
+          sparse-checkout-cone-mode: false
+
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust build
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            python-env-tools-src/target
+          key: ${{ runner.os }}-cargo-pet-${{ hashFiles('python-env-tools-src/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-pet-
+
+      - name: Build Python Environment Tools
+        run: cargo build --release --package pet
+        working-directory: python-env-tools-src
+
+      - name: Copy pet binary (Unix)
+        if: runner.os != 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet python-env-tools/bin/
+          chmod +x python-env-tools/bin/pet
+
+      - name: Copy pet binary (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet.exe python-env-tools/bin/
+        shell: bash
+
       - name: Install Node
         uses: actions/setup-node@v4
         with:
@@ -188,6 +274,49 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Checkout Python Environment Tools
+        uses: actions/checkout@v4
+        with:
+          repository: 'microsoft/python-environment-tools'
+          path: 'python-env-tools-src'
+          sparse-checkout: |
+            crates
+            Cargo.toml
+            Cargo.lock
+          sparse-checkout-cone-mode: false
+
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust build
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            python-env-tools-src/target
+          key: ${{ runner.os }}-cargo-pet-${{ hashFiles('python-env-tools-src/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-pet-
+
+      - name: Build Python Environment Tools
+        run: cargo build --release --package pet
+        working-directory: python-env-tools-src
+
+      - name: Copy pet binary (Unix)
+        if: runner.os != 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet python-env-tools/bin/
+          chmod +x python-env-tools/bin/pet
+
+      - name: Copy pet binary (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          mkdir -p python-env-tools/bin
+          cp python-env-tools-src/target/release/pet.exe python-env-tools/bin/
+        shell: bash
+
       - name: Install Node
         uses: actions/setup-node@v4
         with:

.vscode-test.mjs

@@ -11,7 +11,6 @@ export default defineConfig([
         mocha: {
             ui: 'tdd',
             timeout: 120000,
-            retries: 1,
         },
         env: {
             VSC_PYTHON_SMOKE_TEST: '1',
@@ -32,7 +31,6 @@ export default defineConfig([
         mocha: {
             ui: 'tdd',
             timeout: 180000,
-            retries: 1,
         },
         env: {
             VSC_PYTHON_E2E_TEST: '1',
@@ -51,7 +49,6 @@ export default defineConfig([
         mocha: {
             ui: 'tdd',
             timeout: 60000,
-            retries: 1,
         },
         env: {
             VSC_PYTHON_INTEGRATION_TEST: '1',

src/extension.ts

@@ -515,34 +515,44 @@ export async function activate(context: ExtensionContext): Promise<PythonEnviron
      * Below are all the contributed features using the APIs.
      */
     setImmediate(async () => {
-        // This is the finder that is used by all the built in environment managers
-        const nativeFinder: NativePythonFinder = await createNativePythonFinder(outputChannel, api, context);
-        context.subscriptions.push(nativeFinder);
-        const sysMgr = new SysPythonManager(nativeFinder, api, outputChannel);
-        sysPythonManager.resolve(sysMgr);
-        await Promise.all([
-            registerSystemPythonFeatures(nativeFinder, context.subscriptions, outputChannel, sysMgr),
-            registerCondaFeatures(nativeFinder, context.subscriptions, outputChannel, projectManager),
-            registerPyenvFeatures(nativeFinder, context.subscriptions, projectManager),
-            registerPipenvFeatures(nativeFinder, context.subscriptions, projectManager),
-            registerPoetryFeatures(nativeFinder, context.subscriptions, outputChannel, projectManager),
-            shellStartupVarsMgr.initialize(),
-        ]);
-
-        await applyInitialEnvironmentSelection(envManagers, projectManager, nativeFinder, api);
-
-        // Register manager-agnostic terminal watcher for package-modifying commands
-        registerTerminalPackageWatcher(api, terminalActivation, outputChannel, context.subscriptions);
-
-        // Register listener for interpreter settings changes for interpreter re-selection
-        context.subscriptions.push(
-            registerInterpreterSettingsChangeListener(envManagers, projectManager, nativeFinder, api),
-        );
+        try {
+            // This is the finder that is used by all the built in environment managers
+            const nativeFinder: NativePythonFinder = await createNativePythonFinder(outputChannel, api, context);
+            context.subscriptions.push(nativeFinder);
+            const sysMgr = new SysPythonManager(nativeFinder, api, outputChannel);
+            sysPythonManager.resolve(sysMgr);
+            await Promise.all([
+                registerSystemPythonFeatures(nativeFinder, context.subscriptions, outputChannel, sysMgr),
+                registerCondaFeatures(nativeFinder, context.subscriptions, outputChannel, projectManager),
+                registerPyenvFeatures(nativeFinder, context.subscriptions, projectManager),
+                registerPipenvFeatures(nativeFinder, context.subscriptions, projectManager),
+                registerPoetryFeatures(nativeFinder, context.subscriptions, outputChannel, projectManager),
+                shellStartupVarsMgr.initialize(),
+            ]);
+
+            await applyInitialEnvironmentSelection(envManagers, projectManager, nativeFinder, api);
+
+            // Register manager-agnostic terminal watcher for package-modifying commands
+            registerTerminalPackageWatcher(api, terminalActivation, outputChannel, context.subscriptions);
+
+            // Register listener for interpreter settings changes for interpreter re-selection
+            context.subscriptions.push(
+                registerInterpreterSettingsChangeListener(envManagers, projectManager, nativeFinder, api),
+            );
 
-        sendTelemetryEvent(EventNames.EXTENSION_MANAGER_REGISTRATION_DURATION, start.elapsedTime);
-        await terminalManager.initialize(api);
-        sendManagerSelectionTelemetry(projectManager);
-        await sendProjectStructureTelemetry(projectManager, envManagers);
+            sendTelemetryEvent(EventNames.EXTENSION_MANAGER_REGISTRATION_DURATION, start.elapsedTime);
+            await terminalManager.initialize(api);
+            sendManagerSelectionTelemetry(projectManager);
+            await sendProjectStructureTelemetry(projectManager, envManagers);
+        } catch (error) {
+            traceError('Failed to initialize environment managers:', error);
+            // Show a user-friendly error message
+            window.showErrorMessage(
+                l10n.t(
+                    'Python Environments: Failed to initialize environment managers. Some features may not work correctly. Check the Output panel for details.',
+                ),
+            );
+        }
     });
 
     sendTelemetryEvent(EventNames.EXTENSION_ACTIVATION_DURATION, start.elapsedTime);