Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-24 02:28:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

testing: clean up nits

Browse Source 
- rename TestController.createRunConfiguration to .createRunProfile, and associated types
- rename TestItemCollection.remove to TestItemCollection.delete
This commit is contained in:
Connor Peet
2021-07-15 14:22:57 -07:00
parent 8a0f4763b1
commit 42c268a626
27 changed files with 415 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
src/vs/workbench/api/common/extHostTesting.ts
View File

@@ -20,14 +20,14 @@ import { ExtHostCommands } from 'vs/workbench/api/common/extHostCommands';
import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
import { TestItemImpl } from 'vs/workbench/api/common/extHostTestingPrivateApi';
import * as Convert from 'vs/workbench/api/common/extHostTypeConverters';
import { TestRunConfigurationGroup, TestRunRequest } from 'vs/workbench/api/common/extHostTypes';
import { TestRunProfileGroup, TestRunRequest } from 'vs/workbench/api/common/extHostTypes';
import { SingleUseTestCollection, TestPosition } from 'vs/workbench/contrib/testing/common/ownedTestCollection';
import { AbstractIncrementalTestCollection, CoverageDetails, IFileCoverage, IncrementalChangeCollector, IncrementalTestCollectionItem, InternalTestItem, ISerializedTestResults, ITestIdWithSrc, ITestItem, RunTestForControllerRequest, TestRunConfigurationBitset, TestsDiff } from 'vs/workbench/contrib/testing/common/testCollection';
import { AbstractIncrementalTestCollection, CoverageDetails, IFileCoverage, IncrementalChangeCollector, IncrementalTestCollectionItem, InternalTestItem, ISerializedTestResults, ITestIdWithSrc, ITestItem, RunTestForControllerRequest, TestRunProfileBitset, TestsDiff } from 'vs/workbench/contrib/testing/common/testCollection';
import type * as vscode from 'vscode';
interface ControllerInfo {
controller: vscode.TestController,
configurations: Map<number, vscode.TestRunConfiguration>,
profiles: Map<number, vscode.TestRunProfile>,
collection: SingleUseTestCollection,
}
@@ -59,7 +59,7 @@ export class ExtHostTesting implements ExtHostTestingShape {
const disposable = new DisposableStore();
const collection = disposable.add(new SingleUseTestCollection(controllerId));
const initialExpand = disposable.add(new RunOnceScheduler(() => collection.expand(collection.root.id, 0), 0));
const configurations = new Map<number, vscode.TestRunConfiguration>();
const profiles = new Map<number, vscode.TestRunProfile>();
const proxy = this.proxy;
const controller: vscode.TestController = {
@@ -75,17 +75,17 @@ export class ExtHostTesting implements ExtHostTestingShape {
get id() {
return controllerId;
},
createRunConfiguration: (label, group, runHandler, isDefault) => {
// Derive the config ID from a hash so that the same config will tend
createRunProfile: (label, group, runHandler, isDefault) => {
// Derive the profile ID from a hash so that the same profile will tend
// to have the same hashes, allowing re-run requests to work across reloads.
let configId = hash(label);
while (configurations.has(configId)) {
configId++;
let profileId = hash(label);
while (profiles.has(profileId)) {
profileId++;
}
const config = new TestRunConfigurationImpl(this.proxy, controllerId, configId, label, group, runHandler, isDefault);
configurations.set(configId, config);
return config;
const profile = new TestRunProfileImpl(this.proxy, controllerId, profileId, label, group, runHandler, isDefault);
profiles.set(profileId, profile);
return profile;
},
createTestRun: (request, name, persist = true) => {
return this.runTracker.createTestRun(controllerId, collection, request, name, persist);
@@ -105,12 +105,12 @@ export class ExtHostTesting implements ExtHostTestingShape {
};
// back compat:
(controller as any).createTestITem = this.createTestItem.bind(this);
(controller as any).createRunConfiguration = controller.createRunProfile;
proxy.$registerTestController(controllerId, label);
disposable.add(toDisposable(() => proxy.$unregisterTestController(controllerId)));
const info: ControllerInfo = { controller, collection, configurations };
const info: ControllerInfo = { controller, collection, profiles: profiles };
this.controllers.set(controllerId, info);
disposable.add(toDisposable(() => this.controllers.delete(controllerId)));
@@ -138,12 +138,12 @@ export class ExtHostTesting implements ExtHostTestingShape {
* Implements vscode.test.runTests
*/
public async runTests(req: vscode.TestRunRequest, token = CancellationToken.None) {
const config = tryGetConfigFromTestRunReq(req);
if (!config) {
throw new Error('The request passed to `vscode.test.runTests` must include a configuration');
const profile = tryGetProfileFromTestRunReq(req);
if (!profile) {
throw new Error('The request passed to `vscode.test.runTests` must include a profile');
}
const controller = this.controllers.get(config.controllerId);
const controller = this.controllers.get(profile.controllerId);
if (!controller) {
throw new Error('Controller not found');
}
@@ -151,11 +151,11 @@ export class ExtHostTesting implements ExtHostTestingShape {
await this.proxy.$runTests({
targets: [{
testIds: req.include?.map(t => t.id) ?? [controller.collection.root.id],
profileGroup: configGroupToBitset[config.group],
profileId: config.configId,
controllerId: config.controllerId,
profileGroup: profileGroupToBitset[profile.group],
profileId: profile.profileId,
controllerId: profile.controllerId,
}],
exclude: req.exclude?.map(t => ({ testId: t.id, controllerId: config.controllerId })),
exclude: req.exclude?.map(t => ({ testId: t.id, controllerId: profile.controllerId })),
}, token);
}
@@ -174,8 +174,8 @@ export class ExtHostTesting implements ExtHostTestingShape {
}
/** @inheritdoc */
$configureRunConfig(controllerId: string, configId: number) {
this.controllers.get(controllerId)?.configurations.get(configId)?.configureHandler?.();
$configureRunProfile(controllerId: string, profileId: number) {
this.controllers.get(controllerId)?.profiles.get(profileId)?.configureHandler?.();
}
/**
@@ -225,9 +225,9 @@ export class ExtHostTesting implements ExtHostTestingShape {
return;
}
const { collection, configurations } = lookup;
const configuration = configurations.get(req.configId);
if (!configuration) {
const { collection, profiles } = lookup;
const profile = profiles.get(req.profileId);
if (!profile) {
return;
}
@@ -249,7 +249,7 @@ export class ExtHostTesting implements ExtHostTestingShape {
const publicReq = new TestRunRequest(
includeTests.map(t => t.actual),
excludeTests.map(t => t.actual),
configuration,
profile,
);
const tracker = this.runTracker.prepareForMainThreadTestRun(
@@ -259,7 +259,7 @@ export class ExtHostTesting implements ExtHostTestingShape {
);
try {
await configuration.runHandler(publicReq, token);
await profile.runHandler(publicReq, token);
} finally {
if (tracker.isRunning && !token.isCancellationRequested) {
await Event.toPromise(tracker.onEnd);
@@ -401,10 +401,10 @@ export class TestRunCoordinator {
// If there is not an existing tracked extension for the request, start
// a new, detached session.
const dto = TestRunDto.fromPublic(controllerId, collection, request);
const config = tryGetConfigFromTestRunReq(request);
const profile = tryGetProfileFromTestRunReq(request);
this.proxy.$startedExtensionTestRun({
controllerId,
config: config && { group: configGroupToBitset[config.group], id: config.configId },
profile: profile && { group: profileGroupToBitset[profile.group], id: profile.profileId },
exclude: request.exclude?.map(t => t.id) ?? [],
id: dto.id,
include: request.include?.map(t => t.id) ?? [collection.root.id],
@@ -424,16 +424,16 @@ export class TestRunCoordinator {
}
}
const tryGetConfigFromTestRunReq = (request: vscode.TestRunRequest) => {
if (!request.configuration) {
const tryGetProfileFromTestRunReq = (request: vscode.TestRunRequest) => {
if (!request.profile) {
return undefined;
}
if (!(request.configuration instanceof TestRunConfigurationImpl)) {
throw new Error(`TestRunRequest.configuration is not an instance created from TestController.createRunConfiguration`);
if (!(request.profile instanceof TestRunProfileImpl)) {
throw new Error(`TestRunRequest.profile is not an instance created from TestController.createRunProfile`);
}
return request.configuration;
return request.profile;
};
export class TestRunDto {
@@ -816,7 +816,7 @@ class TestObservers {
}
}
export class TestRunConfigurationImpl implements vscode.TestRunConfiguration {
export class TestRunProfileImpl implements vscode.TestRunProfile {
readonly #proxy: MainThreadTestingShape;
private _configureHandler?: (() => void);
@@ -827,7 +827,7 @@ export class TestRunConfigurationImpl implements vscode.TestRunConfiguration {
public set label(label: string) {
if (label !== this._label) {
this._label = label;
this.#proxy.$updateTestRunConfig(this.controllerId, this.configId, { label });
this.#proxy.$updateTestRunConfig(this.controllerId, this.profileId, { label });
}
}
@@ -838,7 +838,7 @@ export class TestRunConfigurationImpl implements vscode.TestRunConfiguration {
public set isDefault(isDefault: boolean) {
if (isDefault !== this._isDefault) {
this._isDefault = isDefault;
this.#proxy.$updateTestRunConfig(this.controllerId, this.configId, { isDefault });
this.#proxy.$updateTestRunConfig(this.controllerId, this.profileId, { isDefault });
}
}
@@ -849,28 +849,28 @@ export class TestRunConfigurationImpl implements vscode.TestRunConfiguration {
public set configureHandler(handler: undefined | (() => void)) {
if (handler !== this._configureHandler) {
this._configureHandler = handler;
this.#proxy.$updateTestRunConfig(this.controllerId, this.configId, { hasConfigurationHandler: !!handler });
this.#proxy.$updateTestRunConfig(this.controllerId, this.profileId, { hasConfigurationHandler: !!handler });
}
}
constructor(
proxy: MainThreadTestingShape,
public readonly controllerId: string,
public readonly configId: number,
public readonly profileId: number,
private _label: string,
public readonly group: vscode.TestRunConfigurationGroup,
public readonly group: vscode.TestRunProfileGroup,
public runHandler: vscode.TestRunHandler,
private _isDefault = false,
) {
this.#proxy = proxy;
const groupBitset = configGroupToBitset[group];
const groupBitset = profileGroupToBitset[group];
if (typeof groupBitset !== 'number') {
throw new Error(`Unknown TestRunConfiguration.group ${group}`);
throw new Error(`Unknown TestRunProfile.group ${group}`);
}
this.#proxy.$publishTestRunConfig({
profileId: configId,
this.#proxy.$publishTestRunProfile({
profileId: profileId,
controllerId,
label: _label,
group: groupBitset,
@@ -880,12 +880,12 @@ export class TestRunConfigurationImpl implements vscode.TestRunConfiguration {
}
dispose(): void {
this.#proxy.$removeTestRunConfig(this.controllerId, this.configId);
this.#proxy.$removeTestProfile(this.controllerId, this.profileId);
}
}
const configGroupToBitset: { [K in TestRunConfigurationGroup]: TestRunConfigurationBitset } = {
[TestRunConfigurationGroup.Coverage]: TestRunConfigurationBitset.Coverage,
[TestRunConfigurationGroup.Debug]: TestRunConfigurationBitset.Debug,
[TestRunConfigurationGroup.Run]: TestRunConfigurationBitset.Run,
const profileGroupToBitset: { [K in TestRunProfileGroup]: TestRunProfileBitset } = {
[TestRunProfileGroup.Coverage]: TestRunProfileBitset.Coverage,
[TestRunProfileGroup.Debug]: TestRunProfileBitset.Debug,
[TestRunProfileGroup.Run]: TestRunProfileBitset.Run,
};