test: add smoke tests for importing as esm module and requiring as commonjs module

Author: rpl

tests/fixtures/import-as-esm/test-import.mjs

@@ -0,0 +1,7 @@
+import assert from 'assert';
+
+// eslint-disable-next-line import/no-unresolved
+import webExt from 'web-ext';
+
+assert.deepEqual(Object.keys(webExt).sort(), ['cmd', 'main', 'util'].sort());
+assert.equal(typeof webExt.cmd.run, 'function');

tests/fixtures/require-as-cjs/test-require.js

@@ -0,0 +1,6 @@
+const assert = require('assert');
+
+const webExt = require('web-ext');
+
+assert.deepEqual(Object.keys(webExt).sort(), ['cmd', 'main', 'util'].sort());
+assert.equal(typeof webExt.cmd.run, 'function');

tests/functional/common.js

@@ -18,6 +18,8 @@ export const webExt = process.env.TEST_WEB_EXT_BIN ?
   path.join(projectDir, 'bin', 'web-ext');
 export const fixturesDir = path.join(functionalTestsDir, '..', 'fixtures');
 export const minimalAddonPath = path.join(fixturesDir, 'minimal-web-ext');
+export const fixtureEsmImport = path.join(fixturesDir, 'import-as-esm');
+export const fixtureCjsRequire = path.join(fixturesDir, 'require-as-cjs');
 export const fakeFirefoxPath = path.join(
   functionalTestsDir,
   process.platform === 'win32' ?

tests/functional/test.lib.imports.js

@@ -0,0 +1,54 @@
+/* @flow */
+import {execSync} from 'child_process';
+import path from 'path';
+
+import {describe, it, before, after} from 'mocha';
+import shell from 'shelljs';
+
+import {
+  withTempDir, fixtureEsmImport, fixtureCjsRequire,
+} from './common';
+
+const npm = shell.which('npm');
+const node = shell.which('node');
+
+describe('web-ext imported as a library', () => {
+  before(function() {
+    // Only run this test in automation, to avoid running
+    // the npm link/npm unlink commands used to prepare
+    // the test environment for these tests.
+    if (!process.env.CI) {
+      this.skip();
+    }
+
+    execSync(`${npm} link`, {
+      cwd: path.resolve(path.join(__dirname, '..', '..')),
+    });
+  });
+
+  after(() => {
+    execSync(`${npm} unlink`, {
+      cwd: path.resolve(path.join(__dirname, '..', '..')),
+    });
+  });
+
+  it('can be imported as an ESM module', async () => {
+    await withTempDir(async (tmpDir) => {
+      execSync(`${npm} link web-ext`, {cwd: tmpDir.path()});
+      shell.cp('-rf', `${fixtureEsmImport}/*`, tmpDir.path());
+      execSync(`${node} --experimental-modules test-import.mjs`, {
+        cwd: tmpDir.path(),
+      });
+    });
+  });
+
+  it('can be imported as a CommonJS module', async () => {
+    await withTempDir(async (tmpDir) => {
+      execSync(`${npm} link web-ext`, {cwd: tmpDir.path()});
+      shell.cp('-rf', `${fixtureCjsRequire}/*`, tmpDir.path());
+      execSync(`${node} --experimental-modules test-require.js`, {
+        cwd: tmpDir.path(),
+      });
+    });
+  });
+});