blockly 12.3.1 → 12.4.0

package/tests/generators/unittest_php.js

@@ -0,0 +1,154 @@
+/**
+ * @license
+ * Copyright 2015 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Generating PHP for unit test blocks.
+ */
+'use strict';
+
+phpGenerator.forBlock['unittest_main'] = function(block) {
+  // Container for unit tests.
+  var resultsVar = phpGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var functionName = phpGenerator.provideFunction_(
+      'unittest_report',
+      [ 'function ' + phpGenerator.FUNCTION_NAME_PLACEHOLDER_ + '() {',
+          '  global ' + resultsVar + ';',
+          '  // Create test report.',
+          '  $report = array();',
+          '  $summary = array();',
+          '  $fails = 0;',
+          '  for ($x = 0; $x < count(' + resultsVar + '); $x++) {',
+          '    if (' + resultsVar + '[$x][0]) {',
+          '      array_push($summary, ".");',
+          '    } else {',
+          '      array_push($summary, "F");',
+          '      $fails++;',
+          '      array_push($report, "");',
+          '      array_push($report, "FAIL: " . ' + resultsVar + '[$x][2]);',
+          '      array_push($report, ' + resultsVar + '[$x][1]);',
+          '    }',
+          '  }',
+          '  array_unshift($report, implode("", $summary));',
+          '  array_push($report, "");',
+          '  array_push($report, "Number of tests run: " . count(' + resultsVar + '));',
+          '  array_push($report, "");',
+          '  if ($fails) {',
+          '    array_push($report, "FAILED (failures=" . $fails . ")");',
+          '  } else {',
+          '    array_push($report, "OK");',
+          '  }',
+          '  return implode("\\n", $report);',
+          '}']);
+  // Setup global to hold test results.
+  var code = resultsVar + ' = array();\n';
+  // Say which test suite this is.
+  code += 'print("\\n====================\\n\\n' +
+      'Running suite: ' +
+      block.getFieldValue('SUITE_NAME') +
+       '\\n");\n';
+  // Run tests (unindented).
+  code += phpGenerator.statementToCode(block, 'DO')
+      .replace(/^  /, '').replace(/\n  /g, '\n');
+  // Send the report to the console (that's where errors will go anyway).
+  code += 'print(' + functionName + '());\n';
+  // Destroy results.
+  code += resultsVar + ' = null;\n';
+  return code;
+};
+
+function phpDefineAssert() {
+  var resultsVar = phpGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var functionName = phpGenerator.provideFunction_(
+      'assertEquals',
+      ['function ' + phpGenerator.FUNCTION_NAME_PLACEHOLDER_ +
+      '($actual, $expected, $message) {',
+      '  global ' + resultsVar + ';',
+      '  // Asserts that a value equals another value.',
+      '  if (!is_array(' + resultsVar + ')) {',
+      '    throw new Exception("Orphaned assert: " . $message);',
+      '  }',
+      '  if ($actual == $expected) {',
+      '    array_push(' + resultsVar + ', [true, "OK", $message]);',
+      '  } else {',
+      '    $expected = is_array($expected) ? implode(" ", $expected) : ' +
+          '$expected;',
+      '    $actual = is_array($actual) ? implode(" ", $actual) : ' +
+          '$actual;',
+      '    array_push(' + resultsVar + ', [false, ' +
+      '"Expected: " . $expected . "\\nActual: " . $actual, $message]);',
+      '  }',
+      '}']);
+  return functionName;
+};
+
+phpGenerator.forBlock['unittest_assertequals'] = function(block) {
+  // Asserts that a value equals another value.
+  var message = phpGenerator.valueToCode(block, 'MESSAGE',
+    phpGenerator.ORDER_NONE) || '';
+  var actual = phpGenerator.valueToCode(block, 'ACTUAL',
+          phpGenerator.ORDER_NONE) || 'null';
+  var expected = phpGenerator.valueToCode(block, 'EXPECTED',
+          phpGenerator.ORDER_NONE) || 'null';
+  return phpDefineAssert() +
+      '(' + actual + ', ' + expected + ', ' + message + ');\n';
+};
+
+phpGenerator.forBlock['unittest_assertvalue'] = function(block) {
+  // Asserts that a value is true, false, or null.
+  var message = phpGenerator.valueToCode(block, 'MESSAGE',
+    phpGenerator.ORDER_NONE) || '';
+  var actual = phpGenerator.valueToCode(block, 'ACTUAL',
+          phpGenerator.ORDER_NONE) || 'null';
+  var expected = block.getFieldValue('EXPECTED');
+  if (expected == 'TRUE') {
+      expected = 'true';
+  } else if (expected == 'FALSE') {
+      expected = 'false';
+  } else if (expected == 'NULL') {
+      expected = 'null';
+  }
+  return phpDefineAssert() +
+      '(' + actual + ', ' + expected + ', ' + message + ');\n';
+};
+
+phpGenerator.forBlock['unittest_fail'] = function(block) {
+  // Always assert an error.
+  var resultsVar = phpGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var message = phpGenerator.quote_(block.getFieldValue('MESSAGE'));
+  var functionName = phpGenerator.provideFunction_(
+      'unittest_fail',
+      [ 'function ' + phpGenerator.FUNCTION_NAME_PLACEHOLDER_ +
+      '($message) {',
+          '  global ' + resultsVar + ';',
+          '  // Always assert an error.',
+          '  if (!' + resultsVar + ') {',
+          '    throw new Exception("Orphaned assert fail: " . $message);',
+          '  }',
+          '  array_push(' + resultsVar + ', [false, "Fail.", $message]);',
+          '}']);
+  return functionName + '(' + message + ');\n';
+};
+
+phpGenerator.forBlock['unittest_adjustindex'] = function(block) {
+  var index = phpGenerator.valueToCode(block, 'INDEX',
+      phpGenerator.ORDER_ADDITION) || '0';
+  // Adjust index if using one-based indexing.
+  if (block.workspace.options.oneBasedIndex) {
+    if (Blockly.utils.string.isNumber(index)) {
+      // If the index is a naked number, adjust it right now.
+      return [Number(index) + 1, phpGenerator.ORDER_ATOMIC];
+    } else {
+      // If the index is dynamic, adjust it in code.
+      index += ' + 1';
+    }
+  } else if (Blockly.utils.string.isNumber(index)) {
+    return [index, phpGenerator.ORDER_ATOMIC];
+  }
+  return [index, phpGenerator.ORDER_ADDITION];
+};

