Payload Builder supporting google.protobuf.Any

include/up-cpp/datamodel/builder/Payload.h

@@ -12,6 +12,7 @@
 #ifndef UP_CPP_DATAMODEL_BUILDER_PAYLOAD_H
 #define UP_CPP_DATAMODEL_BUILDER_PAYLOAD_H
 
+#include <google/protobuf/any.pb.h>
 #include <uprotocol/v1/uattributes.pb.h>
 
 #include <cstdint>
@@ -79,8 +80,8 @@
 	///          will compile out.
 	/// @param data Data to be serialized and stored.
 	template <typename Serializer, typename ValueT>
 	Payload(Serializer s, const ValueT& data) {
 		auto serializedData = Serializer::serialize(data);
 		if (!UPayloadFormat_IsValid(
 		        std::get<PayloadType::Format>(serializedData))) {
 			throw std::out_of_range("Invalid Serializer payload format");
@@ -95,7 +96,7 @@
 	///
 	/// @throws std::out_of_range If format is not valid for v1::UPayloadFormat
 	Payload(const std::vector<uint8_t>& value_bytes,
 	        const v1::UPayloadFormat format);
 
 	/// @brief Creates a Payload builder with a provided pre-serialized data.
 	///
@@ -106,7 +107,7 @@
 	///
 	/// @note This would typically be used for UPAYLOAD_FORMAT_TEXT or
 	///       UPAYLOAD_FORMAT_JSON, but can be used for other payload formats.
 	Payload(const std::string& value, const v1::UPayloadFormat format);
 
 	/// @brief Creates a Payload builder with a provided pre-serialized data.
 	///
@@ -119,7 +120,7 @@
 	///
 	/// @note This would typically be used for UPAYLOAD_FORMAT_TEXT or
 	///       UPAYLOAD_FORMAT_JSON, but can be used for other payload formats.
 	Payload(std::string&& value, const v1::UPayloadFormat format);
 
 	/// @brief Creates a Payload builder with a provided pre-serialized data.
 	///
@@ -131,6 +132,13 @@
 	///                           for v1::UPayloadFormat
 	explicit Payload(Serialized&&);
 
+	/// @brief Creates a Payload builder with a provided protobuf::Any.
+	///
+	/// The contents of value will be moved into the Payload object.
+	///
+	/// @param An initialized google::protobuf::Any object..
+	explicit Payload(const google::protobuf::Any&);
+
 	/// @brief Move constructor.
 	Payload(Payload&&) noexcept;
 

src/datamodel/builder/Payload.cpp

@@ -1,4 +1,4 @@
 // SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
 //
 // See the NOTICE file(s) distributed with this work for additional
 // information regarding copyright ownership.
@@ -27,7 +27,7 @@
 	if (!UPayloadFormat_IsValid(format)) {
 		throw std::out_of_range("Invalid String payload format");
 	}
 	payload_ = std::make_tuple(std::move(value), format);
 }
 
 // Move string constructor
@@ -46,23 +46,30 @@
 	payload_ = std::move(serialized);
 }
 
+// google::protobuf::Any constructor
+Payload::Payload(const google::protobuf::Any& any) {
+	payload_ = std::make_tuple(
+		any.SerializeAsString(),
+		uprotocol::v1::UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY);	
+}
+
 // Move constructor
 Payload::Payload(Payload&& other) noexcept
     : payload_(std::move(other.payload_)), moved_(std::move(other.moved_)) {}
 
 // Copy constructor
 Payload::Payload(const Payload& other)
     : payload_(other.payload_), moved_(other.moved_) {}
 
 // Move assignment operator
 Payload& Payload::operator=(Payload&& other) noexcept {
 	payload_ = std::move(other.payload_);
 	moved_ = std::move(other.moved_);
 	return *this;
 }
 
 // Copy assignment operator
 Payload& Payload::operator=(const Payload& other) {
 	payload_ = other.payload_;
 	moved_ = other.moved_;
 	return *this;

test/coverage/datamodel/PayloadBuilderTest.cpp

@@ -1,4 +1,4 @@
 // SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
 //
 // See the NOTICE file(s) distributed with this work for additional
 // information regarding copyright ownership.
@@ -101,7 +101,7 @@
 
 	// Act
 	Payload payload(uriObject);
-	auto& [payload_reference, _] = payload.buildCopy();
+	auto& [payload_reference, payload_format] = payload.buildCopy();
 	const void* original_address = payload_reference.data();
 
 	// Assert
@@ -110,7 +110,7 @@
 	          uprotocol::v1::UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF);
 	EXPECT_EQ(payloadData, expectedPayloadData);
 
-	EXPECT_THROW(auto _ = payload.buildCopy(), Payload::PayloadMoved);
+	EXPECT_THROW(auto result = payload.buildCopy(), Payload::PayloadMoved);
 	EXPECT_EQ(original_address, payloadData.data());
 }
 
@@ -130,7 +130,9 @@
 	          uprotocol::v1::UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF);
 	EXPECT_EQ(payloadData, uriObject.SerializeAsString());
 
-	EXPECT_THROW(std::move(payload).buildMove(), Payload::PayloadMoved);
+	EXPECT_THROW({
+		auto _ = std::move(payload).buildMove();
+	}, Payload::PayloadMoved);	
 }
 
 // Create serialized protobuf payload. Call build after move.
@@ -340,6 +342,31 @@
 	EXPECT_THROW(auto _ = payload.buildCopy(), Payload::PayloadMoved);
 }
 
+// Create Any and move payload object test
+TEST_F(PayloadTest, AnyMovePayloadTest) {  // NOLINT
+	// Arrange
+	uprotocol::v1::UUri uri_object;  // NOLINT
+	uri_object.set_authority_name(testStringPayload_);
+	google::protobuf::Any any;
+	any.PackFrom(uri_object, "hello_world");
+
+	// Act
+	Payload payload(any);
+	auto [serialized_data, payload_format] = std::move(payload).buildMove();
+
+	// Assert
+	EXPECT_EQ(
+	    payload_format,
+	    uprotocol::v1::UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY);
+	google::protobuf::Any parsed_any;
+	EXPECT_TRUE(parsed_any.ParseFromString(serialized_data));
+	EXPECT_EQ(parsed_any.type_url(), "hello_world/uprotocol.v1.UUri");
+
+	uprotocol::v1::UUri parsed_uri_object;
+	EXPECT_TRUE(parsed_uri_object.ParseFromString(parsed_any.value()));
+	EXPECT_EQ(parsed_uri_object.authority_name(), testStringPayload_);
+}
+
 /////////////////////RValue String Payload Tests/////////////////////
 
 // Create RValue String Payload