Cucumber sync hooks #4288

mgrybyk · 2019-07-31T22:46:32Z

Proposed changes

~~remove before/after step hooks~~, see add BeforeStep / AfterStep hooks cucumber/cucumber-js#997
fix before/after step and scenario hooks
somewhat fix before/after feature hooks, they work as BeforeAll/AfterAll per worker

fixes #4207

Types of changes

Bugfix (non-breaking change which fixes an issue)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

Further comments

Reviewers: @webdriverio/technical-committee

packages/wdio-cli/src/templates/wdio.conf.tpl.ejs

christian-bromann

Awesome! Can we add a smoke test that checks if all hooks are executed (e.g. by writing the name of the hook into a file or something around that)

packages/wdio-cucumber-framework/src/index.js

mgrybyk · 2019-08-01T07:57:11Z

If I could somehow determine step type in wrapStep function that would be awesome.
In such we would be able to add before after step hooks.
I've noticed that wrap step function also wraps hooks defined by user. I'm pretty sure this is not something we'd like to do, have to take a look if we can handle it somehow. Sorry to say cucumberJs doesn't support it

mgrybyk · 2019-08-01T13:23:21Z

Great news! I've managed to make before/after step hooks work!

codecov · 2019-08-01T14:13:53Z

Codecov Report

Merging #4288 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #4288      +/-   ##
==========================================
+ Coverage   99.31%   99.31%   +<.01%     
==========================================
  Files         178      180       +2     
  Lines        4359     4408      +49     
  Branches      936      948      +12     
==========================================
+ Hits         4329     4378      +49     
  Misses         27       27              
  Partials        3        3

Impacted Files	Coverage Δ
packages/webdriverio/src/constants.js	`100% <ø> (ø)`	⬆️
packages/wdio-config/src/constants.js	`100% <ø> (ø)`	⬆️
packages/wdio-sync/src/executeHooksWithArgs.js	`100% <ø> (ø)`
packages/wdio-sync/src/index.js	`100% <100%> (ø)`
packages/wdio-utils/src/utils.js	`100% <100%> (ø)`
packages/wdio-cucumber-framework/src/constants.js	`100% <100%> (ø)`	⬆️
packages/wdio-cucumber-framework/src/index.js	`98.61% <100%> (+0.36%)`	⬆️
packages/wdio-cucumber-framework/src/utils.js	`100% <100%> (ø)`	⬆️
... and 1 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 18cdfc5...7aa97e7. Read the comment docs.

packages/wdio-sync/src/index.js

packages/wdio-cucumber-framework/src/utils.js

mgrybyk · 2019-08-02T08:27:15Z

Added smoke tests for cucumber to ensure hooks and steps are running sync, will add unit tests later on

mgrybyk · 2019-08-02T13:48:31Z

work completed

christian-bromann · 2019-08-02T13:58:18Z

Thanks so much, I will take a closer look on Monday.

mgrybyk · 2019-08-02T15:03:11Z

@christian-bromann thank you!
Added one very last commit, noticed that step before/after hooks error are not printed out.

mgrybyk · 2019-08-05T12:45:03Z

resolved all the conflicts and made changes according to #4308

miguelyoobic95 · 2019-08-08T10:00:52Z

Looking forward to seeing this merged, we will test the new version straight away once it is :) thanks a lot guys

packages/wdio-cucumber-framework/src/index.js

packages/wdio-cucumber-framework/src/utils.js

mgrybyk · 2019-08-14T08:15:31Z

resolved conflicts, any other comments @christian-bromann @erwinheitzman ?

christian-bromann

👍

christian-bromann

👍

no answer

* wdio-cucumber-framework: sync hooks * wdio-cucumber-framework: add before after step hooks * wdio-cucumber-framework: simplify wrap step with hooks * wdio-cucumber-framework: fix sync step hook * wdio-cucumber-framework: add unit tests * wdio-cucumber-framework: added docs * wdio-sync: add executeSync test, mark other functions as ignored * fix typos in docs * wdio-cucumber-framework: print step hook failure * use isFunctionAsync everywhere * fix wdio-utils version * wdio-cucumber-framework: utils functions minor fixes * wdio-cucumber-framework: simplify getDataFromResult * remove redundant verifications * wdio-cucumber-framework: move hook definition types to constants * remove comma

