refactored mocha classes

Author: DavertMik

lib/codecept.js

@@ -1,14 +1,14 @@
-const { existsSync, readFileSync } = require('fs');
-const glob = require('glob');
-const fsPath = require('path');
-const { resolve } = require('path');
-
-const container = require('./container');
-const Config = require('./config');
-const event = require('./event');
-const runHook = require('./hooks');
-const output = require('./output');
-const { emptyFolder } = require('./utils');
+const { existsSync, readFileSync } = require('fs')
+const glob = require('glob')
+const fsPath = require('path')
+const { resolve } = require('path')
+
+const container = require('./container')
+const Config = require('./config')
+const event = require('./event')
+const runHook = require('./hooks')
+const output = require('./output')
+const { emptyFolder } = require('./utils')
 
 /**
  * CodeceptJS runner
@@ -22,10 +22,10 @@ class Codecept {
    * @param {*} opts
    */
   constructor(config, opts) {
-    this.config = Config.create(config);
-    this.opts = opts;
-    this.testFiles = new Array(0);
-    this.requireModules(config.require);
+    this.config = Config.create(config)
+    this.opts = opts
+    this.testFiles = new Array(0)
+    this.requireModules(config.require)
   }
 
   /**
@@ -36,12 +36,12 @@ class Codecept {
   requireModules(requiringModules) {
     if (requiringModules) {
       requiringModules.forEach(requiredModule => {
-        const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`);
+        const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`)
         if (isLocalFile) {
-          requiredModule = resolve(requiredModule);
+          requiredModule = resolve(requiredModule)
         }
-        require(requiredModule);
-      });
+        require(requiredModule)
+      })
     }
   }
 
@@ -52,10 +52,10 @@ class Codecept {
    * @param {string} dir
    */
   init(dir) {
-    this.initGlobals(dir);
+    this.initGlobals(dir)
     // initializing listeners
-    container.create(this.config, this.opts);
-    this.runHooks();
+    container.create(this.config, this.opts)
+    this.runHooks()
   }
 
   /**
@@ -64,37 +64,37 @@ class Codecept {
    * @param {string} dir
    */
   initGlobals(dir) {
-    global.codecept_dir = dir;
-    global.output_dir = fsPath.resolve(dir, this.config.output);
+    global.codecept_dir = dir
+    global.output_dir = fsPath.resolve(dir, this.config.output)
 
-    if (this.config.emptyOutputFolder) emptyFolder(global.output_dir);
+    if (this.config.emptyOutputFolder) emptyFolder(global.output_dir)
 
     if (!this.config.noGlobals) {
-      global.Helper = global.codecept_helper = require('@codeceptjs/helper');
-      global.actor = global.codecept_actor = require('./actor');
-      global.pause = require('./pause');
-      global.within = require('./within');
-      global.session = require('./session');
-      global.DataTable = require('./data/table');
-      global.locate = locator => require('./locator').build(locator);
-      global.inject = container.support;
-      global.share = container.share;
-      global.secret = require('./secret').secret;
-      global.codecept_debug = output.debug;
-      global.codeceptjs = require('./index'); // load all objects
+      global.Helper = global.codecept_helper = require('@codeceptjs/helper')
+      global.actor = global.codecept_actor = require('./actor')
+      global.pause = require('./pause')
+      global.within = require('./within')
+      global.session = require('./session')
+      global.DataTable = require('./data/table')
+      global.locate = locator => require('./locator').build(locator)
+      global.inject = container.support
+      global.share = container.share
+      global.secret = require('./secret').secret
+      global.codecept_debug = output.debug
+      global.codeceptjs = require('./index') // load all objects
 
       // BDD
-      const stepDefinitions = require('./mocha/bdd');
-      global.Given = stepDefinitions.Given;
-      global.When = stepDefinitions.When;
-      global.Then = stepDefinitions.Then;
-      global.DefineParameterType = stepDefinitions.defineParameterType;
+      const stepDefinitions = require('./mocha/bdd')
+      global.Given = stepDefinitions.Given
+      global.When = stepDefinitions.When
+      global.Then = stepDefinitions.Then
+      global.DefineParameterType = stepDefinitions.defineParameterType
 
       // debug mode
-      global.debugMode = false;
+      global.debugMode = false
 
       // mask sensitive data
-      global.maskSensitiveData = this.config.maskSensitiveData || false;
+      global.maskSensitiveData = this.config.maskSensitiveData || false
     }
   }
 
