improved running bdd tests

Author: DavertMik

examples/custom_steps.js

@@ -1 +1,3 @@
-module.exports = actor;
+import { actor } from 'codeceptjs'
+
+export default actor

examples/fragments/Signin.js

@@ -1,9 +1,13 @@
-let I;
+import { actor } from 'codeceptjs'
 
-module.exports = {
+let I
+
+const signinMethods = {
   _init() {
-    I = actor();
+    I = actor()
   },
 
   // insert your locators and methods here
-};
+}
+
+export default signinMethods

examples/pages/Admin.js

@@ -1,9 +1,13 @@
-let I;
+import { actor } from 'codeceptjs'
 
-module.exports = {
+let I
+
+const adminMethods = {
   _init() {
-    I = actor();
+    I = actor()
   },
 
   // insert your locators and methods here
-};
+}
+
+export default adminMethods

examples/pages/Login.js

@@ -1,12 +1,16 @@
-const I = actor();
+import { actor } from 'codeceptjs'
 
-module.exports = {
+const I = actor()
+
+const loginMethods = {
   login(email, password) {
-    I.click('Sign in');
-    I.fillField('Username or email address', email);
-    I.fillField('Password', password);
-    I.click('Sign in');
+    I.click('Sign in')
+    I.fillField('Username or email address', email)
+    I.fillField('Password', password)
+    I.click('Sign in')
   },
-};
+}
+
+Object.setPrototypeOf(loginMethods, class Login {}.prototype)
 
-Object.setPrototypeOf(module.exports, class Login {}.prototype);
+export default loginMethods

examples/pages/Smth.js

@@ -1,18 +1,21 @@
-const I = actor();
-const loginPage = require('./Login');
+import { actor } from 'codeceptjs'
+import loginPage from './Login.js'
 
-class Smth {}
+const I = actor()
 
-module.exports = {
+class Smth {}
 
+const smthMethods = {
   openGitHub() {
-    I.amOnPage('https://github.com');
+    I.amOnPage('https://github.com')
   },
 
   openAndLogin() {
-    this.openGitHub();
-    loginPage.login('[email protected]', '1234356');
+    this.openGitHub()
+    loginPage.login('[email protected]', '1234356')
   },
-};
+}
+
+Object.setPrototypeOf(smthMethods, Smth.prototype)
 
-Object.setPrototypeOf(module.exports, Smth.prototype);
+export default smthMethods

examples/step_definitions/steps.js

@@ -1,33 +1,33 @@
-const assert = require('assert');
-const Smth = require('../pages/Smth');
+import assert from 'assert'
+import { actor } from 'codeceptjs'
+import Smth from '../pages/Smth.js'
 
-const I = actor();
+const I = actor()
 // Add in your custom step files
 
 Given('I have a defined step', () => {
   // TODO: replace with your own step
-  I.amOnPage('https://google.com');
-});
+  console.log('Step executed: I have a defined step')
+})
 
 Given('Open google', () => {
-  // From "features\lawPage.feature" {"line":72,"column":7}
-  I.amOnPage('https://www.google.ru/webhp?hl=ru&sa=X&ved=0ahUKEwjY7rWfrPjbAhUHFiwKHas5DCMQPAgD');
-});
+  I.amOnPage('https://www.google.com')
+})
 
 Given('I open GitHub', () => {
-  Smth.openGitHub();
-  I.dontSee('Ups');
-});
+  Smth.openGitHub()
+  I.dontSee('Ups')
+})
 
 Then('check link', async () => {
   // From "features\lawPage.feature" {"line":73,"column":7}
-  const link = await I.grabAttributeFrom({ css: '#gbw > div > div > div.gb_qe.gb_R.gb_Pg.gb_Fg > div:nth-child(2) > a' }, 'href');
-  const response = await I.sendGetRequest(link);
-  assert(response.statusCode === 200);
-  I.see('Google');
-});
+  const link = await I.grabAttributeFrom({ css: '#gbw > div > div > div.gb_qe.gb_R.gb_Pg.gb_Fg > div:nth-child(2) > a' }, 'href')
+  const response = await I.sendGetRequest(link)
+  assert(response.statusCode === 200)
+  I.see('Google')
+})
 
 When(/^I see "(.*)" text and "(.*)" is not "(.*)"$/, async (text, text2, text3) => {
-  I.see(text);
-  assert(text2 !== text3);
-});
+  console.log(`Step executed: I see "${text}" text and "${text2}" is not "${text3}"`)
+  assert(text2 !== text3)
+})

examples/user_helper.js