miguelyoobic95 · 2019-09-18T16:38:33Z

Is this supposed to be working ? We have upgraded and I get my first step on my test being called beforeFeature which is causing quite a bit of issues

mgrybyk · 2019-09-18T17:14:06Z

Please raise an issue with proper description.

miguelyoobic95 · 2019-09-19T09:14:30Z

Do you want me to raise an issue or would this be related to this one ? Basically we have a beforeFeature hook with some async code and the first Given of the cucumber test is still triggered before all the async actions in beforeFeature have finished running. Would beforeAll and afterAll be better replacements ?

mgrybyk · 2019-09-19T09:18:06Z

It's not related to the PR, I don't know anything about your setup, looks like some configuration issue.
If you still have some problems please raise an issue with proper description and steps to reproduce.
Thank you

miguelyoobic95 · 2020-02-27T14:27:50Z

Hey guys, I still have issues, will file a bug report with a repro case as soon as possible.

Is there an example repo where running functions inside the hooks is working ? Would like to have a look at one so I can check whether our setup is correct.

Weirdly the code within the hooks on our side only seems to be able to run a console log and it stops running correctly as soon as I add anything else with it stops running, almost like it terminates completely. Any help with examples would be great, I will link the issue here once I raise it :)

miguelyoobic95 · 2020-02-27T14:31:39Z

Hey guys, I still have issues, will file a bug report with a repro case as soon as possible.

Is there an example repo where running functions inside the hooks is working ? Would like to have a look at one so I can check whether our setup is correct.

Weirdly the code within the hooks on our side only seems to be able to run a console log and it stops running correctly as soon as I add anything else with it stops running, almost like it terminates completely. Any help with examples would be great, I will link the issue here once I raise it :)

mgrybyk added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jul 31, 2019

mgrybyk commented Jul 31, 2019

View reviewed changes

packages/wdio-cli/src/templates/wdio.conf.tpl.ejs Outdated Show resolved Hide resolved

mgrybyk added the work-in-progress label Jul 31, 2019

christian-bromann requested changes Aug 1, 2019

View reviewed changes

mgrybyk commented Aug 1, 2019

View reviewed changes

packages/wdio-cucumber-framework/src/index.js Outdated Show resolved Hide resolved

mgrybyk added the wdio-cucumber-framework label Aug 1, 2019

mgrybyk requested a review from christian-bromann August 1, 2019 14:16

mgrybyk mentioned this pull request Aug 1, 2019

[Cucumber + v5] How to make hooks (afterStep) to run and finish before next step is executed? #4207

Closed

mgrybyk commented Aug 2, 2019

View reviewed changes

packages/wdio-sync/src/index.js Show resolved Hide resolved

packages/wdio-cucumber-framework/src/utils.js Show resolved Hide resolved

mgrybyk removed the work-in-progress label Aug 2, 2019

This was referenced Aug 2, 2019

WDIO hooks don't populate Cucumber's World #4248

Closed

CucumberJS - Quality of life #4263

Closed

mgrybyk closed this Aug 3, 2019

mgrybyk reopened this Aug 3, 2019

mgrybyk mentioned this pull request Aug 5, 2019

@wdio/allure-reporter: Skip reporting of passing hooks with option useCucumberStepReporter #4309

Merged

6 tasks

This was referenced Aug 5, 2019

Cucumber v5 error in steps file from supporting file results in "Unknown error" (no stack trace) #4314

Closed

screenshots are not attached to allure for webdriverIO 5.x.x in cucumber #4335

Closed

erwinheitzman reviewed Aug 12, 2019

View reviewed changes

packages/wdio-cucumber-framework/src/index.js Outdated Show resolved Hide resolved

erwinheitzman reviewed Aug 12, 2019

View reviewed changes

packages/wdio-cucumber-framework/src/utils.js Outdated Show resolved Hide resolved

erwinheitzman reviewed Aug 12, 2019

