Add "Open Settings" option to environment file notification

Author: eleanorjboyd

src/common/localize.ts

@@ -16,6 +16,7 @@ export namespace Common {
     export const quickCreate = l10n.t('Quick Create');
     export const installPython = l10n.t('Install Python');
     export const dontShowAgain = l10n.t("Don't Show Again");
+    export const openSettings = l10n.t('Open Settings');
 }
 
 export namespace WorkbenchStrings {

src/features/terminal/terminalEnvVarInjector.ts

@@ -4,19 +4,20 @@
 import * as fse from 'fs-extra';
 import * as path from 'path';
 import {
+    commands,
     Disposable,
     EnvironmentVariableScope,
     GlobalEnvironmentVariableCollection,
     workspace,
     WorkspaceFolder,
 } from 'vscode';
+import { Common } from '../../common/localize';
 import { traceError, traceVerbose } from '../../common/logging';
+import { getGlobalPersistentState } from '../../common/persistentState';
 import { resolveVariables } from '../../common/utils/internalVariables';
+import * as windowApis from '../../common/window.apis';
 import { getConfiguration, getWorkspaceFolder } from '../../common/workspace.apis';
 import { EnvVarManager } from '../execution/envVariableManager';
-import { getGlobalPersistentState } from '../../common/persistentState';
-import { Common } from '../../common/localize';
-import * as windowApis from '../../common/window.apis';
 
 /**
  * Manages injection of workspace-specific environment variables into VS Code terminals
@@ -192,7 +193,10 @@ export class TerminalEnvVarInjector implements Disposable {
      */
     private async showEnvFileNotification(): Promise<void> {
         const state = await getGlobalPersistentState();
-        const dontShowAgain = await state.get<boolean>(TerminalEnvVarInjector.DONT_SHOW_ENV_FILE_NOTIFICATION_KEY, false);
+        const dontShowAgain = await state.get<boolean>(
+            TerminalEnvVarInjector.DONT_SHOW_ENV_FILE_NOTIFICATION_KEY,
+            false,
+        );
 
         if (dontShowAgain) {
             traceVerbose('TerminalEnvVarInjector: Env file notification suppressed by user preference');
@@ -201,10 +205,14 @@ export class TerminalEnvVarInjector implements Disposable {
 
         const result = await windowApis.showInformationMessage(
             'An environment file is configured but terminal environment injection is disabled. Enable "python.terminal.useEnvFile" to use environment variables from .env files in terminals.',
+            Common.openSettings,
             Common.dontShowAgain,
         );
 
-        if (result === Common.dontShowAgain) {
+        if (result === Common.openSettings) {
+            await commands.executeCommand('workbench.action.openSettings', 'python.terminal.useEnvFile');
+            traceVerbose('TerminalEnvVarInjector: User opened settings for useEnvFile');
+        } else if (result === Common.dontShowAgain) {
             await state.set(TerminalEnvVarInjector.DONT_SHOW_ENV_FILE_NOTIFICATION_KEY, true);
             traceVerbose('TerminalEnvVarInjector: User chose to not show env file notification again');
         }

src/test/features/terminalEnvVarInjectorNotification.unit.test.ts

@@ -4,13 +4,13 @@
 import * as assert from 'node:assert';
 import * as sinon from 'sinon';
 import * as typeMoq from 'typemoq';
-import { GlobalEnvironmentVariableCollection, Uri, workspace } from 'vscode';
-import { EnvVarManager } from '../../features/execution/envVariableManager';
-import { TerminalEnvVarInjector } from '../../features/terminal/terminalEnvVarInjector';
+import { commands, GlobalEnvironmentVariableCollection, Uri, workspace } from 'vscode';
+import { Common } from '../../common/localize';
 import * as persistentState from '../../common/persistentState';
-import * as workspaceApis from '../../common/workspace.apis';
 import * as windowApis from '../../common/window.apis';
-import { Common } from '../../common/localize';
+import * as workspaceApis from '../../common/workspace.apis';
+import { EnvVarManager } from '../../features/execution/envVariableManager';
+import { TerminalEnvVarInjector } from '../../features/terminal/terminalEnvVarInjector';
 
 interface MockScopedCollection {
     clear: sinon.SinonStub;
@@ -27,6 +27,7 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
     let mockGetConfiguration: sinon.SinonStub;
     let mockGetWorkspaceFolder: sinon.SinonStub;
     let mockShowInformationMessage: sinon.SinonStub;
+    let mockExecuteCommand: sinon.SinonStub;
     let envVarChangeHandler: (args: { uri?: Uri; changeType?: number }) => void;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let workspaceFoldersStub: any;
@@ -72,6 +73,9 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
         // Setup showInformationMessage mock
         mockShowInformationMessage = sinon.stub(windowApis, 'showInformationMessage').resolves(undefined);
 
+        // Setup executeCommand mock
+        mockExecuteCommand = sinon.stub(commands, 'executeCommand').resolves();
+
         // Setup environment variable change event handler - will be overridden in tests
         envVarManager
             .setup((m) => m.onDidChangeEnvironmentVariables)
@@ -96,15 +100,15 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
         // Setup environment variable change handler to capture it
         envVarManager.reset();
         envVarCollection.reset();
-        
+
         // Re-setup scoped collection after reset
         envVarCollection
             .setup((x) => x.getScoped(typeMoq.It.isAny()))
             .returns(
                 () => mockScopedCollection as unknown as ReturnType<GlobalEnvironmentVariableCollection['getScoped']>,
             );
         envVarCollection.setup((x) => x.clear()).returns(() => {});
-        
+
         // Setup event handler to capture it
         envVarManager
             .setup((m) => m.onDidChangeEnvironmentVariables)
@@ -131,7 +135,7 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
         envVarChangeHandler({ uri: testUri });
         await new Promise((resolve) => setTimeout(resolve, 10)); // Allow async notification
 
-        // Assert - notification should be shown
+        // Assert - notification should be shown with both buttons
         assert.ok(mockShowInformationMessage.called, 'showInformationMessage should be called');
         const notificationCall = mockShowInformationMessage.getCall(0);
         assert.ok(
@@ -140,6 +144,11 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
         );
         assert.strictEqual(
             notificationCall.args[1],
+            Common.openSettings,
+            'Notification should have "Open Settings" button',
+        );
+        assert.strictEqual(
+            notificationCall.args[2],
             Common.dontShowAgain,
             'Notification should have "Don\'t Show Again" button',
         );
@@ -219,6 +228,47 @@ suite('TerminalEnvVarInjector Notification Tests', () => {
         assert.strictEqual(setCall.args[1], true, 'Should set state to true');
     });
 
+    test('should open settings when user clicks "Open Settings" button', async () => {
+        // Arrange - user clicks the "Open Settings" button
+        mockState.get.resolves(false);
+        mockShowInformationMessage.resolves(Common.openSettings);
+
+        // Setup environment variable change handler to capture it
+        envVarManager.reset();
+        envVarManager
+            .setup((m) => m.onDidChangeEnvironmentVariables)
+            .returns((handler) => {
+                envVarChangeHandler = handler;
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                return { dispose: () => {} } as any;
+            });
+
+        const mockConfig = {
+            get: sinon.stub(),
+        };
+        mockConfig.get.withArgs('terminal.useEnvFile', false).returns(false);
+        mockConfig.get.withArgs('envFile').returns('.env');
+        mockGetConfiguration.returns(mockConfig);
+
+        const testUri = Uri.file('/workspace');
+        mockGetWorkspaceFolder.returns({ uri: testUri });
+
+        // Act - create injector and trigger env var change
+        injector = new TerminalEnvVarInjector(envVarCollection.object, envVarManager.object);
+        await new Promise((resolve) => setTimeout(resolve, 10)); // Allow async initialization
+
+        envVarChangeHandler({ uri: testUri });
+        await new Promise((resolve) => setTimeout(resolve, 50)); // Allow async notification and command execution
+
+        // Assert - executeCommand should be called to open settings
+        assert.ok(mockExecuteCommand.called, 'executeCommand should be called');
+        const commandCall = mockExecuteCommand.getCall(0);
+        assert.strictEqual(commandCall.args[0], 'workbench.action.openSettings', 'Should open settings');
+        assert.strictEqual(commandCall.args[1], 'python.terminal.useEnvFile', 'Should open useEnvFile setting');
+        // State should NOT be set when clicking "Open Settings"
+        assert.ok(!mockState.set.called, 'state.set should not be called when opening settings');
+    });
+
     test('should not show notification when useEnvFile is true', async () => {
         // Arrange - useEnvFile is enabled
         mockState.get.resolves(false);