initial conversion of test/examples to ESM

RobotWebTools · Sep 21, 2021 · 179e506 · 179e506
1 parent ac261d6
commit 179e506
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 21 deletions.
diff --git a/test/examples/check-topics.example.js b/test/examples/check-topics.example.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 var expectedTopics = [
     // '/turtle1/cmd_vel', '/turtle1/color_sensor', '/turtle1/pose',

diff --git a/test/examples/fibonacci.example.js b/test/examples/fibonacci.example.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 describe('Fibonacci Example', function() {
     it('Fibonacci', function(done) {

diff --git a/test/examples/karma.conf.cjs b/test/examples/karma.conf.cjs
@@ -2,17 +2,22 @@ module.exports = function(config) {
 	config.set({
 
 		// Base path, that will be used to resolve files and exclude
-		basePath: '',
+		basePath: '../../',
 
 		// Testing frameworks
 		frameworks: ['mocha', 'chai'],
 
 		// List of files / patterns to load in the browser
 		files: [
-			"../../node_modules/eventemitter2/lib/eventemitter2.js",
-			"../../build/roslib.js",
-			"../require-shim.js",
-			"*.js"
+			// Make some file available to be fetched/imported, but not included in the HTML.
+			{pattern: 'build/roslib.esm.js', serve: true, included: false},
+    		{pattern: 'test/util/shim/chai.js', serve: true, included: false},
+    		{pattern: 'test/util/shim/stream.js', serve: true, included: false},
+
+			// This file maps some import specifiers to our module shims.
+			'test/util/write-importmap.js',
+
+			{pattern: 'test/examples/*.example.js', type: 'module'},
 		],
 
 		// test results reporter to use

diff --git a/test/examples/params.examples.js b/test/examples/params.examples.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 describe('Param setting', function() {
     var ros = new ROSLIB.Ros({

diff --git a/test/examples/pubsub.example.js b/test/examples/pubsub.example.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 describe('Topics Example', function() {
     this.timeout(1000);

diff --git a/test/examples/tf.example.js b/test/examples/tf.example.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 describe('TF2 Republisher Example', function() {
     it('tf republisher', function(done) {

diff --git a/test/examples/tf_service.example.js b/test/examples/tf_service.example.js
@@ -1,5 +1,7 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const {expect} = chai;
 
 describe('TF2 Republisher Service Example', function() {
     it('tf republisher', function(done) {

diff --git a/test/examples/topic-listener.example.js b/test/examples/topic-listener.example.js
@@ -1,5 +1,9 @@
-var expect = require('chai').expect;
-var ROSLIB = require('../..');
+import chai from 'chai';
+import Stream from 'stream';
+import * as ROSLIB from '../../src/RosLibNode.js';
+
+const TransformStream = Stream.Transform;
+const {expect} = chai;
 
 var ros = new ROSLIB.Ros({
     url: 'ws://localhost:9090'
@@ -55,8 +59,8 @@ describe('Topics Example', function() {
     });
 });
 
+// Only in Node.js, not browsers (f.e. during Mocha tests, but not during Karma tests)
 if (ROSLIB.Topic.prototype.toStream) {
-    var TransformStream = require('stream').Transform;
     describe('Topic Streams are readable and writable', function() {
         this.timeout(1000);
 
@@ -90,7 +94,7 @@ if (ROSLIB.Topic.prototype.toStream) {
             var stream = createAndStreamTopic('/echo/test-stream').toStream();
             var expected = messages.slice();
 
-            expect(stream).to.be.instanceof(require('stream'));
+            expect(stream).to.be.instanceof(Stream);
             stream.on('data', function(message) {
                 expect(message).to.be.eql(expected.shift());
             });

diff --git a/test/util/shim/stream.js b/test/util/shim/stream.js
@@ -0,0 +1,3 @@
+// This is empty because `stream` is not used when in a browser (and this file
+// is a shim for when in a browser).
+export default {}
diff --git a/test/util/write-importmap.js b/test/util/write-importmap.js
@@ -4,6 +4,7 @@ document.write(/*html*/`
     {
       "imports": {
         "chai": "/base/test/util/shim/chai.js",
+        "stream": "/base/test/util/shim/stream.js",
         "xmldom": "/base/src/util/shim/xmldom.js",
         "cbor-js": "/base/src/util/shim/cbor.js",
         "/base/src/RosLibNode.js": "/base/build/roslib.esm.js"