View reviewed changes

packages/wdio-cucumber-framework/src/utils.js Outdated Show resolved Hide resolved

erwinheitzman reviewed Aug 12, 2019

View reviewed changes

packages/wdio-cucumber-framework/src/utils.js Outdated Show resolved Hide resolved

mgrybyk added 10 commits August 14, 2019 10:10

wdio-cucumber-framework: added docs

e08bf4b

wdio-sync: add executeSync test, mark other functions as ignored

059ab3e

fix typos in docs

6514a5d

wdio-cucumber-framework: print step hook failure

4dde85f

use isFunctionAsync everywhere

9394465

fix wdio-utils version

0174aed

wdio-cucumber-framework: utils functions minor fixes

dd35e49

wdio-cucumber-framework: simplify getDataFromResult

6f9aca0

remove redundant verifications

6f3edd4

wdio-cucumber-framework: move hook definition types to constants

f897f9e

mgrybyk dismissed christian-bromann’s stale review via f897f9e August 14, 2019 08:14

christian-bromann previously approved these changes Aug 14, 2019

View reviewed changes

Merge branch 'master' into cucumber-sync-hooks

0f150d4

christian-bromann dismissed their stale review via 0f150d4 August 14, 2019 13:51

christian-bromann previously approved these changes Aug 14, 2019

View reviewed changes

remove comma

7aa97e7

christian-bromann dismissed their stale review via 7aa97e7 August 14, 2019 13:52

christian-bromann approved these changes Aug 14, 2019

View reviewed changes

christian-bromann merged commit 2939b3a into webdriverio:master Aug 14, 2019

christian-bromann mentioned this pull request Aug 18, 2019

How to get failed step description #4377

Closed

mgrybyk deleted the cucumber-sync-hooks branch August 20, 2019 07:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cucumber sync hooks #4288

Cucumber sync hooks #4288

mgrybyk commented Jul 31, 2019 •

edited

christian-bromann left a comment

mgrybyk commented Aug 1, 2019

mgrybyk commented Aug 1, 2019

codecov bot commented Aug 1, 2019 •

edited

mgrybyk commented Aug 2, 2019

mgrybyk commented Aug 2, 2019

christian-bromann commented Aug 2, 2019

mgrybyk commented Aug 2, 2019

mgrybyk commented Aug 5, 2019

miguelyoobic95 commented Aug 8, 2019

mgrybyk commented Aug 14, 2019

christian-bromann left a comment

christian-bromann left a comment

miguelyoobic95 commented Sep 18, 2019

mgrybyk commented Sep 18, 2019

miguelyoobic95 commented Sep 19, 2019

mgrybyk commented Sep 19, 2019

miguelyoobic95 commented Feb 27, 2020

miguelyoobic95 commented Feb 27, 2020

Cucumber sync hooks #4288

Cucumber sync hooks #4288

Conversation

mgrybyk commented Jul 31, 2019 • edited

Proposed changes

Types of changes

Checklist

Further comments

Reviewers: @webdriverio/technical-committee

christian-bromann left a comment

Choose a reason for hiding this comment

mgrybyk commented Aug 1, 2019

mgrybyk commented Aug 1, 2019

codecov bot commented Aug 1, 2019 • edited

Codecov Report

mgrybyk commented Aug 2, 2019

mgrybyk commented Aug 2, 2019

christian-bromann commented Aug 2, 2019

mgrybyk commented Aug 2, 2019

mgrybyk commented Aug 5, 2019

miguelyoobic95 commented Aug 8, 2019

mgrybyk commented Aug 14, 2019

christian-bromann left a comment

Choose a reason for hiding this comment

christian-bromann left a comment

Choose a reason for hiding this comment

miguelyoobic95 commented Sep 18, 2019

mgrybyk commented Sep 18, 2019

miguelyoobic95 commented Sep 19, 2019

mgrybyk commented Sep 19, 2019

miguelyoobic95 commented Feb 27, 2020

miguelyoobic95 commented Feb 27, 2020

mgrybyk commented Jul 31, 2019 •

edited

codecov bot commented Aug 1, 2019 •

edited