Improved pause (#1400)

* updated helper formatting in docs

* improved interactive pause

* fixed linting

Author: DavertMik

examples/codecept.json

@@ -36,6 +36,9 @@
     "stepByStepReport": {},
     "autoDelay": {
       "enabled": true
+    },
+    "retryFailedStep": {
+      "enabled": true
     }
   },
   "tests": "./*_test.js",

examples/github_test.js

@@ -14,6 +14,7 @@ Scenario('Visit Home Page @retry', async (I) => {
 
 Scenario('search @grop', (I) => {
   I.amOnPage('https://github.com/search');
+  pause();
   I.fillField('Search GitHub', 'CodeceptJS');
   I.pressKey('Enter');
   I.wait(1);

lib/codecept.js

@@ -1,6 +1,6 @@
 const fsPath = require('path');
 const readFileSync = require('fs').readFileSync;
-const Container = require('./container');
+const container = require('./container');
 const Config = require('./config');
 const event = require('../lib/event');
 const glob = require('glob');
@@ -52,7 +52,7 @@ class Codecept {
   init(dir) {
     this.initGlobals(dir);
     // initializing listeners
-    Container.create(this.config, this.opts);
+    container.create(this.config, this.opts);
     this.runHooks();
   }
 
@@ -151,7 +151,7 @@ class Codecept {
    * @param {string} [test]
    */
   run(test) {
-    const mocha = Container.mocha();
+    const mocha = container.mocha();
     mocha.files = this.testFiles;
     if (test) {
       test = fsPath.join(global.codecept_dir, test);

lib/listener/steps.js

@@ -1,4 +1,5 @@
 const event = require('../event');
+const store = require('../store');
 
 let currentTest;
 let currentHook;
@@ -52,6 +53,7 @@ module.exports = function () {
   });
 
   event.dispatcher.on(event.step.started, (step) => {
+    if (store.debugMode) return;
     if (currentHook && Array.isArray(currentHook.steps)) {
       return currentHook.steps.push(step);
     }

lib/pause.js

@@ -1,4 +1,5 @@
 const container = require('./container');
+const store = require('./store');
 const recorder = require('./recorder');
 const event = require('./event');
 const output = require('./output');
@@ -29,19 +30,18 @@ const pause = function () {
 
 function pauseSession() {
   recorder.session.start('pause');
-  output.print(colors.yellow(' Interactive shell started'));
-  output.print(colors.yellow(` Press ${colors.bold('ENTER')} to run the next step`));
-  output.print(colors.yellow(` Enter ${colors.bold('exit')} to exit the interactive shell and resume the test`));
   if (!next) {
-    output.print(colors.yellow(' - Use JavaScript syntax to try steps in action'));
-    output.print(colors.yellow(` - Press ${colors.bold('TAB')} twice to see all available commands`));
+    output.print(colors.yellow(' Interactive shell started'));
+    output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
     output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
+    output.print(colors.yellow(` - Press ${colors.bold('TAB')} twice to see all available commands`));
+    output.print(colors.yellow(` - Type ${colors.bold('exit')} + Enter to exit the interactive shell`));
   }
   rl = readline.createInterface(process.stdin, process.stdout, completer);
 
   rl.on('line', parseInput);
   rl.on('close', () => {
-    console.log('Exiting interactive shell....');
+    if (!next) console.log('Exiting interactive shell....');
   });
   return new Promise(((resolve) => {
     finish = resolve;
@@ -52,13 +52,15 @@ function pauseSession() {
 function parseInput(cmd) {
   rl.pause();
   next = false;
+  store.debugMode = false;
   if (cmd === '') next = true;
-  if (!cmd || cmd === 'resume') {
+  if (!cmd || cmd === 'resume' || cmd === 'exit') {
     finish();
     recorder.session.restore();
     rl.close();
     return nextStep();
   }
+  store.debugMode = true;
   try {
     const I = container.support('I');
     eval(`I.${cmd}`); // eslint-disable-line no-eval
@@ -87,7 +89,6 @@ function completer(line) {
   const completions = methodsOfObject(I);
   const hits = completions.filter((c) => {
     if (c.indexOf(line) === 0) {
-      // console.log('bang! ' + c);
       return c;
     }
     return null;

lib/plugin/autoDelay.js

@@ -1,4 +1,5 @@
 const Container = require('../container');
+const store = require('../store');
 const recorder = require('../recorder');
 const event = require('../event');
 const log = require('../output').log;
@@ -82,6 +83,7 @@ module.exports = function (config) {
     if (config.methods.indexOf(step.helperMethod) < 0) return; // skip non-actions
 
     recorder.add('auto-delay', async () => {
+      if (store.debugMode) return; // no need to delay in debug
       log(`Delaying for ${config.delayBefore}ms`);
       return new Promise((resolve) => {
         setTimeout(resolve, config.delayBefore);
@@ -92,8 +94,8 @@ module.exports = function (config) {
   event.dispatcher.on(event.step.after, (step) => {
     if (config.methods.indexOf(step.helperMethod) < 0) return; // skip non-actions
 
-
     recorder.add('auto-delay', async () => {
+      if (store.debugMode) return; // no need to delay in debug
       log(`Delaying for ${config.delayAfter}ms`);
       return new Promise((resolve) => {
         setTimeout(resolve, config.delayAfter);

lib/plugin/retryFailedStep.js

@@ -1,4 +1,5 @@
 const event = require('../event');
+const store = require('../store');
 const recorder = require('../recorder');
 
 const defaultConfig = {
@@ -40,6 +41,12 @@ const defaultConfig = {
 module.exports = (config) => {
   config = Object.assign(defaultConfig, config);
 
+  const when = (err) => {
+    if (store.debugMode) return false;
+    if (config.when) return config.when(err);
+  };
+  config.when = when;
+
   event.dispatcher.on(event.test.before, (test) => {
     recorder.retry(config);
   });

lib/step.js

@@ -1,3 +1,5 @@
+const store = require('./store');
+
 const STACK_LINE = 4;
 
 // using support objetcs for metastep detection
@@ -141,6 +143,7 @@ Step.MetaStep = MetaStep;
 module.exports = Step;
 
 function detectMetaStep(stack) {
+  if (store.debugMode) return; // no detection in debug
   if (!support) loadSupportObjects(); // deprecated
 
   for (let i = STACK_LINE; i < stack.length; i++) {
@@ -164,9 +167,9 @@ function detectMetaStep(stack) {
 }
 
 function loadSupportObjects() {
-  const Config = require('./config');
+  const config = require('./config');
   const path = require('path');
-  support = Config.get('include', {});
+  support = config.get('include', {});
   if (support) {
     for (const name in support) {
       const file = support[name];

lib/store.js

@@ -0,0 +1,6 @@
+// global values for current session
+const store = {
+  debugMode: false,
+};
+
+module.exports = store;