Files
blockly/tests/mocha/xml_test.js
Beka Westberg 9e5df6216a Fixed comment ownership. (#2923)
* Moved comment icons to use a model-based system. The block holds the model of the comment, and the comment icon holds a reference to it.
* Reorganized the setVisible function.
* Changed how xml.js serializes and deserializes comments.
2019-09-20 13:16:07 -07:00

711 lines
24 KiB
JavaScript

/**
* @license
* Visual Blocks Editor
*
* Copyright 2019 Google Inc.
* https://developers.google.com/blockly/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
suite('XML', function() {
var assertSimpleField = function(fieldDom, name, text) {
assertEquals(text, fieldDom.textContent);
assertEquals(name, fieldDom.getAttribute('name'));
};
var assertNonSerializingField = function(fieldDom) {
assertEquals(undefined, fieldDom.childNodes[0]);
};
var assertVariableField = function(fieldDom, name, type, id, text) {
assertEquals(name, fieldDom.getAttribute('name'));
assertEquals(type, fieldDom.getAttribute('variabletype'));
assertEquals(id, fieldDom.getAttribute('id'));
assertEquals(text, fieldDom.textContent);
};
setup(function() {
Blockly.defineBlocksWithJsonArray([
{
"type": "empty_block",
"message0": "",
"args0": []
},
]);
});
teardown(function() {
delete Blockly.Blocks['empty_block'];
});
suite('Serialization', function() {
setup(function() {
this.workspace = new Blockly.Workspace();
});
teardown(function() {
this.workspace.dispose();
});
suite('Fields', function() {
test('Angle', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_angle_test_block",
"message0": "%1",
"args0": [
{
"type": "field_angle",
"name": "ANGLE",
"angle": 90
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_angle_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'ANGLE', '90');
delete Blockly.Blocks['field_angle_test_block'];
});
test('Checkbox', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_checkbox_test_block",
"message0": "%1",
"args0": [
{
"type": "field_checkbox",
"name": "CHECKBOX",
"checked": true
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_checkbox_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'CHECKBOX', 'TRUE');
delete Blockly.Blocks['field_checkbox_test_block'];
});
test('Colour', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_colour_test_block",
"message0": "%1",
"args0": [
{
"type": "field_colour",
"name": "COLOUR",
"colour": '#000099'
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_colour_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'COLOUR', '#000099');
delete Blockly.Blocks['field_colour_test_block'];
});
/* If you want to run date tests add the date picker here:
* https://github.com/google/blockly/blob/master/core/blockly.js#L41
* before unskipping.
*/
test.skip('Date', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_date_test_block",
"message0": "%1",
"args0": [
{
"type": "field_date",
"name": "DATE",
"date": "2020-02-20"
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_date_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'DATE', '2020-02-20');
delete Blockly.Blocks['field_date_test_block'];
});
test('Dropdown', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_dropdown_test_block",
"message0": "%1",
"args0": [
{
"type": "field_dropdown",
"name": "DROPDOWN",
"options": [
[
"a",
"A"
],
[
"b",
"B"
],
[
"c",
"C"
]
]
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_dropdown_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'DROPDOWN', 'A');
delete Blockly.Blocks['field_dropdown_test_block'];
});
test('Image', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_image_test_block",
"message0": "%1",
"args0": [
{
"type": "field_image",
"name": "IMAGE",
"src": "https://blockly-demo.appspot.com/static/tests/media/a.png",
"width": 32,
"height": 32,
"alt": "A"
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_image_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block);
assertNonSerializingField(resultFieldDom);
delete Blockly.Blocks['field_image_test_block'];
});
test('Label', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_label_test_block",
"message0": "%1",
"args0": [
{
"type": "field_label",
"name": "LABEL",
"text": "default"
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_label_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block);
assertNonSerializingField(resultFieldDom);
delete Blockly.Blocks['field_label_test_block'];
});
test('Label Serializable', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_label_serializable_test_block",
"message0": "%1",
"args0": [
{
"type": "field_label_serializable",
"name": "LABEL",
"text": "default"
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_label_serializable_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'LABEL', 'default');
delete Blockly.Blocks['field_label_serializable_test_block'];
});
test('Number', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_number_test_block",
"message0": "%1",
"args0": [
{
"type": "field_number",
"name": "NUMBER",
"value": 97
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_number_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'NUMBER', '97');
delete Blockly.Blocks['field_number_test_block'];
});
test('Text Input', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "field_text_input_test_block",
"message0": "%1",
"args0": [
{
"type": "field_input",
"name": "TEXT",
"text": "default"
}
],
}]);
var block = new Blockly.Block(this.workspace,
'field_text_input_test_block');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertSimpleField(resultFieldDom, 'TEXT', 'default');
});
suite('Variable Fields', function() {
setup(function() {
Blockly.defineBlocksWithJsonArray([{
'type': 'field_variable_test_block',
'message0': '%1',
'args0': [
{
'type': 'field_variable',
'name': 'VAR',
'variable': 'item'
}
]
}]);
});
teardown(function() {
delete Blockly.Blocks['field_variable_test_block'];
});
test('Variable Trivial', function() {
this.workspace.createVariable('name1', '', 'id1');
var block = new Blockly.Block(this.workspace,
'field_variable_test_block');
block.inputList[0].fieldRow[0].setValue('id1');
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
assertVariableField(resultFieldDom, 'VAR', null, 'id1', 'name1');
});
test('Variable Default Case', function() {
var cacheGenUid = Blockly.utils.genUid;
Blockly.utils.genUid = function() {
return '1';
};
try {
this.workspace.createVariable('name1');
Blockly.Events.disable();
var block = new Blockly.Block(this.workspace,
'field_variable_test_block');
block.inputList[0].fieldRow[0].setValue('1');
Blockly.Events.enable();
var resultFieldDom = Blockly.Xml.blockToDom(block).childNodes[0];
// Expect type is null and ID is '1' since we don't specify type and ID.
assertVariableField(resultFieldDom, 'VAR', null, '1', 'name1');
} finally {
Blockly.utils.genUid = cacheGenUid;
}
});
});
});
suite('Comments', function() {
suite('Headless', function() {
setup(function() {
this.block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block"/>'
), this.workspace);
});
test('Text', function() {
this.block.setCommentText('test text');
var xml = Blockly.Xml.blockToDom(this.block);
var commentXml = xml.firstChild;
chai.assert.equal(commentXml.tagName, 'comment');
chai.assert.equal(commentXml.innerHTML, 'test text');
});
test('No Text', function() {
var xml = Blockly.Xml.blockToDom(this.block);
chai.assert.isNull(xml.firstChild);
});
test('Empty Text', function() {
this.block.setCommentText('');
var xml = Blockly.Xml.blockToDom(this.block);
chai.assert.isNull(xml.firstChild);
});
});
suite('Rendered', function() {
setup(function() {
// Let the parent teardown dispose of it.
this.workspace = Blockly.inject('blocklyDiv', {comments: true});
this.block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block"/>'
), this.workspace);
});
test('Text', function() {
this.block.setCommentText('test text');
var xml = Blockly.Xml.blockToDom(this.block);
var commentXml = xml.firstChild;
chai.assert.equal(commentXml.tagName, 'comment');
chai.assert.equal(commentXml.innerHTML, 'test text');
});
test('No Text', function() {
var xml = Blockly.Xml.blockToDom(this.block);
chai.assert.isNull(xml.firstChild);
});
test('Empty Text', function() {
this.block.setCommentText('');
var xml = Blockly.Xml.blockToDom(this.block);
chai.assert.isNull(xml.firstChild);
});
test('Size', function() {
this.block.setCommentText('test text');
this.block.getCommentIcon().setBubbleSize(100, 200);
var xml = Blockly.Xml.blockToDom(this.block);
var commentXml = xml.firstChild;
chai.assert.equal(commentXml.tagName, 'comment');
chai.assert.equal(commentXml.getAttribute('w'), 100);
chai.assert.equal(commentXml.getAttribute('h'), 200);
});
test('Pinned True', function() {
this.block.setCommentText('test text');
this.block.getCommentIcon().setVisible(true);
var xml = Blockly.Xml.blockToDom(this.block);
var commentXml = xml.firstChild;
chai.assert.equal(commentXml.tagName, 'comment');
chai.assert.equal(commentXml.getAttribute('pinned'), 'true');
});
test('Pinned False', function() {
this.block.setCommentText('test text');
var xml = Blockly.Xml.blockToDom(this.block);
var commentXml = xml.firstChild;
chai.assert.equal(commentXml.tagName, 'comment');
chai.assert.equal(commentXml.getAttribute('pinned'), 'false');
});
});
});
});
suite('Deserialization', function() {
setup(function() {
this.workspace = new Blockly.Workspace();
});
teardown(function() {
this.workspace.dispose();
});
suite('Dynamic Category Blocks', function() {
test('Untyped Variables', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "variables_get",
"message0": "%1",
"args0": [
{
"type": "field_variable",
"name": "VAR",
}
]
},
{
"type": "variables_set",
"message0": "%1 %2",
"args0": [
{
"type": "field_variable",
"name": "VAR"
},
{
"type": "input_value",
"name": "VALUE"
}
]
},
{
"type": "math_change",
"message0": "%1 %2",
"args0": [
{
"type": "field_variable",
"name": "VAR",
},
{
"type": "input_value",
"name": "DELTA",
"check": "Number"
}
]
},
{
"type": "math_number",
"message0": "%1",
"args0": [{
"type": "field_number",
"name": "NUM",
"value": 0
}],
"output": "Number"
}]);
this.workspace.createVariable('name1', '', 'id1');
var blocksArray = Blockly.Variables.flyoutCategoryBlocks(this.workspace);
try {
for (var i = 0, xml; xml = blocksArray[i]; i++) {
Blockly.Xml.domToBlock(xml, this.workspace);
}
} finally {
delete Blockly.Blocks['variables_get'];
delete Blockly.Blocks['variables_set'];
delete Blockly.Blocks['math_change'];
delete Blockly.Blocks['math_number'];
}
});
test('Typed Variables', function() {
Blockly.defineBlocksWithJsonArray([{
"type": "variables_get",
"message0": "%1",
"args0": [
{
"type": "field_variable",
"name": "VAR",
}
]
},
{
"type": "variables_set",
"message0": "%1 %2",
"args0": [
{
"type": "field_variable",
"name": "VAR"
},
{
"type": "input_value",
"name": "VALUE"
}
]
},
{
"type": "math_change",
"message0": "%1 %2",
"args0": [
{
"type": "field_variable",
"name": "VAR",
},
{
"type": "input_value",
"name": "DELTA",
"check": "Number"
}
]
},
{
"type": "math_number",
"message0": "%1",
"args0": [{
"type": "field_number",
"name": "NUM",
"value": 0
}],
"output": "Number"
}]);
this.workspace.createVariable('name1', 'String', 'id1');
this.workspace.createVariable('name2', 'Number', 'id2');
this.workspace.createVariable('name3', 'Colour', 'id3');
var blocksArray = Blockly.VariablesDynamic
.flyoutCategoryBlocks(this.workspace);
try {
for (var i = 0, xml; xml = blocksArray[i]; i++) {
Blockly.Xml.domToBlock(xml, this.workspace);
}
} finally {
delete Blockly.Blocks['variables_get'];
delete Blockly.Blocks['variables_set'];
delete Blockly.Blocks['math_change'];
delete Blockly.Blocks['math_number'];
}
});
});
suite('Comments', function() {
suite('Headless', function() {
test('Text', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment>test text</comment>' +
'</block>'
), this.workspace);
chai.assert.equal(block.getCommentText(), 'test text');
});
test('No Text', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment></comment>' +
'</block>'
), this.workspace);
chai.assert.equal(block.getCommentText(), '');
});
test('Size', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment w="100" h="200">test text</comment>' +
'</block>'
), this.workspace);
chai.assert.deepEqual(block.commentModel.size,
{width: 100, height: 200});
});
test('Pinned True', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment pinned="true">test text</comment>' +
'</block>'
), this.workspace);
chai.assert.isTrue(block.commentModel.pinned);
});
test('Pinned False', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment pinned="false">test text</comment>' +
'</block>'
), this.workspace);
chai.assert.isFalse(block.commentModel.pinned);
});
test('Pinned Undefined', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment>test text</comment>' +
'</block>'
), this.workspace);
chai.assert.isFalse(block.commentModel.pinned);
});
});
suite('Rendered', function() {
setup(function() {
// Let the parent teardown dispose of it.
this.workspace = Blockly.inject('blocklyDiv', {comments: true});
});
test('Text', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment>test text</comment>' +
'</block>'
), this.workspace);
chai.assert.equal(block.getCommentText(), 'test text');
chai.assert.isNotNull(block.getCommentIcon());
});
test('No Text', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment></comment>' +
'</block>'
), this.workspace);
chai.assert.equal(block.getCommentText(), '');
chai.assert.isNotNull(block.getCommentIcon());
});
test('Size', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment w="100" h="200">test text</comment>' +
'</block>'
), this.workspace);
chai.assert.deepEqual(block.commentModel.size,
{width: 100, height: 200});
chai.assert.isNotNull(block.getCommentIcon());
chai.assert.deepEqual(block.getCommentIcon().getBubbleSize(),
{width: 100, height: 200});
});
suite('Pinned', function() {
setup(function() {
this.clock = sinon.useFakeTimers();
});
teardown(function() {
this.clock.restore();
});
test('Pinned True', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment pinned="true">test text</comment>' +
'</block>'
), this.workspace);
this.clock.tick(1);
chai.assert.isTrue(block.commentModel.pinned);
chai.assert.isNotNull(block.getCommentIcon());
chai.assert.isTrue(block.getCommentIcon().isVisible());
});
test('Pinned False', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment pinned="false">test text</comment>' +
'</block>'
), this.workspace);
this.clock.tick(1);
chai.assert.isFalse(block.commentModel.pinned);
chai.assert.isNotNull(block.getCommentIcon());
chai.assert.isFalse(block.getCommentIcon().isVisible());
});
test('Pinned Undefined', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block">' +
' <comment>test text</comment>' +
'</block>'
), this.workspace);
this.clock.tick(1);
chai.assert.isFalse(block.commentModel.pinned);
chai.assert.isNotNull(block.getCommentIcon());
chai.assert.isFalse(block.getCommentIcon().isVisible());
});
});
});
});
});
suite('Round Tripping', function() {
setup(function() {
var options = {
comments: true
};
this.renderedWorkspace = Blockly.inject('blocklyDiv', options);
this.headlessWorkspace = new Blockly.Workspace(options);
});
teardown(function() {
this.renderedWorkspace.dispose();
this.headlessWorkspace.dispose();
});
suite('Rendered -> XML -> Headless -> XML', function() {
setup(function() {
this.assertRoundTrip = function() {
var renderedXml = Blockly.Xml.workspaceToDom(this.renderedWorkspace);
Blockly.Xml.domToWorkspace(renderedXml, this.headlessWorkspace);
var headlessXml = Blockly.Xml.workspaceToDom(this.headlessWorkspace);
var renderedText = Blockly.Xml.domToText(renderedXml);
var headlessText = Blockly.Xml.domToText(headlessXml);
chai.assert.equal(headlessText, renderedText);
};
});
test('Comment', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block"/>'
), this.renderedWorkspace);
block.setCommentText('test text');
block.getCommentIcon().setBubbleSize(100, 100);
block.getCommentIcon().setVisible(true);
this.assertRoundTrip();
});
});
suite('Headless -> XML -> Rendered -> XML', function() {
setup(function() {
this.assertRoundTrip = function() {
var headlessXml = Blockly.Xml.workspaceToDom(this.headlessWorkspace);
Blockly.Xml.domToWorkspace(headlessXml, this.renderedWorkspace);
var renderedXml = Blockly.Xml.workspaceToDom(this.renderedWorkspace);
var renderedText = Blockly.Xml.domToText(renderedXml);
var headlessText = Blockly.Xml.domToText(headlessXml);
chai.assert.equal(renderedText, headlessText);
};
});
test('Comment', function() {
var block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
'<block type="empty_block"/>'
), this.headlessWorkspace);
block.setCommentText('test text');
block.commentModel.size = new Blockly.utils.Size(100, 100);
block.commentModel.pinned = true;
this.assertRoundTrip();
});
});
});
});