fix(dev-tools): Have runSerializationTestSuite accept Blockly

Have runSerializationTestSuite accept a second argument which is the Blockly object to use for XML serialization/deserialization. This works around an issue in blockly-samples that (following the deletion of the alias for blockly in webpack.config.js) causes tests using this function to fail due to having two copies of jsdom loaded, where each will reject DOM objects created by the other. See google#2229 (comment) for more details.
cpcallen · Mar 5, 2024 · 8de739f · 8de739f
1 parent 76d3ce8
commit 8de739f
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 28 deletions.
diff --git a/plugins/block-dynamic-connection/test/dynamic_if.mocha.js b/plugins/block-dynamic-connection/test/dynamic_if.mocha.js
@@ -6,7 +6,7 @@
 
 const chai = require('chai');
 const {testHelpers} = require('@blockly/dev-tools');
-const Blockly = require('blockly');
+const Blockly = require('blockly/node');
 const {overrideOldBlockDefinitions} = require('../src/index');
 
 const assert = chai.assert;
@@ -641,5 +641,5 @@ suite('If block', function () {
       },
     },
   ];
-  testHelpers.runSerializationTestSuite(testCases);
+  testHelpers.runSerializationTestSuite(testCases, Blockly);
 });
diff --git a/plugins/block-dynamic-connection/test/dynamic_list_create.mocha.js b/plugins/block-dynamic-connection/test/dynamic_list_create.mocha.js
@@ -6,7 +6,7 @@
 
 const chai = require('chai');
 const {testHelpers} = require('@blockly/dev-tools');
-const Blockly = require('blockly');
+const Blockly = require('blockly/node');
 const {overrideOldBlockDefinitions} = require('../src/index');
 
 const assert = chai.assert;
@@ -540,5 +540,5 @@ suite('List create block', function () {
       },
     },
   ];
-  testHelpers.runSerializationTestSuite(testCases);
+  testHelpers.runSerializationTestSuite(testCases, Blockly);
 });
diff --git a/plugins/block-dynamic-connection/test/dynamic_text_join.mocha.js b/plugins/block-dynamic-connection/test/dynamic_text_join.mocha.js
@@ -6,7 +6,7 @@
 
 const chai = require('chai');
 const {testHelpers} = require('@blockly/dev-tools');
-const Blockly = require('blockly');
+const Blockly = require('blockly/node');
 const {overrideOldBlockDefinitions} = require('../src/index');
 
 const assert = chai.assert;
@@ -542,5 +542,5 @@ suite('Text join block', function () {
       },
     },
   ];
-  testHelpers.runSerializationTestSuite(testCases);
+  testHelpers.runSerializationTestSuite(testCases, Blockly);
 });
diff --git a/plugins/block-plus-minus/test/if.mocha.js b/plugins/block-plus-minus/test/if.mocha.js
@@ -172,7 +172,7 @@ suite('If block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   suite('JSON', function () {
@@ -222,7 +222,7 @@ suite('If block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   runPlusMinusTestSuite('controls_if', 1, 1, 'IF', assertIfBlockStructure);

diff --git a/plugins/block-plus-minus/test/list_create.mocha.js b/plugins/block-plus-minus/test/list_create.mocha.js
@@ -206,7 +206,7 @@ suite('List create block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   suite('Json', function () {
@@ -299,7 +299,7 @@ suite('List create block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   runPlusMinusTestSuite(

diff --git a/plugins/block-plus-minus/test/procedures.mocha.js b/plugins/block-plus-minus/test/procedures.mocha.js
@@ -339,7 +339,7 @@ suite('Procedure blocks', function () {
             },
           },
         ];
-        runSerializationTestSuite(testCases);
+        runSerializationTestSuite(testCases, Blockly);
       });
 
       suite('Json', function () {
@@ -514,7 +514,7 @@ suite('Procedure blocks', function () {
             },
           },
         ];
-        runSerializationTestSuite(testCases);
+        runSerializationTestSuite(testCases, Blockly);
       });
 
       suite('Adding and removing inputs', function () {

diff --git a/plugins/block-plus-minus/test/text_join.mocha.js b/plugins/block-plus-minus/test/text_join.mocha.js
@@ -195,7 +195,7 @@ suite('Text join block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   suite('Json', function () {
@@ -275,7 +275,7 @@ suite('Text join block', function () {
         },
       },
     ];
-    runSerializationTestSuite(testCases);
+    runSerializationTestSuite(testCases, Blockly);
   });
 
   runPlusMinusTestSuite('text_join', 2, 0, 'ADD', assertTextJoinBlockStructure);

