feat: add tests for per-block generators in field-colour

.prettierignore

@@ -21,3 +21,5 @@ PULL_REQUEST_TEMPLATE.md
 plugins/dev-create/templates/sample-app/*
 plugins/dev-create/templates/sample-app-ts/*
 
+# Golden test files
+plugins/**/golden/*

eslint.config.js

@@ -44,6 +44,8 @@ module.exports = [
       // specific examples that are sometimes copied into plugins
       'plugins/dev-create/templates/sample-app',
       'plugins/dev-create/templates/sample-app-ts',
+      // Golden test files
+      'plugins/**/golden/*',
     ],
   },
   js.configs.recommended, // eslint-recommended

plugins/field-colour/src/blocks/colourBlend.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {Block, common as BlocklyCommon} from 'blockly';
+import {Block, common as BlocklyCommon} from 'blockly/core';
 import {
   JavascriptGenerator,
   Order as JavascriptOrder,

plugins/field-colour/src/blocks/colourPicker.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {Block, common as BlocklyCommon} from 'blockly';
+import {Block, common as BlocklyCommon} from 'blockly/core';
 import {
   JavascriptGenerator,
   Order as JavascriptOrder,

plugins/field-colour/src/blocks/colourRandom.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {Block, common as BlocklyCommon} from 'blockly';
+import {Block, common as BlocklyCommon} from 'blockly/core';
 import {
   JavascriptGenerator,
   Order as JavascriptOrder,

plugins/field-colour/src/blocks/colourRgb.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {Block, common as BlocklyCommon} from 'blockly';
+import {Block, common as BlocklyCommon} from 'blockly/core';
 import {
   JavascriptGenerator,
   Order as JavascriptOrder,

plugins/field-colour/test/blocks_test.mocha.js

@@ -0,0 +1,254 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import fs from 'fs';
+import * as Blockly from 'blockly/core';
+import 'blockly/blocks';
+
+import {javascriptGenerator} from 'blockly/javascript';
+import {dartGenerator} from 'blockly/dart';
+import {phpGenerator} from 'blockly/php';
+import {pythonGenerator} from 'blockly/python';
+import {luaGenerator} from 'blockly/lua';
+import {installAllBlocks} from '../src/index';
+import {assert} from 'chai';
+
+const blockJson = {
+  blocks: {
+    languageVersion: 0,
+    blocks: [
+      {
+        type: 'colour_picker',
+        x: 13,
+        y: 13,
+        fields: {
+          COLOUR: '#ff0000',
+        },
+      },
+      {
+        type: 'colour_random',
+        x: 13,
+        y: 113,
+      },
+      {
+        type: 'colour_rgb',
+        x: 13,
+        y: 263,
+        inputs: {
+          RED: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 0,
+              },
+            },
+          },
+          GREEN: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 1,
+              },
+            },
+          },
+          BLUE: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 20,
+              },
+            },
+          },
+        },
+      },
+      {
+        type: 'colour_blend',
+        x: 13,
+        y: 363,
+        inputs: {
+          COLOUR1: {
+            shadow: {
+              type: 'colour_picker',
+              fields: {
+                COLOUR: '#ff0000',
+              },
+            },
+          },
+          COLOUR2: {
+            shadow: {
+              type: 'colour_picker',
+              fields: {
+                COLOUR: '#3333ff',
+              },
+            },
+          },
+          RATIO: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 0.5,
+              },
+            },
+          },
+        },
+      },
+      {
+        type: 'colour_picker',
+        x: 13,
+        y: 63,
+        fields: {
+          COLOUR: '#3333ff',
+        },
+      },
+      {
+        type: 'colour_rgb',
+        x: 13,
+        y: 163,
+        inputs: {
+          RED: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 100,
+              },
+            },
+          },
+          GREEN: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 50,
+              },
+            },
+          },
+          BLUE: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 0,
+              },
+            },
+          },
+        },
+      },
+      {
+        type: 'colour_blend',
+        x: 13,
+        y: 463,
+        inputs: {
+          COLOUR1: {
+            shadow: {
+              type: 'colour_picker',
+              fields: {
+                COLOUR: '#000000',
+              },
+            },
+          },
+          COLOUR2: {
+            shadow: {
+              type: 'colour_picker',
+              fields: {
+                COLOUR: '#ffffff',
+              },
+            },
+          },
+          RATIO: {
+            shadow: {
+              type: 'math_number',
+              fields: {
+                NUM: 0.3,
+              },
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+
+/**
+ * Uninstall old blocks and generators, since they come pre-installed
+ * with Blockly.
+ * TODO(#2194): Delete this function and calls to it.
+ */
+function uninstallBlocks() {
+  delete Blockly.Blocks['colour_blend'];
+  delete Blockly.Blocks['colour_rgb'];
+  delete Blockly.Blocks['colour_random'];
+  delete Blockly.Blocks['colour_picker'];
+
+  const blockNames = [
+    'colour_blend',
+    'colour_rgb',
+    'colour_random',
+    'colour_picker',
+  ];
+  blockNames.forEach((name) => {
+    delete javascriptGenerator.forBlock[name];
+    delete dartGenerator.forBlock[name];
+    delete luaGenerator.forBlock[name];
+    delete pythonGenerator.forBlock[name];
+    delete phpGenerator.forBlock[name];
+  });
+}
+
+/**
+ * Assert that the generated code matches the golden code for the specified
+ * language.
+ * @param {string} suffix The suffix of the golden file.
+ * @param {string} generated The generated code to compare against the
+ *     golden file.
+ */
+function checkResult(suffix, generated) {
+  const fileName = `test/golden/golden.${suffix}`;
+  const goldenContents = fs.readFileSync(fileName);
+  // Normalize the line feeds.
+  const normalized = goldenContents.toString().replace(/(?:\r\n|\r|\n)/g, '\n');
+  assert.equal(generated, normalized);
+}
+
+suite('Colour Block Generators', function () {
+  suiteSetup(function () {
+    uninstallBlocks();
+    installAllBlocks({
+      javascript: javascriptGenerator,
+      dart: dartGenerator,
+      lua: luaGenerator,
+      python: pythonGenerator,
+      php: phpGenerator,
+    });
+  });
+  setup(function () {
+    this.workspace = new Blockly.Workspace();
+    Blockly.serialization.workspaces.load(blockJson, this.workspace);
+  });
+  test('JavaScript', function () {
+    const generated = javascriptGenerator.workspaceToCode(this.workspace);
+    checkResult('js', generated);
+  });
+  test('Dart', function () {
+    const generated = dartGenerator.workspaceToCode(this.workspace);
+    checkResult('dart', generated);
+  });
+  test('Lua', function () {
+    const generated = luaGenerator.workspaceToCode(this.workspace);
+    checkResult('lua', generated);
+  });
+  test('Python', function () {
+    const generated = pythonGenerator.workspaceToCode(this.workspace);
+    checkResult('py', generated);
+  });
+  test('PHP', function () {
+    const generated = phpGenerator.workspaceToCode(this.workspace);
+    checkResult('php', generated);
+  });
+  teardown(function () {
+    this.workspace.dispose();
+  });
+  suiteTeardown(function () {
+    uninstallBlocks();
+  });
+});