forked from google/blockly
-
Notifications
You must be signed in to change notification settings - Fork 0
/
icon_test.js
369 lines (318 loc) · 11.5 KB
/
icon_test.js
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
/**
* @license
* Copyright 2023 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {assert} from '../../node_modules/chai/chai.js';
import {
sharedTestSetup,
sharedTestTeardown,
} from './test_helpers/setup_teardown.js';
import {defineEmptyBlock} from './test_helpers/block_definitions.js';
import {MockIcon, MockSerializableIcon} from './test_helpers/icon_mocks.js';
suite('Icon', function () {
setup(function () {
this.clock = sharedTestSetup.call(this, {fireEventsNow: false}).clock;
defineEmptyBlock();
});
teardown(function () {
sharedTestTeardown.call(this);
});
class MockNonSerializableIcon extends MockIcon {
getType() {
return 'non-serializable icon';
}
}
function createHeadlessWorkspace() {
return new Blockly.Workspace();
}
function createWorkspaceSvg() {
const workspace = new Blockly.WorkspaceSvg(new Blockly.Options({}));
workspace.createDom();
return workspace;
}
function createUninitializedBlock(workspace) {
return workspace.newBlock('empty_block');
}
function createInitializedBlock(workspace) {
const block = workspace.newBlock('empty_block');
block.initSvg();
block.render();
return block;
}
function createHeadlessBlock(workspace) {
return createUninitializedBlock(workspace);
}
suite('Hooks getting properly triggered by the block', function () {
suite('Triggering view initialization', function () {
test('initView is not called by headless blocks', function () {
const workspace = createHeadlessWorkspace();
const block = createUninitializedBlock(workspace);
const icon = new MockIcon();
const initViewSpy = sinon.spy(icon, 'initView');
block.addIcon(icon);
assert.isFalse(
initViewSpy.called,
'Expected initView to not be called',
);
});
test(
'initView is called by headful blocks that are currently ' +
'rendered when the icon is added',
function () {
const workspace = new Blockly.WorkspaceSvg(new Blockly.Options({}));
workspace.createDom();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const initViewSpy = sinon.spy(icon, 'initView');
block.addIcon(icon);
assert.isTrue(
initViewSpy.calledOnce,
'Expected initView to be called',
);
},
);
});
suite('Triggering applying colors', function () {
test('applyColour is not called by headless blocks', function () {
const workspace = createHeadlessWorkspace();
const block = createUninitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
assert.isFalse(
applyColourSpy.called,
'Expected applyColour to not be called',
);
});
test(
'applyColour is called by headful blocks that are currently ' +
'rendered when the icon is added',
function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
assert.isTrue(
applyColourSpy.calledOnce,
'Expected applyColour to be called',
);
},
);
test("applyColour is called when the block's color changes", function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
applyColourSpy.resetHistory();
block.setColour('#cccccc');
assert.isTrue(
applyColourSpy.calledOnce,
'Expected applyColour to be called',
);
});
test("applyColour is called when the block's style changes", function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
applyColourSpy.resetHistory();
block.setStyle('logic_block');
assert.isTrue(
applyColourSpy.calledOnce,
'Expected applyColour to be called',
);
});
test('applyColour is called when the block is disabled', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
applyColourSpy.resetHistory();
block.setDisabledReason(true, 'test reason');
assert.isTrue(
applyColourSpy.calledOnce,
'Expected applyColour to be called',
);
});
test('applyColour is called when the block becomes a shadow', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const applyColourSpy = sinon.spy(icon, 'applyColour');
block.addIcon(icon);
applyColourSpy.resetHistory();
block.setShadow(true);
assert.isTrue(
applyColourSpy.calledOnce,
'Expected applyColour to be called',
);
});
});
suite('Triggering updating editability', function () {
test('updateEditable is not called by headless blocks', function () {
const workspace = createHeadlessWorkspace();
const block = createUninitializedBlock(workspace);
const icon = new MockIcon();
const updateEditableSpy = sinon.spy(icon, 'updateEditable');
block.addIcon(icon);
assert.isFalse(
updateEditableSpy.called,
'Expected updateEditable to not be called',
);
});
test(
'updateEditable is called by headful blocks that are currently ' +
'rendered when the icon is added',
function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const updateEditableSpy = sinon.spy(icon, 'updateEditable');
block.addIcon(icon);
assert.isTrue(
updateEditableSpy.calledOnce,
'Expected updateEditable to be called',
);
},
);
test('updateEditable is called when the block is made ineditable', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const updateEditableSpy = sinon.spy(icon, 'updateEditable');
block.addIcon(icon);
updateEditableSpy.resetHistory();
block.setEditable(false);
assert.isTrue(
updateEditableSpy.calledOnce,
'Expected updateEditable to be called',
);
});
test('updateEditable is called when the block is made editable', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const updateEditableSpy = sinon.spy(icon, 'updateEditable');
block.addIcon(icon);
block.setEditable(false);
updateEditableSpy.resetHistory();
block.setEditable(true);
assert.isTrue(
updateEditableSpy.calledOnce,
'Expected updateEditable to be called',
);
});
});
suite('Triggering updating collapsed-ness', function () {
test('updateCollapsed is not called by headless blocks', function () {
const workspace = createHeadlessWorkspace();
const block = createUninitializedBlock(workspace);
const icon = new MockIcon();
const updateCollapsedSpy = sinon.spy(icon, 'updateCollapsed');
block.addIcon(icon);
block.setCollapsed(true);
block.setCollapsed(false);
assert.isFalse(
updateCollapsedSpy.called,
'Expected updateCollapsed to not be called',
);
});
test('updateCollapsed is called when the block is collapsed', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const updateCollapsedSpy = sinon.stub(icon, 'updateCollapsed');
block.addIcon(icon);
updateCollapsedSpy.resetHistory();
block.setCollapsed(true);
this.clock.runAll();
assert.isTrue(
updateCollapsedSpy.called,
'Expected updateCollapsed to be called',
);
});
test('updateCollapsed is called when the block is expanded', function () {
const workspace = createWorkspaceSvg();
const block = createInitializedBlock(workspace);
const icon = new MockIcon();
const updateCollapsedSpy = sinon.spy(icon, 'updateCollapsed');
block.addIcon(icon);
block.setCollapsed(true);
block.setCollapsed(false);
this.clock.runAll();
assert.isTrue(
updateCollapsedSpy.called,
'Expected updateCollapsed to be called',
);
});
});
});
suite('Serialization', function () {
test('serializable icons are saved', function () {
const block = createHeadlessBlock(createHeadlessWorkspace());
block.addIcon(new MockSerializableIcon());
const json = Blockly.serialization.blocks.save(block);
assert.deepNestedInclude(
json,
{'icons': {'serializable icon': 'some state'}},
'Expected the JSON to include the saved state of the ' +
'serializable icon.',
);
});
test('non-serializable icons are not saved', function () {
const block = createHeadlessBlock(createHeadlessWorkspace());
block.addIcon(new MockNonSerializableIcon());
const json = Blockly.serialization.blocks.save(block);
assert.notProperty(
json,
'icons',
'Expected the JSON to not include any saved state for icons',
);
});
});
suite('Deserialization', function () {
test('registered icons are instantiated and added to the block', function () {
Blockly.icons.registry.register(
'serializable icon',
MockSerializableIcon,
);
const workspace = createHeadlessWorkspace();
const json = {
'type': 'empty_block',
'icons': {
'serializable icon': 'some state',
},
};
const block = Blockly.serialization.blocks.append(json, workspace);
assert.equal(
block.getIcon('serializable icon').state,
'some state',
'Expected the icon to have been properly instantiated and ' +
'deserialized',
);
Blockly.icons.registry.unregister('serializable icon');
});
test('trying to deserialize an unregistered icon throws an error', function () {
const workspace = createHeadlessWorkspace();
const json = {
'type': 'empty_block',
'icons': {
'serializable icon': 'some state',
},
};
assert.throws(
() => {
Blockly.serialization.blocks.append(json, workspace);
},
Blockly.serialization.exceptions.UnregisteredIcon,
'',
'Expected deserializing an unregistered icon to throw',
);
});
});
});