package/tests/generators/unittest_python.js

@@ -0,0 +1,138 @@
+/**
+ * @license
+ * Copyright 2012 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Generating Python for unit test blocks.
+ */
+'use strict';
+
+pythonGenerator.forBlock['unittest_main'] = function(block) {
+  // Container for unit tests.
+  var resultsVar = pythonGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var functionName = pythonGenerator.provideFunction_(
+      'unittest_report',
+      ['def ' + pythonGenerator.FUNCTION_NAME_PLACEHOLDER_ + '():',
+       '  # Create test report.',
+       '  report = []',
+       '  summary = []',
+       '  fails = 0',
+       '  for (success, log, message) in ' + resultsVar + ':',
+       '    if success:',
+       '      summary.append(".")',
+       '    else:',
+       '      summary.append("F")',
+       '      fails += 1',
+       '      report.append("")',
+       '      report.append("FAIL: " + message)',
+       '      report.append(log)',
+       '  report.insert(0, "".join(summary))',
+       '  report.append("")',
+       '  report.append("Number of tests run: %d" % len(' + resultsVar + '))',
+       '  report.append("")',
+       '  if fails:',
+       '    report.append("FAILED (failures=%d)" % fails)',
+       '  else:',
+       '    report.append("OK")',
+       '  return "\\n".join(report)']);
+
+  // Setup global to hold test results.
+  var code = resultsVar + ' = []\n';
+  // Say which test suite this is.
+  code += 'print(\'\\n====================\\n\\n' +
+      'Running suite: ' +
+      block.getFieldValue('SUITE_NAME') +
+       '\')\n';
+  // Run tests (unindented).
+  code += pythonGenerator.statementToCode(block, 'DO')
+      .replace(/^  /, '').replace(/\n  /g, '\n');
+  // Print the report.
+  code += 'print(' + functionName + '())\n';
+  // Destroy results.
+  code += resultsVar + ' = None\n';
+  return code;
+};
+
+function pythonDefineAssert() {
+  var resultsVar = pythonGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var functionName = pythonGenerator.provideFunction_(
+      'assertEquals',
+      ['def ' + pythonGenerator.FUNCTION_NAME_PLACEHOLDER_ +
+          '(actual, expected, message):',
+       '  # Asserts that a value equals another value.',
+       '  if ' + resultsVar + ' == None:',
+       '    raise Exception("Orphaned assert equals: " + message)',
+       '  if actual == expected:',
+       '    ' + resultsVar + '.append((True, "OK", message))',
+       '  else:',
+       '    ' + resultsVar + '.append((False, ' +
+           '"Expected: %s\\nActual: %s" % (expected, actual), message))']);
+  return functionName;
+};
+
+pythonGenerator.forBlock['unittest_assertequals'] = function(block) {
+  // Asserts that a value equals another value.
+  var message = pythonGenerator.valueToCode(block, 'MESSAGE',
+      pythonGenerator.ORDER_NONE) || '';
+  var actual = pythonGenerator.valueToCode(block, 'ACTUAL',
+      pythonGenerator.ORDER_NONE) || 'None';
+  var expected = pythonGenerator.valueToCode(block, 'EXPECTED',
+      pythonGenerator.ORDER_NONE) || 'None';
+  return pythonDefineAssert() +
+      '(' + actual + ', ' + expected + ', ' + message + ')\n';
+};
+
+pythonGenerator.forBlock['unittest_assertvalue'] = function(block) {
+  // Asserts that a value is true, false, or null.
+  var message = pythonGenerator.valueToCode(block, 'MESSAGE',
+      pythonGenerator.ORDER_NONE) || '';
+  var actual = pythonGenerator.valueToCode(block, 'ACTUAL',
+      pythonGenerator.ORDER_NONE) || 'None';
+  var expected = block.getFieldValue('EXPECTED');
+  if (expected == 'TRUE') {
+    expected = 'True';
+  } else if (expected == 'FALSE') {
+    expected = 'False';
+  } else if (expected == 'NULL') {
+    expected = 'None';
+  }
+  return pythonDefineAssert() +
+      '(' + actual + ', ' + expected + ', ' + message + ')\n';
+};
+
+pythonGenerator.forBlock['unittest_fail'] = function(block) {
+  // Always assert an error.
+  var resultsVar = pythonGenerator.nameDB_.getName('unittestResults',
+      Blockly.Names.DEVELOPER_VARIABLE_TYPE);
+  var message = pythonGenerator.quote_(block.getFieldValue('MESSAGE'));
+  var functionName = pythonGenerator.provideFunction_(
+      'fail',
+      ['def ' + pythonGenerator.FUNCTION_NAME_PLACEHOLDER_ + '(message):',
+       '  # Always assert an error.',
+       '  if ' + resultsVar + ' == None:',
+       '    raise Exception("Orphaned assert equals: " + message)',
+       '  ' + resultsVar + '.append((False, "Fail.", message))']);
+  return functionName + '(' + message + ')\n';
+};
+
+pythonGenerator.forBlock['unittest_adjustindex'] = function(block) {
+  var index = pythonGenerator.valueToCode(block, 'INDEX',
+      pythonGenerator.ORDER_ADDITIVE) || '0';
+  // Adjust index if using one-based indexing.
+  if (block.workspace.options.oneBasedIndex) {
+    if (Blockly.utils.string.isNumber(index)) {
+      // If the index is a naked number, adjust it right now.
+      return [Number(index) + 1, pythonGenerator.ORDER_ATOMIC];
+    } else {
+      // If the index is dynamic, adjust it in code.
+      index += ' + 1';
+    }
+  } else if (Blockly.utils.string.isNumber(index)) {
+    return [index, pythonGenerator.ORDER_ATOMIC];
+  }
+  return [index, pythonGenerator.ORDER_ADDITIVE];
+};

