Merge branch 'main' into feature/improve-console-output-on-missing-and-ambiguous-steps

daantimmer · daantimmer · commit 36788c10c35f · 2025-07-04T13:35:17.000Z
diff --git a/.github/workflows/linting-formatting.yml b/.github/workflows/linting-formatting.yml
@@ -32,7 +32,7 @@ jobs:
           VALIDATE_ALL_CODEBASE: true
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - run: git diff
-      - uses: github/codeql-action/upload-sarif@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3.29.0
+      - uses: github/codeql-action/upload-sarif@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
         if: ${{ success() || failure() }}
         with:
           sarif_file: megalinter-reports/megalinter-report.sarif
diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml
@@ -31,6 +31,6 @@ jobs:
           results_format: sarif
           repo_token: ${{ secrets.SCORECARD_READ_TOKEN }}
           publish_results: true
-      - uses: github/codeql-action/upload-sarif@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3.29.0
+      - uses: github/codeql-action/upload-sarif@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
         with:
           sarif_file: scorecards.sarif
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -73,12 +73,12 @@ jobs:
       - uses: hendrikmuhs/ccache-action@63069e3931dedbf3b63792097479563182fe70d1 # v1.2.18
         with:
           key: ${{ github.job }}
-      - uses: github/codeql-action/init@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3.29.0
+      - uses: github/codeql-action/init@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
         with:
           languages: cpp
       - uses: lukka/run-cmake@af1be47fd7c933593f687731bc6fdbee024d3ff4 # v10.8
         with:
           configurePreset: "Host"
           buildPreset: "Host-Debug"
           configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']"
-      - uses: github/codeql-action/analyze@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3.29.0
+      - uses: github/codeql-action/analyze@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
diff --git a/cucumber_cpp/acceptance_test/features/test_scenarios.feature b/cucumber_cpp/acceptance_test/features/test_scenarios.feature
@@ -18,7 +18,5 @@ Feature: Simple feature file
 
   @result:UNDEFINED
   Scenario: A scenario with undefined step
-    Given a given step
-    When a when step
-    Then a missing step
-    Then a then step
+    Given a missing step
+    Then this should be skipped
diff --git a/cucumber_cpp/acceptance_test/hooks/Hooks.cpp b/cucumber_cpp/acceptance_test/hooks/Hooks.cpp
@@ -1,4 +1,4 @@
-#include "cucumber_cpp/library/Hooks.hpp"
+#include "cucumber_cpp/CucumberCpp.hpp"
 #include "gmock/gmock.h"
 #include <iostream>
 #include <string>
diff --git a/cucumber_cpp/acceptance_test/steps/Steps.cpp b/cucumber_cpp/acceptance_test/steps/Steps.cpp
@@ -1,7 +1,6 @@
-#include "cucumber_cpp/library/Steps.hpp"
+#include "cucumber_cpp/CucumberCpp.hpp"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
-#include <cstdint>
 #include <iostream>
 #include <string>
 
@@ -60,3 +59,8 @@ GIVEN("this is ambiguous( or not)")
 {
     // empty
 }
