feat: ndjson reporting - get pickle json from scenario info

Author: alextech

cucumber_cpp/acceptance_test/MainNdjsonAssertion.cpp

@@ -15,8 +15,7 @@ int main(const int argc, char**argv)
 
     CLI11_PARSE(app, argc, argv);
 
-    NdjsonComparer comparer;
-    const bool areEquivalent = comparer.AreEquivalent(pathExpected, pathActual);
+    const bool areEquivalent = NdjsonComparer::AreEquivalent(pathExpected, pathActual);
 
     std::cout << (areEquivalent ? "true" : "false");
 

cucumber_cpp/library/engine/FeatureFactory.cpp

@@ -187,9 +187,9 @@ namespace cucumber_cpp::library::engine
                 return;
 
             featureInfo.Scenarios().push_back(std::make_unique<ScenarioInfo>(
+                pickle,
                 featureInfo,
                 std::move(tags),
-                pickle.name,
                 scenario.description,
                 scenario.location.line,
                 scenario.location.column.value_or(0)));
@@ -200,9 +200,9 @@ namespace cucumber_cpp::library::engine
         void ConstructScenario(const FeatureTreeFactory& featureTreeFactory, RuleInfo& ruleInfo, const FlatAst& flatAst, const cucumber::messages::scenario& scenario, const cucumber::messages::pickle& pickle, std::set<std::string, std::less<>> tags)
         {
             ruleInfo.Scenarios().push_back(std::make_unique<ScenarioInfo>(
+                pickle,
                 ruleInfo,
                 std::move(tags),
-                pickle.name,
                 scenario.description,
                 scenario.location.line,
                 scenario.location.column.value_or(0)));

cucumber_cpp/library/engine/ScenarioInfo.cpp

@@ -16,19 +16,19 @@
 
 namespace cucumber_cpp::library::engine
 {
-    ScenarioInfo::ScenarioInfo(const struct RuleInfo& ruleInfo, std::set<std::string, std::less<>> tags, std::string title, std::string description, std::size_t line, std::size_t column)
-        : parentInfo{ &ruleInfo }
+    ScenarioInfo::ScenarioInfo(cucumber::messages::pickle pickle, const struct RuleInfo& ruleInfo, std::set<std::string, std::less<>> tags, std::string description, std::size_t line, std::size_t column)
+        : pickle(std::move(pickle))
+        , parentInfo{ &ruleInfo }
         , tags{ std::move(tags) }
-        , title{ std::move(title) }
         , description{ std::move(description) }
         , line{ line }
         , column{ column }
     {}
 
-    ScenarioInfo::ScenarioInfo(const struct FeatureInfo& featureInfo, std::set<std::string, std::less<>> tags, std::string title, std::string description, std::size_t line, std::size_t column)
-        : parentInfo{ &featureInfo }
+    ScenarioInfo::ScenarioInfo(cucumber::messages::pickle pickle, const struct FeatureInfo& featureInfo, std::set<std::string, std::less<>> tags, std::string description, std::size_t line, std::size_t column)
+        : pickle(std::move(pickle))
+        , parentInfo{ &featureInfo }
         , tags{ std::move(tags) }
-        , title{ std::move(title) }
         , description{ std::move(description) }
         , line{ line }
         , column{ column }
@@ -61,7 +61,7 @@ namespace cucumber_cpp::library::engine
 
     const std::string& ScenarioInfo::Title() const
     {
-        return title;
+        return pickle.name;
     }
 
     const std::string& ScenarioInfo::Description() const
@@ -93,4 +93,10 @@ namespace cucumber_cpp::library::engine
     {
         return children;
     }
+
+    std::string ScenarioInfo::ToJson() const
+    {
+        return pickle.to_json();
+    }
+
 }

cucumber_cpp/library/engine/ScenarioInfo.hpp

@@ -4,6 +4,7 @@
 #include "cucumber_cpp/library/engine/RuleInfo.hpp"
 #include "cucumber_cpp/library/engine/StepInfo.hpp"
 #include <cstddef>
+#include <cucumber/messages/pickle.hpp>
 #include <filesystem>
 #include <functional>
 #include <memory>
@@ -19,8 +20,8 @@ namespace cucumber_cpp::library::engine
 
     struct ScenarioInfo
     {
-        ScenarioInfo(const RuleInfo& ruleInfo, std::set<std::string, std::less<>> tags, std::string title, std::string description, std::size_t line, std::size_t column);
-        ScenarioInfo(const FeatureInfo& featureInfo, std::set<std::string, std::less<>> tags, std::string title, std::string description, std::size_t line, std::size_t column);
+        ScenarioInfo(cucumber::messages::pickle pickle, const RuleInfo& ruleInfo, std::set<std::string, std::less<>> tags, std::string description, std::size_t line, std::size_t column);
+        ScenarioInfo(cucumber::messages::pickle pickle, const FeatureInfo& featureInfo, std::set<std::string, std::less<>> tags, std::string description, std::size_t line, std::size_t column);
 
         [[nodiscard]] const struct FeatureInfo& FeatureInfo() const;
         [[nodiscard]] std::optional<std::reference_wrapper<const struct RuleInfo>> RuleInfo() const;
@@ -37,11 +38,13 @@ namespace cucumber_cpp::library::engine
         [[nodiscard]] std::vector<std::unique_ptr<StepInfo>>& Children();
         [[nodiscard]] const std::vector<std::unique_ptr<StepInfo>>& Children() const;
 
+        [[nodiscard]] std::string ToJson() const;
+
     private:
+        const cucumber::messages::pickle pickle;
         std::variant<const struct FeatureInfo*, const struct RuleInfo*> parentInfo;
 
         std::set<std::string, std::less<>> tags;
-        std::string title;
         std::string description;
 
         std::size_t line;

cucumber_cpp/library/report/NdjsonReport.cpp

@@ -56,7 +56,6 @@ namespace cucumber_cpp::library::report
         // TODO find a place to record first meta line.
         outStream << "{\"source\":" << featureInfo.SourceInfo()->ToJson() << "}\n";
         outStream << "{\"gherkinDocument\":" << featureInfo.ToJson() << "}\n";
-        // TODO find where pickle definition is coming from
         // TODO testRunStarted
     }
 
@@ -75,6 +74,8 @@ namespace cucumber_cpp::library::report
 
     void NdjsonReport::ScenarioStart(const engine::ScenarioInfo& scenarioInfo)
     {
+        // each scenario is a pickle
+        outStream << "{\"pickle\":" << scenarioInfo.ToJson() << "}\n";
     }
 
     void NdjsonReport::ScenarioEnd(engine::Result result, const engine::ScenarioInfo& scenarioInfo, TraceTime::Duration duration)