feat: added single include header that exposes all required interfaces in the cucumber_cpp namespace (#149)

Author: daantimmer

cucumber_cpp/CMakeLists.txt

@@ -1,4 +1,20 @@
+
+
 add_subdirectory(library)
 add_subdirectory(runner)
 add_subdirectory(example)
 add_subdirectory(acceptance_test)
+
+add_library(cucumber_cpp INTERFACE)
+
+target_sources(cucumber_cpp INTERFACE
+    CucumberCpp.hpp
+)
+
+target_include_directories(cucumber_cpp INTERFACE
+    ./
+)
+
+target_link_libraries(cucumber_cpp INTERFACE
+    cucumber_cpp.library
+)

cucumber_cpp/CucumberCpp.hpp

@@ -0,0 +1,18 @@
+#ifndef CUCUMBER_CPP_CUCUMBER_CPP_HPP
+#define CUCUMBER_CPP_CUCUMBER_CPP_HPP
+
+#include "cucumber_cpp/library/Application.hpp"
+#include "cucumber_cpp/library/Context.hpp"
+#include "cucumber_cpp/library/Hooks.hpp"
+#include "cucumber_cpp/library/Steps.hpp"
+#include "cucumber_cpp/library/report/Report.hpp"
+
+namespace cucumber_cpp
+{
+    using cucumber_cpp::library::Application;
+    using cucumber_cpp::library::Context;
+    using cucumber_cpp::library::engine::Step;
+    using cucumber_cpp::library::report::ReportHandlerV2;
+}
+
+#endif

cucumber_cpp/acceptance_test/CMakeLists.txt

@@ -2,11 +2,9 @@ set(CMAKE_COMPILE_WARNING_AS_ERROR On)
 
 add_executable(cucumber_cpp.acceptance_test ${CCR_EXCLUDE_FROM_ALL})
 
-target_sources(cucumber_cpp.acceptance_test PRIVATE
-    Main.cpp
-)
 target_link_libraries(cucumber_cpp.acceptance_test PRIVATE
-    cucumber_cpp.library
+    cucumber_cpp
+    cucumber_cpp.runner
     cucumber_cpp.acceptance_test.hooks
     cucumber_cpp.acceptance_test.steps
 )
@@ -18,7 +16,7 @@ target_sources(cucumber_cpp.acceptance_test.custom PRIVATE
 )
 
 target_link_libraries(cucumber_cpp.acceptance_test.custom PRIVATE
-    cucumber_cpp.library
+    cucumber_cpp
     cucumber_cpp.acceptance_test.hooks
     cucumber_cpp.acceptance_test.steps
 )

cucumber_cpp/acceptance_test/Main.cpp

@@ -1,9 +1,8 @@
-#include "cucumber_cpp/library/Application.hpp"
-#include <span>
+#include "cucumber_cpp/CucumberCpp.hpp"
 
 int main(int argc, char** argv)
 {
-    cucumber_cpp::library::Application application{};
+    cucumber_cpp::Application application{};
 
     application.CliParser().add_flag("--required", *application.ProgramContext().EmplaceAt<bool>("--required"))->required();
 

cucumber_cpp/acceptance_test/MainCustom.cpp

@@ -1,6 +1,10 @@
 @bats
 Feature: Test scenario and step hook bindings
 
+  @program_hooks
+  Scenario: Run failing Scenario hooks before
+    Given a given step
+
   @fail_scenariohook_before
   Scenario: Run failing Scenario hooks before
     Given a given step

cucumber_cpp/acceptance_test/features/test_hooks.feature

@@ -75,7 +75,7 @@ teardown() {
 }
 
 @test "Run Program hooks" {
-    run .build/Host/cucumber_cpp/acceptance_test/Debug/cucumber_cpp.acceptance_test run --feature cucumber_cpp/acceptance_test/features --tag @bats --report console
+    run .build/Host/cucumber_cpp/acceptance_test/Debug/cucumber_cpp.acceptance_test run --feature cucumber_cpp/acceptance_test/features --tag @bats and @program_hooks --report console
     assert_success
 
     assert_output --partial "HOOK_BEFORE_ALL"

cucumber_cpp/acceptance_test/test.bats

@@ -8,7 +8,7 @@ target_sources(cucumber_cpp.example PRIVATE
 )
 
 target_link_libraries(cucumber_cpp.example PRIVATE
-    cucumber_cpp.library
+    cucumber_cpp
     cucumber_cpp.example.hooks
     cucumber_cpp.example.steps
 )

cucumber_cpp/example/CMakeLists.txt

@@ -1,9 +1,9 @@
-#include "cucumber_cpp/library/Application.hpp"
+#include "cucumber_cpp/CucumberCpp.hpp"
 #include <string>
 
 int main(int argc, char** argv)
 {
-    cucumber_cpp::library::Application application{};
+    cucumber_cpp::Application application{};
 
     application.CliParser().add_option("--com", *application.ProgramContext().EmplaceAt<std::string>("--com"))->required();
     auto* stOpt = application.CliParser().add_flag("--st", *application.ProgramContext().EmplaceAt<bool>("--st"));

cucumber_cpp/example/Main.cpp

@@ -1,8 +1,8 @@
 #include "cucumber_cpp/library/Hooks.hpp"
 #include "cucumber_cpp/example/fixtures/Fixture.hpp"
 #include "cucumber_cpp/library/Context.hpp"
-#include <algorithm>
-#include <string_view>
+#include <iostream>
+#include <string>
 
 HOOK_BEFORE_ALL()
 {