package/tests/generators/variables.xml

@@ -0,0 +1,68 @@
+<xml xmlns="https://developers.google.com/blockly/xml">
+  <!-- Do not include <variables> here to test backward compatibility. -->
+  <block type="unittest_main" x="0" y="0">
+    <field name="SUITE_NAME">Variables</field>
+    <statement name="DO">
+      <block type="variables_set" inline="false">
+        <field name="VAR">item</field>
+        <value name="VALUE">
+          <block type="math_number">
+            <field name="NUM">123</field>
+          </block>
+        </value>
+        <next>
+          <block type="unittest_assertequals" inline="false">
+            <value name="MESSAGE">
+               <block type="text">
+                 <field name="TEXT">variable</field>
+               </block>
+             </value>
+            <value name="ACTUAL">
+              <block type="variables_get">
+                <field name="VAR">item</field>
+              </block>
+            </value>
+            <value name="EXPECTED">
+              <block type="math_number">
+                <field name="NUM">123</field>
+              </block>
+            </value>
+            <next>
+              <block type="variables_set" inline="false">
+                <field name="VAR">if</field>
+                <value name="VALUE">
+                  <block type="math_number">
+                    <field name="NUM">123</field>
+                  </block>
+                </value>
+                <next>
+                  <block type="unittest_assertequals" inline="false">
+                    <value name="MESSAGE">
+                       <block type="text">
+                         <field name="TEXT">reserved variable</field>
+                       </block>
+                     </value>
+                    <value name="ACTUAL">
+                      <block type="variables_get">
+                        <field name="VAR">if</field>
+                      </block>
+                    </value>
+                    <value name="EXPECTED">
+                      <block type="math_number">
+                        <field name="NUM">123</field>
+                      </block>
+                    </value>
+                  </block>
+                </next>
+              </block>
+            </next>
+          </block>
+        </next>
+      </block>
+    </statement>
+  </block>
+  <block type="variables_get" x="300" y="100">
+    <field name="VAR">naked</field>
+    <comment pinned="false" h="80" w="160">Intentionally non-connected variable.</comment>
+  </block>
+</xml>

