refactored tests

Author: DavertMik

docs/basics.md

@@ -29,6 +29,7 @@ function makeDoneCallableOnce(done) {
     return done(err)
   }
 }
+
 /**
  * Wraps test function, injects support objects from container,
  * starts promise chain with recorder, performs before/after hooks

lib/mocha/scenario.js renamed to lib/mocha/asyncWrapper.js

@@ -7,7 +7,7 @@ const { enhanceMochaSuite } = require('./suite')
 const { createTest } = require('./test')
 const { matchStep } = require('./bdd')
 const event = require('../event')
-const scenario = require('./scenario')
+const { injected, setup, teardown, suiteSetup, suiteTeardown } = require('./asyncWrapper')
 const Step = require('../step')
 const DataTableArgument = require('../data/dataTableArgument')
 const transform = require('../transform')
@@ -39,10 +39,10 @@ module.exports = (text, file) => {
   suite.file = file
   suite.timeout(0)
 
-  suite.beforeEach('codeceptjs.before', () => scenario.setup(suite))
-  suite.afterEach('codeceptjs.after', () => scenario.teardown(suite))
-  suite.beforeAll('codeceptjs.beforeSuite', () => scenario.suiteSetup(suite))
-  suite.afterAll('codeceptjs.afterSuite', () => scenario.suiteTeardown(suite))
+  suite.beforeEach('codeceptjs.before', () => setup(suite))
+  suite.afterEach('codeceptjs.after', () => teardown(suite))
+  suite.beforeAll('codeceptjs.beforeSuite', () => suiteSetup(suite))
+  suite.afterAll('codeceptjs.afterSuite', () => suiteTeardown(suite))
 
   const runSteps = async steps => {
     for (const step of steps) {
@@ -103,7 +103,7 @@ module.exports = (text, file) => {
     if (child.background) {
       suite.beforeEach(
         'Before',
-        scenario.injected(async () => runSteps(child.background.steps), suite, 'before'),
+        injected(async () => runSteps(child.background.steps), suite, 'before'),
       )
       continue
     }

lib/mocha/gherkin.js

@@ -10,16 +10,20 @@ class Hook {
     this.error = error
   }
 
-  toString() {
+  get hookName() {
     return this.constructor.name.replace('Hook', '')
   }
 
+  toString() {
+    return this.hookName
+  }
+
   toCode() {
     return this.toString() + '()'
   }
 
   retry(n) {
-    // must be implemented for each hook
+    this.suite.opts[`retry${this.hookName}`] = n
   }
 
   get title() {
@@ -31,29 +35,13 @@ class Hook {
   }
 }
 
-class BeforeHook extends Hook {
-  retry(n) {
-    this.suite.opts['retryBefore'] = n
-  }
-}
+class BeforeHook extends Hook {}
 
-class AfterHook extends Hook {
-  retry(n) {
-    this.suite.opts['retryAfter'] = n
-  }
-}
+class AfterHook extends Hook {}
 
-class BeforeSuiteHook extends Hook {
-  retry(n) {
-    this.suite.opts['retryBeforeSuite'] = n
-  }
-}
+class BeforeSuiteHook extends Hook {}
 
-class AfterSuiteHook extends Hook {
-  retry(n) {
-    this.suite.opts['retryAfterSuite'] = n
-  }
-}
+class AfterSuiteHook extends Hook {}
 
 function fireHook(eventType, suite, error) {
   const hook = suite.ctx?.test?.title?.match(/"([^"]*)"/)[1]

lib/mocha/hooks.js

@@ -1,5 +1,5 @@
 const Test = require('mocha/lib/test')
-const scenario = require('./scenario')
+const { test: testWrapper } = require('./asyncWrapper')
 const { enhanceMochaSuite } = require('./suite')
 
 /**
@@ -37,7 +37,7 @@ function enhanceMochaTest(test) {
    */
   test.addToSuite = function (suite) {
     enhanceMochaSuite(suite)
-    suite.addTest(scenario.test(this))
+    suite.addTest(testWrapper(this))
     test.tags = [...(test.tags || []), ...(suite.tags || [])]
     test.fullTitle = () => `${suite.title}: ${test.title}`
   }

lib/mocha/test.js

@@ -1,5 +1,5 @@
 const escapeRe = require('escape-string-regexp')
-const scenario = require('./scenario')
+const { test, setup, teardown, suiteSetup, suiteTeardown, injected } = require('./asyncWrapper')
 const ScenarioConfig = require('./scenarioConfig')
 const FeatureConfig = require('./featureConfig')
 const addDataContext = require('../data/context')
@@ -94,11 +94,11 @@ module.exports = function (suite) {
 
       suite.file = file
       suites.unshift(suite)
-      suite.beforeEach('codeceptjs.before', () => scenario.setup(suite))
-      afterEachHooks.push(['finalize codeceptjs', () => scenario.teardown(suite)])
+      suite.beforeEach('codeceptjs.before', () => setup(suite))
+      afterEachHooks.push(['finalize codeceptjs', () => teardown(suite)])
 
-      suite.beforeAll('codeceptjs.beforeSuite', () => scenario.suiteSetup(suite))
-      afterAllHooks.push(['codeceptjs.afterSuite', () => scenario.suiteTeardown(suite)])
+      suite.beforeAll('codeceptjs.beforeSuite', () => suiteSetup(suite))
+      afterAllHooks.push(['codeceptjs.afterSuite', () => suiteTeardown(suite)])
 
       return new FeatureConfig(suite)
     }
