@opentap/runner-client 1.0.0-beta.52 → 1.0.0-beta.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/BaseClient.d.ts +155 -0
- package/lib/BaseClient.js +295 -0
- package/lib/RunnerClient.d.ts +1 -114
- package/lib/RunnerClient.js +8 -1070
- package/lib/SessionClient.d.ts +52 -332
- package/lib/SessionClient.js +288 -4831
- package/lib/requestDTOs.d.ts +70 -70
- package/lib/requestDTOs.js +1 -131
- package/package.json +2 -9
package/lib/SessionClient.d.ts
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import { BreakPoints, CommonContext, CommonSettings,
|
|
2
|
-
|
|
1
|
+
import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, Links, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, RunStatus, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
|
|
2
|
+
import { BaseClient } from './BaseClient';
|
|
3
|
+
export declare class SessionClient extends BaseClient {
|
|
3
4
|
private http;
|
|
4
5
|
private baseUrl;
|
|
5
6
|
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
6
|
-
constructor(
|
|
7
|
-
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
8
|
-
});
|
|
7
|
+
constructor(baseSubject: string, server: string);
|
|
9
8
|
/**
|
|
10
9
|
* Retrieve session logs
|
|
11
10
|
* @param id (optional)
|
|
@@ -16,8 +15,7 @@ export declare class SessionClient {
|
|
|
16
15
|
* @param limit (optional)
|
|
17
16
|
* @return Successfully retrieved OpenTAP log messages.
|
|
18
17
|
*/
|
|
19
|
-
getSessionLogs(id
|
|
20
|
-
protected processGetSessionLogs(response: Response): Promise<LogList>;
|
|
18
|
+
getSessionLogs(id?: string, levels?: number[], excludedSources?: string[], filterText?: string, offset?: number, limit?: number): Promise<LogList>;
|
|
21
19
|
/**
|
|
22
20
|
* Retrieve session log indexes
|
|
23
21
|
* @param id (optional)
|
|
@@ -27,15 +25,13 @@ export declare class SessionClient {
|
|
|
27
25
|
* @param searchText (optional)
|
|
28
26
|
* @return Logs indexes retrieved
|
|
29
27
|
*/
|
|
30
|
-
sessionLogSearch(id: string | undefined,
|
|
31
|
-
protected processSessionLogSearch(response: Response): Promise<number[]>;
|
|
28
|
+
sessionLogSearch(id: string | undefined, levels: number[] | null | undefined, excludedSources: string[] | null | undefined, filterText: string | null | undefined, searchText: string | null | undefined): Promise<number[]>;
|
|
32
29
|
/**
|
|
33
30
|
* Retrieve log sources
|
|
34
31
|
* @param id (optional)
|
|
35
32
|
* @return Logs indexes retrieved
|
|
36
33
|
*/
|
|
37
34
|
sessionLogSources(id: string | undefined): Promise<string[]>;
|
|
38
|
-
protected processSessionLogSources(response: Response): Promise<string[]>;
|
|
39
35
|
/**
|
|
40
36
|
* Retrieve session log counts
|
|
41
37
|
* @param id (optional)
|
|
@@ -44,9 +40,6 @@ export declare class SessionClient {
|
|
|
44
40
|
sessionLogCounts(id: string | undefined): Promise<{
|
|
45
41
|
[key: string]: number;
|
|
46
42
|
}>;
|
|
47
|
-
protected processSessionLogCounts(response: Response): Promise<{
|
|
48
|
-
[key: string]: number;
|
|
49
|
-
}>;
|
|
50
43
|
/**
|
|
51
44
|
* Retrieve log severities
|
|
52
45
|
* @return Log levels retrieved
|
|
@@ -54,490 +47,217 @@ export declare class SessionClient {
|
|
|
54
47
|
logLevels(): Promise<{
|
|
55
48
|
[key: string]: string;
|
|
56
49
|
}>;
|
|
57
|
-
protected processLogLevels(response: Response): Promise<{
|
|
58
|
-
[key: string]: string;
|
|
59
|
-
}>;
|
|
60
|
-
/**
|
|
61
|
-
* Retrieve testplan run logs
|
|
62
|
-
* @param id (optional)
|
|
63
|
-
* @param level (optional)
|
|
64
|
-
* @param excludedSource (optional)
|
|
65
|
-
* @param filterText (optional)
|
|
66
|
-
* @param offset (optional)
|
|
67
|
-
* @param limit (optional)
|
|
68
|
-
* @return Logs retrieved
|
|
69
|
-
*/
|
|
70
|
-
testPlanRunLogs(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, offset: number | undefined, limit: number | undefined): Promise<LogList>;
|
|
71
|
-
protected processTestPlanRunLogs(response: Response): Promise<LogList>;
|
|
72
|
-
/**
|
|
73
|
-
* Search testplan run logs
|
|
74
|
-
* @param id (optional)
|
|
75
|
-
* @param level (optional)
|
|
76
|
-
* @param excludedSource (optional)
|
|
77
|
-
* @param filterText (optional)
|
|
78
|
-
* @param searchText (optional)
|
|
79
|
-
* @return Logs indexes retrieved
|
|
80
|
-
*/
|
|
81
|
-
testPlanRunLogSearch(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, searchText: string | null | undefined): Promise<number[]>;
|
|
82
|
-
protected processTestPlanRunLogSearch(response: Response): Promise<number[]>;
|
|
83
|
-
/**
|
|
84
|
-
* Retrieve testplan run log sources
|
|
85
|
-
* @param id (optional)
|
|
86
|
-
* @return Logs indexes retrieved
|
|
87
|
-
*/
|
|
88
|
-
testPlanRunLogSources(id: string | undefined): Promise<string[]>;
|
|
89
|
-
protected processTestPlanRunLogSources(response: Response): Promise<string[]>;
|
|
90
|
-
/**
|
|
91
|
-
* Retrieve testplan run log count
|
|
92
|
-
* @param id (optional)
|
|
93
|
-
* @return Logs indexes retrieved
|
|
94
|
-
*/
|
|
95
|
-
testPlanRunLogCounts(id: string | undefined): Promise<{
|
|
96
|
-
[key: string]: number;
|
|
97
|
-
}>;
|
|
98
|
-
protected processTestPlanRunLogCounts(response: Response): Promise<{
|
|
99
|
-
[key: string]: number;
|
|
100
|
-
}>;
|
|
101
50
|
/**
|
|
102
51
|
* Get status, with an optional testplan execution completion timeout
|
|
103
|
-
* @param timeout (optional)
|
|
52
|
+
* @param {number | null | undefined} timeout (optional)
|
|
53
|
+
* @return RunStatus retrieved
|
|
104
54
|
*/
|
|
105
55
|
getStatus(timeout: number | null | undefined): Promise<RunStatus>;
|
|
106
|
-
protected processGetStatus(response: Response): Promise<RunStatus>;
|
|
107
56
|
/**
|
|
108
|
-
*
|
|
57
|
+
* Upload test plan XML
|
|
58
|
+
* @param xml Test Plan XML
|
|
109
59
|
* @return Test plan loaded. List of load errors is returned.
|
|
110
60
|
*/
|
|
111
|
-
|
|
112
|
-
protected processLoadTestPlanFile(response: Response): Promise<string[]>;
|
|
113
|
-
/**
|
|
114
|
-
* Upload .TapPlan XML
|
|
115
|
-
* @param testPlanName (optional)
|
|
116
|
-
* @return Test plan loaded
|
|
117
|
-
*/
|
|
118
|
-
setTestPlanXML(testPlanName: string | null | undefined, planXML: string): Promise<void>;
|
|
119
|
-
protected processSetTestPlanXML(response: Response): Promise<void>;
|
|
61
|
+
setTestPlanXML(xml: string): Promise<string[]>;
|
|
120
62
|
/**
|
|
121
63
|
* Retrieve loaded test plan XML
|
|
122
64
|
* @return Test plan retrieved
|
|
123
65
|
*/
|
|
124
66
|
getTestPlanXML(): Promise<string>;
|
|
125
|
-
protected processGetTestPlanXML(response: Response): Promise<string>;
|
|
126
|
-
/**
|
|
127
|
-
* Upload test plan XML
|
|
128
|
-
* @param testPlanName (optional)
|
|
129
|
-
* @return Test plan loaded. List of load errors is returned.
|
|
130
|
-
*/
|
|
131
|
-
setTestPlanXMLNonInteractive(testPlanName: string | null | undefined, planXML: string): Promise<string[]>;
|
|
132
|
-
protected processSetTestPlanXMLNonInteractive(response: Response): Promise<string[]>;
|
|
133
67
|
/**
|
|
134
68
|
* Load test plan using a test plan TapPackage from a repository
|
|
69
|
+
* @param {RepositoryPackageDefinition} packageReference
|
|
135
70
|
* @return Test plan loaded. List of load errors is returned.
|
|
136
71
|
*/
|
|
137
72
|
loadTestPlanFromRepository(packageReference: RepositoryPackageReference): Promise<string[]>;
|
|
138
|
-
protected processLoadTestPlanFromRepository(response: Response): Promise<string[]>;
|
|
139
73
|
/**
|
|
140
74
|
* Save currently loaded test plan to a repository
|
|
75
|
+
* @param {RepositoryPackageDefinition} packageReference
|
|
141
76
|
* @return Test plan uploaded.
|
|
142
77
|
*/
|
|
143
78
|
saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<void>;
|
|
144
|
-
protected processSaveTestPlanToRepository(response: Response): Promise<void>;
|
|
145
79
|
/**
|
|
146
80
|
* Test plan resources opened
|
|
147
81
|
* @return Test plan resources opened.
|
|
148
82
|
*/
|
|
149
83
|
resourcesOpen(): Promise<TestPlan>;
|
|
150
|
-
protected processResourcesOpen(response: Response): Promise<TestPlan>;
|
|
151
84
|
/**
|
|
152
85
|
* Test plan resources closed
|
|
153
86
|
* @return Test plan resources closed.
|
|
154
87
|
*/
|
|
155
88
|
resourcesClose(): Promise<TestPlan>;
|
|
156
|
-
protected processResourcesClose(response: Response): Promise<TestPlan>;
|
|
157
89
|
/**
|
|
158
90
|
* Retrieve test plan or test step settings
|
|
159
|
-
* @
|
|
91
|
+
* @param {string} contextId
|
|
92
|
+
* @return List of settings retrieved
|
|
160
93
|
*/
|
|
161
94
|
getSettings(contextId: string): Promise<Setting[]>;
|
|
162
|
-
protected processGetSettings(response: Response): Promise<Setting[]>;
|
|
163
95
|
/**
|
|
164
96
|
* Change test plan or test step settings
|
|
97
|
+
* @param {string} contextId
|
|
98
|
+
* @param {Setting[]} settings
|
|
165
99
|
* @return Settings changed
|
|
166
100
|
*/
|
|
167
101
|
setSettings(contextId: string, settings: Setting[]): Promise<Setting[]>;
|
|
168
|
-
protected processSetSettings(response: Response): Promise<Setting[]>;
|
|
169
102
|
/**
|
|
170
103
|
* Retrieve test plan structure
|
|
171
|
-
* @param properties
|
|
104
|
+
* @param {string[] | null | undefined} properties
|
|
172
105
|
* @return Test plan retrieved
|
|
173
106
|
*/
|
|
174
107
|
getTestPlan(properties: string[] | null | undefined): Promise<TestPlan>;
|
|
175
|
-
protected processGetTestPlan(response: Response): Promise<TestPlan>;
|
|
176
108
|
/**
|
|
177
109
|
* Change test plan structure
|
|
110
|
+
* @param {TestPlan} plan
|
|
178
111
|
* @return Test plan changed
|
|
179
112
|
*/
|
|
180
113
|
setTestPlan(plan: TestPlan): Promise<TestPlan>;
|
|
181
|
-
protected processSetTestPlan(response: Response): Promise<TestPlan>;
|
|
182
114
|
/**
|
|
183
115
|
* Retrieve all validation errors present in the test plan
|
|
184
116
|
* @return Retrieved validation errors for loaded TestPlan
|
|
185
117
|
*/
|
|
186
118
|
getValidationErrors(): Promise<TestStepValidationError[]>;
|
|
187
|
-
protected processGetValidationErrors(response: Response): Promise<TestStepValidationError[]>;
|
|
188
119
|
/**
|
|
189
120
|
* Retrieve or change common test step settings
|
|
121
|
+
* @param {CommonSettings} commonSettings
|
|
190
122
|
* @return Common test step settings retrieved or changed
|
|
191
123
|
*/
|
|
192
124
|
commonStepSettings(commonSettings: CommonSettings): Promise<CommonSettings>;
|
|
193
|
-
protected processCommonStepSettings(response: Response): Promise<CommonSettings>;
|
|
194
125
|
/**
|
|
195
126
|
* Retrieve or invoke common test step settings context menu items
|
|
127
|
+
* @param {string} propertyName
|
|
128
|
+
* @param {TestPlan} commonContext
|
|
196
129
|
* @return Get context menu (right-click menu) for a property in the testplan or teststep
|
|
197
130
|
*/
|
|
198
131
|
commonStepSettingsContextMenu(propertyName: string | null, commonContext: CommonContext): Promise<CommonContext>;
|
|
199
|
-
protected processCommonStepSettingsContextMenu(response: Response): Promise<CommonContext>;
|
|
200
132
|
/**
|
|
201
133
|
* Retrieve all pending user input IDs
|
|
202
134
|
* @return Retrieved pending user inputs
|
|
203
135
|
*/
|
|
204
136
|
getUserInputs(): Promise<string[]>;
|
|
205
|
-
protected processGetUserInputs(response: Response): Promise<string[]>;
|
|
206
137
|
/**
|
|
207
138
|
* Retrieve pending user input based on ID
|
|
139
|
+
* @param {string} id
|
|
208
140
|
* @return Retrieved pending user input
|
|
209
141
|
*/
|
|
210
142
|
getUserInput(id: string): Promise<Interaction>;
|
|
211
|
-
protected processGetUserInput(response: Response): Promise<Interaction>;
|
|
212
143
|
/**
|
|
213
144
|
* Modify or answer pending user input based on ID
|
|
145
|
+
* @param interaction
|
|
146
|
+
* @returns {Promise<Interaction>}
|
|
214
147
|
*/
|
|
215
|
-
setUserInput(
|
|
216
|
-
protected processSetUserInput(response: Response): Promise<Interaction>;
|
|
148
|
+
setUserInput(interaction: Interaction): Promise<Interaction>;
|
|
217
149
|
/**
|
|
218
150
|
* Property context menu
|
|
151
|
+
* @param {string} contextId
|
|
152
|
+
* @param {string | null} propertyName
|
|
219
153
|
* @return Get context menu (right-click menu) for a property in the testplan or teststep
|
|
220
154
|
*/
|
|
221
155
|
getContextMenu(contextId: string, propertyName: string | null): Promise<Setting[]>;
|
|
222
|
-
protected processGetContextMenu(response: Response): Promise<Setting[]>;
|
|
223
156
|
/**
|
|
224
157
|
* Property context menu
|
|
158
|
+
* @param {string} contextId
|
|
159
|
+
* @param {string | null} propertyName
|
|
160
|
+
* @param {Setting[]} contextMenu
|
|
225
161
|
* @return Set context menu (right-click menu) for a property in the testplan or teststep
|
|
226
162
|
*/
|
|
227
163
|
setContextMenu(contextId: string, propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
|
|
228
|
-
protected processSetContextMenu(response: Response): Promise<Setting[]>;
|
|
229
164
|
/**
|
|
230
165
|
* Get data grid
|
|
231
|
-
* @
|
|
166
|
+
* @param {string} contextId
|
|
167
|
+
* @param {string | null} propertyName
|
|
168
|
+
* @return DataGridControl retrieved
|
|
232
169
|
*/
|
|
233
170
|
getDataGrid(contextId: string, propertyName: string | null): Promise<DataGridControl>;
|
|
234
|
-
protected processGetDataGrid(response: Response): Promise<DataGridControl>;
|
|
235
171
|
/**
|
|
236
172
|
* Set data grid
|
|
237
173
|
* @return Set data grid
|
|
238
174
|
*/
|
|
239
|
-
setDataGrid(contextId: string, propertyName: string
|
|
240
|
-
protected processSetDataGrid(response: Response): Promise<DataGridControl>;
|
|
175
|
+
setDataGrid(contextId: string, propertyName: string, dataGridControl: DataGridControl): Promise<DataGridControl>;
|
|
241
176
|
/**
|
|
242
|
-
* Add item to data grid
|
|
243
|
-
* @
|
|
177
|
+
* Add item type to data grid
|
|
178
|
+
* @param {string} contextId
|
|
179
|
+
* @param {string | null} propertyName
|
|
180
|
+
* @param {string | null} typeName
|
|
181
|
+
* @return DataGridControl retrieved
|
|
244
182
|
*/
|
|
245
183
|
addDataGridItemType(contextId: string, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
|
|
246
|
-
protected processAddDataGridItemType(response: Response): Promise<DataGridControl>;
|
|
247
184
|
/**
|
|
248
185
|
* Add item to data grid
|
|
249
|
-
* @
|
|
186
|
+
* @param {string} contextId
|
|
187
|
+
* @param {string | null} propertyName
|
|
188
|
+
* @return DataGridControl retrieved
|
|
250
189
|
*/
|
|
251
190
|
addDataGridItem(contextId: string, propertyName: string | null): Promise<DataGridControl>;
|
|
252
|
-
protected processAddDataGridItem(response: Response): Promise<DataGridControl>;
|
|
253
191
|
/**
|
|
254
192
|
* Get item types available in the data grid
|
|
255
|
-
* @
|
|
193
|
+
* @param {string} contextId
|
|
194
|
+
* @param {string | null} propertyName
|
|
195
|
+
* @return List of ListItemType retrieved
|
|
256
196
|
*/
|
|
257
197
|
getDataGridTypes(contextId: string, propertyName: string | null): Promise<ListItemType[]>;
|
|
258
|
-
protected processGetDataGridTypes(response: Response): Promise<ListItemType[]>;
|
|
259
|
-
/**
|
|
260
|
-
* Get installed files to be used in FilePaths
|
|
261
|
-
* @param extension (optional)
|
|
262
|
-
* @return Get installed files
|
|
263
|
-
*/
|
|
264
|
-
getInstalledFiles(extension: string | null | undefined): Promise<InstalledFile[]>;
|
|
265
|
-
protected processGetInstalledFiles(response: Response): Promise<InstalledFile[]>;
|
|
266
198
|
/**
|
|
267
199
|
* Retrieve static available step type information.
|
|
268
200
|
* @return StepTypes retrieved
|
|
269
201
|
*/
|
|
270
202
|
getTestStepTypes(): Promise<TestStepType[]>;
|
|
271
|
-
protected processGetTestStepTypes(response: Response): Promise<TestStepType[]>;
|
|
272
|
-
/**
|
|
273
|
-
* DEPRECATED. Use /edit/plan/repository/load (LoadTestPlanFromRepository) instead
|
|
274
|
-
* @return Test plan loaded. List of load errors is returned.
|
|
275
|
-
* @deprecated
|
|
276
|
-
*/
|
|
277
|
-
loadTestPlanFromRepositoryReference(packageReference: RepositoryPackageReference): Promise<string[]>;
|
|
278
|
-
protected processLoadTestPlanFromRepositoryReference(response: Response): Promise<string[]>;
|
|
279
|
-
/**
|
|
280
|
-
* DEPRECATED. Use /edit/settings/{contextId} (GetSettings) instead
|
|
281
|
-
* @return Test step retrieved
|
|
282
|
-
* @deprecated
|
|
283
|
-
*/
|
|
284
|
-
getTestStep(stepId: string): Promise<TestStep>;
|
|
285
|
-
protected processGetTestStep(response: Response): Promise<TestStep>;
|
|
286
|
-
/**
|
|
287
|
-
* DEPRECATED. Use /edit/settings/{contextId} (SetSettings) instead
|
|
288
|
-
* @return Test step changed
|
|
289
|
-
* @deprecated
|
|
290
|
-
*/
|
|
291
|
-
setTestStep(stepId: string, step: TestStep): Promise<TestStep>;
|
|
292
|
-
protected processSetTestStep(response: Response): Promise<TestStep>;
|
|
293
|
-
/**
|
|
294
|
-
* DEPRECATED. Use /edit/settings/{contextId} (GetSettings) instead
|
|
295
|
-
* @return Get testplan properties
|
|
296
|
-
* @deprecated
|
|
297
|
-
*/
|
|
298
|
-
getTestPlanSettings(): Promise<TestPlan>;
|
|
299
|
-
protected processGetTestPlanSettings(response: Response): Promise<TestPlan>;
|
|
300
|
-
/**
|
|
301
|
-
* DEPRECATED. Use /edit/settings/{contextId} (SetSettings) instead
|
|
302
|
-
* @return Set testplan properties
|
|
303
|
-
* @deprecated
|
|
304
|
-
*/
|
|
305
|
-
setTestPlanSettings(testPlan: TestPlan): Promise<TestPlan>;
|
|
306
|
-
protected processSetTestPlanSettings(response: Response): Promise<TestPlan>;
|
|
307
|
-
/**
|
|
308
|
-
* DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (GetContextMenu) instead
|
|
309
|
-
* @return Get context menu (right-click menu) for a property in a step
|
|
310
|
-
* @deprecated
|
|
311
|
-
*/
|
|
312
|
-
getTestStepContextMenu(stepId: string, propertyName: string | null): Promise<Setting[]>;
|
|
313
|
-
protected processGetTestStepContextMenu(response: Response): Promise<Setting[]>;
|
|
314
|
-
/**
|
|
315
|
-
* DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (SetContextMenu) instead
|
|
316
|
-
* @return Set context menu (right-click menu) for a property in a step
|
|
317
|
-
* @deprecated
|
|
318
|
-
*/
|
|
319
|
-
setTestStepContextMenu(stepId: string, propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
|
|
320
|
-
protected processSetTestStepContextMenu(response: Response): Promise<Setting[]>;
|
|
321
|
-
/**
|
|
322
|
-
* DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (GetContextMenu) instead
|
|
323
|
-
* @return Get context menu (right-click menu) for a property in the testplan
|
|
324
|
-
* @deprecated
|
|
325
|
-
*/
|
|
326
|
-
getTestPlanContextMenu(propertyName: string | null): Promise<Setting[]>;
|
|
327
|
-
protected processGetTestPlanContextMenu(response: Response): Promise<Setting[]>;
|
|
328
|
-
/**
|
|
329
|
-
* DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (SetContextMenu) instead
|
|
330
|
-
* @return Set context menu (right-click menu) for a property in the testplan
|
|
331
|
-
* @deprecated
|
|
332
|
-
*/
|
|
333
|
-
setTestPlanContextMenu(propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
|
|
334
|
-
protected processSetTestPlanContextMenu(response: Response): Promise<Setting[]>;
|
|
335
|
-
/**
|
|
336
|
-
* DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName} (GetDataGrid) instead
|
|
337
|
-
* @return Get data grid
|
|
338
|
-
* @deprecated
|
|
339
|
-
*/
|
|
340
|
-
getDataGridDeprecated(stepId: string, propertyName: string | null): Promise<DataGridControl>;
|
|
341
|
-
protected processGetDataGridDeprecated(response: Response): Promise<DataGridControl>;
|
|
342
|
-
/**
|
|
343
|
-
* DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName} (SetDataGrid) instead
|
|
344
|
-
* @return Set data grid
|
|
345
|
-
* @deprecated
|
|
346
|
-
*/
|
|
347
|
-
setDataGridDeprecated(stepId: string, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
|
|
348
|
-
protected processSetDataGridDeprecated(response: Response): Promise<DataGridControl>;
|
|
349
|
-
/**
|
|
350
|
-
* DEPRECATED. Use //edit/datagrid/{contextId}/{propertyName}/new/{typeName} (AddDataGridItemType) instead
|
|
351
|
-
* @return Add data grid item
|
|
352
|
-
* @deprecated
|
|
353
|
-
*/
|
|
354
|
-
addDataGridItemTypeDeprecated(stepId: string, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
|
|
355
|
-
protected processAddDataGridItemTypeDeprecated(response: Response): Promise<DataGridControl>;
|
|
356
|
-
/**
|
|
357
|
-
* DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName}/new (AddDataGridItem) instead
|
|
358
|
-
* @return Add data grid item
|
|
359
|
-
* @deprecated
|
|
360
|
-
*/
|
|
361
|
-
addDataGridItemDeprecated(stepId: string, propertyName: string | null): Promise<DataGridControl>;
|
|
362
|
-
protected processAddDataGridItemDeprecated(response: Response): Promise<DataGridControl>;
|
|
363
|
-
/**
|
|
364
|
-
* DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName}/availabletypes (GetDataGridTypes) instead
|
|
365
|
-
* @return Add data grid item
|
|
366
|
-
* @deprecated
|
|
367
|
-
*/
|
|
368
|
-
getDataGridTypesDeprecated(stepId: string, propertyName: string | null): Promise<ListItemType[]>;
|
|
369
|
-
protected processGetDataGridTypesDeprecated(response: Response): Promise<ListItemType[]>;
|
|
370
203
|
/**
|
|
371
204
|
* Pause test plan execution at next possible test step
|
|
372
205
|
*/
|
|
373
206
|
setPauseNext(): Promise<void>;
|
|
374
|
-
protected processSetPauseNext(response: Response): Promise<void>;
|
|
375
207
|
/**
|
|
376
208
|
* Retrieve breakpoints set in test plan
|
|
377
209
|
*/
|
|
378
210
|
getBreakpoints(): Promise<BreakPoints>;
|
|
379
|
-
protected processGetBreakpoints(response: Response): Promise<BreakPoints>;
|
|
380
211
|
/**
|
|
381
212
|
* Set breakpoints in test plan
|
|
213
|
+
* @param {BreakPoints} breakPointsDto
|
|
214
|
+
* @return BreakPoints retrieved
|
|
382
215
|
*/
|
|
383
216
|
setBreakpoints(breakPointsDto: BreakPoints): Promise<BreakPoints>;
|
|
384
|
-
protected processSetBreakpoints(response: Response): Promise<BreakPoints>;
|
|
385
217
|
/**
|
|
386
218
|
* Jump test plan execution to step. Execution state must be 'breaking'.
|
|
219
|
+
* @param {string} stepId
|
|
387
220
|
*/
|
|
388
221
|
setJumpToStep(stepId: string): Promise<void>;
|
|
389
|
-
protected processSetJumpToStep(response: Response): Promise<void>;
|
|
390
|
-
/**
|
|
391
|
-
* Execute test plan
|
|
392
|
-
*/
|
|
393
|
-
runTestPlan(): Promise<RunStatus>;
|
|
394
|
-
protected processRunTestPlan(response: Response): Promise<RunStatus>;
|
|
395
222
|
/**
|
|
396
223
|
* Execute test plan with attaching metadata
|
|
224
|
+
* @param {Parameter[]} parameters
|
|
225
|
+
* @return RunStatus retrieved
|
|
397
226
|
*/
|
|
398
227
|
runTestPlanMetadata(parameters: Parameter[]): Promise<RunStatus>;
|
|
399
|
-
protected processRunTestPlanMetadata(response: Response): Promise<RunStatus>;
|
|
400
228
|
/**
|
|
401
229
|
* Abort test plan execution
|
|
402
230
|
*/
|
|
403
231
|
abortTestPlan(): Promise<void>;
|
|
404
|
-
protected processAbortTestPlan(response: Response): Promise<void>;
|
|
405
232
|
/**
|
|
406
233
|
* Shuts down session
|
|
407
234
|
*/
|
|
408
235
|
shutdown(): Promise<void>;
|
|
409
|
-
protected processShutdown(response: Response): Promise<void>;
|
|
410
236
|
/**
|
|
411
237
|
* Retrieves installed packages in this session
|
|
412
238
|
*/
|
|
413
239
|
getImage(): Promise<Image>;
|
|
414
|
-
protected processGetImage(response: Response): Promise<Image>;
|
|
415
240
|
/**
|
|
416
241
|
* Retrieves session readiness
|
|
417
242
|
*/
|
|
418
243
|
getReadiness(): Promise<void>;
|
|
419
|
-
protected processGetReadiness(response: Response): Promise<void>;
|
|
420
244
|
/**
|
|
421
245
|
* Retrieves watchdog
|
|
422
246
|
*/
|
|
423
247
|
getWatchDog(): Promise<WatchDog>;
|
|
424
|
-
protected processGetWatchDog(response: Response): Promise<WatchDog>;
|
|
425
248
|
/**
|
|
426
249
|
* Sets a new watchdog
|
|
250
|
+
* @param {WatchDog} watchDog
|
|
427
251
|
*/
|
|
428
252
|
setWatchDog(watchDog: WatchDog): Promise<WatchDog>;
|
|
429
|
-
protected processSetWatchDog(response: Response): Promise<WatchDog>;
|
|
430
253
|
/**
|
|
431
254
|
* Links to other applications or services
|
|
432
255
|
*/
|
|
433
256
|
getLinks(): Promise<Links>;
|
|
434
257
|
protected processGetLinks(response: Response): Promise<Links>;
|
|
435
|
-
/**
|
|
436
|
-
* Retrieve component settings overview
|
|
437
|
-
*/
|
|
438
|
-
getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
|
|
439
|
-
protected processGetComponentSettingsOverview(response: Response): Promise<ComponentSettingsIdentifier[]>;
|
|
440
|
-
/**
|
|
441
|
-
* Change componentsettings
|
|
442
|
-
*/
|
|
443
|
-
setComponentSettings(groupName: string | null, name: string | null, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
|
|
444
|
-
protected processSetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
|
|
445
|
-
/**
|
|
446
|
-
* Retrieve componentsettings
|
|
447
|
-
*/
|
|
448
|
-
getComponentSettings(groupName: string | null, name: string | null): Promise<ComponentSettingsBase>;
|
|
449
|
-
protected processGetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
|
|
450
|
-
/**
|
|
451
|
-
* Retrieve componentsettings list item
|
|
452
|
-
*/
|
|
453
|
-
getComponentSettingsListItem(groupName: string | null, name: string | null, index: number): Promise<ComponentSettingsListItem>;
|
|
454
|
-
protected processGetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
|
|
455
|
-
/**
|
|
456
|
-
* Set componentsettings list item settings
|
|
457
|
-
*/
|
|
458
|
-
setComponentSettingsListItem(groupName: string | null, name: string | null, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
|
|
459
|
-
protected processSetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
|
|
460
|
-
/**
|
|
461
|
-
* Get component setting data grid
|
|
462
|
-
* @return Get component setting data grid
|
|
463
|
-
*/
|
|
464
|
-
getComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
|
|
465
|
-
protected processGetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
|
|
466
|
-
/**
|
|
467
|
-
* Set component setting data grid
|
|
468
|
-
* @return Set data grid
|
|
469
|
-
*/
|
|
470
|
-
setComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
|
|
471
|
-
protected processSetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
|
|
472
|
-
/**
|
|
473
|
-
* Add component setting item to data grid
|
|
474
|
-
* @return Add component setting data grid item
|
|
475
|
-
*/
|
|
476
|
-
addComponentSettingDataGridItemType(groupName: string | null, name: string | null, index: number, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
|
|
477
|
-
protected processAddComponentSettingDataGridItemType(response: Response): Promise<DataGridControl>;
|
|
478
|
-
/**
|
|
479
|
-
* Add component setting item to data grid
|
|
480
|
-
* @return Add component setting data grid item
|
|
481
|
-
*/
|
|
482
|
-
addComponentSettingDataGridItem(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
|
|
483
|
-
protected processAddComponentSettingDataGridItem(response: Response): Promise<DataGridControl>;
|
|
484
|
-
/**
|
|
485
|
-
* Get item types available in the component setting data grid
|
|
486
|
-
* @return Get component setting data grid types
|
|
487
|
-
*/
|
|
488
|
-
getComponentSettingDataGridTypes(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<ListItemType[]>;
|
|
489
|
-
protected processGetComponentSettingDataGridTypes(response: Response): Promise<ListItemType[]>;
|
|
490
|
-
/**
|
|
491
|
-
* Change componentsettings profiles
|
|
492
|
-
*/
|
|
493
|
-
setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
|
|
494
|
-
protected processSetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
|
|
495
|
-
/**
|
|
496
|
-
* Get componentsettings profiles
|
|
497
|
-
*/
|
|
498
|
-
getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
|
|
499
|
-
protected processGetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
|
|
500
|
-
/**
|
|
501
|
-
* Upload exported OpenTAP Settings files
|
|
502
|
-
* @param file (optional)
|
|
503
|
-
*/
|
|
504
|
-
uploadComponentSettings(file: FileParameter | null | undefined): Promise<void>;
|
|
505
|
-
protected processUploadComponentSettings(response: Response): Promise<void>;
|
|
506
|
-
/**
|
|
507
|
-
* DEPRECATED: Use /componentsettings/load (LoadComponentSettingsFromRepository) instead
|
|
508
|
-
* @deprecated
|
|
509
|
-
*/
|
|
510
|
-
loadComponentSettingsFromPackageReference(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
|
|
511
|
-
protected processLoadComponentSettingsFromPackageReference(response: Response): Promise<ErrorResponse[]>;
|
|
512
|
-
/**
|
|
513
|
-
* Load a component settings TapPackage by referencing a package in a package repository
|
|
514
|
-
*/
|
|
515
|
-
loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
|
|
516
|
-
protected processLoadComponentSettingsFromRepository(response: Response): Promise<ErrorResponse[]>;
|
|
517
|
-
/**
|
|
518
|
-
* Save a TapPackage containing component settings in a package repository
|
|
519
|
-
* @return Settings TapPackage uploaded.
|
|
520
|
-
*/
|
|
521
|
-
saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
|
|
522
|
-
protected processSaveComponentSettingsToRepository(response: Response): Promise<void>;
|
|
523
|
-
/**
|
|
524
|
-
* Retrieve types available to be added to specified component settings list
|
|
525
|
-
*/
|
|
526
|
-
getComponentSettingsListAvailableTypes(groupName: string | null, name: string | null): Promise<ListItemType[]>;
|
|
527
|
-
protected processGetComponentSettingsListAvailableTypes(response: Response): Promise<ListItemType[]>;
|
|
528
|
-
/**
|
|
529
|
-
* Adds a new item to a component settings list
|
|
530
|
-
*/
|
|
531
|
-
addComponentSettingsListItem(groupName: string | null, name: string | null, typeName: string | null): Promise<ComponentSettingsBase>;
|
|
532
|
-
protected processAddComponentSettingsListItem(response: Response): Promise<ComponentSettingsBase>;
|
|
533
258
|
/**
|
|
534
259
|
* Retrieve settings types used in creating a Settings TapPackage
|
|
535
260
|
*/
|
|
536
261
|
getSettingsTypes(): Promise<string[]>;
|
|
537
262
|
protected processGetSettingsTypes(response: Response): Promise<string[]>;
|
|
538
|
-
/**
|
|
539
|
-
* Download a TapPackage containing settings files
|
|
540
|
-
*/
|
|
541
|
-
downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
|
|
542
|
-
protected processDownloadSettingsPackage(response: Response): Promise<FileResponse>;
|
|
543
263
|
}
|