+
+THEN("this should be skipped")
+{
+    FAIL();
+}
diff --git a/cucumber_cpp/acceptance_test/test.bats b/cucumber_cpp/acceptance_test/test.bats
@@ -30,7 +30,7 @@ teardown() {
     run .build/Host/cucumber_cpp/acceptance_test/Debug/cucumber_cpp.acceptance_test run --tag "@result:UNDEFINED" --feature cucumber_cpp/acceptance_test/features --report console
     assert_failure
     assert_output --partial "undefined \"cucumber_cpp/acceptance_test/features/test_scenarios.feature\""
-    assert_output --partial "skipped Then a then step"
+    assert_output --partial "skipped Then this should be skipped"
 }
 
 @test "No tests" {
@@ -128,7 +128,7 @@ teardown() {
     assert_failure
     assert_output --partial "Step missing: \"a missing step\""
     assert_output --partial "undefined \"cucumber_cpp/acceptance_test/features/test_scenarios.feature\""
-    assert_output --partial "skipped Then a then step"
+    assert_output --partial "skipped Then this should be skipped"
 }
 
 @test "Dry run with known ambiguous steps" {
diff --git a/cucumber_cpp/library/Application.hpp b/cucumber_cpp/library/Application.hpp
@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_APPLICATION_HPP
 #define CUCUMBER_CPP_APPLICATION_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber/gherkin/app.hpp"
 #include "cucumber_cpp/library/Context.hpp"
 #include "cucumber_cpp/library/cucumber_expression/ParameterRegistry.hpp"
diff --git a/cucumber_cpp/library/Context.hpp b/cucumber_cpp/library/Context.hpp
@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_CONTEXT_HPP
 #define CUCUMBER_CPP_CONTEXT_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include <algorithm>
 #include <forward_list>
 #include <iostream>
diff --git a/cucumber_cpp/library/Hooks.hpp b/cucumber_cpp/library/Hooks.hpp
@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_HOOKS_HPP
 #define CUCUMBER_CPP_HOOKS_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/BodyMacro.hpp"
 #include "cucumber_cpp/library/HookRegistry.hpp"
 
diff --git a/cucumber_cpp/library/StepRegistry.cpp b/cucumber_cpp/library/StepRegistry.cpp
@@ -7,10 +7,8 @@
 #include "cucumber_cpp/library/cucumber_expression/RegularExpression.hpp"
 #include "cucumber_cpp/library/engine/StepType.hpp"
 #include "cucumber_cpp/library/engine/Table.hpp"
-#include <algorithm>
 #include <cstddef>
 #include <memory>
-#include <ranges>
 #include <source_location>
 #include <span>
 #include <string>
@@ -20,29 +18,18 @@
 
 namespace cucumber_cpp::library
 {
-    namespace
-    {
-        auto TypeFilter(engine::StepType stepType)
-        {
-            return [stepType](const StepRegistry::Entry& entry)
-            {
-                return entry.type == stepType || entry.type == engine::StepType::any;
-            };
-        };
-    }
-
     StepRegistry::StepRegistry(cucumber_expression::ParameterRegistry& parameterRegistry)
         : parameterRegistry{ parameterRegistry }
     {
         for (const auto& matcher : StepStringRegistration::Instance().GetEntries())
             Register(matcher.regex, matcher.type, matcher.factory, matcher.loc);
     }
 
-    StepRegistry::StepMatch StepRegistry::Query(engine::StepType stepType, const std::string& expression)
+    StepRegistry::StepMatch StepRegistry::Query(const std::string& expression)
     {
         std::vector<StepMatch> matches;
 
-        for (Entry& entry : registry | std::views::filter(TypeFilter(stepType)))
+        for (Entry& entry : registry)
         {
             auto match = std::visit(cucumber_expression::MatchVisitor{ expression }, entry.regex);
             if (match)
@@ -66,11 +53,6 @@ namespace cucumber_cpp::library
         return registry.size();
     }
 
-    std::size_t StepRegistry::Size(engine::StepType stepType) const
-    {
-        return std::ranges::count(registry, stepType, &Entry::type);
-    }
-
     std::vector<StepRegistry::EntryView> StepRegistry::List() const
     {
         std::vector<StepRegistry::EntryView> list;
diff --git a/cucumber_cpp/library/StepRegistry.hpp b/cucumber_cpp/library/StepRegistry.hpp
@@ -89,10 +89,9 @@ namespace cucumber_cpp::library
 
         explicit StepRegistry(cucumber_expression::ParameterRegistry& parameterRegistry);
 
-        [[nodiscard]] StepMatch Query(engine::StepType stepType, const std::string& expression);
+        [[nodiscard]] StepMatch Query(const std::string& expression);
 
         [[nodiscard]] std::size_t Size() const;
-        [[nodiscard]] std::size_t Size(engine::StepType stepType) const;
 
         [[nodiscard]] std::vector<EntryView> List() const;
 
diff --git a/cucumber_cpp/library/Steps.hpp b/cucumber_cpp/library/Steps.hpp
@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_STEPSMACRO_HPP
 #define CUCUMBER_CPP_STEPSMACRO_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/BodyMacro.hpp"
 #include "cucumber_cpp/library/StepRegistry.hpp"
 #include "cucumber_cpp/library/engine/Step.hpp"
diff --git a/cucumber_cpp/library/engine/FeatureFactory.cpp b/cucumber_cpp/library/engine/FeatureFactory.cpp
@@ -158,7 +158,6 @@ namespace cucumber_cpp::library::engine
             }
             catch (const std::out_of_range&)
             {
-
                 throw UnsupportedAsteriskError{ std::format("{}:{}: * steps are not supported", scenarioInfo.FeatureInfo().Path().string(), step.location.line) };
             }
         }
@@ -293,7 +292,7 @@ namespace cucumber_cpp::library::engine
     {
         try
         {
-            auto stepMatch = stepRegistry.Query(stepType, stepText);
+            auto stepMatch = stepRegistry.Query(stepText);
             return std::make_unique<StepInfo>(scenarioInfo, std::move(stepText), stepType, line, column, std::move(table), std::move(stepMatch));
         }
         catch (const StepRegistry::StepNotFoundError&)
diff --git a/cucumber_cpp/library/report/Report.hpp b/cucumber_cpp/library/report/Report.hpp
@@ -1,6 +1,9 @@
 #ifndef REPORT_REPORT_HPP
 #define REPORT_REPORT_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/TraceTime.hpp"
 #include "cucumber_cpp/library/engine/ContextManager.hpp"
 #include "cucumber_cpp/library/engine/FeatureInfo.hpp"
diff --git a/cucumber_cpp/library/test/TestSteps.cpp b/cucumber_cpp/library/test/TestSteps.cpp
@@ -1,7 +1,6 @@
 #include "cucumber_cpp/library/Context.hpp"
 #include "cucumber_cpp/library/StepRegistry.hpp"
 #include "cucumber_cpp/library/cucumber_expression/ParameterRegistry.hpp"
-#include "cucumber_cpp/library/engine/StepType.hpp"
 #include "gtest/gtest.h"
 #include <cstdint>
 #include <gmock/gmock.h>
@@ -22,43 +21,19 @@ namespace cucumber_cpp::library
     TEST_F(TestSteps, RegisterThroughPreregistration)
     {
         EXPECT_THAT(stepRegistry.Size(), testing::Ge(1));
-        EXPECT_THAT(stepRegistry.Size(engine::StepType::given), testing::Ge(1));
-        EXPECT_THAT(stepRegistry.Size(engine::StepType::when), testing::Ge(1));
-        EXPECT_THAT(stepRegistry.Size(engine::StepType::then), testing::Ge(1));
-        EXPECT_THAT(stepRegistry.Size(engine::StepType::any), testing::Ge(1));
     }
 
     TEST_F(TestSteps, GetGivenStep)
     {
-        const auto matches = stepRegistry.Query(engine::StepType::given, "This is a GIVEN step");
-
-        EXPECT_THAT(matches.stepRegexStr, testing::StrEq("^This is a GIVEN step$"));
-    }
-
-    TEST_F(TestSteps, GetWhenStep)
-    {
-        const auto matches = stepRegistry.Query(engine::StepType::when, "This is a WHEN step");
-
-        EXPECT_THAT(matches.stepRegexStr, testing::StrEq("^This is a WHEN step$"));
-    }
-
-    TEST_F(TestSteps, GetThenStep)
-    {
-        const auto matches = stepRegistry.Query(engine::StepType::then, "This is a THEN step");
-
-        EXPECT_THAT(matches.stepRegexStr, testing::StrEq("^This is a THEN step$"));
-    }
-
-    TEST_F(TestSteps, GetAnyStep)
-    {
-        const auto matches = stepRegistry.Query(engine::StepType::given, "This is a STEP step");
-
-        EXPECT_THAT(matches.stepRegexStr, testing::StrEq("^This is a STEP step$"));
+        EXPECT_THAT(stepRegistry.Query("This is a GIVEN step").stepRegexStr, testing::StrEq("^This is a GIVEN step$"));
+        EXPECT_THAT(stepRegistry.Query("This is a WHEN step").stepRegexStr, testing::StrEq("^This is a WHEN step$"));
+        EXPECT_THAT(stepRegistry.Query("This is a THEN step").stepRegexStr, testing::StrEq("^This is a THEN step$"));
+        EXPECT_THAT(stepRegistry.Query("This is a STEP step").stepRegexStr, testing::StrEq("^This is a STEP step$"));
     }
 
     TEST_F(TestSteps, GetStepWithMatches)
     {
-        const auto matches = stepRegistry.Query(engine::StepType::when, "This is a step with a 10s delay");
+        const auto matches = stepRegistry.Query("This is a step with a 10s delay");
 
         EXPECT_THAT(matches.stepRegexStr, testing::StrEq("^This is a step with a ([0-9]+)s delay$"));
 
@@ -68,20 +43,17 @@ namespace cucumber_cpp::library
 
     TEST_F(TestSteps, GetInvalidStep)
     {
-        EXPECT_THROW((void)stepRegistry.Query(engine::StepType::when, "This step does not exist"), StepRegistry::StepNotFoundError);
+        EXPECT_THROW((void)stepRegistry.Query("This step does not exist"), StepRegistry::StepNotFoundError);
     }
 
     TEST_F(TestSteps, GetAmbiguousStep)
     {
-        EXPECT_NO_THROW((void)stepRegistry.Query(engine::StepType::given, "an ambiguous step"));
-        EXPECT_NO_THROW((void)stepRegistry.Query(engine::StepType::when, "an ambiguous step"));
-
-        EXPECT_THROW((void)stepRegistry.Query(engine::StepType::then, "an ambiguous step"), StepRegistry::AmbiguousStepError);
+        EXPECT_THROW((void)stepRegistry.Query("an ambiguous step"), StepRegistry::AmbiguousStepError);
     }
 
     TEST_F(TestSteps, InvokeTestWithCucumberExpressions)
     {
-        const auto matches = stepRegistry.Query(engine::StepType::when, R"(Step with cucumber expression syntax 1.5 "abcdef" 10)");
+        const auto matches = stepRegistry.Query(R"(Step with cucumber expression syntax 1.5 "abcdef" 10)");
 
         auto contextStorage{ std::make_shared<ContextStorageFactoryImpl>() };
         Context context{ contextStorage };
@@ -99,16 +71,16 @@ namespace cucumber_cpp::library
 
     TEST_F(TestSteps, EscapedCucumberExpression)
     {
-        const auto matchesParens = stepRegistry.Query(engine::StepType::then, R"(An expression with (parenthesis) should remain as is)");
+        const auto matchesParens = stepRegistry.Query(R"(An expression with (parenthesis) should remain as is)");
         EXPECT_THAT(matchesParens.stepRegexStr, testing::StrEq(R"(^An expression with \(parenthesis\) should remain as is$)"));
 
-        const auto matchesBrace = stepRegistry.Query(engine::StepType::then, R"(An expression with {braces} should remain as is)");
+        const auto matchesBrace = stepRegistry.Query(R"(An expression with {braces} should remain as is)");
         EXPECT_THAT(matchesBrace.stepRegexStr, testing::StrEq(R"(^An expression with \{braces\} should remain as is$)"));
     }
 
     TEST_F(TestSteps, FunctionLikeStep)
     {
-        const auto matches = stepRegistry.Query(engine::StepType::then, R"(An expression that looks like a function func(1, 2) should keep its parameters)");
+        const auto matches = stepRegistry.Query(R"(An expression that looks like a function func(1, 2) should keep its parameters)");
 
         auto contextStorage{ std::make_shared<ContextStorageFactoryImpl>() };
         Context context{ contextStorage };
@@ -118,7 +90,7 @@ namespace cucumber_cpp::library
 
     TEST_F(TestSteps, EscapedParenthesis)
     {
-        const auto matches1 = stepRegistry.Query(engine::StepType::then, R"(An expression with \(escaped parenthesis\) should keep the slash)");
-        const auto matches2 = stepRegistry.Query(engine::StepType::then, R"(An expression with \{escaped braces\} should keep the slash)");
+        const auto matches1 = stepRegistry.Query(R"(An expression with \(escaped parenthesis\) should keep the slash)");
+        const auto matches2 = stepRegistry.Query(R"(An expression with \{escaped braces\} should keep the slash)");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#include "cucumber_cpp/library/Hooks.hpp"`
	`1`	`+#include "cucumber_cpp/CucumberCpp.hpp"`
`2`	`2`	`#include "gmock/gmock.h"`
`3`	`3`	`#include <iostream>`
`4`	`4`	`#include <string>`