feat: add optional asynchronous/parallel support

.clang-tidy

@@ -10,6 +10,7 @@ Checks:          '
     -cppcoreguidelines-pro-bounds-constant-array-index,
     -cppcoreguidelines-pro-type-cstyle-cast,
     -cppcoreguidelines-special-member-functions,
+    -cppcoreguidelines-avoid-reference-coroutine-parameters,
     misc-*,
     -misc-no-recursion,
     -misc-non-private-member-variables-in-classes,

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
     container: ghcr.io/philips-software/amp-devcontainer-cpp:v6.8.2@sha256:8d6d0b49bef9b1f572793dee8dcc05edcbe4f44f108f075640dda284ff3e2d4e # v6.8.2
     strategy:
       matrix:
-        target: [Host, Windows]
+        target: [Host, Host-Asynchronous, Windows]
       fail-fast: false
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
@@ -65,8 +65,8 @@ jobs:
           max-size: 2G
       - uses: lukka/run-cmake@af1be47fd7c933593f687731bc6fdbee024d3ff4 # v10.8
         with:
-          configurePreset: "Host"
-          buildPreset: "Host-Debug"
+          configurePreset: "Host-Asynchronous"
+          buildPreset: "Host-Asynchronous-Debug"
       - run: |
           bats --formatter junit cucumber_cpp/acceptance_test/test.bats | tee test-report.xml
       - uses: EnricoMi/publish-unit-test-result-action@c950f6fb443cb5af20a377fd0dfaa78838901040 # v2.23.0
@@ -81,7 +81,7 @@ jobs:
       matrix:
         os: [macos, windows, ubuntu]
         version: [latest]
-        type: [synchronous]
+        type: [synchronous, asynchronous]
       fail-fast: false
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

.vscode/launch.json

@@ -46,7 +46,10 @@
             "args": [
                 "--format",
                 "pretty",
-                "summary",
+                // "summary",
+                "--parallel",
+                "2",
+                "--fail-fast",
                 "--retry",
                 "1",
                 "--tags",

CMakeLists.txt

@@ -3,6 +3,10 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 project(cucumber-cpp-runner LANGUAGES C CXX VERSION 4.0.0) # x-release-please-version
 
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED On)
+set(CMAKE_CXX_EXTENSIONS Off)
+
 include(ccr_test_helpers)
 
 if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
@@ -18,10 +22,12 @@ else()
     set(CCR_EXCLUDE_FROM_ALL "EXCLUDE_FROM_ALL")
 endif()
 
+
 option(CCR_FETCH_DEPS "Fetch dependencies via FetchContent." ${CCR_DEFAULTOPT} )
 option(CCR_BUILD_TESTS "Enable build of the tests" ${CCR_DEFAULTOPT})
 option(CCR_ENABLE_COVERAGE "Enable compiler flags for code coverage measurements" Off)
 option(CCR_ENABLE_TIME_PROFILE "Enable compiler flags for time profiling measurements" Off)
+option(CCR_ENABLE_PARALLEL_SUPPORT "Enable parallel support through libcoro" Off)
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
@@ -57,10 +63,6 @@ if (CCR_ENABLE_TIME_PROFILE)
     endif()
 endif()
 
-set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_CXX_STANDARD_REQUIRED On)
-set(CMAKE_CXX_EXTENSIONS Off)
-
 set_directory_properties(PROPERTY USE_FOLDERS ON)
 
 include(FetchContent)
@@ -78,6 +80,10 @@ else()
     find_package(cucumber_gherkin REQUIRED)
     find_package(fmt REQUIRED)
 
+    if(CCR_ENABLE_PARALLEL_SUPPORT)
+        find_package(libcoro REQUIRED)
+    endif()
+
     if (CCR_BUILD_TESTS)
         find_package(yaml-cpp REQUIRED)
     endif()

CMakePresets.json

@@ -24,14 +24,23 @@
             "generator": "Ninja",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug",
-                "CCR_ENABLE_COVERAGE": "On"
+                "CCR_ENABLE_COVERAGE": "On",
+                "CCR_ENABLE_PARALLEL_SUPPORT": "On"
             }
         },
         {
             "name": "Host",
             "inherits": "defaults",
             "generator": "Ninja Multi-Config"
         },
+        {
+            "name": "Host-Asynchronous",
+            "inherits": "Host",
+            "generator": "Ninja Multi-Config",
+            "cacheVariables": {
+                "CCR_ENABLE_PARALLEL_SUPPORT": "On"
+            }
+        },
         {
             "name": "host-single-Debug-synchronous",
             "hidden": true,
@@ -57,6 +66,32 @@
             "displayName": "Configuration for macOS Debug and Tests, Single Config Generator, synchronous",
             "inherits": "host-single-Debug-synchronous"
         },
