forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
widget.spec.ts
571 lines (489 loc) · 18.2 KB
/
widget.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { expect } from 'chai';
import { Message, MessageLoop } from '@phosphor/messaging';
import { Widget } from '@phosphor/widgets';
import { ClientSession, IClientSession } from '@jupyterlab/apputils';
import { CodeEditor, CodeEditorWrapper } from '@jupyterlab/codeeditor';
import {
Cell,
CellModel,
InputPrompt,
CodeCell,
CodeCellModel,
MarkdownCell,
RawCell,
RawCellModel,
MarkdownCellModel,
CellFooter,
CellHeader,
InputArea
} from '@jupyterlab/cells';
import { OutputArea, OutputPrompt } from '@jupyterlab/outputarea';
import {
createClientSession,
framePromise,
NBTestUtils
} from '@jupyterlab/testutils';
const RENDERED_CLASS = 'jp-mod-rendered';
const rendermime = NBTestUtils.defaultRenderMime();
class LogBaseCell extends Cell {
methods: string[] = [];
constructor() {
super({
model: new CellModel({}),
contentFactory: NBTestUtils.createBaseCellFactory()
});
}
protected onAfterAttach(msg: Message): void {
super.onAfterAttach(msg);
this.methods.push('onAfterAttach');
}
protected onActivateRequest(msg: Message): void {
super.onActivateRequest(msg);
this.methods.push('onActivateRequest');
}
protected onUpdateRequest(msg: Message): void {
super.onUpdateRequest(msg);
this.methods.push('onUpdateRequest');
}
}
class LogCodeCell extends CodeCell {
methods: string[] = [];
constructor() {
super({
model: new CodeCellModel({}),
contentFactory: NBTestUtils.createCodeCellFactory(),
rendermime
});
}
protected onUpdateRequest(msg: Message): void {
super.onAfterAttach(msg);
this.methods.push('onUpdateRequest');
}
protected onMetadataChanged(model: any, args: any): void {
super.onMetadataChanged(model, args);
this.methods.push('onMetadataChanged');
}
}
class LogMarkdownCell extends MarkdownCell {
methods: string[] = [];
protected onUpdateRequest(msg: Message): void {
super.onAfterAttach(msg);
this.methods.push('onUpdateRequest');
}
}
describe('cells/widget', () => {
const editorFactory = NBTestUtils.editorFactory;
describe('Cell', () => {
const contentFactory = NBTestUtils.createBaseCellFactory();
const model = new CellModel({});
describe('#constructor()', () => {
it('should create a base cell widget', () => {
const widget = new Cell({ model, contentFactory });
expect(widget).to.be.an.instanceof(Cell);
});
it('should accept a custom contentFactory', () => {
const contentFactory = NBTestUtils.createBaseCellFactory();
const widget = new Cell({ model, contentFactory });
expect(widget).to.be.an.instanceof(Cell);
});
it('shoule accept a custom editorConfig', () => {
const editorConfig: Partial<CodeEditor.IConfig> = {
insertSpaces: false,
matchBrackets: false
};
const widget = new Cell({ editorConfig, model, contentFactory });
expect(widget.editor.getOption('insertSpaces')).to.equal(false);
expect(widget.editor.getOption('matchBrackets')).to.equal(false);
expect(widget.editor.getOption('lineNumbers')).to.equal(
CodeEditor.defaultConfig.lineNumbers
);
});
});
describe('#model', () => {
it('should be the model used by the widget', () => {
const model = new CellModel({});
const widget = new Cell({ model, contentFactory });
expect(widget.model).to.equal(model);
});
});
describe('#editorWidget', () => {
it('should be a code editor widget', () => {
const widget = new Cell({ model, contentFactory });
expect(widget.editorWidget).to.be.an.instanceof(CodeEditorWrapper);
});
});
describe('#editor', () => {
it('should be a cell editor', () => {
const widget = new Cell({ model, contentFactory });
expect(widget.editor.uuid).to.be.ok;
});
});
describe('#inputArea', () => {
it('should be the input area for the cell', () => {
const widget = new Cell({ model });
expect(widget.inputArea).to.be.an.instanceof(InputArea);
});
});
describe('#readOnly', () => {
it('should be a boolean', () => {
const widget = new Cell({ model, contentFactory });
expect(typeof widget.readOnly).to.equal('boolean');
});
it('should default to false', () => {
const widget = new Cell({ model, contentFactory });
expect(widget.readOnly).to.equal(false);
});
it('should be settable', () => {
const widget = new Cell({
model,
contentFactory
});
widget.readOnly = true;
expect(widget.readOnly).to.equal(true);
});
it('should ignore being set to the same value', async () => {
const widget = new LogBaseCell();
widget.readOnly = true;
widget.readOnly = true;
await framePromise();
expect(widget.methods).to.deep.equal(['onUpdateRequest']);
});
});
describe('#inputCollapsed', () => {
it('should be the view state of the input being collapsed', () => {
const widget = new LogBaseCell();
expect(widget.inputHidden).to.equal(false);
widget.inputHidden = true;
expect(widget.inputHidden).to.equal(true);
});
});
describe('#onActivateRequest()', () => {
it('should focus the cell editor', async () => {
const widget = new LogBaseCell();
Widget.attach(widget, document.body);
widget.activate();
await framePromise();
expect(widget.methods).to.contain('onActivateRequest');
await framePromise();
expect(widget.editor.hasFocus()).to.equal(true);
widget.dispose();
});
});
describe('#setPrompt()', () => {
it('should not throw an error (full test in input area)', () => {
const widget = new Cell({ model, contentFactory });
expect(() => {
widget.setPrompt(void 0);
}).to.not.throw;
expect(() => {
widget.setPrompt(null);
}).to.not.throw();
expect(() => {
widget.setPrompt('');
}).to.not.throw();
expect(() => {
widget.setPrompt('null');
}).to.not.throw();
expect(() => {
widget.setPrompt('test');
}).to.not.throw();
});
});
describe('#dispose()', () => {
it('should dispose of the resources held by the widget', () => {
const widget = new Cell({ model, contentFactory });
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
it('should be safe to call multiple times', () => {
const widget = new Cell({ model, contentFactory });
widget.dispose();
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
});
describe('#onAfterAttach()', () => {
it('should run when widget is attached', () => {
const widget = new LogBaseCell();
expect(widget.methods).to.not.contain('onAfterAttach');
Widget.attach(widget, document.body);
expect(widget.methods).to.contain('onAfterAttach');
widget.dispose();
});
});
describe('#onUpdateRequest()', () => {
it('should update the widget', () => {
const widget = new LogBaseCell();
expect(widget.methods).to.not.contain('onUpdateRequest');
MessageLoop.sendMessage(widget, Widget.Msg.UpdateRequest);
expect(widget.methods).to.contain('onUpdateRequest');
});
});
describe('#.defaultContentFactory', () => {
it('should be a contentFactory', () => {
expect(Cell.defaultContentFactory).to.be.an.instanceof(
Cell.ContentFactory
);
});
});
describe('.ContentFactory', () => {
describe('#constructor', () => {
it('should create a ContentFactory', () => {
const factory = new Cell.ContentFactory({ editorFactory });
expect(factory).to.be.an.instanceof(Cell.ContentFactory);
});
});
describe('#editorFactory', () => {
it('should be the editor factory used by the content factory', () => {
const factory = new Cell.ContentFactory({ editorFactory });
expect(factory.editorFactory).to.equal(editorFactory);
});
});
describe('#createCellHeader()', () => {
it('should create a new cell header', () => {
const factory = new Cell.ContentFactory();
expect(factory.createCellHeader()).to.be.an.instanceof(CellHeader);
});
});
describe('#createCellFooter()', () => {
it('should create a new cell footer', () => {
const factory = new Cell.ContentFactory();
expect(factory.createCellFooter()).to.be.an.instanceof(CellFooter);
});
});
describe('#createOutputPrompt()', () => {
it('should create a new output prompt', () => {
const factory = new Cell.ContentFactory();
expect(factory.createOutputPrompt()).to.be.an.instanceof(
OutputPrompt
);
});
});
describe('#createInputPrompt()', () => {
it('should create a new input prompt', () => {
const factory = new Cell.ContentFactory();
expect(factory.createInputPrompt()).to.be.an.instanceof(InputPrompt);
});
});
});
});
describe('CodeCell', () => {
const contentFactory = NBTestUtils.createCodeCellFactory();
const model = new CodeCellModel({});
describe('#constructor()', () => {
it('should create a code cell widget', () => {
const widget = new CodeCell({ model, rendermime, contentFactory });
expect(widget).to.be.an.instanceof(CodeCell);
});
it('should accept a custom contentFactory', () => {
const contentFactory = NBTestUtils.createCodeCellFactory();
const widget = new CodeCell({ model, contentFactory, rendermime });
expect(widget).to.be.an.instanceof(CodeCell);
});
});
describe('#outputArea', () => {
it('should be the output area used by the cell', () => {
const widget = new CodeCell({ model, rendermime });
expect(widget.outputArea).to.be.an.instanceof(OutputArea);
});
});
describe('#outputCollapsed', () => {
it('should initialize from the model', () => {
const collapsedModel = new CodeCellModel({});
let widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputHidden).to.equal(false);
collapsedModel.metadata.set('collapsed', true);
collapsedModel.metadata.set('jupyter', { outputs_hidden: false });
widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputHidden).to.equal(true);
collapsedModel.metadata.set('collapsed', false);
collapsedModel.metadata.set('jupyter', { outputs_hidden: true });
widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputHidden).to.equal(true);
});
it('should be the view state of the output being collapsed', () => {
const widget = new CodeCell({ model, rendermime });
expect(widget.outputHidden).to.equal(false);
widget.outputHidden = true;
expect(widget.outputHidden).to.equal(true);
});
});
describe('#outputsScrolled', () => {
it('should initialize from the model', () => {
const collapsedModel = new CodeCellModel({});
let widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputsScrolled).to.equal(false);
collapsedModel.metadata.set('scrolled', false);
widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputsScrolled).to.equal(false);
collapsedModel.metadata.set('scrolled', 'auto');
widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputsScrolled).to.equal(false);
collapsedModel.metadata.set('scrolled', true);
widget = new CodeCell({ model: collapsedModel, rendermime });
expect(widget.outputsScrolled).to.equal(true);
});
});
describe('#dispose()', () => {
it('should dispose of the resources held by the widget', () => {
const widget = new CodeCell({ model, rendermime, contentFactory });
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
it('should be safe to call multiple times', () => {
const widget = new CodeCell({ model, rendermime, contentFactory });
widget.dispose();
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
});
describe('#onUpdateRequest()', () => {
it('should update the widget', () => {
const widget = new LogCodeCell();
expect(widget.methods).to.not.contain('onUpdateRequest');
MessageLoop.sendMessage(widget, Widget.Msg.UpdateRequest);
expect(widget.methods).to.contain('onUpdateRequest');
});
});
describe('#onMetadataChanged()', () => {
it('should fire when model metadata changes', () => {
const method = 'onMetadataChanged';
const widget = new LogCodeCell();
expect(widget.methods).to.not.contain(method);
widget.model.metadata.set('foo', 1);
expect(widget.methods).to.contain(method);
});
});
describe('.execute()', () => {
let session: IClientSession;
beforeEach(async () => {
session = await createClientSession();
await (session as ClientSession).initialize();
await session.kernel.ready;
});
afterEach(() => {
return session.shutdown();
});
it('should fulfill a promise if there is no code to execute', async () => {
const widget = new CodeCell({ model, rendermime, contentFactory });
try {
await CodeCell.execute(widget, session);
} catch (error) {
console.log('IT BREAKS HERE');
throw error;
}
});
it('should fulfill a promise if there is code to execute', async () => {
const widget = new CodeCell({ model, rendermime, contentFactory });
let originalCount: number;
widget.model.value.text = 'foo';
originalCount = widget.model.executionCount;
await CodeCell.execute(widget, session);
const executionCount = widget.model.executionCount;
expect(executionCount).to.not.equal(originalCount);
});
});
});
describe('MarkdownCell', () => {
const contentFactory = NBTestUtils.createBaseCellFactory();
const model = new MarkdownCellModel({});
describe('#constructor()', () => {
it('should create a markdown cell widget', () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
expect(widget).to.be.an.instanceof(MarkdownCell);
});
it('should accept a custom contentFactory', () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
expect(widget).to.be.an.instanceof(MarkdownCell);
});
it('should set the default mimetype to text/x-ipythongfm', () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
expect(widget.model.mimeType).to.equal('text/x-ipythongfm');
});
});
describe('#rendered', () => {
it('should default to true', async () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
Widget.attach(widget, document.body);
expect(widget.rendered).to.equal(true);
await framePromise();
expect(widget.node.classList.contains(RENDERED_CLASS)).to.equal(true);
});
it('should unrender the widget', async () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
Widget.attach(widget, document.body);
widget.rendered = false;
await framePromise();
expect(widget.node.classList.contains(RENDERED_CLASS)).to.equal(false);
widget.dispose();
});
it('should ignore being set to the same value', async () => {
const widget = new LogMarkdownCell({
model,
rendermime,
contentFactory
});
Widget.attach(widget, document.body);
widget.rendered = false;
widget.rendered = false;
await framePromise();
const updates = widget.methods.filter(method => {
return method === 'onUpdateRequest';
});
expect(updates).to.have.length(1);
widget.dispose();
});
});
describe('#dispose()', () => {
it('should dispose of the resources held by the widget', () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
it('should be safe to call multiple times', () => {
const widget = new MarkdownCell({ model, rendermime, contentFactory });
widget.dispose();
widget.dispose();
expect(widget.isDisposed).to.equal(true);
});
});
describe('#onUpdateRequest()', () => {
it('should update the widget', () => {
const widget = new LogMarkdownCell({
model,
rendermime,
contentFactory
});
expect(widget.methods).to.not.contain('onUpdateRequest');
MessageLoop.sendMessage(widget, Widget.Msg.UpdateRequest);
expect(widget.methods).to.contain('onUpdateRequest');
});
});
});
describe('RawCell', () => {
const contentFactory = NBTestUtils.createBaseCellFactory();
describe('#constructor()', () => {
it('should create a raw cell widget', () => {
const model = new RawCellModel({});
const widget = new RawCell({ model, contentFactory });
expect(widget).to.be.an.instanceof(RawCell);
});
});
});
describe('CellHeader', () => {
describe('#constructor()', () => {
it('should create a new cell header', () => {
expect(new CellHeader()).to.be.an.instanceof(CellHeader);
});
});
});
describe('CellFooter', () => {
describe('#constructor()', () => {
it('should create a new cell footer', () => {
expect(new CellFooter()).to.be.an.instanceof(CellFooter);
});
});
});
});