fix(multiple): async bootstrapAll must be called before creating chunks (codeceptjs#1738)

Author: Vorobeyko

lib/command/run-multiple.js

@@ -62,50 +62,52 @@ module.exports = function (selectedRuns, options) {
     fail('No runs provided. Use --all option to run all configured runs');
   }
 
-  const done = () => event.emit(event.multiple.before, null);
-  runHook(config.bootstrapAll, done, 'bootstrapAll');
-
-  if (options.config) { // update paths to config path
-    if (config.tests) {
-      config.tests = path.resolve(testRoot, config.tests);
+  const done = () => {
+    event.emit(event.multiple.before, null);
+    if (options.config) { // update paths to config path
+      if (config.tests) {
+        config.tests = path.resolve(testRoot, config.tests);
+      }
+      if (config.gherkin && config.gherkin.features) {
+        config.gherkin.features = path.resolve(testRoot, config.gherkin.features);
+      }
     }
-    if (config.gherkin && config.gherkin.features) {
-      config.gherkin.features = path.resolve(testRoot, config.gherkin.features);
+
+    if (options.features) {
+      config.tests = '';
     }
-  }
 
-  if (options.features) {
-    config.tests = '';
-  }
+    if (options.tests && config.gherkin) {
+      config.gherkin.features = '';
+    }
 
-  if (options.tests && config.gherkin) {
-    config.gherkin.features = '';
-  }
+    const childProcessesPromise = new Promise((resolve, reject) => {
+      processesDone = resolve;
+    });
 
-  const childProcessesPromise = new Promise((resolve, reject) => {
-    processesDone = resolve;
-  });
+    const runsToExecute = [];
+    collection.createRuns(selectedRuns, config).forEach((run) => {
+      const runName = run.getOriginalName() || run.getName();
+      const runConfig = run.getConfig();
+      runsToExecute.push(executeRun(runName, runConfig));
+    });
 
-  const runsToExecute = [];
-  collection.createRuns(selectedRuns, config).forEach((run) => {
-    const runName = run.getOriginalName() || run.getName();
-    const runConfig = run.getConfig();
-    runsToExecute.push(executeRun(runName, runConfig));
-  });
+    if (!runsToExecute.length) {
+      fail('Nothing scheduled for execution');
+    }
 
-  if (!runsToExecute.length) {
-    fail('Nothing scheduled for execution');
-  }
+    // Execute all forks
+    totalSubprocessCount = runsToExecute.length;
+    runsToExecute.forEach(runToExecute => runToExecute.call(this));
 
-  // Execute all forks
-  totalSubprocessCount = runsToExecute.length;
-  runsToExecute.forEach(runToExecute => runToExecute.call(this));
+    return childProcessesPromise.then(() => {
+      // fire hook
+      const done = () => event.emit(event.multiple.after, null);
+      runHook(config.teardownAll, done, 'teardownAll');
+    });
+  };
 
-  return childProcessesPromise.then(() => {
-    // fire hook
-    const done = () => event.emit(event.multiple.after, null);
-    runHook(config.teardownAll, done, 'teardownAll');
-  });
+  runHook(config.bootstrapAll, done, 'bootstrapAll');
 };
 
 function executeRun(runName, runConfig) {

lib/hooks.js

@@ -40,8 +40,7 @@ function loadCustomHook(module) {
 
 function callSync(callable, done) {
   if (isAsync(callable)) {
-    callAsync(callable, done);
-    if (!hasArguments(callable)) done();
+    callAsync(callable, done, hasArguments(callable));
   } else if (hasArguments(callable)) {
     callable(done);
   } else {
@@ -50,8 +49,16 @@ function callSync(callable, done) {
   }
 }
 
-function callAsync(callable, done = undefined) {
-  const called = done ? callable(done) : callable();
+function callAsync(callable, done, hasArgs = false) {
+  let called = new Promise(() => {});
+
+  if (done) {
+    if (hasArgs) called = callable(done);
+    else called = callable().then(() => done());
+  } else {
+    called = callable();
+  }
+
   called.catch((err) => {
     output.print('');
     output.error(err.message);

test/data/sandbox/codecept.async.bootstrapall.multiple.code.js

@@ -0,0 +1,29 @@
+const event = require('../../../lib/event');
+
+exports.config = {
+  tests: './*_test.js',
+  timeout: 10000,
+  output: './output',
+  helpers: {
+    FileSystem: {},
+  },
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  name: 'require test',
+  multiple: {
+    default: {
+      browsers: ['chrome', { browser: 'firefox' }],
+    },
+  },
+  bootstrapAll: async (done) => {
+    Promise.resolve('inside Promise').then(res => console.log(`Results: ${res}`)).then(() => done());
+    event.dispatcher.on(event.multiple.before, () => {
+      console.log('"event.multiple.before" is called');
+    });
+  },
+  teardownAll: async (done) => {
+    console.log('"teardownAll" is called.');
+    done();
+  },
+};

test/runner/run_multiple_test.js

@@ -174,6 +174,16 @@ describe('CodeceptJS Multiple Runner', function () {
 
   describe('bootstrapAll and teardownAll', () => {
     const _codecept_run = `run-multiple --config ${codecept_dir}`;
+    it('should be executed from async function in config', (done) => {
+      exec(`${runner} ${_codecept_run}/codecept.async.bootstrapall.multiple.code.js default`, (err, stdout, stderr) => {
+        console.log(stdout);
+        stdout.should.include('CodeceptJS'); // feature
+        stdout.should.include('Results: inside Promise\n"event.multiple.before" is called');
+        stdout.should.include('"teardownAll" is called.');
+        assert(!err);
+        done();
+      });
+    });
 
     it('should be executed from function in config', (done) => {
       exec(`${runner} ${_codecept_run}/codecept.bootstrapall.multiple.code.js default`, (err, stdout, stderr) => {