scratch-vm/test/unit/serialization_sb2.js
Katie Broida 899ce56214
Confirm extension in use in sb2 serialization (#1643)
Add a check when serializing sb2 projects to see whether an extension is actually in use in a block or a visible monitor.
2018-10-17 10:49:08 -04:00

151 lines
5.5 KiB
JavaScript

const path = require('path');
const test = require('tap').test;
const extractProjectJson = require('../fixtures/readProjectFile').extractProjectJson;
const RenderedTarget = require('../../src/sprites/rendered-target');
const Runtime = require('../../src/engine/runtime');
const sb2 = require('../../src/serialization/sb2');
test('spec', t => {
t.type(sb2, 'object');
t.type(sb2.deserialize, 'function');
t.end();
});
test('default', t => {
// Get SB2 JSON (string)
const uri = path.resolve(__dirname, '../fixtures/default.sb2');
const json = extractProjectJson(uri);
// Create runtime instance & load SB2 into it
const rt = new Runtime();
sb2.deserialize(json, rt).then(({targets}) => {
// Test
t.type(json, 'object');
t.type(rt, 'object');
t.type(targets, 'object');
t.ok(targets[0] instanceof RenderedTarget);
t.type(targets[0].id, 'string');
t.type(targets[0].blocks, 'object');
t.type(targets[0].variables, 'object');
t.type(targets[0].comments, 'object');
t.equal(targets[0].isOriginal, true);
t.equal(targets[0].currentCostume, 0);
t.equal(targets[0].isOriginal, true);
t.equal(targets[0].isStage, true);
t.ok(targets[1] instanceof RenderedTarget);
t.type(targets[1].id, 'string');
t.type(targets[1].blocks, 'object');
t.type(targets[1].variables, 'object');
t.type(targets[1].comments, 'object');
t.equal(targets[1].isOriginal, true);
t.equal(targets[1].currentCostume, 0);
t.equal(targets[1].isOriginal, true);
t.equal(targets[1].isStage, false);
t.end();
});
});
test('data scoping', t => {
// Get SB2 JSON (string)
const uri = path.resolve(__dirname, '../fixtures/data.sb2');
const json = extractProjectJson(uri);
// Create runtime instance & load SB2 into it
const rt = new Runtime();
sb2.deserialize(json, rt).then(({targets}) => {
const globalVariableIds = Object.keys(targets[0].variables);
const localVariableIds = Object.keys(targets[1].variables);
t.equal(targets[0].variables[globalVariableIds[0]].name, 'foo');
t.equal(targets[1].variables[localVariableIds[0]].name, 'local');
t.end();
});
});
test('whenclicked blocks imported separately', t => {
// This sb2 fixture has a single "whenClicked" block on both sprite and stage
const uri = path.resolve(__dirname, '../fixtures/when-clicked.sb2');
const json = extractProjectJson(uri);
// Create runtime instance & load SB2 into it
const rt = new Runtime();
sb2.deserialize(json, rt).then(({targets}) => {
const stage = targets[0];
t.equal(stage.isStage, true); // Make sure we have the correct target
const stageOpcode = stage.blocks.getBlock(stage.blocks.getScripts()[0]).opcode;
t.equal(stageOpcode, 'event_whenstageclicked');
const sprite = targets[1];
t.equal(sprite.isStage, false); // Make sure we have the correct target
const spriteOpcode = sprite.blocks.getBlock(sprite.blocks.getScripts()[0]).opcode;
t.equal(spriteOpcode, 'event_whenthisspriteclicked');
t.end();
});
});
test('Ordering', t => {
// This SB2 has 3 sprites that have been reordered in scratch 2
// so the order in the file is not the order specified by the indexInLibrary property.
const uri = path.resolve(__dirname, '../fixtures/ordering.sb2');
const json = extractProjectJson(uri);
const rt = new Runtime();
sb2.deserialize(json, rt).then(({targets}) => {
// Would fail with any other ordering.
t.equal(targets[1].sprite.name, 'First');
t.equal(targets[2].sprite.name, 'Second');
t.equal(targets[3].sprite.name, 'Third');
t.end();
});
});
test('Extensions used in blocks serialized', t => {
const uri = path.resolve(__dirname, '../fixtures/extensions-in-blocks.sb2');
const json = extractProjectJson(uri);
const rt = new Runtime();
const expectedExtensionIDs = new Set(['videoSensing', 'wedo2', 'pen']);
// Make sure any extensions loaded in a block are added to the project
sb2.deserialize(json, rt).then(({extensions}) => {
t.deepEquals(extensions.extensionIDs, expectedExtensionIDs);
t.end();
});
});
test('Extensions used in visible monitors serialized', t => {
const uri = path.resolve(__dirname, '../fixtures/extensions-in-monitors.sb2');
const json = extractProjectJson(uri);
const rt = new Runtime();
sb2.deserialize(json, rt).then(({extensions}) => {
const monitorState = rt.getMonitorState();
const monitor = monitorState.first();
const monitorOpcode = monitor.opcode.split('_')[0];
t.ok(extensions.extensionIDs.has(monitorOpcode));
t.equals(monitor.visible, true);
t.end();
});
});
test('No extensions serialized', t => {
// This test project has had the video motion monitor checked, saved,
// then unchecked and then saved
const uri = path.resolve(__dirname, '../fixtures/extensions-not-serialized.sb2');
const json = extractProjectJson(uri);
const rt = new Runtime();
sb2.deserialize(json, rt).then(({extensions}) => {
const monitorState = rt.getMonitorState();
const monitor = monitorState.first();
const monitorOpcode = monitor.opcode.split('_')[0];
t.equals(monitor.visible, false);
t.notOk(extensions.extensionIDs.has(monitorOpcode));
t.end();
});
});