Add global hooks, global attachments, hook types (#102)

Author: davidjgoss

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Add new `TestRunHookStarted` and `TestRunHookFinished` messages ([#102](https://github.com/cucumber/messages/pull/102))
+
+### Changed
+- BREAKING CHANGE: Add `id` property to `TestRunStarted`, optionally reference in `TestCase`, `Attachment` and `TestRunFinished` ([#102](https://github.com/cucumber/messages/pull/102))
+- BREAKING CHANGE: Add `type` property to `Hook` ([#102](https://github.com/cucumber/messages/pull/102))
 
 ## [26.0.1] - 2024-09-22
 ### Changed

Makefile

@@ -19,8 +19,11 @@ schemas = \
 	./jsonschema/TestRunFinished.json \
 	./jsonschema/TestRunStarted.json \
 	./jsonschema/Duration.json \
+	./jsonschema/TestStepResult.json \
 	./jsonschema/TestStepFinished.json \
 	./jsonschema/TestStepStarted.json \
+	./jsonschema/TestRunHookFinished.json \
+	./jsonschema/TestRunHookStarted.json \
 	./jsonschema/UndefinedParameterType.json \
 	./jsonschema/Envelope.json
 

cpp/include/messages/cucumber/messages/all.hpp

@@ -47,6 +47,8 @@
 #include <cucumber/messages/test_case_finished.hpp>
 #include <cucumber/messages/test_case_started.hpp>
 #include <cucumber/messages/test_run_finished.hpp>
+#include <cucumber/messages/test_run_hook_finished.hpp>
+#include <cucumber/messages/test_run_hook_started.hpp>
 #include <cucumber/messages/test_run_started.hpp>
 #include <cucumber/messages/test_step_finished.hpp>
 #include <cucumber/messages/test_step_result.hpp>

cpp/include/messages/cucumber/messages/attachment.hpp

@@ -41,6 +41,7 @@ struct attachment
     std::optional<std::string> test_case_started_id;
     std::optional<std::string> test_step_id;
     std::optional<std::string> url;
+    std::optional<std::string> test_run_started_id;
 
     std::string to_string() const;
 

cpp/include/messages/cucumber/messages/envelope.hpp

@@ -22,6 +22,8 @@
 #include <cucumber/messages/test_run_started.hpp>
 #include <cucumber/messages/test_step_finished.hpp>
 #include <cucumber/messages/test_step_started.hpp>
+#include <cucumber/messages/test_run_hook_started.hpp>
+#include <cucumber/messages/test_run_hook_finished.hpp>
 #include <cucumber/messages/undefined_parameter_type.hpp>
 
 namespace cucumber::messages {
@@ -59,6 +61,8 @@ struct envelope
     std::optional<cucumber::messages::test_run_started> test_run_started;
     std::optional<cucumber::messages::test_step_finished> test_step_finished;
     std::optional<cucumber::messages::test_step_started> test_step_started;
+    std::optional<cucumber::messages::test_run_hook_started> test_run_hook_started;
+    std::optional<cucumber::messages::test_run_hook_finished> test_run_hook_finished;
     std::optional<cucumber::messages::undefined_parameter_type> undefined_parameter_type;
 
     std::string to_string() const;

cpp/include/messages/cucumber/messages/hook.hpp

@@ -7,6 +7,7 @@
 #include <nlohmann/json.hpp>
 
 #include <cucumber/messages/source_reference.hpp>
+#include <cucumber/messages/hook_type.hpp>
 
 namespace cucumber::messages {
 
@@ -24,6 +25,7 @@ struct hook
     std::optional<std::string> name;
     cucumber::messages::source_reference source_reference;
     std::optional<std::string> tag_expression;
+    std::optional<cucumber::messages::hook_type> type;
 
     std::string to_string() const;
 

cpp/include/messages/cucumber/messages/hook_type.hpp

@@ -0,0 +1,23 @@
+#pragma once
+
+#include <string_view>
+
+namespace cucumber::messages {
+
+enum class hook_type
+{
+    BEFORE_TEST_RUN,
+    AFTER_TEST_RUN,
+    BEFORE_TEST_CASE,
+    AFTER_TEST_CASE,
+    BEFORE_TEST_STEP,
+    AFTER_TEST_STEP
+};
+
+std::string_view
+to_string(hook_type v);
+
+std::ostream&
+operator<<(std::ostream& os, hook_type v);
+
+}

cpp/include/messages/cucumber/messages/test_case.hpp

@@ -27,6 +27,7 @@ struct test_case
     std::string id;
     std::string pickle_id;
     std::vector<cucumber::messages::test_step> test_steps;
+    std::optional<std::string> test_run_started_id;
 
     std::string to_string() const;
 

cpp/include/messages/cucumber/messages/test_run_finished.hpp

@@ -25,6 +25,7 @@ struct test_run_finished
     bool success;
     cucumber::messages::timestamp timestamp;
     std::optional<cucumber::messages::exception> exception;
+    std::optional<std::string> test_run_started_id;
 
     std::string to_string() const;
 

cpp/include/messages/cucumber/messages/test_run_hook_finished.hpp

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <vector>
+#include <string>
+#include <optional>
+
+#include <nlohmann/json.hpp>
+
+#include <cucumber/messages/test_step_result.hpp>
+#include <cucumber/messages/timestamp.hpp>
+
+namespace cucumber::messages {
+
+using json = nlohmann::json;
+
+//
+// Represents the TestRunHookFinished message in Cucumber's message protocol
+// @see <a href=https://github.com/cucumber/messages>Github - Cucumber - Messages</a>
+//
+// Generated code
+
+struct test_run_hook_finished
+{
+    std::string test_run_hook_started_id;
+    cucumber::messages::test_step_result result;
+    cucumber::messages::timestamp timestamp;
+
+    std::string to_string() const;
+
+    void to_json(json& j) const;
+    std::string to_json() const;
+};
+
+std::ostream&
+operator<<(std::ostream& os, const test_run_hook_finished& msg);
+
+void to_json(json& j, const test_run_hook_finished& m);
+
+}

cpp/include/messages/cucumber/messages/test_run_hook_started.hpp

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <vector>
+#include <string>
+#include <optional>
+
+#include <nlohmann/json.hpp>
+
+#include <cucumber/messages/timestamp.hpp>
+
+namespace cucumber::messages {
+
+using json = nlohmann::json;
+
+//
+// Represents the TestRunHookStarted message in Cucumber's message protocol
+// @see <a href=https://github.com/cucumber/messages>Github - Cucumber - Messages</a>
+//
+// Generated code
+
+struct test_run_hook_started
+{
+    std::string id;
+    std::string test_run_started_id;
+    std::string hook_id;
+    cucumber::messages::timestamp timestamp;
+
+    std::string to_string() const;
+
+    void to_json(json& j) const;
+    std::string to_json() const;
+};
+
+std::ostream&
+operator<<(std::ostream& os, const test_run_hook_started& msg);
+
+void to_json(json& j, const test_run_hook_started& m);
+
+}

cpp/include/messages/cucumber/messages/test_run_started.hpp

@@ -21,6 +21,7 @@ using json = nlohmann::json;
 struct test_run_started
 {
     cucumber::messages::timestamp timestamp;
+    std::optional<std::string> id;
 
     std::string to_string() const;
 

cpp/src/lib/messages/cucumber/messages/attachment.cpp

@@ -18,6 +18,7 @@ attachment::to_string() const
     cucumber::messages::to_string(oss, ", test_case_started_id=", test_case_started_id);
     cucumber::messages::to_string(oss, ", test_step_id=", test_step_id);
     cucumber::messages::to_string(oss, ", url=", url);
+    cucumber::messages::to_string(oss, ", test_run_started_id=", test_run_started_id);
 
     return oss.str();
 }
@@ -33,6 +34,7 @@ attachment::to_json(json& j) const
     cucumber::messages::to_json(j, camelize("test_case_started_id"), test_case_started_id);
     cucumber::messages::to_json(j, camelize("test_step_id"), test_step_id);
     cucumber::messages::to_json(j, camelize("url"), url);
+    cucumber::messages::to_json(j, camelize("test_run_started_id"), test_run_started_id);
 }
 
 std::string

cpp/src/lib/messages/cucumber/messages/envelope.cpp

@@ -26,6 +26,8 @@ envelope::to_string() const
     cucumber::messages::to_string(oss, ", test_run_started=", test_run_started);
     cucumber::messages::to_string(oss, ", test_step_finished=", test_step_finished);
     cucumber::messages::to_string(oss, ", test_step_started=", test_step_started);
+    cucumber::messages::to_string(oss, ", test_run_hook_started=", test_run_hook_started);
+    cucumber::messages::to_string(oss, ", test_run_hook_finished=", test_run_hook_finished);
     cucumber::messages::to_string(oss, ", undefined_parameter_type=", undefined_parameter_type);
 
     return oss.str();
@@ -50,6 +52,8 @@ envelope::to_json(json& j) const
     cucumber::messages::to_json(j, camelize("test_run_started"), test_run_started);
     cucumber::messages::to_json(j, camelize("test_step_finished"), test_step_finished);
     cucumber::messages::to_json(j, camelize("test_step_started"), test_step_started);
+    cucumber::messages::to_json(j, camelize("test_run_hook_started"), test_run_hook_started);
+    cucumber::messages::to_json(j, camelize("test_run_hook_finished"), test_run_hook_finished);
     cucumber::messages::to_json(j, camelize("undefined_parameter_type"), undefined_parameter_type);
 }
 

cpp/src/lib/messages/cucumber/messages/hook.cpp

@@ -14,6 +14,7 @@ hook::to_string() const
     cucumber::messages::to_string(oss, ", name=", name);
     cucumber::messages::to_string(oss, ", source_reference=", source_reference);
     cucumber::messages::to_string(oss, ", tag_expression=", tag_expression);
+    cucumber::messages::to_string(oss, ", type=", type);
 
     return oss.str();
 }
@@ -25,6 +26,7 @@ hook::to_json(json& j) const
     cucumber::messages::to_json(j, camelize("name"), name);
     cucumber::messages::to_json(j, camelize("source_reference"), source_reference);
     cucumber::messages::to_json(j, camelize("tag_expression"), tag_expression);
+    cucumber::messages::to_json(j, camelize("type"), type);
 }
 
 std::string

cpp/src/lib/messages/cucumber/messages/hook_type.cpp

@@ -0,0 +1,33 @@
+#include <iostream>
+#include <unordered_map>
+
+#include <cucumber/messages/hook_type.hpp>
+
+namespace cucumber::messages {
+
+std::string_view
+to_string(hook_type v)
+{
+    using map_type = std::unordered_map<hook_type, std::string_view>;
+
+    static const map_type m = {
+        { hook_type::BEFORE_TEST_RUN, "BEFORE_TEST_RUN" },
+        { hook_type::AFTER_TEST_RUN, "AFTER_TEST_RUN" },
+        { hook_type::BEFORE_TEST_CASE, "BEFORE_TEST_CASE" },
+        { hook_type::AFTER_TEST_CASE, "AFTER_TEST_CASE" },
+        { hook_type::BEFORE_TEST_STEP, "BEFORE_TEST_STEP" },
+        { hook_type::AFTER_TEST_STEP, "AFTER_TEST_STEP" }
+    };
+
+    return m.at(v);
+}
+
+std::ostream&
+operator<<(std::ostream& os, hook_type v)
+{
+    os << to_string(v);
+
+    return os;
+}
+
+}

cpp/src/lib/messages/cucumber/messages/test_case.cpp

@@ -13,6 +13,7 @@ test_case::to_string() const
     cucumber::messages::to_string(oss, "id=", id);
     cucumber::messages::to_string(oss, ", pickle_id=", pickle_id);
     cucumber::messages::to_string(oss, ", test_steps=", test_steps);
+    cucumber::messages::to_string(oss, ", test_run_started_id=", test_run_started_id);
 
     return oss.str();
 }
@@ -23,6 +24,7 @@ test_case::to_json(json& j) const
     cucumber::messages::to_json(j, camelize("id"), id);
     cucumber::messages::to_json(j, camelize("pickle_id"), pickle_id);
     cucumber::messages::to_json(j, camelize("test_steps"), test_steps);
+    cucumber::messages::to_json(j, camelize("test_run_started_id"), test_run_started_id);
 }
 
 std::string

cpp/src/lib/messages/cucumber/messages/test_run_finished.cpp

@@ -14,6 +14,7 @@ test_run_finished::to_string() const
     cucumber::messages::to_string(oss, ", success=", success);
     cucumber::messages::to_string(oss, ", timestamp=", timestamp);
     cucumber::messages::to_string(oss, ", exception=", exception);
+    cucumber::messages::to_string(oss, ", test_run_started_id=", test_run_started_id);
 
     return oss.str();
 }
@@ -25,6 +26,7 @@ test_run_finished::to_json(json& j) const
     cucumber::messages::to_json(j, camelize("success"), success);
     cucumber::messages::to_json(j, camelize("timestamp"), timestamp);
     cucumber::messages::to_json(j, camelize("exception"), exception);
+    cucumber::messages::to_json(j, camelize("test_run_started_id"), test_run_started_id);
 }
 
 std::string

cpp/src/lib/messages/cucumber/messages/test_run_hook_finished.cpp

@@ -0,0 +1,52 @@
+#include <sstream>
+
+#include <cucumber/messages/utils.hpp>
+#include <cucumber/messages/test_run_hook_finished.hpp>
+
+namespace cucumber::messages {
+
+std::string
+test_run_hook_finished::to_string() const
+{
+    std::ostringstream oss;
+
+    cucumber::messages::to_string(oss, "test_run_hook_started_id=", test_run_hook_started_id);
+    cucumber::messages::to_string(oss, ", result=", result);
+    cucumber::messages::to_string(oss, ", timestamp=", timestamp);
+
+    return oss.str();
+}
+
+void
+test_run_hook_finished::to_json(json& j) const
+{
+    cucumber::messages::to_json(j, camelize("test_run_hook_started_id"), test_run_hook_started_id);
+    cucumber::messages::to_json(j, camelize("result"), result);
+    cucumber::messages::to_json(j, camelize("timestamp"), timestamp);
+}
+
+std::string
+test_run_hook_finished::to_json() const
+{
+    std::ostringstream oss;
+    json j;
+
+    to_json(j);
+
+    oss << j;
+
+    return oss.str();
+}
+
+std::ostream&
+operator<<(std::ostream& os, const test_run_hook_finished& msg)
+{
+    os << msg.to_string();
+
+    return os;
+}
+
+void to_json(json& j, const test_run_hook_finished& m)
+{ m.to_json(j); }
+
+}