Repository navigation
Expand file tree
/
Copy pathmain.ts
More file actions
214 lines (191 loc) · 10.1 KB
/
Copy pathmain.ts
File metadata and controls
214 lines (191 loc) · 10.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
'use strict';
import { inject, injectable } from 'inversify';
import { ConfigurationChangeEvent, Disposable, Uri, tests, TestResultState, WorkspaceFolder, Command } from 'vscode';
import { IApplicationShell, ICommandManager, IContextKeyManager, IWorkspaceService } from '../common/application/types';
import * as constants from '../common/constants';
import '../common/extensions';
import { IDisposableRegistry, Product } from '../common/types';
import { IInterpreterService } from '../interpreter/contracts';
import { IServiceContainer } from '../ioc/types';
import { EventName } from '../telemetry/constants';
import { captureTelemetry, sendTelemetryEvent } from '../telemetry/index';
import { selectTestWorkspace } from './common/testUtils';
import { TestSettingsPropertyNames } from './configuration/types';
import { ITestConfigurationService, ITestsHelper } from './common/types';
import { ITestingService } from './types';
import { IExtensionActivationService } from '../activation/types';
import { ITestController } from './testController/common/types';
import { DelayedTrigger, IDelayedTrigger } from '../common/utils/delayTrigger';
import { ExtensionContextKey } from '../common/application/contextKeys';
import { checkForFailedTests, updateTestResultMap } from './testController/common/testItemUtilities';
import { Testing } from '../common/utils/localize';
import { traceVerbose } from '../logging';
@injectable()
export class TestingService implements ITestingService {
constructor(@inject(IServiceContainer) private serviceContainer: IServiceContainer) {}
public getSettingsPropertyNames(product: Product): TestSettingsPropertyNames {
const helper = this.serviceContainer.get<ITestsHelper>(ITestsHelper);
return helper.getSettingsPropertyNames(product);
}
}
@injectable()
export class UnitTestManagementService implements IExtensionActivationService {
private activatedOnce: boolean = false;
public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
private readonly disposableRegistry: Disposable[];
private workspaceService: IWorkspaceService;
private context: IContextKeyManager;
private testController: ITestController | undefined;
private configChangeTrigger: IDelayedTrigger;
// This is temporarily needed until the proposed API settles for this part
private testStateMap: Map<string, TestResultState> = new Map();
constructor(@inject(IServiceContainer) private serviceContainer: IServiceContainer) {
this.disposableRegistry = serviceContainer.get<Disposable[]>(IDisposableRegistry);
this.workspaceService = serviceContainer.get<IWorkspaceService>(IWorkspaceService);
this.context = this.serviceContainer.get<IContextKeyManager>(IContextKeyManager);
if (tests && !!tests.createTestController) {
this.testController = serviceContainer.get<ITestController>(ITestController);
}
const configChangeTrigger = new DelayedTrigger(
this.configurationChangeHandler.bind(this),
500,
'Test Configuration Change',
);
this.configChangeTrigger = configChangeTrigger;
this.disposableRegistry.push(configChangeTrigger);
}
public async activate(): Promise<void> {
if (this.activatedOnce) {
return;
}
this.activatedOnce = true;
this.registerHandlers();
this.registerCommands();
if (!!tests.testResults) {
await this.updateTestUIButtons();
this.disposableRegistry.push(
tests.onDidChangeTestResults(() => {
this.updateTestUIButtons();
}),
);
}
if (this.testController) {
this.testController.onRefreshingStarted(async () => {
await this.context.setContext(ExtensionContextKey.RefreshingTests, true);
});
this.testController.onRefreshingCompleted(async () => {
await this.context.setContext(ExtensionContextKey.RefreshingTests, false);
});
this.testController.onRunWithoutConfiguration(async (unconfigured: WorkspaceFolder[]) => {
const workspaces = this.workspaceService.workspaceFolders ?? [];
if (unconfigured.length === workspaces.length) {
const commandManager = this.serviceContainer.get<ICommandManager>(ICommandManager);
await commandManager.executeCommand('workbench.view.testing.focus');
// TODO: this is a workaround for https://github.com/microsoft/vscode/issues/130696
// Once that is fixed delete this notification and test should be configured from the test view.
const app = this.serviceContainer.get<IApplicationShell>(IApplicationShell);
const response = await app.showInformationMessage(
Testing.testNotConfigured,
Testing.configureTests,
);
if (response === Testing.configureTests) {
await commandManager.executeCommand(
constants.Commands.Tests_Configure,
undefined,
constants.CommandSource.ui,
unconfigured[0].uri,
);
}
}
});
}
}
private async updateTestUIButtons() {
// See if we already have stored tests results from previous runs.
// The tests results currently has a historical test status based on runs. To get a
// full picture of the tests state these need to be reduced by test id.
updateTestResultMap(this.testStateMap, tests.testResults);
const hasFailedTests = checkForFailedTests(this.testStateMap);
await this.context.setContext(ExtensionContextKey.HasFailedTests, hasFailedTests);
}
private async configurationChangeHandler(eventArgs: ConfigurationChangeEvent) {
const workspaces = this.workspaceService.workspaceFolders ?? [];
const changedWorkspaces: Uri[] = workspaces
.filter((w) => eventArgs.affectsConfiguration('python.testing', w.uri))
.map((w) => w.uri);
await Promise.all(changedWorkspaces.map((u) => this.testController?.refreshTestData(u)));
}
@captureTelemetry(EventName.UNITTEST_CONFIGURE, undefined, false)
private async configureTests(resource?: Uri) {
let wkspace: Uri | undefined;
if (resource) {
const wkspaceFolder = this.workspaceService.getWorkspaceFolder(resource);
wkspace = wkspaceFolder ? wkspaceFolder.uri : undefined;
} else {
const appShell = this.serviceContainer.get<IApplicationShell>(IApplicationShell);
wkspace = await selectTestWorkspace(appShell);
}
if (!wkspace) {
return;
}
const interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
const commandManager = this.serviceContainer.get<ICommandManager>(ICommandManager);
if (!(await interpreterService.getActiveInterpreter(wkspace))) {
commandManager.executeCommand(constants.Commands.TriggerEnvironmentSelection, wkspace);
return;
}
const configurationService = this.serviceContainer.get<ITestConfigurationService>(ITestConfigurationService);
await configurationService.promptToEnableAndConfigureTestFramework(wkspace!);
}
private registerCommands(): void {
const commandManager = this.serviceContainer.get<ICommandManager>(ICommandManager);
this.disposableRegistry.push(
commandManager.registerCommand(
constants.Commands.Tests_Configure,
(_, _cmdSource: constants.CommandSource = constants.CommandSource.commandPalette, resource?: Uri) => {
// Ignore the exceptions returned.
// This command will be invoked from other places of the extension.
this.configureTests(resource).ignoreErrors();
traceVerbose('Testing: Trigger refresh after config change');
this.testController?.refreshTestData(resource, { forceRefresh: true });
},
),
commandManager.registerCommand(constants.Commands.Tests_CopilotSetup, (resource?: Uri):
| { message: string; command: Command }
| undefined => {
const wkspaceFolder =
this.workspaceService.getWorkspaceFolder(resource) || this.workspaceService.workspaceFolders?.at(0);
if (!wkspaceFolder) {
return undefined;
}
const configurationService = this.serviceContainer.get<ITestConfigurationService>(
ITestConfigurationService,
);
if (configurationService.hasConfiguredTests(wkspaceFolder.uri)) {
return undefined;
}
return {
message: Testing.copilotSetupMessage,
command: {
title: Testing.configureTests,
command: constants.Commands.Tests_Configure,
arguments: [undefined, constants.CommandSource.ui, resource],
},
};
}),
);
}
private registerHandlers() {
const interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
this.disposableRegistry.push(
this.workspaceService.onDidChangeConfiguration((e) => {
this.configChangeTrigger.trigger(e);
}),
interpreterService.onDidChangeInterpreter(async () => {
traceVerbose('Testing: Triggered refresh due to interpreter change.');
sendTelemetryEvent(EventName.UNITTEST_DISCOVERY_TRIGGER, undefined, { trigger: 'interpreter' });
await this.testController?.refreshTestData(undefined, { forceRefresh: true });
}),
);
}
}