Spaces:
Running
Running
File size: 15,821 Bytes
30c32c8 |
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 |
const test = require('tap').test;
const path = require('path');
const VirtualMachine = require('../../src/index');
const Runtime = require('../../src/engine/runtime');
const sb3 = require('../../src/serialization/sb3');
const readFileToBuffer = require('../fixtures/readProjectFile').readFileToBuffer;
const exampleProjectPath = path.resolve(__dirname, '../fixtures/clone-cleanup.sb2');
const commentsSB2ProjectPath = path.resolve(__dirname, '../fixtures/comments.sb2');
const commentsSB3ProjectPath = path.resolve(__dirname, '../fixtures/comments.sb3');
const commentsSB3NoDupeIds = path.resolve(__dirname, '../fixtures/comments_no_duplicate_id_serialization.sb3');
const variableReporterSB2ProjectPath = path.resolve(__dirname, '../fixtures/top-level-variable-reporter.sb2');
const topLevelReportersProjectPath = path.resolve(__dirname, '../fixtures/top-level-reporters.sb3');
const draggableSB3ProjectPath = path.resolve(__dirname, '../fixtures/draggable.sb3');
const originSB3ProjectPath = path.resolve(__dirname, '../fixtures/origin.sb3');
const originAbsentSB3ProjectPath = path.resolve(__dirname, '../fixtures/origin-absent.sb3');
const FakeRenderer = require('../fixtures/fake-renderer');
test('serialize', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(exampleProjectPath))
.then(() => {
const result = sb3.serialize(vm.runtime);
// @todo Analyze
t.type(JSON.stringify(result), 'string');
t.end();
});
});
test('deserialize', t => {
const vm = new VirtualMachine();
sb3.deserialize('', vm.runtime).then(({targets}) => {
// @todo Analyze
t.type(targets, 'object');
t.end();
});
});
test('serialize sb2 project with comments as sb3', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB2ProjectPath))
.then(() => {
const result = sb3.serialize(vm.runtime);
t.type(JSON.stringify(result), 'string');
t.type(result.targets, 'object');
t.equal(Array.isArray(result.targets), true);
t.equal(result.targets.length, 2);
const stage = result.targets[0];
t.equal(stage.isStage, true);
// The stage has 0 blocks, and 1 workspace comment
t.type(stage.blocks, 'object');
t.equal(Object.keys(stage.blocks).length, 0);
t.type(stage.comments, 'object');
t.equal(Object.keys(stage.comments).length, 1);
const stageBlockComments = Object.values(stage.comments).filter(comment => !!comment.blockId);
const stageWorkspaceComments = Object.values(stage.comments).filter(comment => comment.blockId === null);
t.equal(stageBlockComments.length, 0);
t.equal(stageWorkspaceComments.length, 1);
const sprite = result.targets[1];
t.equal(sprite.isStage, false);
t.type(sprite.blocks, 'object');
// Sprite 1 has 6 blocks, 5 block comments, and 1 workspace comment
t.equal(Object.keys(sprite.blocks).length, 6);
t.type(sprite.comments, 'object');
t.equal(Object.keys(sprite.comments).length, 6);
const spriteBlockComments = Object.values(sprite.comments).filter(comment => !!comment.blockId);
const spriteWorkspaceComments = Object.values(sprite.comments).filter(comment => comment.blockId === null);
t.equal(spriteBlockComments.length, 5);
t.equal(spriteWorkspaceComments.length, 1);
t.end();
});
});
test('deserialize sb3 project with comments', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB3ProjectPath))
.then(() => {
const runtime = vm.runtime;
t.type(runtime.targets, 'object');
t.equal(Array.isArray(runtime.targets), true);
t.equal(runtime.targets.length, 2);
const stage = runtime.targets[0];
t.equal(stage.isStage, true);
// The stage has 0 blocks, and 1 workspace comment
t.type(stage.blocks, 'object');
t.equal(Object.keys(stage.blocks._blocks).length, 0);
t.type(stage.comments, 'object');
t.equal(Object.keys(stage.comments).length, 1);
const stageBlockComments = Object.values(stage.comments).filter(comment => !!comment.blockId);
const stageWorkspaceComments = Object.values(stage.comments).filter(comment => comment.blockId === null);
t.equal(stageBlockComments.length, 0);
t.equal(stageWorkspaceComments.length, 1);
const sprite = runtime.targets[1];
t.equal(sprite.isStage, false);
t.type(sprite.blocks, 'object');
// Sprite 1 has 6 blocks, 5 block comments, and 1 workspace comment
t.equal(Object.values(sprite.blocks._blocks).filter(block => !block.shadow).length, 6);
t.type(sprite.comments, 'object');
t.equal(Object.keys(sprite.comments).length, 6);
const spriteBlockComments = Object.values(sprite.comments).filter(comment => !!comment.blockId);
const spriteWorkspaceComments = Object.values(sprite.comments).filter(comment => comment.blockId === null);
t.equal(spriteBlockComments.length, 5);
t.equal(spriteWorkspaceComments.length, 1);
t.end();
});
});
test('deserialize sb3 project with comments - no duplicate id serialization', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB3NoDupeIds))
.then(() => {
const runtime = vm.runtime;
t.type(runtime.targets, 'object');
t.equal(Array.isArray(runtime.targets), true);
t.equal(runtime.targets.length, 2);
const stage = runtime.targets[0];
t.equal(stage.isStage, true);
// The stage has 0 blocks, and 0 workspace comment
t.type(stage.blocks, 'object');
t.equal(Object.keys(stage.blocks._blocks).length, 0);
t.type(stage.comments, 'object');
t.equal(Object.keys(stage.comments).length, 0);
const sprite = runtime.targets[1];
t.equal(sprite.isStage, false);
t.type(sprite.blocks, 'object');
// Sprite1 has 1 blocks, 1 block comment, and 1 workspace comment
t.equal(Object.values(sprite.blocks._blocks).filter(block => !block.shadow).length, 1);
t.type(sprite.comments, 'object');
t.equal(Object.keys(sprite.comments).length, 2);
const spriteBlockComments = Object.values(sprite.comments).filter(comment => !!comment.blockId);
const spriteWorkspaceComments = Object.values(sprite.comments).filter(comment => comment.blockId === null);
t.equal(spriteBlockComments.length, 1);
t.equal(spriteWorkspaceComments.length, 1);
t.end();
});
});
test('serializing and deserializing sb3 preserves sprite layer order', t => {
const vm = new VirtualMachine();
vm.attachRenderer(new FakeRenderer());
return vm.loadProject(readFileToBuffer(path.resolve(__dirname, '../fixtures/ordering.sb2')))
.then(() => {
// Target get layer order needs a renderer,
// fake the numbers we would get back from the
// renderer in order to test that they are serialized
// correctly
vm.runtime.targets[0].getLayerOrder = () => 0;
vm.runtime.targets[1].getLayerOrder = () => 20;
vm.runtime.targets[2].getLayerOrder = () => 10;
vm.runtime.targets[3].getLayerOrder = () => 30;
const result = sb3.serialize(vm.runtime);
t.type(JSON.stringify(result), 'string');
t.type(result.targets, 'object');
t.equal(Array.isArray(result.targets), true);
t.equal(result.targets.length, 4);
// First check that the sprites are ordered correctly (as they would
// appear in the target pane)
t.equal(result.targets[0].name, 'Stage');
t.equal(result.targets[1].name, 'First');
t.equal(result.targets[2].name, 'Second');
t.equal(result.targets[3].name, 'Third');
// Check that they are in the correct layer order (as they would render
// back to front on the stage)
t.equal(result.targets[0].layerOrder, 0);
t.equal(result.targets[1].layerOrder, 2);
t.equal(result.targets[2].layerOrder, 1);
t.equal(result.targets[3].layerOrder, 3);
return result;
})
.then(serializedObject =>
sb3.deserialize(
JSON.parse(JSON.stringify(serializedObject)), new Runtime(), null, false)
.then(({targets}) => {
// First check that the sprites are ordered correctly (as they would
// appear in the target pane)
t.equal(targets[0].sprite.name, 'Stage');
t.equal(targets[1].sprite.name, 'First');
t.equal(targets[2].sprite.name, 'Second');
t.equal(targets[3].sprite.name, 'Third');
// Check that they are in the correct layer order (as they would render
// back to front on the stage)
t.equal(targets[0].layerOrder, 0);
t.equal(targets[1].layerOrder, 2);
t.equal(targets[2].layerOrder, 1);
t.equal(targets[3].layerOrder, 3);
t.end();
}));
});
test('serializeBlocks', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB3ProjectPath))
.then(() => {
const blocks = vm.runtime.targets[1].blocks._blocks;
const result = sb3.serializeBlocks(blocks);
// @todo Analyze
t.type(result[0], 'object');
t.ok(Object.keys(result[0]).length < Object.keys(blocks).length, 'less blocks in serialized format');
t.ok(Array.isArray(result[1]));
t.end();
});
});
test('serializeBlocks serializes x and y for topLevel blocks with x,y of 0,0', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(topLevelReportersProjectPath))
.then(() => {
// Verify that there are 2 blocks and they are both top level
const blocks = vm.runtime.targets[1].blocks._blocks;
const blockIds = Object.keys(blocks);
t.equal(blockIds.length, 2);
const blocksArray = blockIds.map(key => blocks[key]);
t.equal(blocksArray.every(b => b.topLevel), true);
// Simulate cleaning up the blocks by resetting x and y positions to 0
blockIds.forEach(blockId => {
blocks[blockId].x = 0;
blocks[blockId].y = 0;
});
const result = sb3.serializeBlocks(blocks);
const serializedBlocks = result[0];
t.type(serializedBlocks, 'object');
const serializedBlockIds = Object.keys(serializedBlocks);
t.equal(serializedBlockIds.length, 2);
const firstBlock = serializedBlocks[serializedBlockIds[0]];
const secondBlock = serializedBlocks[serializedBlockIds[1]];
t.equal(firstBlock.x, 0);
t.equal(firstBlock.y, 0);
t.equal(secondBlock.x, 0);
t.equal(secondBlock.y, 0);
t.end();
});
});
test('deserializeBlocks', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB3ProjectPath))
.then(() => {
const blocks = vm.runtime.targets[1].blocks._blocks;
const serialized = sb3.serializeBlocks(blocks)[0];
const deserialized = sb3.deserializeBlocks(serialized);
t.equal(Object.keys(deserialized).length, Object.keys(blocks).length, 'same number of blocks');
t.end();
});
});
test('deserializeBlocks on already deserialized input', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(commentsSB3ProjectPath))
.then(() => {
const blocks = vm.runtime.targets[1].blocks._blocks;
const serialized = sb3.serializeBlocks(blocks)[0];
const deserialized = sb3.deserializeBlocks(serialized);
const deserializedAgain = sb3.deserializeBlocks(deserialized);
t.deepEqual(deserialized, deserializedAgain, 'no change from second pass of deserialize');
t.end();
});
});
test('getExtensionIdForOpcode', t => {
t.equal(sb3.getExtensionIdForOpcode('wedo_loopy'), 'wedo');
// does not consider CORE to be extensions
t.false(sb3.getExtensionIdForOpcode('control_loopy'));
// only considers things before the first underscore
t.equal(sb3.getExtensionIdForOpcode('hello_there_loopy'), 'hello');
// does not return anything for opcodes with no extension
t.false(sb3.getExtensionIdForOpcode('hello'));
// forbidden characters must be replaced with '-'
t.equal(sb3.getExtensionIdForOpcode('hi:there/happy_people'), 'hi-there-happy');
t.end();
});
test('(#1608) serializeBlocks maintains top level variable reporters', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(variableReporterSB2ProjectPath))
.then(() => {
const blocks = vm.runtime.targets[0].blocks._blocks;
const result = sb3.serialize(vm.runtime);
// Project should have 1 block, a top-level variable reporter
t.equal(Object.keys(blocks).length, 1);
t.equal(Object.keys(result.targets[0].blocks).length, 1);
// Make sure deserializing these blocks works
t.doesNotThrow(() => {
sb3.deserialize(JSON.parse(JSON.stringify(result)), vm.runtime);
});
t.end();
});
});
test('(#1850) sprite draggability state read when loading SB3 file', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(draggableSB3ProjectPath))
.then(() => {
const sprite1Obj = vm.runtime.targets.find(target => target.sprite.name === 'Sprite1');
// Sprite1 in project should have draggable set to true
t.equal(sprite1Obj.draggable, true);
t.end();
});
});
test('load origin value from SB3 file json metadata', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(originSB3ProjectPath))
.then(() => {
t.type(vm.runtime.origin, 'string');
})
.then(() => vm.loadProject(readFileToBuffer(originAbsentSB3ProjectPath)))
.then(() => {
// After loading a project with an origin, then loading one without an origin,
// origin value should no longer be set.
t.equal(vm.runtime.origin, null);
t.end();
});
});
test('serialize origin value if it is present', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(originSB3ProjectPath))
.then(() => {
const result = sb3.serialize(vm.runtime);
t.type(result.meta.origin, 'string');
t.end();
});
});
test('do not serialize origin value if it is not present', t => {
const vm = new VirtualMachine();
vm.loadProject(readFileToBuffer(originAbsentSB3ProjectPath))
.then(() => {
const result = sb3.serialize(vm.runtime);
t.equal(result.meta.origin, undefined);
t.end();
});
});
|