@@ -1,34 +1,34 @@
-const assert = require('assert');
+import assert from 'assert'
+import Helper from '@codeceptjs/helper'
 
 class User extends Helper {
-  _beforeSuite() {
-  }
+  _beforeSuite() {}
 
   _before() {
-    this.i = 0;
+    this.i = 0
   }
 
   failNTimes(n) {
-    this.i++;
+    this.i++
     // this.i++;
-    console.log(this.i, n);
-    if (this.i < n) throw new Error('ups, error');
+    console.log(this.i, n)
+    if (this.i < n) throw new Error('ups, error')
   }
 
   // add custom methods here
   // If you need to access other helpers
   // use: this.helpers['helperName']
   seeAuthentication() {
     return this.helpers.WebDriverIO.browser.cookie((err, res) => {
-      const cookies = res.value;
+      const cookies = res.value
       for (const k in cookies) {
-        if (cookies[k].name !== 'logged_in') continue;
-        assert.equal(cookies[k].value, 'yes');
-        return;
+        if (cookies[k].name !== 'logged_in') continue
+        assert.equal(cookies[k].value, 'yes')
+        return
       }
-      assert.fail(cookies, 'logged_in', 'Auth cookie not set');
-    });
+      assert.fail(cookies, 'logged_in', 'Auth cookie not set')
+    })
   }
 }
 
-module.exports = User;
+export default User

lib/listener/helpers.js

@@ -42,6 +42,7 @@ export default function () {
   })
 
   event.dispatcher.on(event.test.before, test => {
+    console.log('DEBUG: helpers listener received test.before for:', test.title)
     // schedule config to revert changes
     runAsyncHelpersHook('_before', test, true)
     recorder.catchWithoutStop(e => output.error(e))
@@ -75,4 +76,8 @@ export default function () {
   event.dispatcher.on(event.all.result, () => {
     runAsyncHelpersHook('_finishTest', {}, true)
   })
+
+  event.dispatcher.on(event.all.after, () => {
+    runAsyncHelpersHook('_cleanup', {}, true)
+  })
 }

lib/mocha/bdd.js

@@ -1,4 +1,5 @@
 import { CucumberExpression, ParameterTypeRegistry, ParameterType } from '@cucumber/cucumber-expressions'
+import event from '../event.js'
 
 let steps = {}
 let Config
@@ -35,14 +36,14 @@ const addStep = async (step, fn) => {
     throw new Error(`Step '${step}' is already defined`)
   }
   steps[step] = fn
-  
+
   // Use the current step file context if available (fallback for old usage)
   if (currentStepFile) {
     let relativePath = currentStepFile
-    
+
     // Remove any leading './' and keep step_definitions/ path
     relativePath = relativePath.replace(/^\.\//, '').replace(/^.*\/(?=step_definitions)/, '')
-    
+
     fn.line = `${relativePath}:3:1`
   } else {
     fn.line = 'unknown_file:1:1'
@@ -94,11 +95,11 @@ const buildParameterType = ({ name, regexp, transformer, useForSnippets, preferF
 }
 
 // Create wrapper functions that capture the call context
-const createStepFunction = (stepType) => {
+const createStepFunction = stepType => {
   return (step, fn) => {
     // Capture the stack trace at the point where Given/When/Then is called
     const callStack = new Error().stack
-    
+
     // Find the caller (step definition file) in the stack
     let callerInfo = 'unknown_file:1:1'
     if (callStack) {
@@ -115,7 +116,7 @@ const createStepFunction = (stepType) => {
         }
       }
     }
-    
+
     // Instead of using global currentStepFile, pass the caller info directly to addStep
     return addStepWithCaller(step, fn, callerInfo)
   }
@@ -129,7 +130,7 @@ const addStepWithCaller = async (step, fn, callerInfo) => {
     throw new Error(`Step '${step}' is already defined`)
   }
   steps[step] = fn
-  
+
   // Use the caller info passed directly
   fn.line = callerInfo
 }
@@ -139,17 +140,21 @@ const When = createStepFunction('When')
 const Then = createStepFunction('Then')
 const And = createStepFunction('And')
 
-export {
-  Given,
-  When,
-  Then,
-  And,
-  matchStep,
-  getSteps,
-  clearSteps,
-  defineParameterType,
+// Before/After hooks for BDD - these are global event listeners
+const Before = fn => {
+  event.dispatcher.on(event.test.started, fn)
+}
+
+const After = fn => {
+  event.dispatcher.on(event.test.finished, fn)
 }
 
+const Fail = fn => {
+  event.dispatcher.on(event.test.failed, fn)
+}
+
+export { Given, When, Then, And, Before, After, Fail, matchStep, getSteps, clearSteps, defineParameterType }
+
 export default {
   Given: addStep,
   When: addStep,