Wrap test function with before after step hooks

[mgrybyk]

NOTE

Please bump version of all the packages when doing release!

Problem

Currently we use mocha/jasmine before/afterEach hooks as wdio before/afterTest hooks.
This has certain limitations, for example if test looks like this

describe('suite', () => {
  describe('sub suite', () => {
    it('test', () => {
      // some test
    })

    afterEach(() => {
      // reload page
    })
  })
})

there is no way to capture screenshot, because screenshot is taken after afterEach hook.

Proposed changes

• Wrap mocha/jasmine framework functions (it, beforeEach and others) with wdio hooks like this:

global.it = function (..args) {
  // call wdio before test/hook
  // call original `it`/`afterEach`/etc function
  // call wdio after test/hook
}

fixes #4004

• Additionally mocha users can now access mocha runnable context that adds more flexibility for custom reporters (ex. Mochawesome with screenshots)

afterTest: function (test, context) {
    context // { test, _runnable }
},

same for hooks

afterHook: function (test, context) {
    context // { test, _runnable, currentTest }
},

• have same approach for all test frameworks: mocha, jasmine and cucumber. See file packages/wdio-utils/src/test-framework/testFnWrapper.js

• allow mixing async and sync like this:

it('async test', async () => {
  await browser.pause(1)
})

it('sync test' () => {
  browser.pause(1) // it was Promise before
})

Types of changes

• Bugfix (non-breaking change which fixes an issue)

there might be some regressions for mocha/jasmine users that strongly rely on beforeTest/afterTest in some very specific way, sorry to say I might miss some use cases, it should be easy to deal with them.
Cucumber users are not affected.

TODO

• have same approach to run before/after test hooks for all frameworks (mocha, cucumber, jasmine)
• verify before/after test hooks in async mode
• add @wdio/sync unit tests
• verify before/afterTest hook functions signature (ideally to avoid breaking changes)
• add smoke tests
• update before/after hook signature in configs and types
• avoid adding dependencies to @wdio/utils
• reorganize smoke added test

Reviewers: @webdriverio/technical-committee

[codecov]

Codecov Report

Merging #4354 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #4354      +/-   ##
==========================================
+ Coverage   99.28%   99.29%   +0.01%     
==========================================
  Files         188      192       +4     
  Lines        4765     4856      +91     
  Branches     1020     1039      +19     
==========================================
+ Hits         4731     4822      +91     
  Misses         31       31              
  Partials        3        3

Impacted Files	Coverage Δ
packages/webdriverio/src/index.js	100% <ø> (ø)	⬆️
packages/wdio-sync/src/utils.js	100% <ø> (ø)	⬆️
packages/webdriverio/src/utils/getElementObject.js	97.82% <ø> (ø)	⬆️
packages/wdio-repl/src/index.js	100% <ø> (ø)	⬆️
packages/webdriverio/src/utils/Timer.js	96.22% <ø> (ø)	⬆️
packages/webdriverio/src/multiremote.js	100% <ø> (ø)	⬆️
packages/wdio-cucumber-framework/src/utils.js	100% <ø> (ø)	⬆️
packages/wdio-utils/src/shim.js	100% <100%> (ø)
packages/wdio-jasmine-framework/src/index.js	100% <100%> (ø)	⬆️
...ges/wdio-utils/src/test-framework/testFnWrapper.js	100% <100%> (ø)
... and 14 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed8a8d2...d672285. Read the comment docs.

[mgrybyk]

not sure it makes much sense to pass spec, before, after as objects

[CrispusDH]

Tiny comments

[christian-bromann]

Please remove the work-in-progress label if it is ready for review

[mgrybyk]

PR is ready for review

[christian-bromann]

I am a bit worried to add a dependency to @wdio/utils given that the package should contain minimal helper functions that don't require a dependency to a different sub package. This can lead to a circular dependency issue. Do you think we can reorg this?

[mgrybyk]

@christian-bromann updated PR according to comments

[mgrybyk]

added more unit tests and removed runFnInFiberContextWithCallback from @wdio/sync as far as it is not used anywhere

[mgrybyk]

@christian-bromann rebased, added temporary pac-resolver mock f5ae88d to prove that all tests are passing

[christian-bromann]

some more comments

[mgrybyk]

@christian-bromann updated PR according to comments.

Please note that due to lot's of changes in imports I'd recommend to release all the packages after merging this one

[christian-bromann]

This is a great refactoring effort , well done 👏