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:6.10.3@sha256:e1f388179dbeabaddcdd37b8b563ed89ca3cd36dcf158aa2e5c4f70eb513efec
     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@5d55ea7949e25f69f0ecb516d8d572297e03a956 # v10.9
         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,8 +81,13 @@ jobs:
       matrix:
         os: [macos, windows, ubuntu]
         version: [latest]
-        type: [synchronous]
+        type: [synchronous, asynchronous]
         preset_suffix: ["", "-no-re2"]
+        exclude:
+          - type: asynchronous
+            preset_suffix: "-no-re2"
+          - type: asynchronous
+            os: macos
       fail-fast: false
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

.github/workflows/static-analysis.yml

@@ -47,7 +47,7 @@ jobs:
 
       - name: Collect coverage
         run: |
-          gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j "$(nproc)" --exclude=.*/example/.* --exclude=.*/external/.* --exclude=.*/test/.*
+          gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j "$(nproc)" --exclude=.*/example/.* --exclude=.*/external/.* --exclude=.*/test/.* --exclude=.*/_deps/.*
 
       - uses: philips-software/sonarqube-issue-conversion@9e9958764ba5fd1d302b039779dc902bedfa4d01 # v1.2.0
         with:

.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.1) # 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,43 +22,22 @@ 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_USE_RE2 "Use the RE2 regex engine (fetched when CCR_FETCH_DEPS is set, otherwise auto-detected)" ${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)
 
-if (CCR_BUILD_TESTS)
-    ccr_enable_testing()
-endif()
-
-if (CCR_ENABLE_COVERAGE)
-    find_program(GCOVR_PATH gcovr)
-
-    if (NOT GCOVR_PATH)
-    message(FATAL_ERROR "Could not find gcovr, which is required for code coverage IDE integration")
-    endif()
-
-    add_custom_target(
-        generate-coverage-report
-        COMMAND ${GCOVR_PATH} --delete --lcov ${CMAKE_CURRENT_BINARY_DIR}/lcov.info
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMENT "Generating code coverage report in LCOV format"
-    )
-endif()
-
 if (CCR_ENABLE_TIME_PROFILE)
     if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
         add_compile_options(-ftime-trace)
     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)
@@ -72,6 +55,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()
@@ -88,6 +75,26 @@ else()
     set(CCR_HAS_RE2 Off)
 endif()
 
+
+if (CCR_BUILD_TESTS)
+    ccr_enable_testing()
+endif()
+
+if (CCR_ENABLE_COVERAGE)
+    find_program(GCOVR_PATH gcovr)
+
+    if (NOT GCOVR_PATH)
+    message(FATAL_ERROR "Could not find gcovr, which is required for code coverage IDE integration")
+    endif()
+
+    add_custom_target(
+        generate-coverage-report
+        COMMAND ${GCOVR_PATH} --lcov ${CMAKE_CURRENT_BINARY_DIR}/lcov.info
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        COMMENT "Generating code coverage report in LCOV format"
+    )
+endif()
+
 # Sanitizer flags are set after external dependencies so that fetched third-party
 # libraries (abseil, re2) are not compiled with sanitizer instrumentation.
 # Abseil's constexpr function-pointer comparisons are not compatible with GCC's

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,
@@ -82,6 +91,32 @@
                 "CCR_USE_RE2": "Off"
             }
         },
+        {
+            "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",
@@ -111,6 +146,13 @@
                 "CCACHE_COMPILERTYPE": "clang-cl"
             },
             "generator": "Ninja Multi-Config"
+        },
+        {
+            "name": "Windows-Asynchronous",
+            "inherits": "Windows",
+            "cacheVariables": {
+                "CCR_ENABLE_PARALLEL_SUPPORT": "On"
+            }
         }
     ],
     "buildPresets": [
@@ -129,6 +171,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",
@@ -164,6 +217,21 @@
             "configuration": "Debug",
             "configurePreset": "macos-Debug-synchronous-no-re2"
         },
+        {
+            "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",
@@ -250,6 +318,24 @@
             "configurePreset": "macos-Debug-synchronous-no-re2",
             "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": [
@@ -354,6 +440,57 @@
                     "name": "macos-Debug-synchronous-no-re2"
                 }
             ]
+        },
+        {
+            "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
 }