Cucumber does not go to AfterStep if the step is failed!

[mattwynne]

Summary

Originally raised in cucumber/common#26 (comment) by @hangnguyenthuy

I'm using Cucumber 2.3.3
I want to print some log after each step so I have my code like this:

AfterStep do
  print_log_for_step(@current_step)
end

But in case the step is failed, it never goes to AfterStep, it move to After scenario so I cannot print log of the failed step.
Right now I have to work around in this case.

Anybody has same problem to me?

[mattwynne]

@hangnguyenthuy this is by design. AfterStep hooks are compiled in as extra test steps, and run as part of the scenario.

In 3.0.0, you'll be able to use an an event, specifically the AfterTestStep event.

I'm working on the documentation for this now, and would love to have you try it out to see if it makes sense. I'll leave this ticket open and ping you when I have something.

[mattwynne]

This is now documented here: https://app.cucumber.pro/projects/cucumber-ruby/documents/master/features/docs/events/test_step_finished_event.feature

[Lupeipei]

@mattwynne I have used test_step_finished event. Now I can capture page screenshot of every step even the step is failed, it is so cool! Thanks a lot.

[mattwynne]

👍 nice one @Lupeipei!

[sandhusatnam]

@mattwynne I am trying the same thing as @Lupeipei did capturing screenshot of every step even the step is failed but it didn't work for me. Here's my piece of code.

AfterConfiguration do |config|
config.on_event :test_step_finished do |event|
puts "Failed at URL: '#{@browser.current_url}'"
embed("data:image/png;base64,#{@browser.screenshot_as(:base64)}",'image/png')
end
end

Any suggestions ?

[mattwynne]

@sandhusatnam it's hard to say... what didn't work? Did you see the puts output? What version of Cucumber are you running?

[sandhusatnam]

@mattwynne Thanks for your reply.
I am using version 3.1.1.
I am not able to see even the puts output when the test case finished, looks to me the event doesn't get triggered.

[aslakhellesoy]

@sandhusatnam try replacing puts with Kernel.puts.

I think the bug here is that Cucumber’s own puts doesn’t print what’s printed in AfterStep, not that the hook doesn’t run.

[FedericoHenze]

@sandhusatnam @mattwynne I'm having the same problem.
In my case, the self instance is nil, therefore, @browser is nil and that raise a "nil:NilClass (NoMethodError)" exception.
any suggestions?

[sandhusatnam]

@aslakhellesoy I am not using the AfterStep hook, I am trying to add a event in AfterConfiguration hook.
Though I tried Kernel.puts in this but doesn't work.

[sandhusatnam]

@FedericoHenze can you share the code snippet ?

[FedericoHenze]

@sandhusatnam

#hooks.rb
AfterConfiguration do |config|
  config.on_event :test_step_finished do |event|
    if event.result.failed? || event.result.passed?
      screenshotName = getScreenshotName(@scenario, event.test_step, event.result)
      @driver.save_screenshot(screenshotName) unless screenshotName.nil?
    end
  end
end

getScreenshotName() is in env.rb and added to the cucumber world.
@driver instance is created like this:

#MyFeature_steps.rb
Given('I am on {string} page') do |page|
  @driver = Selenium::WebDriver.for :chrome
  @driver.get page
end

[sandhusatnam]

@FedericoHenze try defining your webdriver instance in env.rb file and then access it in your hooks and step file. Let me know if that works

[FedericoHenze]

@sandhusatnam same result, I guess is not a @driver problem because everything is nil also the self instance

[aslakhellesoy]

I tried Kernel.puts in this but doesn't work.

Can you please be more specific than "doesn't work"? Whnat are you seeing and what did you expect to see instead?

[sandhusatnam]

@aslakhellesoy well I am not able to see anything neither with puts nor with Kernel.puts.
I am expecting puts or Kernel.puts to print a string.

[mattwynne]

@sandhusatnam here are the scenarios for this feature:

https://app.cucumber.pro/projects/cucumber-ruby/documents/branch/master/features/docs/events/test_step_finished_event.feature

these are tested and passing. Can you see what's different between your code and the examples?

[sandhusatnam]

@mattwynne well I am able to print puts statement using the code snippet you mentioned above, but the test_step_results are weird.

Also I am not able to attach the screenshot using event.

[mattwynne]

Ha! I think that's because they use unicode characters for check-marks and crosses to indicate passes or failure. They're probably not coming through on your terminal for some reason. Try printing result.class.name instead.

[sandhusatnam]

@mattwynne Great that works but what about the screenshot ?
I am to trying to capture a screenshot and embedd it into the cucumber report but the json report doesn't have anything in there related to screenshot.

Any suggestion ?

[sandhusatnam]

@mattwynne I got it its not able to add screenshot because the web driver instance is nil, not sure why so as I am able to run the test case.

Also, the puts statements are not being included in the json_report.
Is that the default behavior of AfterConfiguration hook ?

[RameshGhk]

Hi @mattwynne
I want to print the error message after the step failed. Is there way to capture the error by using AfterConfiguration hook?

Below is the example.

AfterConfiguration do |config|
  config.on_event :test_step_finished do |event|
      if event.result.failed?
      $logger.error("Exception received as #{How can I log the error message?}")
      end
  end
end

Any suggestions ?

[mattwynne]

Hi @RameshGhk. Please try not to use GitHub issues for support. Asking in Slack is a much better choice in future for faster response.

The event.result is a https://www.rubydoc.info/github/cucumber/cucumber-ruby-core/Cucumber/Core/Test/Result

If it's a Failed you can look at the exception property.

[RameshGhk]

Hi @mattwynne ,
Thanks a lot for your quick response. Yes I will follow slack going forward.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.