@@ -103,32 +103,33 @@ class Codecept {
    */
   runHooks() {
     // default hooks
-    runHook(require('./listener/steps'));
-    runHook(require('./listener/artifacts'));
-    runHook(require('./listener/config'));
-    runHook(require('./listener/helpers'));
-    runHook(require('./listener/retry'));
-    runHook(require('./listener/timeout'));
-    runHook(require('./listener/exit'));
+    runHook(require('./listener/store'))
+    runHook(require('./listener/steps'))
+    runHook(require('./listener/artifacts'))
+    runHook(require('./listener/config'))
+    runHook(require('./listener/helpers'))
+    runHook(require('./listener/globalTimeout'))
+    runHook(require('./listener/globalRetry'))
+    runHook(require('./listener/exit'))
 
     // custom hooks (previous iteration of plugins)
-    this.config.hooks.forEach(hook => runHook(hook));
+    this.config.hooks.forEach(hook => runHook(hook))
   }
 
   /**
    * Executes bootstrap.
    *
    */
   async bootstrap() {
-    return runHook(this.config.bootstrap, 'bootstrap');
+    return runHook(this.config.bootstrap, 'bootstrap')
   }
 
   /**
    * Executes teardown.
 
    */
   async teardown() {
-    return runHook(this.config.teardown, 'teardown');
+    return runHook(this.config.teardown, 'teardown')
   }
 
   /**
@@ -139,42 +140,42 @@ class Codecept {
   loadTests(pattern) {
     const options = {
       cwd: global.codecept_dir,
-    };
+    }
 
-    let patterns = [pattern];
+    let patterns = [pattern]
     if (!pattern) {
-      patterns = [];
+      patterns = []
 
       // If the user wants to test a specific set of test files as an array or string.
       if (this.config.tests && !this.opts.features) {
         if (Array.isArray(this.config.tests)) {
-          patterns.push(...this.config.tests);
+          patterns.push(...this.config.tests)
         } else {
-          patterns.push(this.config.tests);
+          patterns.push(this.config.tests)
         }
       }
 
       if (this.config.gherkin.features && !this.opts.tests) {
         if (Array.isArray(this.config.gherkin.features)) {
           this.config.gherkin.features.forEach(feature => {
-            patterns.push(feature);
-          });
+            patterns.push(feature)
+          })
         } else {
-          patterns.push(this.config.gherkin.features);
+          patterns.push(this.config.gherkin.features)
         }
       }
     }
 
     for (pattern of patterns) {
       glob.sync(pattern, options).forEach(file => {
-        if (file.includes('node_modules')) return;
+        if (file.includes('node_modules')) return
         if (!fsPath.isAbsolute(file)) {
-          file = fsPath.join(global.codecept_dir, file);
+          file = fsPath.join(global.codecept_dir, file)
         }
         if (!this.testFiles.includes(fsPath.resolve(file))) {
-          this.testFiles.push(fsPath.resolve(file));
+          this.testFiles.push(fsPath.resolve(file))
         }
-      });
+      })
     }
   }
 
@@ -185,36 +186,36 @@ class Codecept {
    * @returns {Promise<void>}
    */
   async run(test) {
-    await container.started();
+    await container.started()
 
     return new Promise((resolve, reject) => {
-      const mocha = container.mocha();
-      mocha.files = this.testFiles;
+      const mocha = container.mocha()
+      mocha.files = this.testFiles
       if (test) {
         if (!fsPath.isAbsolute(test)) {
-          test = fsPath.join(global.codecept_dir, test);
+          test = fsPath.join(global.codecept_dir, test)
         }
-        mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test);
+        mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test)
       }
       const done = () => {
-        event.emit(event.all.result, this);
-        event.emit(event.all.after, this);
-        resolve();
-      };
+        event.emit(event.all.result, this)
+        event.emit(event.all.after, this)
+        resolve()
+      }
 
       try {
-        event.emit(event.all.before, this);
-        mocha.run(() => done());
+        event.emit(event.all.before, this)
+        mocha.run(() => done())
       } catch (e) {
-        output.error(e.stack);
-        reject(e);
+        output.error(e.stack)
+        reject(e)
       }
-    });
+    })
   }
 
   static version() {
-    return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version;
+    return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version
   }
 }
 
-module.exports = Codecept;
+module.exports = Codecept

lib/listener/retry.js renamed to lib/listener/globalRetry.js

@@ -0,0 +1,12 @@
+const event = require('../event')
+const store = require('../store')
+
+module.exports = function () {
+  event.dispatcher.on(event.test.before, test => {
+    store.currentTest = test
+  })
+
+  event.dispatcher.on(event.test.finished, test => {
+    store.currentTest = null
+  })
+}

lib/listener/timeout.js renamed to lib/listener/globalTimeout.js

@@ -60,6 +60,7 @@ class FeatureConfig {
     if (tagName[0] !== '@') tagName = `@${tagName}`
     if (!this.suite.tags) this.suite.tags = []
     this.suite.tags.push(tagName)
+    this.suite.title = `${this.suite.title.trim()} ${tagName}`
     return this
   }
 }

lib/listener/store.js

@@ -0,0 +1,12 @@
+const Suite = require('mocha/lib/suite')
+const Test = require('mocha/lib/test')
+const { BeforeHook, AfterHook, BeforeSuiteHook, AfterSuiteHook } = require('./hooks')
+
+module.exports = {
+  Suite,
+  Test,
+  BeforeHook,
+  AfterHook,
+  BeforeSuiteHook,
+  AfterSuiteHook,
+}

lib/mocha/featureConfig.js

@@ -40,7 +40,6 @@ module.exports.test = test => {
     return test
   }
 
-  test.steps = []
   test.timeout(0)
   test.async = true