forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.ts
More file actions
246 lines (205 loc) · 6.84 KB
/
types.ts
File metadata and controls
246 lines (205 loc) · 6.84 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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
import { CancellationToken, Disposable, OutputChannel, Uri } from 'vscode';
import { IUnitTestSettings } from '../../common/configSettings';
import { Product } from '../../common/types';
import { CommandSource } from './constants';
export type TestProvider = 'nosetest' | 'pytest' | 'unittest';
export type TestDiscoveryOptions = {
workspaceFolder: Uri;
cwd: string;
args: string[];
token: CancellationToken;
ignoreCache: boolean;
outChannel: OutputChannel;
};
export type TestRunOptions = {
workspaceFolder: Uri;
cwd: string;
tests: Tests;
args: string[];
testsToRun?: TestsToRun;
token: CancellationToken;
outChannel?: OutputChannel;
debug?: boolean;
};
export type TestFolder = TestResult & {
name: string;
testFiles: TestFile[];
nameToRun: string;
status?: TestStatus;
folders: TestFolder[];
};
export type TestFile = TestResult & {
name: string;
fullPath: string;
functions: TestFunction[];
suites: TestSuite[];
nameToRun: string;
xmlName: string;
status?: TestStatus;
errorsWhenDiscovering?: string;
};
export type TestSuite = TestResult & {
name: string;
functions: TestFunction[];
suites: TestSuite[];
isUnitTest: Boolean;
isInstance: Boolean;
nameToRun: string;
xmlName: string;
status?: TestStatus;
};
export type TestFunction = TestResult & {
name: string;
nameToRun: string;
status?: TestStatus;
};
export type TestResult = Node & {
passed?: boolean;
time: number;
line?: number;
message?: string;
traceback?: string;
functionsPassed?: number;
functionsFailed?: number;
functionsDidNotRun?: number;
};
export type Node = {
expanded?: Boolean;
};
export type FlattenedTestFunction = {
testFunction: TestFunction;
parentTestSuite?: TestSuite;
parentTestFile: TestFile;
xmlClassName: string;
};
export type FlattenedTestSuite = {
testSuite: TestSuite;
parentTestSuite?: TestSuite;
parentTestFile: TestFile;
xmlClassName: string;
};
export type TestSummary = {
passed: number;
failures: number;
errors: number;
skipped: number;
};
export type Tests = {
summary: TestSummary;
testFiles: TestFile[];
testFunctions: FlattenedTestFunction[];
testSuites: FlattenedTestSuite[];
testFolders: TestFolder[];
rootTestFolders: TestFolder[];
};
export enum TestStatus {
Unknown,
Discovering,
Idle,
Running,
Fail,
Error,
Skipped,
Pass
}
export type TestsToRun = {
testFolder?: TestFolder[];
testFile?: TestFile[];
testSuite?: TestSuite[];
testFunction?: TestFunction[];
};
export type UnitTestProduct = Product.nosetest | Product.pytest | Product.unittest;
export interface ITestConfigSettingsService {
updateTestArgs(testDirectory: string, product: UnitTestProduct, args: string[]): Promise<void>;
enable(testDirectory: string | Uri, product: UnitTestProduct): Promise<void>;
disable(testDirectory: string | Uri, product: UnitTestProduct): Promise<void>;
}
export interface ITestManagerService extends Disposable {
getTestManager(): ITestManager | undefined;
getTestWorkingDirectory(): string;
getPreferredTestManager(): UnitTestProduct | undefined;
}
export const IWorkspaceTestManagerService = Symbol('IWorkspaceTestManagerService');
export interface IWorkspaceTestManagerService extends Disposable {
getTestManager(resource: Uri): ITestManager | undefined;
getTestWorkingDirectory(resource: Uri): string;
getPreferredTestManager(resource: Uri): UnitTestProduct | undefined;
}
export type TestSettingsPropertyNames = {
enabledName: keyof IUnitTestSettings;
argsName: keyof IUnitTestSettings;
pathName?: keyof IUnitTestSettings;
};
export const ITestsHelper = Symbol('ITestsHelper');
export interface ITestsHelper {
parseProviderName(product: UnitTestProduct): TestProvider;
getSettingsPropertyNames(product: Product): TestSettingsPropertyNames;
flattenTestFiles(testFiles: TestFile[]): Tests;
placeTestFilesIntoFolders(tests: Tests): void;
}
export const ITestVisitor = Symbol('ITestVisitor');
export interface ITestVisitor {
visitTestFunction(testFunction: TestFunction): void;
visitTestSuite(testSuite: TestSuite): void;
visitTestFile(testFile: TestFile): void;
visitTestFolder(testFile: TestFolder): void;
}
export const ITestCollectionStorageService = Symbol('ITestCollectionStorageService');
export interface ITestCollectionStorageService extends Disposable {
getTests(wkspace: Uri): Tests | undefined;
storeTests(wkspace: Uri, tests: Tests | null | undefined): void;
}
export const ITestResultsService = Symbol('ITestResultsService');
export interface ITestResultsService {
resetResults(tests: Tests): void;
updateResults(tests: Tests): void;
}
export type launchOptions = {
cwd: string;
args: string[];
token?: CancellationToken;
outChannel?: OutputChannel;
port: number;
host: string;
};
export const ITestDebugLauncher = Symbol('ITestDebugLauncher');
export interface ITestDebugLauncher {
getLaunchOptions(resource?: Uri): Promise<{ port: number, host: string }>;
launchDebugger(options: launchOptions): Promise<void>;
}
export const ITestManagerFactory = Symbol('ITestManagerFactory');
export interface ITestManagerFactory extends Function {
// tslint:disable-next-line:callable-types
(testProvider: TestProvider, workspaceFolder: Uri, rootDirectory: string): ITestManager;
}
export const ITestManagerServiceFactory = Symbol('TestManagerServiceFactory');
export interface ITestManagerServiceFactory extends Function {
// tslint:disable-next-line:callable-types
(workspaceFolder: Uri): ITestManagerService;
}
export const ITestManager = Symbol('ITestManager');
export interface ITestManager extends Disposable {
readonly status: TestStatus;
readonly enabled: boolean;
readonly workingDirectory: string;
readonly workspaceFolder: Uri;
stop(): void;
resetTestResults(): void;
discoverTests(cmdSource: CommandSource, ignoreCache?: boolean, quietMode?: boolean, userInitiated?: boolean): Promise<Tests>;
runTest(cmdSource: CommandSource, testsToRun?: TestsToRun, runFailedTests?: boolean, debug?: boolean): Promise<Tests>;
}
export const ITestDiscoveryService = Symbol('ITestDiscoveryService');
export interface ITestDiscoveryService {
discoverTests(options: TestDiscoveryOptions): Promise<Tests>;
}
export const ITestsParser = Symbol('ITestsParser');
export interface ITestsParser {
parse(content: string, options: ParserOptions): Tests;
}
export type ParserOptions = TestDiscoveryOptions;
export const IUnitTestSocketServer = Symbol('IUnitTestSocketServer');
export interface IUnitTestSocketServer extends Disposable {
on(event: string | symbol, listener: Function): this;
start(options?: { port?: number, host?: string }): Promise<number>;
stop(): void;
}