fix: catch exceptions while constructing a step fixture (#364)

Exceptions were already caught when executing a step (hook
implementation or step implementation).

But custom step test fixtures could also throw (missing context values,
ASSERT_'s etc). These were not caught.

This PR ensures both the construction of a step and the execution of a
step are properly inside a try/catch block.

Author: daantimmer

cucumber_cpp/Steps.hpp

@@ -8,6 +8,7 @@
 #include "cucumber_cpp/library/cucumber_expression/MatchRange.hpp"
 #include "cucumber_cpp/library/cucumber_expression/ParameterRegistry.hpp"
 #include "cucumber_cpp/library/engine/ExecutionContext.hpp"
+#include "cucumber_cpp/library/engine/Hook.hpp"
 #include "cucumber_cpp/library/util/DocString.hpp"
 #include "cucumber_cpp/library/util/Table.hpp"
 

cucumber_cpp/acceptance_test/features/test_nested_steps.feature

@@ -1,5 +1,10 @@
-@nested_steps
 Feature: Nested Steps
+    @nested_steps
     Scenario: Call other steps from within a step
         Given a step calls another step with "cucumber"
         Then the stored string is "cucumber"
+
+    @nested_failing_steps
+    Scenario: Call other steps from within a step
+        When a step calls another step that will fail
+        Then this should be skipped

cucumber_cpp/acceptance_test/features/test_step_fixture_failure.feature

@@ -0,0 +1,7 @@
+@fail_step_fixture
+Feature: Simple feature file
+    Rule: Test rule
+        Scenario: Test scenario without failing step fixture
+            Given step fixture does not fail
+        Scenario: Test with failing step fixture
+            Given step fixture fails

cucumber_cpp/acceptance_test/steps/Steps.cpp

@@ -1,4 +1,4 @@
-#include "cucumber_cpp/CucumberCpp.hpp"
+#include "cucumber_cpp/Steps.hpp"
 #include "fmt/format.h"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
@@ -107,7 +107,7 @@ THEN("the exception is caught")
 
 THEN("the next scenario is executed")
 {
-    /* do nothing */
+    // empty
 }
 
 GIVEN("{int} and {int} are equal", (std::int32_t a, std::int32_t b))
@@ -140,3 +140,30 @@ GIVEN(R"(I attach a link to {string})", (const std::string& url))
 {
     Link(url, "title");
 }
+
+GIVEN(R"(step fixture does not fail)")
+{
+    // empty
+}
+
+struct FailingStepFixture : cucumber_cpp::StepBase
+{
+    using StepBase::StepBase;
+
+    bool nonExistentKey = context.Get<bool>("nonExistentKey");
+};
+
+GIVEN_F(FailingStepFixture, R"(step fixture fails)")
+{
+    // empty
+}
+
+GIVEN("a nested step that fails")
+{
+    ASSERT_THAT(false, testing::IsTrue());
+}
+
+GIVEN("a step calls another step that will fail")
+{
+    Step("a nested step that fails");
+}

cucumber_cpp/acceptance_test/steps/UsedUnused.cpp

@@ -1,4 +1,4 @@
-#include "cucumber_cpp/CucumberCpp.hpp"
+#include "cucumber_cpp/Steps.hpp"
 
 STEP("This step is unused")
 {

cucumber_cpp/acceptance_test/test.bats

@@ -222,3 +222,21 @@ teardown() {
     assert_output --partial "|   this step is used | -        |"
     assert_output --partial "| This step is unused | UNUSED   |"
 }
+
+@test "Test failure in step fixture results in error" {
+    run $acceptance_test --format summary --format-options "{ \"summary\": {\"theme\":\"plain\"} }"  --tags "@fail_step_fixture" -- cucumber_cpp/acceptance_test/features
+    assert_failure
+    assert_output --partial "key not found: \"nonExistentKey\""
+    assert_output --partial "2 scenarios 1 passed, 1 failed"
+    assert_output --partial "2 steps 1 passed, 1 failed"
+}
+
+@test "Test nested failures propagate properly" {
+    run $acceptance_test --format summary --format-options "{ \"summary\": {\"theme\":\"plain\"} }" --tags "@nested_failing_steps" -- cucumber_cpp/acceptance_test/features
+    assert_failure
+    assert_output --partial "FAILED nested step: \"* a nested step that fails\""
+    assert_output --partial "Value of: false"
+    assert_output --partial "Expected: is true"
+    assert_output --partial "Actual: false (of type bool)"
+    assert_output --partial "↷ Then this should be skipped"
+}

cucumber_cpp/example/steps/Steps.cpp

@@ -1,5 +1,5 @@
 #include "cucumber_cpp/library/Steps.hpp"
-#include "cucumber_cpp/CucumberCpp.hpp"
+#include "cucumber_cpp/Steps.hpp"
 #include "cucumber_cpp/library/Context.hpp"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"

cucumber_cpp/library/CMakeLists.txt

@@ -48,5 +48,5 @@ add_subdirectory(tag_expression)
 add_subdirectory(util)
 
 if (CCR_BUILD_TESTS)
-    # add_subdirectory(test)
+    add_subdirectory(test)
 endif()

cucumber_cpp/library/engine/CMakeLists.txt

@@ -24,5 +24,5 @@ target_link_libraries(cucumber_cpp.library.engine PUBLIC
 
 if (CCR_BUILD_TESTS)
     add_subdirectory(test)
-    # add_subdirectory(test_helper)
+    add_subdirectory(test_helper)
 endif()

cucumber_cpp/library/engine/test_helper/StepImplementations.cpp

@@ -62,7 +62,7 @@ WHEN("I call a nested step")
 {
     ASSERT_THAT(context.Contains("nested"), testing::IsFalse());
 
-    Given("I am a nested step");
+    Step("I am a nested step");
 }
 
 THEN("the nested step was called")