swtich to esmocha (#877)

* swtich to esmocha

* mock adjusts

* increase timeout

Author: mshima

.mocharc.cjs

@@ -0,0 +1,5 @@
+/** @type {import('mocha').MochaOptions} */
+module.exports = {
+  timeout: 20000,
+  parallel: true,
+};

package-lock.json

@@ -37,7 +37,7 @@
     "postinstall": "yodoctor",
     "postupdate": "yodoctor",
     "pretest": "xo",
-    "test": "c8 mocha --timeout=30000"
+    "test": "c8 esmocha"
   },
   "xo": {
     "overrides": [
@@ -93,12 +93,12 @@
     "@types/node": "^22.14.0",
     "c8": "^10.1.3",
     "coveralls": "^3.0.2",
+    "esmocha": "^3.0.0",
     "mocha": "^11.0.1",
     "mockery": "^2.0.0",
     "nock": "^13.2.1",
     "registry-url": "^7.0.0",
     "sinon": "^20.0.0",
-    "testdouble": "^3.20.2",
     "xo": "0.60.0"
   },
   "engines": {

package.json

@@ -1,4 +1,5 @@
 import sinon from 'sinon';
+import {createEnv} from 'yeoman-environment';
 
 export const fakeCrossSpawn = event => sinon.stub().returns({
   on(name, callback) {
@@ -10,8 +11,7 @@ export const fakeCrossSpawn = event => sinon.stub().returns({
   },
 });
 
-export const fakeEnv = async () => {
-  const {createEnv} = await import('yeoman-environment');
+export const fakeEnv = () => {
   const env = createEnv();
   sinon.stub(env, 'lookup');
   sinon.stub(env, 'run');

test/helpers.js

@@ -1,24 +1,30 @@
 import assert from 'node:assert';
-import * as td from 'testdouble';
+import {esmocha} from 'esmocha';
 import sinon from 'sinon';
 import _ from 'lodash';
 import inquirer from 'inquirer';
 import Router from '../lib/router.js';
 
+const globalConfig = {
+  remove: sinon.stub(),
+  removeAll: sinon.stub(),
+  getAll() {
+    return {
+      'generator-phoenix': {},
+      'generator-unicorn': {},
+    };
+  },
+};
+
+await esmocha.mock('../lib/utils/global-config.js', {default: globalConfig});
+const {clearConfig} = (await import('../lib/routes/clear-config.js'));
+esmocha.reset();
+
 describe('clear config route', () => {
   beforeEach(async function () {
     this.sandbox = sinon.createSandbox();
-    this.globalConfig = {
-      remove: sinon.stub(),
-      removeAll: sinon.stub(),
-      getAll() {
-        return {
-          'generator-phoenix': {},
-          'generator-unicorn': {},
-        };
-      },
-    };
-    const config = {
+    this.globalConfig = globalConfig;
+    const config_ = {
       get() {
         return {
           unicorn: 20,
@@ -27,11 +33,8 @@ describe('clear config route', () => {
       },
     };
     this.homeRoute = sinon.stub().returns(Promise.resolve());
-    this.router = new Router(sinon.stub(), config);
+    this.router = new Router(sinon.stub(), config_);
     this.router.registerRoute('home', this.homeRoute);
-    await td.replaceEsm('../lib/utils/global-config.js', undefined, this.globalConfig);
-
-    const {clearConfig} = (await import('../lib/routes/clear-config.js'));
 
     this.router.registerRoute('clearConfig', clearConfig);
     this.router.generators = {
@@ -50,7 +53,7 @@ describe('clear config route', () => {
 
   afterEach(function () {
     this.sandbox.restore();
-    td.reset();
+    esmocha.clearAllMocks();
   });
 
   it('allow returning home', function () {

test/route-clear-config.js

@@ -1,25 +1,25 @@
-import * as td from 'testdouble';
+import {esmocha, expect} from 'esmocha';
 import sinon from 'sinon';
 import inquirer from 'inquirer';
 import Router from '../lib/router.js';
 
+const {default: open} = await esmocha.mock('open');
+const {help: helpRoute} = await import('../lib/routes/help.js');
+esmocha.reset();
+
 describe('help route', () => {
   beforeEach(async function () {
     this.sandbox = sinon.createSandbox();
     this.homeRoute = sinon.stub().returns(Promise.resolve());
     this.router = new Router(sinon.stub());
     this.router.registerRoute('home', this.homeRoute);
     this.open = sinon.stub();
-    await td.replaceEsm('open', undefined, this.open);
-
-    const {help: helpRoute} = await import('../lib/routes/help.js');
-
     this.router.registerRoute('help', helpRoute);
   });
 
   afterEach(function () {
     this.sandbox.restore();
-    td.reset();
+    esmocha.clearAllMocks();
   });
 
   it('allow returning home', function () {
@@ -33,8 +33,8 @@ describe('help route', () => {
     const url = 'http://yeoman.io';
     this.sandbox.stub(inquirer, 'prompt').returns(Promise.resolve({whereTo: url}));
     return this.router.navigate('help').then(() => {
-      sinon.assert.calledWith(this.open, url);
-      sinon.assert.calledOnce(this.open);
+      expect(open).toHaveBeenCalledTimes(1);
+      expect(open).toHaveBeenCalledWith(url);
     });
   });
 });

test/route-help.js

@@ -1,34 +1,45 @@
 import assert from 'node:assert';
+import {esmocha, expect} from 'esmocha';
 import _ from 'lodash';
-import inquirer from 'inquirer';
 import nock from 'nock';
-import * as td from 'testdouble';
-import sinon from 'sinon';
 import registryUrlFactory from 'registry-url';
 import Router from '../lib/router.js';
 import * as helpers from './helpers.js';
 
+const spawn = await esmocha.mock('cross-spawn', {
+  default: esmocha.fn().mockReturnValue({
+    on: esmocha.fn().mockImplementation(function (name, callback) {
+      if (name === 'close') {
+        callback();
+      }
+
+      return this;
+    }),
+  }),
+});
+
+esmocha.spyOn(_, 'memoize').mockImplementation(function_ => function_);
+const {default: inquirer} = await esmocha.mock('inquirer');
+const {install} = await import('../lib/routes/install.js');
+esmocha.reset();
+_.memoize.mockRestore();
+
 const registryUrl = registryUrlFactory();
 
 describe('install route', () => {
   beforeEach(async function () {
-    this.sandbox = sinon.createSandbox();
     this.env = await helpers.fakeEnv();
-    this.homeRoute = sinon.stub().returns(Promise.resolve());
+    this.homeRoute = esmocha.fn().mockResolvedValue();
     this.router = new Router(this.env);
     this.router.registerRoute('home', this.homeRoute);
-    this.spawn = helpers.fakeCrossSpawn('close');
-    await td.replaceEsm('cross-spawn', undefined, this.spawn);
-
-    const {install} = await import('../lib/routes/install.js');
 
     this.router.registerRoute('install', install);
     this.env.registerStub(_.noop, 'generator-unicorn');
   });
 
-  afterEach(function () {
-    this.sandbox.restore();
-    td.reset();
+  afterEach(() => {
+    esmocha.clearAllMocks();
+    nock.cleanAll();
   });
 
   describe('npm success with results', () => {
@@ -83,6 +94,7 @@ describe('install route', () => {
       nock(registryUrl)
         .get('/-/v1/search')
         .query(true)
+        .times(4)
         .reply(200, {objects: this.packages.map(data => ({package: data}))})
         .filteringPath(/\/[^?]+$/g, '/pkg')
         .get('/pkg')
@@ -95,13 +107,9 @@ describe('install route', () => {
         .reply(200, this.blacklist);
     });
 
-    afterEach(() => {
-      nock.cleanAll();
-    });
-
     it('filters already installed generators and match search term', function (done) {
       let call = 0;
-      this.sandbox.stub(inquirer, 'prompt').callsFake(argument => {
+      inquirer.prompt.mockImplementation(argument => {
         call++;
         if (call === 1) {
           return Promise.resolve({searchTerm: 'unicorn'});
@@ -124,7 +132,7 @@ describe('install route', () => {
 
     it('filters blacklisted generators and match search term', function (done) {
       let call = 0;
-      this.sandbox.stub(inquirer, 'prompt').callsFake(argument => {
+      inquirer.prompt.mockImplementation(argument => {
         call++;
         if (call === 1) {
           return Promise.resolve({searchTerm: 'blacklist'});
@@ -144,33 +152,32 @@ describe('install route', () => {
       this.router.navigate('install');
     });
 
-    it('allow redo the search', function (done) {
+    it('allow redo the search', async function () {
       let call = 0;
-      this.sandbox.stub(inquirer, 'prompt').callsFake(argument => {
+      inquirer.prompt.mockImplementation(async argument => {
         call++;
         if (call === 1) {
-          return Promise.resolve({searchTerm: 'unicorn'});
+          return {searchTerm: 'unicorn'};
         }
 
         if (call === 2) {
-          return Promise.resolve({toInstall: 'install'});
+          return {toInstall: 'install'};
         }
 
         if (call === 3) {
           assert.strictEqual(argument[0].name, 'searchTerm');
-          return Promise.resolve({searchTerm: 'unicorn'});
+          return {searchTerm: 'unicorn'};
         }
 
-        done();
-        return Promise.resolve({toInstall: 'home'});
+        return {toInstall: 'home'};
       });
 
-      this.router.navigate('install');
+      await this.router.navigate('install');
     });
 
     it('allow going back home', function () {
       let call = 0;
-      this.sandbox.stub(inquirer, 'prompt').callsFake(() => {
+      inquirer.prompt.mockImplementation(() => {
         call++;
         if (call === 1) {
           return Promise.resolve({searchTerm: 'unicorn'});
@@ -180,13 +187,13 @@ describe('install route', () => {
       });
 
       return this.router.navigate('install').then(() => {
-        sinon.assert.calledOnce(this.homeRoute);
+        expect(this.homeRoute).toHaveBeenCalledTimes(1);
       });
     });
 
     it('install a generator', function () {
       let call = 0;
-      this.sandbox.stub(inquirer, 'prompt').callsFake(() => {
+      inquirer.prompt.mockImplementation(() => {
         call++;
         if (call === 1) {
           return Promise.resolve({searchTerm: 'unicorn'});
@@ -200,9 +207,9 @@ describe('install route', () => {
       });
 
       return this.router.navigate('install').then(() => {
-        sinon.assert.calledWith(this.spawn, 'npm', ['install', '--global', 'generator-unicorn'], {stdio: 'inherit'});
-        sinon.assert.calledOnce(this.spawn);
-        sinon.assert.calledOnce(this.homeRoute);
+        expect(spawn.default).toHaveBeenCalledTimes(1);
+        expect(spawn.default).toHaveBeenCalledWith('npm', ['install', '--global', 'generator-unicorn'], {stdio: 'inherit'});
+        expect(this.homeRoute).toHaveBeenCalledTimes(1);
       });
     });
   });
@@ -230,10 +237,10 @@ describe('install route', () => {
         });
     });
 
-    it('list options if search have no results', function (done) {
+    it('list options if search have no results', async function () {
       let call = 0;
 
-      this.sandbox.stub(inquirer, 'prompt').callsFake(argument => {
+      inquirer.prompt.mockImplementation(argument => {
         call++;
 
         if (call === 1) {
@@ -243,13 +250,12 @@ describe('install route', () => {
         if (call === 2) {
           const {choices} = argument[0];
           assert.deepStrictEqual(_.map(choices, 'value'), ['install', 'home']);
-          done();
         }
 
         return Promise.resolve({toInstall: 'home'});
       });
 
-      this.router.navigate('install');
+      await this.router.navigate('install');
     });
   });
 });

test/route-install.js

@@ -1,9 +1,13 @@
-import * as td from 'testdouble';
 import sinon from 'sinon';
 import inquirer from 'inquirer';
+import {esmocha} from 'esmocha';
 import Router from '../lib/router.js';
 import * as helpers from './helpers.js';
 
+const {default: crossSpawn} = await esmocha.mock('cross-spawn');
+const {update} = await import('../lib/routes/update.js');
+esmocha.reset();
+
 describe('update route', () => {
   beforeEach(async function () {
     this.sandbox = sinon.createSandbox();
@@ -15,15 +19,13 @@ describe('update route', () => {
     this.router.registerRoute('home', this.homeRoute);
 
     this.crossSpawn = helpers.fakeCrossSpawn('close');
-    await td.replaceEsm('cross-spawn', undefined, this.crossSpawn);
-
-    const {update} = await import('../lib/routes/update.js');
+    crossSpawn.mockImplementation(this.crossSpawn);
 
     this.router.registerRoute('update', update);
   });
 
   afterEach(function () {
-    td.reset();
+    esmocha.clearAllMocks();
     this.sandbox.restore();
   });