This repository has been archived by the owner on Aug 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 38
/
manager.spec.ts
432 lines (388 loc) · 13.3 KB
/
manager.spec.ts
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { expect } from 'chai';
import { ServiceManager } from '@jupyterlab/services';
import { Widget } from '@phosphor/widgets';
import { DocumentManager } from '@jupyterlab/docmanager';
import {
DocumentRegistry,
TextModelFactory,
ABCWidgetFactory,
DocumentWidget,
IDocumentWidget
} from '@jupyterlab/docregistry';
import { dismissDialog } from '@jupyterlab/testutils';
class WidgetFactory extends ABCWidgetFactory<IDocumentWidget> {
protected createNewWidget(
context: DocumentRegistry.Context
): IDocumentWidget {
const content = new Widget();
const widget = new DocumentWidget({ content, context });
widget.addClass('WidgetFactory');
return widget;
}
}
/**
* A test documentWidget that maintains some state in
* count
*/
class CloneTestWidget extends DocumentWidget {
constructor(args: any) {
super(args);
this.counter = args.count;
}
counter: number = 0;
}
/**
* A widget factory for CloneTestWidget widgets
*/
class WidgetFactoryWithSharedState extends ABCWidgetFactory<CloneTestWidget> {
protected createNewWidget(
context: DocumentRegistry.Context
): CloneTestWidget {
return new CloneTestWidget({ context, content: new Widget(), count: 0 });
}
clone(widget: CloneTestWidget, context: DocumentRegistry.Context) {
return new CloneTestWidget({
context,
content: new Widget(),
count: widget.counter + 1
});
}
}
describe('@jupyterlab/docmanager', () => {
let manager: DocumentManager;
let services: ServiceManager.IManager;
let context: DocumentRegistry.Context;
let widget: Widget;
const textModelFactory = new TextModelFactory();
const widgetFactory = new WidgetFactory({
name: 'test',
fileTypes: ['text'],
canStartKernel: true,
preferKernel: true
});
const widgetFactoryShared = new WidgetFactoryWithSharedState({
name: 'CloneTestWidget',
fileTypes: []
});
before(() => {
services = new ServiceManager({ standby: 'never' });
return services.ready;
});
beforeEach(() => {
const registry = new DocumentRegistry({ textModelFactory });
registry.addWidgetFactory(widgetFactory);
registry.addWidgetFactory(widgetFactoryShared);
DocumentRegistry.defaultFileTypes.forEach(ft => {
registry.addFileType(ft);
});
manager = new DocumentManager({
registry,
manager: services,
opener: {
open: (widget: Widget) => {
// no-op
}
}
});
});
afterEach(() => {
manager.dispose();
});
describe('DocumentWidgetManager', () => {
describe('#constructor()', () => {
it('should create a new document manager', () => {
expect(manager).to.be.an.instanceof(DocumentManager);
});
});
describe('#isDisposed', () => {
it('should test whether the manager is disposed', () => {
expect(manager.isDisposed).to.equal(false);
manager.dispose();
expect(manager.isDisposed).to.equal(true);
});
});
describe('#dispose()', () => {
it('should dispose of the resources used by the manager', () => {
expect(manager.isDisposed).to.equal(false);
manager.dispose();
expect(manager.isDisposed).to.equal(true);
manager.dispose();
expect(manager.isDisposed).to.equal(true);
});
});
describe('#services', () => {
it('should get the service manager for the manager', () => {
expect(manager.services).to.be.an.instanceof(ServiceManager);
});
});
describe('#registry', () => {
it('should get the registry used by the manager', () => {
expect(manager.registry).to.be.an.instanceof(DocumentRegistry);
});
});
describe('#open()', () => {
it('should open a file and return the widget used to view it', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.open(model.path);
expect(widget.hasClass('WidgetFactory')).to.equal(true);
await dismissDialog();
});
it('should start a kernel if one is given', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
const session = await services.sessions.startNew({ path: model.path });
const id = session.kernel.id;
widget = manager.open(session.path, 'default', { id });
context = manager.contextForWidget(widget);
await context.session.ready;
expect(context.session.kernel).to.be.ok;
await context.session.shutdown();
});
it('should not auto-start a kernel if there is none given', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.open(model.path, 'default');
context = manager.contextForWidget(widget);
await dismissDialog();
expect(context.session.kernel).to.be.null;
});
it('should return undefined if the factory is not found', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.open(model.path, 'foo');
expect(widget).to.be.undefined;
});
it('should return undefined if the factory has no model factory', async () => {
const widgetFactory2 = new WidgetFactory({
name: 'test',
modelName: 'foo',
fileTypes: ['text']
});
manager.registry.addWidgetFactory(widgetFactory2);
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.open(model.path, 'foo');
expect(widget).to.be.undefined;
});
});
describe('#createNew()', () => {
it('should open a file and return the widget used to view it', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path);
expect(widget.hasClass('WidgetFactory')).to.equal(true);
await dismissDialog();
});
it('should start a kernel if one is given', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
const session = await services.sessions.startNew({ path: model.path });
const id = session.kernel.id;
widget = manager.createNew(session.path, 'default', { id });
context = manager.contextForWidget(widget);
await context.session.ready;
expect(context.session.kernel.id).to.equal(id);
await context.session.shutdown();
});
it('should not start a kernel if not given', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path, 'default');
context = manager.contextForWidget(widget);
await dismissDialog();
expect(context.session.kernel).to.be.null;
});
it('should return undefined if the factory is not found', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path, 'foo');
expect(widget).to.be.undefined;
});
it('should return undefined if the factory has no model factory', async () => {
const widgetFactory2 = new WidgetFactory({
name: 'test',
modelName: 'foo',
fileTypes: ['text']
});
manager.registry.addWidgetFactory(widgetFactory2);
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path, 'foo');
expect(widget).to.be.undefined;
});
});
describe('#findWidget()', () => {
it('should find a widget given a file and a widget name', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path);
expect(manager.findWidget(model.path, 'test')).to.equal(widget);
await dismissDialog();
});
it('should find a widget given a file', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path);
expect(manager.findWidget(model.path)).to.equal(widget);
await dismissDialog();
});
it('should fail to find a widget', () => {
expect(manager.findWidget('foo')).to.be.undefined;
});
it('should fail to find a widget with non default factory and the default widget name', async () => {
const widgetFactory2 = new WidgetFactory({
name: 'test2',
fileTypes: ['text']
});
manager.registry.addWidgetFactory(widgetFactory2);
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path, 'test2');
expect(manager.findWidget(model.path)).to.be.undefined;
});
it('should find a widget with non default factory given a file and a null widget name', async () => {
const widgetFactory2 = new WidgetFactory({
name: 'test2',
fileTypes: ['text']
});
manager.registry.addWidgetFactory(widgetFactory2);
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path, 'test2');
expect(manager.findWidget(model.path, null)).to.equal(widget);
await dismissDialog();
});
});
describe('#contextForWidget()', () => {
it('should find the context for a widget', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path);
context = manager.contextForWidget(widget);
expect(context.path).to.equal(model.path);
await dismissDialog();
});
it('should fail to find the context for the widget', () => {
widget = new Widget();
expect(manager.contextForWidget(widget)).to.be.undefined;
});
});
describe('#cloneWidget()', () => {
it('should clone the given widget', async () => {
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
widget = manager.createNew(model.path);
const clone = manager.cloneWidget(widget);
expect(manager.contextForWidget(widget)).to.equal(
manager.contextForWidget(clone)
);
await dismissDialog();
});
it('should return undefined if the source widget is not managed', () => {
widget = new Widget();
expect(manager.cloneWidget(widget)).to.be.undefined;
});
it('should allow widget factories to override clone', () => {
widget = manager.createNew('foo', 'CloneTestWidget');
const clonedWidget: CloneTestWidget = manager.cloneWidget(
widget
) as CloneTestWidget;
expect(clonedWidget.counter).to.equal(1);
const newWidget: CloneTestWidget = manager.createNew(
'bar',
'CloneTestWidget'
) as CloneTestWidget;
expect(newWidget.counter).to.equal(0);
expect(
(manager.cloneWidget(clonedWidget) as CloneTestWidget).counter
).to.equal(2);
});
});
describe('#closeFile()', () => {
it('should close the widgets associated with a given path', async () => {
let called = 0;
let path = '';
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
path = model.path;
widget = manager.createNew(path);
const clone = manager.cloneWidget(widget);
widget.disposed.connect(() => {
called++;
});
clone.disposed.connect(() => {
called++;
});
await dismissDialog();
await manager.closeFile(path);
expect(called).to.equal(2);
});
it('should be a no-op if there are no open files on that path', () => {
return manager.closeFile('foo');
});
});
describe('#closeAll()', () => {
it('should close all of the open documents', async () => {
let called = 0;
let path = '';
const model = await services.contents.newUntitled({
type: 'file',
ext: '.txt'
});
path = model.path;
const widget0 = manager.createNew(path);
widget0.disposed.connect(() => {
called++;
});
await dismissDialog();
const widget1 = manager.createNew(path);
widget1.disposed.connect(() => {
called++;
});
await dismissDialog();
await manager.closeAll();
expect(called).to.equal(2);
});
it('should be a no-op if there are no open documents', async () => {
await manager.closeAll();
});
});
});
});