package/tests/generators/webdriver.js

@@ -0,0 +1,123 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Node.js script to run generator tests in Chrome, via webdriver.
+ */
+var webdriverio = require('webdriverio');
+var fs = require('fs');
+var path = require('path');
+
+
+/**
+ * Run the generator for a given language and save the results to a file.
+ * @param {Thenable} browser A Thenable managing the processing of the browser
+ *     tests.
+ * @param {string} filename Where to write the output file.
+ * @param {Function} codegenFn The function to run for code generation for this
+ *     language.
+ */
+async function runLangGeneratorInBrowser(browser, filename, codegenFn) {
+  await browser.execute(codegenFn);
+  var elem = await browser.$("#importExport");
+  var result = await elem.getValue();
+  fs.writeFileSync(filename, result, function(err) {
+    if (err) {
+      return console.log(err);
+    }
+  });
+}
+
+/**
+ * Runs the generator tests in Chrome. It uses webdriverio to
+ * launch Chrome and load index.html. Outputs a summary of the test results
+ * to the console and outputs files for later validation.
+ * @param {string} outputDir Output directory.
+ * @return The Thenable managing the processing of the browser tests.
+ */
+async function runGeneratorsInBrowser(outputDir) {
+  var options = {
+    capabilities: {
+      browserName: 'chrome',
+      'goog:chromeOptions': {
+        args: ['--allow-file-access-from-files'],
+      },
+    },
+    logLevel: 'warn',
+  };
+
+  // Run in headless mode on Github Actions.
+  if (process.env.CI) {
+    options.capabilities['goog:chromeOptions'].args.push(
+        '--headless', '--no-sandbox', '--disable-dev-shm-usage',);
+  } else {
+    // --disable-gpu is needed to prevent Chrome from hanging on Linux with
+    // NVIDIA drivers older than v295.20. See
+    // https://github.com/google/blockly/issues/5345 for details.
+    options.capabilities['goog:chromeOptions'].args.push('--disable-gpu');
+  }
+
+  var url = 'file://' + __dirname + '/index.html';
+  var prefix = path.join(outputDir, 'generated');
+
+  console.log('Starting webdriverio...');
+  const browser = await webdriverio.remote(options);
+
+  // Increase the script timeouts to 2 minutes to allow the generators to finish.
+  await browser.setTimeout({ 'script': 120000 })
+
+  console.log('Loading url: ' + url);
+  await browser.url(url);
+
+  await browser
+    .$('.blocklySvg .blocklyWorkspace > .blocklyBlockCanvas')
+    .waitForExist({timeout: 2000});
+
+  await browser.execute(function() {
+    checkAll();
+    return loadSelected();
+  });
+
+  await runLangGeneratorInBrowser(browser, prefix + '.js',
+      function() {
+        toJavaScript();
+      });
+  await runLangGeneratorInBrowser(browser, prefix + '.py',
+      function() {
+        toPython();
+      });
+  await runLangGeneratorInBrowser(browser, prefix + '.dart',
+      function() {
+        toDart();
+      });
+  await runLangGeneratorInBrowser(browser, prefix + '.lua',
+      function() {
+        toLua();
+      });
+  await runLangGeneratorInBrowser(browser, prefix + '.php',
+      function() {
+        toPhp();
+      });
+
+  await browser.deleteSession();
+}
+
+if (require.main === module) {
+  runGeneratorsInBrowser('tests/generators/tmp').catch(e => {
+    console.error(e);
+    process.exit(1);
+  }).then(function(result) {
+    if (result) {
+      console.log('Generator tests failed');
+      process.exit(1);
+    } else {
+      console.log('Generator tests passed');
+      process.exit(0);
+    }
+  });
+}
+
+module.exports = {runGeneratorsInBrowser};

