Skip to content

Add ignore button to the MacInterpreterSelectedAndNoOtherInterpreters… #4808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 20, 2019
Merged

Add ignore button to the MacInterpreterSelectedAndNoOtherInterpreters… #4808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58e21ee
Add ignore button to the MacInterpreterSelectedAndNoOtherInterpreters…
alinalobast Mar 18, 2019
07ca967
Create 4448.md
DonJayamanne Mar 18, 2019
df5996d
Added ignore to another prompt
DonJayamanne Mar 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions news/1 Enhancements/4448.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add button to ignore the message warning about the use of the macOS system install of Python.
(thanks [Alina Lobastova](https://github.com/alina7091))
18 changes: 17 additions & 1 deletion src/client/application/diagnostics/checks/macPythonInterpreter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,9 @@ export class InvalidMacPythonInterpreterService extends BaseDiagnosticsService {
);
await Promise.all(
diagnostics.map(async diagnostic => {
if (!this.canHandle(diagnostic)) {
const canHandle = await this.canHandle(diagnostic);
const shouldIgnore = await this.filterService.shouldIgnoreDiagnostic(diagnostic.code);
if (!canHandle || shouldIgnore) {
return;
}
const commandPrompts = this.getCommandPrompts(diagnostic);
Expand Down Expand Up @@ -151,6 +153,13 @@ export class InvalidMacPythonInterpreterService extends BaseDiagnosticsService {
type: 'executeVSCCommand',
options: 'python.setInterpreter'
})
},
{
prompt: 'Do not show again',
command: commandFactory.createCommand(diagnostic, {
type: 'ignore',
options: DiagnosticScope.Global
})
}
];
}
Expand All @@ -169,6 +178,13 @@ export class InvalidMacPythonInterpreterService extends BaseDiagnosticsService {
type: 'launch',
options: 'https://www.python.org/downloads'
})
},
{
prompt: 'Do not show again',
command: commandFactory.createCommand(diagnostic, {
type: 'ignore',
options: DiagnosticScope.Global
})
}
];
}
Expand Down
57 changes: 51 additions & 6 deletions src/test/application/diagnostics/checks/macPythonInterpreter.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@
import { expect } from 'chai';
import * as typemoq from 'typemoq';
import { ConfigurationChangeEvent } from 'vscode';
import { BaseDiagnosticsService } from '../../../../client/application/diagnostics/base';
import { InvalidMacPythonInterpreterDiagnostic, InvalidMacPythonInterpreterService } from '../../../../client/application/diagnostics/checks/macPythonInterpreter';
import { CommandOption, IDiagnosticsCommandFactory } from '../../../../client/application/diagnostics/commands/types';
import { DiagnosticCodes } from '../../../../client/application/diagnostics/constants';
import { DiagnosticCommandPromptHandlerServiceId, MessageCommandPrompt } from '../../../../client/application/diagnostics/promptHandler';
import { IDiagnostic, IDiagnosticCommand, IDiagnosticHandlerService, IDiagnosticsService } from '../../../../client/application/diagnostics/types';
import { DiagnosticScope, IDiagnostic, IDiagnosticCommand, IDiagnosticFilterService, IDiagnosticHandlerService, IDiagnosticsService } from '../../../../client/application/diagnostics/types';
import { CommandsWithoutArgs } from '../../../../client/common/application/commands';
import { IWorkspaceService } from '../../../../client/common/application/types';
import { IPlatformService } from '../../../../client/common/platform/types';
Expand All @@ -30,6 +31,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
let interpreterService: typemoq.IMock<IInterpreterService>;
let platformService: typemoq.IMock<IPlatformService>;
let helper: typemoq.IMock<IInterpreterHelper>;
let filterService: typemoq.IMock<IDiagnosticFilterService>;
const pythonPath = 'My Python Path in Settings';
let serviceContainer: typemoq.IMock<IServiceContainer>;
function createContainer() {
Expand Down Expand Up @@ -57,6 +59,9 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
.returns(() => helper.object);
serviceContainer.setup(s => s.get(typemoq.It.isValue(IDisposableRegistry)))
.returns(() => []);
filterService = typemoq.Mock.ofType<IDiagnosticFilterService>();
serviceContainer.setup(s => s.get(typemoq.It.isValue(IDiagnosticFilterService)))
.returns(() => filterService.object);

platformService
.setup(p => p.isMac)
Expand All @@ -67,8 +72,14 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
suite('Diagnostics', () => {
setup(() => {
diagnosticService = new class extends InvalidMacPythonInterpreterService {
public _clear() {
while (BaseDiagnosticsService.handledDiagnosticCodeKeys.length > 0) {
BaseDiagnosticsService.handledDiagnosticCodeKeys.shift();
}
}
protected addPythonPathChangedHandler() { noop(); }
}(createContainer(), interpreterService.object, platformService.object, helper.object);
(diagnosticService as any)._clear();
});

test('Can handle InvalidPythonPathInterpreter diagnostics', async () => {
Expand Down Expand Up @@ -96,7 +107,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
expect(canHandle).to.be.equal(false, 'Invalid value');
diagnostic.verifyAll();
});
test('Should return empty diagnostics if not a Macc', async () => {
test('Should return empty diagnostics if not a Mac', async () => {
platformService.reset();
platformService
.setup(p => p.isMac)
Expand Down Expand Up @@ -252,6 +263,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
test('Handling no interpreters diagnostic should return select interpreter cmd', async () => {
const diagnostic = new InvalidMacPythonInterpreterDiagnostic(DiagnosticCodes.MacInterpreterSelectedAndHaveOtherInterpretersDiagnostic, undefined);
const cmd = {} as any as IDiagnosticCommand;
const cmdIgnore = {} as any as IDiagnosticCommand;
let messagePrompt: MessageCommandPrompt | undefined;
messageHandler
.setup(i => i.handle(typemoq.It.isValue(diagnostic), typemoq.It.isAny()))
Expand All @@ -262,18 +274,26 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
typemoq.It.isObjectWith<CommandOption<'executeVSCCommand', CommandsWithoutArgs>>({ type: 'executeVSCCommand' })))
.returns(() => cmd)
.verifiable(typemoq.Times.once());
commandFactory.setup(f => f.createCommand(typemoq.It.isAny(),
typemoq.It.isObjectWith<CommandOption<'ignore', DiagnosticScope>>({ type: 'ignore', options: DiagnosticScope.Global })))
.returns(() => cmdIgnore)
.verifiable(typemoq.Times.once());

await diagnosticService.handle([diagnostic]);

messageHandler.verifyAll();
commandFactory.verifyAll();
expect(messagePrompt).not.be.equal(undefined, 'Message prompt not set');
expect(messagePrompt!.commandPrompts).to.be.deep.equal([{ prompt: 'Select Python Interpreter', command: cmd }]);
expect(messagePrompt!.commandPrompts).to.be.deep.equal([
{ prompt: 'Select Python Interpreter', command: cmd },
{ prompt: 'Do not show again', command: cmdIgnore }
]);
});
test('Handling no interpreters diagnostisc should return download and learn links', async () => {
test('Handling no interpreters diagnostisc should return 3 commands', async () => {
const diagnostic = new InvalidMacPythonInterpreterDiagnostic(DiagnosticCodes.MacInterpreterSelectedAndNoOtherInterpretersDiagnostic, undefined);
const cmdDownload = {} as any as IDiagnosticCommand;
const cmdLearn = {} as any as IDiagnosticCommand;
const cmdIgnore = {} as any as IDiagnosticCommand;
let messagePrompt: MessageCommandPrompt | undefined;
messageHandler
.setup(i => i.handle(typemoq.It.isValue(diagnostic), typemoq.It.isAny()))
Expand All @@ -288,13 +308,38 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
typemoq.It.isObjectWith<CommandOption<'launch', string>>({ type: 'launch', options: 'https://www.python.org/downloads' })))
.returns(() => cmdDownload)
.verifiable(typemoq.Times.once());
commandFactory.setup(f => f.createCommand(typemoq.It.isAny(),
typemoq.It.isObjectWith<CommandOption<'ignore', DiagnosticScope>>({ type: 'ignore', options: DiagnosticScope.Global })))
.returns(() => cmdIgnore)
.verifiable(typemoq.Times.once());

await diagnosticService.handle([diagnostic]);

messageHandler.verifyAll();
commandFactory.verifyAll();
expect(messagePrompt).not.be.equal(undefined, 'Message prompt not set');
expect(messagePrompt!.commandPrompts).to.be.deep.equal([{ prompt: 'Learn more', command: cmdLearn }, { prompt: 'Download', command: cmdDownload }]);
expect(messagePrompt!.commandPrompts).to.be.deep.equal([
{ prompt: 'Learn more', command: cmdLearn },
{ prompt: 'Download', command: cmdDownload },
{ prompt: 'Do not show again', command: cmdIgnore }
]);
});
test('Should not display a message if No Interpreters diagnostic has been ignored', async () => {
const diagnostic = new InvalidMacPythonInterpreterDiagnostic(DiagnosticCodes.MacInterpreterSelectedAndNoOtherInterpretersDiagnostic, undefined);

filterService.setup(f => f.shouldIgnoreDiagnostic(typemoq.It.isValue(DiagnosticCodes.MacInterpreterSelectedAndNoOtherInterpretersDiagnostic)))
.returns(() => Promise.resolve(true))
.verifiable(typemoq.Times.once());
commandFactory.setup(f => f.createCommand(typemoq.It.isAny(), typemoq.It.isAny()))
.verifiable(typemoq.Times.never());
messageHandler.setup(f => f.handle(typemoq.It.isAny(), typemoq.It.isAny()))
.verifiable(typemoq.Times.never());

await diagnosticService.handle([diagnostic]);

messageHandler.verifyAll();
filterService.verifyAll();
commandFactory.verifyAll();
});
});

Expand All @@ -310,7 +355,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
test('Event Handler is registered and invoked', async () => {
let invoked = false;
let callbackHandler!: (e: ConfigurationChangeEvent) => Promise<void>;
const workspaceService = { onDidChangeConfiguration: (cb : (e: ConfigurationChangeEvent) => Promise<void>) => callbackHandler = cb } as any;
const workspaceService = { onDidChangeConfiguration: (cb: (e: ConfigurationChangeEvent) => Promise<void>) => callbackHandler = cb } as any;
const serviceContainerObject = createContainer();
serviceContainer.setup(s => s.get(typemoq.It.isValue(IWorkspaceService)))
.returns(() => workspaceService);
Expand Down