@@ -118,22 +118,22 @@ module.exports = function (suite) {
     }
 
     context.BeforeSuite = function (fn) {
-      suites[0].beforeAll('BeforeSuite', scenario.injected(fn, suites[0], 'beforeSuite'))
+      suites[0].beforeAll('BeforeSuite', injected(fn, suites[0], 'beforeSuite'))
       return new HookConfig(new BeforeSuiteHook({ suite: suites[0] }))
     }
 
     context.AfterSuite = function (fn) {
-      afterAllHooks.unshift(['AfterSuite', scenario.injected(fn, suites[0], 'afterSuite')])
+      afterAllHooks.unshift(['AfterSuite', injected(fn, suites[0], 'afterSuite')])
       return new HookConfig(new AfterSuiteHook({ suite: suites[0] }))
     }
 
     context.Background = context.Before = function (fn) {
-      suites[0].beforeEach('Before', scenario.injected(fn, suites[0], 'before'))
+      suites[0].beforeEach('Before', injected(fn, suites[0], 'before'))
       return new HookConfig(new BeforeHook({ suite: suites[0] }))
     }
 
     context.After = function (fn) {
-      afterEachHooks.unshift(['After', scenario.injected(fn, suites[0], 'after')])
+      afterEachHooks.unshift(['After', injected(fn, suites[0], 'after')])
       return new HookConfig(new AfterHook({ suite: suites[0] }))
     }
 

lib/mocha/ui.js

@@ -0,0 +1,12 @@
+exports.config = {
+  tests: './*_test2.js',
+  output: './output',
+  helpers: {
+    CustomHelper: {
+      require: './helper.js',
+    },
+  },
+  bootstrap: null,
+  mocha: {},
+  name: 'retryHooks',
+}

test/data/sandbox/configs/retryHooks/codecept.retry.hookconfig.conf.js

@@ -0,0 +1,18 @@
+Feature('Retry #Async hooks')
+
+let i = 0
+
+Before(async ({ I }) => {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => {
+      console.log('ok', i, new Date())
+      i++
+      if (i < 3) reject(new Error('not works'))
+      resolve()
+    }, 0)
+  })
+}).retry(2)
+
+Scenario('async hook works', () => {
+  console.log('works')
+})

test/data/sandbox/configs/retryHooks/retry_async_hook_test2.js

@@ -17,6 +17,14 @@ describe('CodeceptJS Retry Hooks', function () {
       })
     })
   })
+
+  it('run should load hook config from Before().retry()', done => {
+    exec(config_run_config('codecept.retry.hookconfig.conf.js', '#Async '), (err, stdout) => {
+      debug_this_test && console.log(stdout)
+      expect(stdout).toContain('1 passed')
+      done()
+    })
+  })
   ;['#Before ', '#BeforeSuite '].forEach(retryHook => {
     it(`should ${retryHook} set hook retries from global config`, done => {
       exec(config_run_config('codecept.retry.obj.conf.js', retryHook), (err, stdout) => {

test/runner/retry_hooks_test.js

@@ -4,9 +4,9 @@ import('chai').then(chai => {
 })
 const sinon = require('sinon')
 
-const scenario = require('../../lib/mocha/scenario')
-const recorder = require('../../lib/recorder')
-const event = require('../../lib/event')
+const { test: testWrapper, setup, teardown, suiteSetup, suiteTeardown } = require('../../../lib/mocha/asyncWrapper')
+const recorder = require('../../../lib/recorder')
+const event = require('../../../lib/event')
 
 let test
 let fn
@@ -17,7 +17,7 @@ let afterSuite
 let failed
 let started
 
-describe('Scenario', () => {
+describe('AsyncWrapper', () => {
   beforeEach(() => {
     test = { timeout: () => {} }
     fn = sinon.spy()
@@ -27,7 +27,7 @@ describe('Scenario', () => {
   afterEach(() => event.cleanDispatcher())
 
   it('should wrap test function', () => {
-    scenario.test(test).fn(() => {})
+    testWrapper(test).fn(() => {})
     expect(fn.called).is.ok
   })
 
@@ -42,8 +42,8 @@ describe('Scenario', () => {
       })
     }
 
-    scenario.setup()
-    scenario.test(test).fn(() => null)
+    setup()
+    testWrapper(test).fn(() => null)
     recorder.add('validation', () => expect(counter).to.eq(4))
     return recorder.promise()
   })
@@ -55,15 +55,15 @@ describe('Scenario', () => {
       event.dispatcher.on(event.test.started, (started = sinon.spy()))
       event.dispatcher.on(event.suite.before, (beforeSuite = sinon.spy()))
       event.dispatcher.on(event.suite.after, (afterSuite = sinon.spy()))
-      scenario.suiteSetup()
-      scenario.setup()
+      suiteSetup()
+      setup()
     })
 
     it('should fire events', () => {
-      scenario.test(test).fn(() => null)
+      testWrapper(test).fn(() => null)
       expect(started.called).is.ok
-      scenario.teardown()
-      scenario.suiteTeardown()
+      teardown()
+      suiteTeardown()
       return recorder
         .promise()
         .then(() => expect(beforeSuite.called).is.ok)
@@ -74,11 +74,11 @@ describe('Scenario', () => {
 
     it('should fire failed event on error', () => {
       event.dispatcher.on(event.test.failed, (failed = sinon.spy()))
-      scenario.setup()
+      setup()
       test.fn = () => {
         throw new Error('ups')
       }
-      scenario.test(test).fn(() => {})
+      testWrapper(test).fn(() => {})
       return recorder
         .promise()
         .then(() => expect(failed.called).is.ok)
@@ -89,7 +89,7 @@ describe('Scenario', () => {
       test.fn = () => {
         recorder.throw(new Error('ups'))
       }
-      scenario.test(test).fn(() => {})
+      testWrapper(test).fn(() => {})
       return recorder
         .promise()
         .then(() => expect(failed.called).is.ok)