Files
blockly/tests/mocha/toolbox_test.js
alschmiedt d0e91a15a2 Toolbox definition (#3891)
* Add support for creating a toolbox with JSON
2020-05-13 08:16:53 -07:00

378 lines
15 KiB
JavaScript

/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
suite('Toolbox', function() {
setup(function() {
Blockly.defineBlocksWithJsonArray([{
"type": "basic_block",
"message0": "%1",
"args0": [
{
"type": "field_input",
"name": "TEXT",
"text": "default"
}
]
}]);
this.toolboxXml = document.getElementById('toolbox-test');
this.workspace = Blockly.inject('blocklyDiv',
{
toolbox: this.toolboxXml
});
this.toolbox = this.workspace.getToolbox();
});
teardown(function() {
this.workspace.dispose();
delete Blockly.Blocks['basic_block'];
sinon.restore();
});
suite('init', function() {
setup(function() {
this.toolbox.init();
});
test('HtmlDiv is created', function() {
chai.assert.isDefined(this.toolbox.HtmlDiv);
});
test('HtmlDiv is inserted before parent node', function() {
var toolboxDiv = Blockly.getMainWorkspace().getInjectionDiv().childNodes[0];
chai.assert.equal(toolboxDiv.className, 'blocklyToolboxDiv blocklyNonSelectable');
});
test('hideChaff is called when the toolbox is clicked', function() {
var hideChaffStub = sinon.stub(Blockly, "hideChaff");
var evt = new MouseEvent('pointerdown', {});
this.toolbox.HtmlDiv.dispatchEvent(evt);
sinon.assert.calledOnce(hideChaffStub);
});
test('Flyout is initialized', function() {
chai.assert.isDefined(this.toolbox.flyout_);
});
});
suite('renderTree', function() {
setup(function() {
this.toolboxXml = Blockly.utils.toolbox.convertToolboxToJSON(this.toolboxXml);
this.toolbox.selectFirstCategory();
this.firstChild = this.toolbox.tree_.getChildAt(0);
this.secondChild = this.toolbox.tree_.getChildAt(1);
this.toolbox.handleBeforeTreeSelected_(this.secondChild);
});
test('Tree is created and set', function() {
this.toolbox.renderTree(this.toolboxXml);
chai.assert.isDefined(this.toolbox.tree_);
});
test('Throws error if a toolbox has both blocks and categories at root level', function() {
var toolbox = this.toolbox;
var badToolboxDef = [
{
"kind": "block",
"blockxml": "<block type='controls_if'></block>"
},
{
"kind": "category",
"name": "loops",
"categorystyle": "math_category",
"contents": [
{
"kind": "block",
"blockxml": "<block type='controls_if'></block>"
},
{
"kind": "button",
"text": "insert",
"callbackkey":"insertConnectionRows"
},
{
"kind": "label",
"text": "Something"
}
]
}
];
chai.assert.throws(function() {
toolbox.renderTree(badToolboxDef);
}, 'Toolbox cannot have both blocks and categories in the root level.');
});
test('Select any open nodes', function() {
this.toolbox.renderTree(this.toolboxXml);
var selectedNode = this.toolbox.tree_.children_[0];
chai.assert.isTrue(selectedNode.selected_);
});
test('Set the state for horizontal layout ', function() {
this.toolbox.horizontalLayout_ = true;
this.toolbox.renderTree(this.toolboxXml);
var orientationAttribute = this.toolbox.tree_.getElement()
.getAttribute('aria-orientation');
chai.assert.equal(orientationAttribute, 'horizontal');
});
test('Create a toolbox from JSON', function() {
var jsonDef = [
{
"kind": "category",
"contents": [
{
"kind": "block",
"blockxml": '<block xmlns="http://www.w3.org/1999/xhtml" type="basic_block"><field name="TEXT">FirstCategory-FirstBlock</field></block>'
},
{
"kind": "label",
"text": "Input/Output:",
"web-class": "ioLabel"
},
{
"kind": "button",
"text": "insert",
"callbackkey": "insertConnectionStacks",
"web-class": "ioLabel"
},
{
"kind": "sep",
"gap": "7"
}
]
}
];
this.toolbox.renderTree(jsonDef);
chai.assert.lengthOf(this.toolbox.tree_.children_, 1);
});
});
suite('handleBeforeTreeSelected_', function() {
setup(function() {
this.toolbox.selectFirstCategory();
this.firstChild = this.toolbox.tree_.getChildAt(0);
this.secondChild = this.toolbox.tree_.getChildAt(1);
this.toolbox.handleBeforeTreeSelected_(this.secondChild);
});
test('Clear the previously selected category', function() {
chai.assert.equal(this.firstChild.getRowElement().style.backgroundColor, '');
});
test('Set color for new selected category', function() {
chai.assert.equal(this.secondChild.getRowElement().style.backgroundColor,
'rgb(85, 119, 238)');
});
});
suite('handleAfterTreeSelected_', function() {
setup(function() {
this.toolbox.selectFirstCategory();
this.firstChild = this.toolbox.tree_.getChildAt(0);
this.secondChild = this.toolbox.tree_.getChildAt(1);
this.showStub = sinon.stub(this.toolbox.flyout_, "show");
});
test('Show the new set of blocks in the flyout', function() {
this.toolbox.handleAfterTreeSelected_(this.firstChild, this.secondChild);
sinon.assert.calledWith(this.showStub, this.secondChild.contents);
});
test('Opening the previous selected category does not scroll', function() {
var scrollStub = sinon.stub(this.toolbox.flyout_, "scrollToStart");
this.toolbox.handleAfterTreeSelected_(null, this.firstChild);
sinon.assert.notCalled(scrollStub);
});
test('Opening new category scrolls to top', function() {
var scrollStub = sinon.stub(this.toolbox.flyout_, "scrollToStart");
this.toolbox.handleAfterTreeSelected_(null, this.secondChild);
sinon.assert.calledOnce(scrollStub);
});
test('Clicking selected category closes flyout', function() {
var flyoutHideStub = sinon.stub(this.toolbox.flyout_, "hide");
this.toolbox.handleAfterTreeSelected_(this.firstChild);
sinon.assert.calledOnce(flyoutHideStub);
});
test('UI Event is fired when new category is selected', function() {
var eventsFireStub = sinon.stub(Blockly.Events, 'fire');
this.toolbox.handleAfterTreeSelected_(this.firstChild);
sinon.assert.calledOnce(eventsFireStub);
});
test('Last category is updated when there is a new node', function() {
this.toolbox.handleAfterTreeSelected_(this.firstChild, this.secondChild);
chai.assert.equal(this.toolbox.lastCategory_, this.secondChild);
});
});
suite('position', function() {
setup(function() {
this.toolbox.init();
});
function checkHorizontalToolbox(toolbox) {
chai.assert.equal(toolbox.HtmlDiv.style.left, '0px', 'Check left position');
chai.assert.equal(toolbox.HtmlDiv.style.height, 'auto', 'Check height');
var svgSize = Blockly.svgSize(toolbox.workspace_.getParentSvg());
chai.assert.equal(toolbox.HtmlDiv.style.width, svgSize.width + 'px', 'Check width');
chai.assert.equal(toolbox.height, toolbox.HtmlDiv.offsetHeight, 'Check height');
}
function checkVerticalToolbox(toolbox) {
var svgSize = Blockly.svgSize(toolbox.workspace_.getParentSvg());
chai.assert.equal(toolbox.HtmlDiv.style.height, svgSize.height + 'px', 'Check height');
chai.assert.equal(toolbox.width, toolbox.HtmlDiv.offsetWidth, 'Check width');
}
test('Return if tree is not yet initialized', function() {
this.toolbox.HtmlDiv = null;
this.toolbox.horizontalLayout_ = true;
this.toolbox.position();
chai.assert.equal(this.toolbox.height, '');
});
test('Position horizontal at top', function() {
var toolbox = this.toolbox;
toolbox.toolboxPosition = Blockly.TOOLBOX_AT_TOP;
toolbox.horizontalLayout_ = true;
toolbox.position();
checkHorizontalToolbox(toolbox);
chai.assert.equal(toolbox.HtmlDiv.style.top, '0px', 'Check top');
});
test('Position horizontal at bottom', function() {
var toolbox = this.toolbox;
toolbox.toolboxPosition = Blockly.TOOLBOX_AT_BOTTOM;
toolbox.horizontalLayout_ = true;
toolbox.position();
checkHorizontalToolbox(toolbox);
chai.assert.equal(toolbox.HtmlDiv.style.bottom, '0px', 'Check bottom');
});
test('Position Vertical at right', function() {
var toolbox = this.toolbox;
toolbox.toolboxPosition = Blockly.TOOLBOX_AT_RIGHT;
toolbox.horizontalLayout_ = false;
toolbox.position();
chai.assert.equal(toolbox.HtmlDiv.style.right, '0px', 'Check right');
checkVerticalToolbox(toolbox);
});
test('Position Vertical at left ', function() {
var toolbox = this.toolbox;
toolbox.toolboxPosition = Blockly.TOOLBOX_AT_RIGHT;
toolbox.horizontalLayout_ = false;
toolbox.position();
chai.assert.equal(toolbox.HtmlDiv.style.left, '0px', 'Check left');
checkVerticalToolbox(toolbox);
});
});
suite('createTree_', function() {
setup(function() {
this.tree = new Blockly.tree.TreeControl(this.toolbox, this.toolbox.config_);
this.tree.contents = [];
this.toolboxXml = document.getElementById('toolbox-test');
this.separatorIdx = 0;
this.buttonIdx = 1;
this.dynamicCategoryIdx = 3;
this.categorySeparatorIdx = 2;
this.toolboxXml = Blockly.utils.toolbox.convertToolboxToJSON(this.toolboxXml);
});
test('Having a dynamic category', function() {
this.toolbox.createTree_(this.toolboxXml, this.tree);
chai.assert.equal(this.tree.children_[this.dynamicCategoryIdx].contents, 'VARIABLE');
});
test('Node is expanded', function() {
var openNode = this.toolbox.createTree_(this.toolboxXml, this.tree);
chai.assert.exists(openNode);
});
test('Having a tree separator', function() {
this.toolbox.createTree_(this.toolboxXml, this.tree);
var sepObj = this.tree.children_[0].contents[this.separatorIdx];
chai.assert.isNotNull(sepObj);
chai.assert.equal(sepObj['gap'], -1);
});
test('Separator between two categories', function() {
this.toolbox.createTree_(this.toolboxXml, this.tree);
chai.assert.instanceOf(this.tree.children_[this.categorySeparatorIdx],
Blockly.Toolbox.TreeSeparator);
});
test('Having a button', function() {
this.toolbox.createTree_(this.toolboxXml, this.tree);
var btnObj = this.tree.children_[0].contents[this.buttonIdx];
chai.assert.isNotNull(btnObj);
chai.assert.equal(btnObj['text'], 'insert');
chai.assert.equal(btnObj['callbackkey'], 'insertConnectionRows');
});
test('Colours are set using correct method', function() {
var setColourFromStyleStub = sinon.stub(this.toolbox, "setColourFromStyle_");
var setColourStub = sinon.stub(this.toolbox, "setColour_");
this.toolbox.createTree_(this.toolboxXml, this.tree);
sinon.assert.calledOnce(setColourFromStyleStub);
sinon.assert.called(setColourStub);
});
});
suite('parseToolbox', function() {
setup(function() {
this.categoryToolboxJSON = getCategoryJSON();
this.simpleToolboxJSON = getSimpleJSON();
});
function checkValue(actual, expected, value) {
var actualVal = actual[value];
var expectedVal = expected[value];
chai.assert.equal(actualVal.toUpperCase(), expectedVal.toUpperCase(), 'Checknig value for: ' + value);
}
function checkContents(actualContents, expectedContents) {
chai.assert.equal(actualContents.length, expectedContents.length);
console.log(actualContents);
for (var i = 0; i < actualContents.length; i++) {
chai.assert.containsAllKeys(actualContents[i], Object.keys(expectedContents[i]));
}
}
function checkCategory(actual, expected) {
checkValue(actual, expected, 'kind');
checkValue(actual, expected, 'name');
checkContents(actual.contents, expected.contents);
}
function checkCategoryToolbox(actual, expected) {
chai.assert.equal(actual.length, expected.length);
for (var i = 0; i < expected.length; i++) {
checkCategory(actual[i], expected[i]);
}
}
function checkSimpleToolbox(actual, expected) {
checkContents(actual, expected);
}
test('Simple Toolbox: Array with xml', function() {
var xmlList = getXmlArray();
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(xmlList);
checkSimpleToolbox(toolboxDef, this.simpleToolboxJSON);
});
test('Category Toolbox: Array with xml', function() {
var categoryOne = Blockly.Xml.textToDom('<category name="First"><block type="basic_block"><field name="TEXT">FirstCategory-FirstBlock</field></block><block type="basic_block"><field name="TEXT">FirstCategory-SecondBlock</field></block></category>');
var categoryTwo = Blockly.Xml.textToDom('<category name="Second"><block type="basic_block"><field name="TEXT">SecondCategory-FirstBlock</field></block></category>');
var xmlList = [categoryOne, categoryTwo];
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(xmlList);
checkCategoryToolbox(toolboxDef, this.categoryToolboxJSON);
});
test('Category Toolbox: Array with JSON', function() {
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(this.categoryToolboxJSON);
chai.assert.isNotNull(toolboxDef);
checkCategoryToolbox(toolboxDef, this.categoryToolboxJSON);
});
test('Simple Toolbox: Array with JSON', function() {
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(this.simpleToolboxJSON);
chai.assert.isNotNull(toolboxDef);
checkSimpleToolbox(toolboxDef, this.simpleToolboxJSON);
});
test('Category Toolbox: NodeList', function() {
var nodeList = document.getElementById('toolbox-categories').childNodes;
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(nodeList);
checkCategoryToolbox(toolboxDef, this.categoryToolboxJSON);
});
test('Simple Toolbox: NodeList', function() {
var nodeList = document.getElementById('toolbox-simple').childNodes;
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(nodeList);
checkSimpleToolbox(toolboxDef, this.simpleToolboxJSON);
});
test('Category Toolbox: xml', function() {
var toolboxXml = document.getElementById('toolbox-categories');
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(toolboxXml);
chai.assert.isNotNull(toolboxDef);
checkCategoryToolbox(toolboxDef, this.categoryToolboxJSON);
});
test('Simple Toolbox: xml', function() {
var toolboxXml = document.getElementById('toolbox-simple');
var toolboxDef = Blockly.utils.toolbox.convertToolboxToJSON(toolboxXml);
chai.assert.isNotNull(toolboxDef);
checkSimpleToolbox(toolboxDef, this.simpleToolboxJSON);
});
});
});