package/tests/migration/renamings.schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/google/blockly/tests/migration/renamings-schema.json",
+  "title": "Renamings",
+  "description": "A file containing information about module and module export renamings",
+  "type": "object",
+  "patternProperties": {
+    "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$": {
+      "$ref": "#/$defs/version"
+    }
+  },
+  "properties": {
+    "develop": {"$ref": "#/$defs/version"}
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "version": {
+      "description": "All the renamings that happened in a paricular release.",
+      "type": "array",
+      "items": {
+        "description": "All the renamings in/of a particular module.",
+        "type": "object",
+        "properties": {
+          "oldName": {"$ref": "#/$defs/dottedIdentifier"},
+          "newName": {"$ref": "#/$defs/dottedIdentifier"},
+          "newExport": {"$ref": "#/$defs/dottedIdentifier"},
+          "oldPath": {"$ref": "#/$defs/dottedIdentifier"},
+          "newPath": {"$ref": "#/$defs/dottedIdentifier"},
+          "exports": {
+            "description": "A list of the exports that have been renamed.",
+            "type": "object",
+            "patternProperties": {
+              "^[A-Za-z$_][A-Za-z0-9$_]*(\\.[A-Za-z$_][A-Za-z0-9$_]*)*$": {
+                "description": "A single renamed (or moved) export.",
+                "type": "object",
+                "properties": {
+                  "newModule": {"$ref": "#/$defs/dottedIdentifier"},
+                  "newExport": {"$ref": "#/$defs/dottedIdentifier"},
+                  "oldPath": {"$ref": "#/$defs/dottedIdentifier"},
+                  "newPath": {"$ref": "#/$defs/dottedIdentifier"},
+                  "getMethod": {"$ref": "#/$defs/dottedIdentifier"},
+                  "setMethod": {"$ref": "#/$defs/dottedIdentifier"}
+                },
+                "additionalProperties": false
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": ["oldName"],
+        "additionalProperties": false
+      }
+    },
+    "dottedIdentifier": {
+      "type": "string",
+      "pattern": "^[A-Za-z$_][A-Za-z0-9$_]*(\\.[A-Za-z$_][A-Za-z0-9$_]*)*$"
+    }
+  }
+}

package/tests/migration/validate-renamings.mjs

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview A script to validate the renamings file
+ * (scripts/migration/renamings.json5) agaist the schema
+ * (renamings-schema.json).
+ */
+
+import {validate} from '@hyperjump/json-schema/draft-2020-12';
+import {BASIC} from '@hyperjump/json-schema/experimental';
+import {readFile} from 'fs/promises';
+import JSON5 from 'json5';
+
+/** @type {URL} Renaming schema filename. */
+const SCHEMA_URL = new URL('renamings.schema.json', import.meta.url);
+
+/** @type {URL} Renamings filename. */
+const RENAMINGS_URL = new URL(
+  '../../scripts/migration/renamings.json5',
+  import.meta.url,
+);
+
+readFile(RENAMINGS_URL).then((renamingsJson5) => {
+  const renamings = JSON5.parse(renamingsJson5);
+
+  validate(SCHEMA_URL, renamings, BASIC).then((output) => {
+    if (!output.valid) {
+      console.error(`Renamings file is invalid.  First error occurs at:
+    ${output.errors[0].instanceLocation}`);
+      console.info(
+        `Here is the full validator output, in case that helps:\n`,
+        output,
+      );
+      process.exit(1);
+    }
+
+    // File passed schema validation.  Do some additional checks.
+    let ok = true;
+    Object.entries(renamings).forEach(([version, modules]) => {
+      // Scan through modules and check for duplicates.
+      const seen = new Set();
+      for (const {oldName} of modules) {
+        if (seen.has(oldName)) {
+          console.error(
+            `Duplicate entry for module ${oldName} ` + `in version ${version}.`,
+          );
+          ok = false;
+        }
+        seen.add(oldName);
+      }
+    });
+    if (!ok) {
+      console.error('Renamings file is invalid.');
+      process.exit(1);
+    }
+    // Default is a successful exit 0.
+  });
+});

package/tests/mocha/.mocharc.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = {
+  ui: 'tdd',
+  reporter: 'landing',
+};