feat: ndjson reporting - gherkin document is not just feature but other properties too. Need to expose original feature pickle since it does not independently generate json but is part of a bigger object.

Author: alextech

cucumber_cpp/library/engine/FeatureInfo.cpp

@@ -75,9 +75,9 @@ namespace cucumber_cpp::library::engine
         return scenarios;
     }
 
-    std::string FeatureInfo::ToJson() const
+    const cucumber::messages::feature& FeatureInfo::Pickle() const
     {
-        return feature.to_json();
+        return feature;
     }
 
 

cucumber_cpp/library/engine/FeatureInfo.hpp

@@ -36,7 +36,7 @@ namespace cucumber_cpp::library::engine
         [[nodiscard]] std::vector<std::unique_ptr<ScenarioInfo>>& Scenarios();
         [[nodiscard]] const std::vector<std::unique_ptr<ScenarioInfo>>& Scenarios() const;
 
-        [[nodiscard]] std::string ToJson() const;
+        [[nodiscard]] const cucumber::messages::feature& Pickle() const;
 
     private:
 

cucumber_cpp/library/report/NdjsonReport.cpp

@@ -1,5 +1,6 @@
 #include "NdjsonReport.hpp"
 #include "Environment.h"
+#include <cucumber/messages/gherkin_document.hpp>
 #include <cucumber/messages/meta.hpp>
 #include <cucumber_cpp/library/engine/SourceInfo.hpp>
 #include <fstream>
@@ -22,7 +23,6 @@ namespace cucumber_cpp::library::report
         outStream.close();
     }
 
-
     /*
      * Unlike XML reporter, where a single document is built up over time and then has to be flushed out in the end all at once,
      * NDJSON is a series of individual json objects appended one after another as the test run progresses.
@@ -51,20 +51,27 @@ namespace cucumber_cpp::library::report
         }
     }
 
-    void NdjsonReport::CreateMeta()
+    void NdjsonReport::RecordMeta()
     {
         // Makeup own metadata since https://github.com/cucumber/ci-environment does not have c++ version (yet)
         cucumber::messages::meta meta (MESSAGES_PROTOCOL_VERSION);
+        meta.ci = cucumber::messages::ci("name", "url", "build_number");
+        meta.ci->git = cucumber::messages::git("remote", "revision", "branch", "tag");
+        outStream << "{\"meta\":" << meta.to_json() << "}\n";
     }
 
 
     void NdjsonReport::FeatureStart(const engine::FeatureInfo& featureInfo)
     {
         InitReportDirectory();
-        CreateMeta();
+        RecordMeta();
 
         outStream << "{\"source\":" << featureInfo.SourceInfo()->ToJson() << "}\n";
-        outStream << "{\"gherkinDocument\":" << featureInfo.ToJson() << "}\n";
+
+        cucumber::messages::gherkin_document gherkinDocument;
+        gherkinDocument.feature = featureInfo.Pickle();
+
+        outStream << "{\"gherkinDocument\":" << gherkinDocument.to_json() << "}\n";
         // TODO testRunStarted
     }
 

cucumber_cpp/library/report/NdjsonReport.hpp

@@ -29,7 +29,7 @@ namespace cucumber_cpp::library::report
 
         std::ofstream outStream;
         void InitReportDirectory();
-        static void CreateMeta() ;
+        void RecordMeta() ;
 
     };