diff --git a/plugins/block-shareable-procedures/test/procedure_blocks.mocha.js b/plugins/block-shareable-procedures/test/procedure_blocks.mocha.js
@@ -2228,7 +2228,7 @@ suite('Procedures', function () {
       },
     },
   ];
-  testHelpers.runSerializationTestSuite(xmlTestCases, globalThis.clock);
+  testHelpers.runSerializationTestSuite(xmlTestCases, Blockly);
 
   const jsonTestCases = [
     {
@@ -2448,5 +2448,5 @@ suite('Procedures', function () {
       },
     },
   ];
-  testHelpers.runSerializationTestSuite(jsonTestCases, globalThis.clock);
+  testHelpers.runSerializationTestSuite(jsonTestCases, Blockly);
 });
diff --git a/plugins/dev-create/templates/block/template/test/block_test.mocha.js b/plugins/dev-create/templates/block/template/test/block_test.mocha.js
@@ -140,7 +140,7 @@ suite('BlockTemplate', function () {
     },
     // TODO add additional test cases.
   ];
-  runSerializationTestSuite(testCases);
+  runSerializationTestSuite(testCases, Blockly);
 
   // TODO add any other relevant tests
 });
diff --git a/plugins/dev-tools/src/block_test_helpers.mocha.js b/plugins/dev-tools/src/block_test_helpers.mocha.js
@@ -158,8 +158,12 @@ export const runCodeGenerationTestSuites = (testSuites) => {
 /**
  * Runs serialization test suite.
  * @param {!Array<!SerializationTestCase>} testCases The test cases to run.
+ * @param {?Blockly} blockly The instance of Blockly to use for the
+ *     tests.  Optional, but must be supplied and must correspond to
+ *     the instance used to create this.workspace if that would not
+ *     otherwise be the case.
  */
-export const runSerializationTestSuite = (testCases) => {
+export const runSerializationTestSuite = (testCases, blockly = Blockly) => {
   /**
    * Creates test callback for xmlToBlock test.
    * @param {!SerializationTestCase} testCase The test case information.
@@ -169,14 +173,14 @@ export const runSerializationTestSuite = (testCases) => {
     return function () {
       let block;
       if (testCase.json) {
-        block = Blockly.serialization.blocks.append(
+        block = blockly.serialization.blocks.append(
           testCase.json,
           this.workspace,
           {recordUndo: true},
         );
       } else {
-        block = Blockly.Xml.domToBlock(
-          Blockly.utils.xml.textToDom(testCase.xml),
+        block = blockly.Xml.domToBlock(
+          blockly.utils.xml.textToDom(testCase.xml),
           this.workspace,
         );
       }
@@ -192,23 +196,23 @@ export const runSerializationTestSuite = (testCases) => {
   const createRoundTripTestCallback = (testCase) => {
     return function () {
       if (testCase.json) {
-        const block = Blockly.serialization.blocks.append(
+        const block = blockly.serialization.blocks.append(
           testCase.json,
           this.workspace,
           {recordUndo: true},
         );
         if (globalThis.clock) globalThis.clock.runAll();
-        const generatedJson = Blockly.serialization.blocks.save(block);
+        const generatedJson = blockly.serialization.blocks.save(block);
         const expectedJson = testCase.expectedJson || testCase.json;
         assert.deepEqual(generatedJson, expectedJson);
       } else {
-        const block = Blockly.Xml.domToBlock(
-          Blockly.utils.xml.textToDom(testCase.xml),
+        const block = blockly.Xml.domToBlock(
+          blockly.utils.xml.textToDom(testCase.xml),
           this.workspace,
         );
         if (globalThis.clock) globalThis.clock.runAll();
-        const generatedXml = Blockly.Xml.domToPrettyText(
-          Blockly.Xml.blockToDom(block),
+        const generatedXml = blockly.Xml.domToPrettyText(
+          blockly.Xml.blockToDom(block),
         );
         const expectedXml = testCase.expectedXml || testCase.xml;
         assert.equal(generatedXml, expectedXml);
@@ -221,7 +225,7 @@ export const runSerializationTestSuite = (testCases) => {
     });
     suite('serialization round-trip', function () {
       setup(function () {
-        sinon.stub(Blockly.utils.idGenerator.TEST_ONLY, 'genUid').returns('1');
+        sinon.stub(blockly.utils.idGenerator.TEST_ONLY, 'genUid').returns('1');
       });
 
       teardown(function () {