Files
blockly/tests/mocha/workspace_comment_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

281 lines
7.4 KiB
JavaScript

/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
sharedTestSetup,
sharedTestTeardown,
} from './test_helpers/setup_teardown.js';
suite('Workspace comment', function () {
setup(function () {
sharedTestSetup.call(this);
this.workspace = new Blockly.Workspace();
});
teardown(function () {
sharedTestTeardown.call(this);
});
suite('getTopComments(ordered=true)', function () {
test('No comments', function () {
chai.assert.equal(this.workspace.getTopComments(true).length, 0);
});
test('One comment', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
chai.assert.equal(this.workspace.getTopComments(true).length, 1);
chai.assert.equal(this.workspace.commentDB.get('comment id'), comment);
});
test('After clear empty workspace', function () {
this.workspace.clear();
chai.assert.equal(this.workspace.getTopComments(true).length, 0);
});
test('After clear non-empty workspace', function () {
new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
this.workspace.clear();
chai.assert.equal(this.workspace.getTopComments(true).length, 0);
chai.assert.isFalse(this.workspace.commentDB.has('comment id'));
});
test('After dispose', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
comment.dispose();
chai.assert.equal(this.workspace.getTopComments(true).length, 0);
chai.assert.isFalse(this.workspace.commentDB.has('comment id'));
});
});
suite('getTopComments(ordered=false)', function () {
test('No comments', function () {
chai.assert.equal(this.workspace.getTopComments(false).length, 0);
});
test('One comment', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
chai.assert.equal(this.workspace.getTopComments(false).length, 1);
chai.assert.equal(this.workspace.commentDB.get('comment id'), comment);
});
test('After clear empty workspace', function () {
this.workspace.clear();
chai.assert.equal(this.workspace.getTopComments(false).length, 0);
});
test('After clear non-empty workspace', function () {
new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
this.workspace.clear();
chai.assert.equal(this.workspace.getTopComments(false).length, 0);
chai.assert.isFalse(this.workspace.commentDB.has('comment id'));
});
test('After dispose', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
comment.dispose();
chai.assert.equal(this.workspace.getTopComments(false).length, 0);
chai.assert.isFalse(this.workspace.commentDB.has('comment id'));
});
});
suite('getCommentById', function () {
test('Trivial', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
chai.assert.equal(this.workspace.getCommentById(comment.id), comment);
});
test('Null id', function () {
chai.assert.isNull(this.workspace.getCommentById(null));
});
test('Non-existent id', function () {
chai.assert.isNull(this.workspace.getCommentById('badId'));
});
test('After dispose', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
comment.dispose();
chai.assert.isNull(this.workspace.getCommentById(comment.id));
});
});
suite('dispose', function () {
test('Called twice', function () {
const comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
comment.dispose();
// Nothing should go wrong the second time dispose is called.
comment.dispose();
});
test('WorkspaceCommentSvg disposed', function () {
const comment = new Blockly.WorkspaceCommentSvg(
this.workspace,
'comment text',
0,
0,
'comment id',
);
comment.dispose();
// Nothing should go wrong the second time dispose is called.
comment.dispose();
});
});
suite('Width and height', function () {
setup(function () {
this.comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
10,
20,
'comment id',
);
});
test('Initial values', function () {
chai.assert.equal(this.comment.getWidth(), 20, 'Width');
chai.assert.equal(this.comment.getHeight(), 10, 'Height');
});
test('setWidth does not affect height', function () {
this.comment.setWidth(30);
chai.assert.equal(this.comment.getWidth(), 30, 'Width');
chai.assert.equal(this.comment.getHeight(), 10, 'Height');
});
test('setHeight does not affect width', function () {
this.comment.setHeight(30);
chai.assert.equal(this.comment.getWidth(), 20, 'Width');
chai.assert.equal(this.comment.getHeight(), 30, 'Height');
});
});
suite('XY position', function () {
setup(function () {
this.comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
10,
20,
'comment id',
);
});
test('Initial position', function () {
const xy = this.comment.getRelativeToSurfaceXY();
chai.assert.equal(xy.x, 0, 'Initial X position');
chai.assert.equal(xy.y, 0, 'Initial Y position');
});
test('moveBy', function () {
this.comment.moveBy(10, 100);
const xy = this.comment.getRelativeToSurfaceXY();
chai.assert.equal(xy.x, 10, 'New X position');
chai.assert.equal(xy.y, 100, 'New Y position');
});
});
suite('Content', function () {
setup(function () {
this.comment = new Blockly.WorkspaceComment(
this.workspace,
'comment text',
0,
0,
'comment id',
);
});
teardown(function () {
sinon.restore();
});
test('After creation', function () {
chai.assert.equal(this.comment.getContent(), 'comment text');
chai.assert.equal(
this.workspace.undoStack_.length,
1,
'Workspace undo stack',
);
});
test('Set to same value', function () {
this.comment.setContent('comment text');
chai.assert.equal(this.comment.getContent(), 'comment text');
// Setting the text to the old value does not fire an event.
chai.assert.equal(
this.workspace.undoStack_.length,
1,
'Workspace undo stack',
);
});
test('Set to different value', function () {
this.comment.setContent('new comment text');
chai.assert.equal(this.comment.getContent(), 'new comment text');
chai.assert.equal(
this.workspace.undoStack_.length,
2,
'Workspace undo stack',
);
});
});
});