+        {
+            "name": "host-single-Debug-asynchronous",
+            "hidden": true,
+            "inherits": "defaults",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "CCR_ENABLE_PARALLEL_SUPPORT": "On"
+            }
+        },
+        {
+            "name": "ubuntu-Debug-asynchronous",
+            "displayName": "Configuration for Linux Debug and Tests, Single Config Generator, asynchronous",
+            "inherits": "host-single-Debug-asynchronous"
+        },
+        {
+            "name": "windows-Debug-asynchronous",
+            "displayName": "Configuration for Windows Debug and Tests, Single Config Generator, asynchronous",
+            "inherits": "host-single-Debug-asynchronous",
+            "toolchainFile": "${sourceDir}/cmake/Windows.MSVC.toolchain.cmake"
+        },
+        {
+            "name": "macos-Debug-asynchronous",
+            "displayName": "Configuration for macOS Debug and Tests, Single Config Generator, asynchronous",
+            "inherits": "host-single-Debug-asynchronous"
+        },
         {
             "name": "host-single-time-profile",
             "displayName": "Configuration time profiling",
@@ -86,6 +121,13 @@
                 "CCACHE_COMPILERTYPE": "clang-cl"
             },
             "generator": "Ninja Multi-Config"
+        },
+        {
+            "name": "Windows-Asynchronous",
+            "inherits": "Windows",
+            "cacheVariables": {
+                "CCR_ENABLE_PARALLEL_SUPPORT": "On"
+            }
         }
     ],
     "buildPresets": [
@@ -104,6 +146,17 @@
             "configurePreset": "Host",
             "jobs": 4
         },
+        {
+            "name": "Host-Asynchronous-Release",
+            "configuration": "Release",
+            "configurePreset": "Host-Asynchronous"
+        },
+        {
+            "name": "Host-Asynchronous-Debug",
+            "configuration": "Debug",
+            "configurePreset": "Host-Asynchronous",
+            "jobs": 4
+        },
         {
             "name": "Host-Iwyu-Debug",
             "configuration": "Debug",
@@ -124,6 +177,21 @@
             "configuration": "Debug",
             "configurePreset": "macos-Debug-synchronous"
         },
+        {
+            "name": "ubuntu-Debug-asynchronous",
+            "configuration": "Debug",
+            "configurePreset": "ubuntu-Debug-asynchronous"
+        },
+        {
+            "name": "windows-Debug-asynchronous",
+            "configuration": "Debug",
+            "configurePreset": "windows-Debug-asynchronous"
+        },
+        {
+            "name": "macos-Debug-asynchronous",
+            "configuration": "Debug",
+            "configurePreset": "macos-Debug-asynchronous"
+        },
         {
             "name": "host-single-time-profile",
             "configuration": "Debug",
@@ -150,7 +218,9 @@
             "name": "defaults",
             "hidden": true,
             "output": {
-                "outputOnFailure": true
+                "outputOnFailure": true,
+                "verbosity": "extra",
+                "debug": true
             },
             "execution": {
                 "noTestsAction": "error",
@@ -192,6 +262,24 @@
             "configurePreset": "macos-Debug-synchronous",
             "configuration": "Debug",
             "inherits": "defaults"
+        },
+        {
+            "name": "ubuntu-Debug-asynchronous",
+            "configurePreset": "ubuntu-Debug-asynchronous",
+            "configuration": "Debug",
+            "inherits": "defaults"
+        },
+        {
+            "name": "windows-Debug-asynchronous",
+            "configurePreset": "windows-Debug-asynchronous",
+            "configuration": "Debug",
+            "inherits": "defaults"
+        },
+        {
+            "name": "macos-Debug-asynchronous",
+            "configurePreset": "macos-Debug-asynchronous",
+            "configuration": "Debug",
+            "inherits": "defaults"
         }
     ],
     "workflowPresets": [
@@ -245,6 +333,57 @@
                     "name": "macos-Debug-synchronous"
                 }
             ]
+        },
+        {
+            "name": "ubuntu-Debug-asynchronous",
+            "steps": [
+                {
+                    "type": "configure",
+                    "name": "ubuntu-Debug-asynchronous"
+                },
+                {
+                    "type": "build",
+                    "name": "ubuntu-Debug-asynchronous"
+                },
+                {
+                    "type": "test",
+                    "name": "ubuntu-Debug-asynchronous"
+                }
+            ]
+        },
+        {
+            "name": "windows-Debug-asynchronous",
+            "steps": [
+                {
+                    "type": "configure",
+                    "name": "windows-Debug-asynchronous"
+                },
+                {
+                    "type": "build",
+                    "name": "windows-Debug-asynchronous"
+                },
+                {
+                    "type": "test",
+                    "name": "windows-Debug-asynchronous"
+                }
+            ]
+        },
+        {
+            "name": "macos-Debug-asynchronous",
+            "steps": [
+                {
+                    "type": "configure",
+                    "name": "macos-Debug-asynchronous"
+                },
+                {
+                    "type": "build",
+                    "name": "macos-Debug-asynchronous"
+                },
+                {
+                    "type": "test",
+                    "name": "macos-Debug-asynchronous"
+                }
+            ]
         }
     ]
 }

