Files
blockly/tests/mocha/json_test.js
Christopher Allen 6f20ac290d refactor(tests): Use import instead of goog.bootstrap to load Blockly in mocha tests (#7406)
* fix(build): Have buildShims clean up up after itself

  We need to create a build/package.json file to allow node.js to
  load build/src/core/blockly.js and the other chunk entry points
  as ES modules (it forcibly assumes .js means CJS even if one is
  trying to import, unless package.json says {"type": "module"}),
  but this interferes with scripts/migration/js2ts doing a
  require('build/deps.js'), which is _not_ an ES module.

  Specific error message was:

  /Users/cpcallen/src/blockly/scripts/migration/js2ts:56
  require(path.resolve(__dirname, '../../build/deps.js'));
  ^

  Error [ERR_REQUIRE_ESM]: require() of ES Module
  /Users/cpcallen/src/blockly/build/deps.js from /Users/cpcallen/src/blockly/scripts/migration/js2ts
  not supported.
  deps.js is treated as an ES module file as it is a .js file whose
  nearest parent package.json contains "type": "module" which
  declares all .js files in that package scope as ES modules.
  Instead rename deps.js to end in .cjs, change the requiring code
  to use dynamic import() which is available in all CommonJS
  modules, or change "type": "module" to "type": "commonjs" in
  /Users/cpcallen/src/blockly/build/package.json to treat all .js
  files as CommonJS (using .mjs for all ES modules instead).

      at Object.<anonymous> (/Users/cpcallen/src/blockly/scripts/migration/js2ts:56:1) {
    code: 'ERR_REQUIRE_ESM'
  }

* chore(tests): Reorder to put interesting script nearer top of file

* chore(tests): Add missing imports of closure/goog/goog.js

  These modules were depending on being loaded via the
  debug module loader, which cannot be used without first loading
  base.js as a script, and thereby defining goog.declareModuleId
  as a side effect—but if they are to be loaded via direct import
  statements then they need to actually import their own
  dependencies.

  This is a temporary measure as soon the goog.declareMouleId
  calls can themselves be deleted.

* refactor(tests): Use import instead of bootstrap to load Blockly

* chores(build): Stop generating deps.mocha.js

  This file was only needed by tests/mocha/index.html's use of
  the debug module loader (via bootstrap.js), which has now been
  removed.

* chore(tests): Remove unneeded goog.declareModuleId calls

  These were only needed because these modules were previously
  being loaded by goog.require and/or goog.bootstrap.

* chores(tests): Remove dead code

  We are fully committed to proper modules now.
2023-08-18 18:06:52 +01:00

315 lines
10 KiB
JavaScript

/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
addMessageToCleanup,
sharedTestSetup,
sharedTestTeardown,
} from './test_helpers/setup_teardown.js';
import {assertNoWarnings, assertWarnings} from './test_helpers/warnings.js';
suite('JSON Block Definitions', function () {
setup(function () {
sharedTestSetup.call(this);
this.workspace_ = new Blockly.Workspace();
});
teardown(function () {
sharedTestTeardown.call(this);
});
suite('defineBlocksWithJsonArray', function () {
test('Basic block', function () {
/** Ensure a block can be instantiated from a JSON definition. */
const BLOCK_TYPE = 'test_json_minimal';
let block;
assertNoWarnings(() => {
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
},
]);
block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
});
chai.assert.isNotNull(block);
chai.assert.equal(BLOCK_TYPE, block.type);
});
test('Null or undefined type id', function () {
const BLOCK_TYPE1 = 'test_json_before_bad_blocks';
const BLOCK_TYPE2 = 'test_json_after_bad_blocks';
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE1]);
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE2]);
const blockTypeCount = Object.keys(Blockly.Blocks).length;
assertWarnings(() => {
Blockly.defineBlocksWithJsonArray([
{'type': BLOCK_TYPE1},
{'type': undefined},
{'type': null},
{'type': BLOCK_TYPE2},
]);
}, [/missing a type attribute/, /missing a type attribute/]);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE1],
'Block before bad blocks should be defined.',
);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE2],
'Block after bad blocks should be defined.',
);
chai.assert.equal(Object.keys(Blockly.Blocks).length, blockTypeCount + 2);
});
test('Null item', function () {
const BLOCK_TYPE1 = 'test_block_before_null';
const BLOCK_TYPE2 = 'test_block_after_null';
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE1]);
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE2]);
const blockTypeCount = Object.keys(Blockly.Blocks).length;
assertWarnings(() => {
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE1,
'message0': 'before',
},
null,
{
'type': BLOCK_TYPE2,
'message0': 'after',
},
]);
}, /is null/);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE1],
'Block before null in array should be defined.',
);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE2],
'Block after null in array should be defined.',
);
chai.assert.equal(Object.keys(Blockly.Blocks).length, blockTypeCount + 2);
});
test('Undefined item', function () {
const BLOCK_TYPE1 = 'test_block_before_undefined';
const BLOCK_TYPE2 = 'test_block_after_undefined';
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE1]);
chai.assert.isUndefined(Blockly.Blocks[BLOCK_TYPE2]);
const blockTypeCount = Object.keys(Blockly.Blocks).length;
assertWarnings(() => {
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE1,
'message0': 'before',
},
undefined,
{
'type': BLOCK_TYPE2,
'message0': 'after',
},
]);
}, /is undefined/);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE1],
'Block before undefined in array should be defined.',
);
chai.assert.isNotNull(
Blockly.Blocks[BLOCK_TYPE2],
'Block after undefined in array should be defined.',
);
chai.assert.equal(Object.keys(Blockly.Blocks).length, blockTypeCount + 2);
});
test('message0 creates input', function () {
const BLOCK_TYPE = 'test_json_message0';
const MESSAGE0 = 'message0';
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
'message0': MESSAGE0,
},
]);
const block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
chai.assert.equal(block.inputList.length, 1);
chai.assert.equal(block.inputList[0].fieldRow.length, 1);
const textField = block.inputList[0].fieldRow[0];
chai.assert.equal(Blockly.FieldLabel, textField.constructor);
chai.assert.equal(MESSAGE0, textField.getText());
});
test('message1 and message0 creates two inputs', function () {
/** Ensure message1 creates a new input. */
const BLOCK_TYPE = 'test_json_message1';
const MESSAGE0 = 'message0';
const MESSAGE1 = 'message1';
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
'message0': MESSAGE0,
'message1': MESSAGE1,
},
]);
const block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
chai.assert.equal(block.inputList.length, 2);
chai.assert.equal(block.inputList[0].fieldRow.length, 1);
const firstTextField = block.inputList[0].fieldRow[0];
chai.assert.equal(Blockly.FieldLabel, firstTextField.constructor);
chai.assert.equal(MESSAGE0, firstTextField.getText());
chai.assert.equal(block.inputList[1].fieldRow.length, 1);
const secondTextField = block.inputList[1].fieldRow[0];
chai.assert.equal(Blockly.FieldLabel, secondTextField.constructor);
chai.assert.equal(MESSAGE1, secondTextField.getText());
});
test('Message string is dereferenced', function () {
const BLOCK_TYPE = 'test_json_message0_i18n';
const MESSAGE0 = '%{BKY_MESSAGE}';
const MESSAGE = 'message';
addMessageToCleanup(this.sharedCleanup, 'MESSAGE');
Blockly.Msg['MESSAGE'] = MESSAGE;
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
'message0': MESSAGE0,
},
]);
const block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
chai.assert.equal(block.inputList.length, 1);
chai.assert.equal(block.inputList[0].fieldRow.length, 1);
const textField = block.inputList[0].fieldRow[0];
chai.assert.equal(Blockly.FieldLabel, textField.constructor);
chai.assert.equal(MESSAGE, textField.getText());
});
test('Dropdown', function () {
const BLOCK_TYPE = 'test_json_dropdown';
const FIELD_NAME = 'FIELD_NAME';
const LABEL0 = 'LABEL0';
const VALUE0 = 'VALUE0';
const LABEL1 = 'LABEL1';
const VALUE1 = 'VALUE1';
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
'message0': '%1',
'args0': [
{
'type': 'field_dropdown',
'name': FIELD_NAME,
'options': [
[LABEL0, VALUE0],
[LABEL1, VALUE1],
],
},
],
},
]);
const block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
chai.assert.equal(block.inputList.length, 1);
chai.assert.equal(block.inputList[0].fieldRow.length, 1);
const dropdown = block.inputList[0].fieldRow[0];
chai.assert.equal(dropdown, block.getField(FIELD_NAME));
chai.assert.equal(Blockly.FieldDropdown, dropdown.constructor);
chai.assert.equal(VALUE0, dropdown.getValue());
const options = dropdown.getOptions();
chai.assert.equal(LABEL0, options[0][0]);
chai.assert.equal(VALUE0, options[0][1]);
chai.assert.equal(LABEL1, options[1][0]);
chai.assert.equal(VALUE1, options[1][1]);
});
test('Dropdown with images', function () {
const BLOCK_TYPE = 'test_json_dropdown';
const FIELD_NAME = 'FIELD_NAME';
const IMAGE1_ALT_TEXT = 'Localized message.';
addMessageToCleanup(this.sharedCleanup, 'ALT_TEXT');
Blockly.Msg['ALT_TEXT'] = IMAGE1_ALT_TEXT;
const IMAGE0 = {
'width': 12,
'height': 34,
'src': 'http://image0.src',
'alt': 'IMAGE0 alt text',
};
const VALUE0 = 'VALUE0';
const IMAGE1 = {
'width': 56,
'height': 78,
'src': 'http://image1.src',
'alt': '%{BKY_ALT_TEXT}',
};
const VALUE1 = 'VALUE1';
const IMAGE2 = {
'width': 90,
'height': 123,
'src': 'http://image2.src',
};
const VALUE2 = 'VALUE2';
Blockly.defineBlocksWithJsonArray([
{
'type': BLOCK_TYPE,
'message0': '%1',
'args0': [
{
'type': 'field_dropdown',
'name': FIELD_NAME,
'options': [
[IMAGE0, VALUE0],
[IMAGE1, VALUE1],
[IMAGE2, VALUE2],
],
},
],
},
]);
const block = new Blockly.Block(this.workspace_, BLOCK_TYPE);
chai.assert.equal(block.inputList.length, 1);
chai.assert.equal(block.inputList[0].fieldRow.length, 1);
const dropdown = block.inputList[0].fieldRow[0];
chai.assert.equal(dropdown, block.getField(FIELD_NAME));
chai.assert.equal(Blockly.FieldDropdown, dropdown.constructor);
chai.assert.equal(VALUE0, dropdown.getValue());
function assertImageEquals(actualImage, expectedImage) {
chai.assert.equal(actualImage.width, expectedImage.width);
chai.assert.equal(actualImage.height, expectedImage.height);
chai.assert.equal(actualImage.src, expectedImage.src);
}
const options = dropdown.getOptions();
const image0 = options[0][0];
assertImageEquals(IMAGE0, image0);
chai.assert.equal(IMAGE0.alt, image0.alt);
chai.assert.equal(options[0][1], VALUE0);
const image1 = options[1][0];
assertImageEquals(IMAGE1, image1);
chai.assert.equal(image1.alt, IMAGE1_ALT_TEXT); // Via Msg reference
chai.assert.equal(VALUE1, options[1][1]);
const image2 = options[2][0];
assertImageEquals(IMAGE1, image1);
chai.assert.notExists(image2.alt); // No alt specified.
chai.assert.equal(VALUE2, options[2][1]);
});
});
});