compatibility/BaseCompatibility.cpp

@@ -236,7 +236,7 @@ namespace compatibility
         auto contextStorageFactory{ std::make_shared<cucumber_cpp::library::ContextStorageFactoryImpl>() };
         auto programContext{ std::make_unique<cucumber_cpp::Context>(contextStorageFactory) };
 
-        cucumber_cpp::library::util::Broadcaster broadcaster;
+        cucumber_cpp::library::util::BroadcasterImpl broadcaster;
 
         BroadcastListener broadcastListener{ devkit.ndjsonFile, devkit.ndjsonFile.parent_path() / "expected.ndjson", devkit.ndjsonFile.parent_path() / "actual.ndjson", broadcaster };
 

compatibility/ambiguous/ambiguous.cpp

@@ -1,12 +1,12 @@
 #include "cucumber_cpp/Steps.hpp"
 #include <string>
 
-STEP(R"(^a (.*?) with (.*?)$)", (const std::string& arg1, const std::string& arg2))
+STEP(R"(^a (.*?) with (.*?)$)", ([[maybe_unused]] const std::string& arg1, [[maybe_unused]] const std::string& arg2))
 {
     // no-op
 }
 
-STEP(R"(^a step with (.*?)$)", (const std::string& arg1))
+STEP(R"(^a step with (.*?)$)", ([[maybe_unused]] const std::string& arg1))
 {
     // no-op
 }

compatibility/minimal/minimal.cpp

@@ -1,7 +1,7 @@
 #include "cucumber_cpp/Steps.hpp"
 #include <cstdint>
 
-STEP(R"(I have {int} cukes in my belly)", (std::int32_t number))
+STEP(R"(I have {int} cukes in my belly)", ([[maybe_unused]] std::int32_t number))
 {
     // no-op
 }

compatibility/regular-expression/regular-expression.cpp

@@ -2,7 +2,7 @@
 #include <optional>
 #include <string>
 
-STEP(R"(^a (.*?)(?: and a (.*?))?(?: and a (.*?))?$)", (const std::optional<std::string>& vegetable1, const std::optional<std::string>& vegetable2, const std::optional<std::string>& vegetable3))
+STEP(R"(^a (.*?)(?: and a (.*?))?(?: and a (.*?))?$)", ([[maybe_unused]] const std::optional<std::string>& vegetable1, [[maybe_unused]] const std::optional<std::string>& vegetable2, [[maybe_unused]] const std::optional<std::string>& vegetable3))
 {
     // no-op
 }

compatibility/rules-backgrounds/rules-backgrounds.cpp

@@ -1,7 +1,7 @@
 #include "cucumber_cpp/Steps.hpp"
 #include <string>
 
-GIVEN(R"(an order for {string})", (const std::string& order))
+GIVEN(R"(an order for {string})", ([[maybe_unused]] const std::string& order))
 {
     // no-op
 }

compatibility/unknown-parameter-type/unknown-parameter-type.cpp

@@ -4,7 +4,7 @@
 struct Airport
 {};
 
-GIVEN(R"({airport} is closed because of a strike)", (const Airport& airport))
+GIVEN(R"({airport} is closed because of a strike)", ([[maybe_unused]] const Airport& airport))
 {
     FAIL() << "Should not be called because airport parameter type has not been defined";
 }

cucumber_cpp/acceptance_test/features/test_optional_feature_hooks.feature

@@ -0,0 +1,4 @@
+@featurehook
+Feature: Test feature hook bindings
+  Scenario: Run feature hooks before and after
+    Given a given step

cucumber_cpp/acceptance_test/hooks/Hooks.cpp

@@ -1,4 +1,5 @@
 #include "cucumber_cpp/CucumberCpp.hpp"
+#include "cucumber_cpp/Steps.hpp"
 #include "gmock/gmock.h"
 #include <gtest/gtest.h>
 #include <iostream>
@@ -17,6 +18,16 @@ HOOK_AFTER_ALL()
     std::cout << "HOOK_AFTER_ALL\n";
 }
 
+HOOK_BEFORE_FEATURE("@featurehook")
+{
+    std::cout << "HOOK_BEFORE_FEATURE\n";
+}
+
+HOOK_AFTER_FEATURE("@featurehook")
+{
+    std::cout << "HOOK_AFTER_FEATURE\n";
+}
+
 HOOK_BEFORE_SCENARIO("@scenariohook and @bats")
 {
     std::cout << "HOOK_BEFORE_SCENARIO\n";

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"