pw_rpc/pwpb/client_server_context_test.cc - pigweed/pigweed - Git at Google

 // Copyright 2022 The Pigweed Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
 // use this file except in compliance with the License. You may obtain a copy of
 // the License at
 //
 //     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 // License for the specific language governing permissions and limitations under
 // the License.

 #include <mutex>
 #include <utility>

 #include "pw_rpc/pwpb/client_server_testing.h"
 #include "pw_rpc_test_protos/test.rpc.pwpb.h"
 #include "pw_sync/mutex.h"
 #include "pw_unit_test/framework.h"

 namespace pw::rpc {
 namespace {

 namespace TestRequest = ::pw::rpc::test::pwpb::TestRequest;
 namespace TestResponse = ::pw::rpc::test::pwpb::TestResponse;
 namespace TestStreamResponse = ::pw::rpc::test::pwpb::TestStreamResponse;

 }  // namespace

 namespace test {

 using GeneratedService = ::pw::rpc::test::pw_rpc::pwpb::TestService;

 class TestService final : public GeneratedService::Service<TestService> {
  public:
   Status TestUnaryRpc(const TestRequest::Message& request,
                       TestResponse::Message& response) {
     response.value = request.integer + 1;
     return static_cast<Status::Code>(request.status_code);
   }

   Status TestAnotherUnaryRpc(const TestRequest::Message& request,
                              TestResponse::Message& response) {
     response.value = 42;
     response.repeated_field.SetEncoder(
         [](TestResponse::StreamEncoder& encoder) {
           constexpr std::array<uint32_t, 3> kValues = {7, 8, 9};
           return encoder.WriteRepeatedField(kValues);
         });
     return static_cast<Status::Code>(request.status_code);
   }

   static void TestServerStreamRpc(const TestRequest::Message&,
                                   ServerWriter<TestStreamResponse::Message>&) {}

   void TestClientStreamRpc(
       ServerReader<TestRequest::Message, TestStreamResponse::Message>&) {}

   void TestBidirectionalStreamRpc(
       ServerReaderWriter<TestRequest::Message, TestStreamResponse::Message>&) {}
 };

 }  // namespace test

 namespace {

 TEST(PwpbClientServerTestContext, ReceivesUnaryRpcResponse) {
   PwpbClientServerTestContext<> ctx;
   test::TestService service;
   ctx.server().RegisterService(service);

   TestResponse::Message response = {};
   auto handler = [&response](const TestResponse::Message& server_response,
                              pw::Status) { response = server_response; };

   TestRequest::Message request{.integer = 1, .status_code = OkStatus().code()};
   auto call = test::GeneratedService::TestUnaryRpc(
       ctx.client(), ctx.channel().id(), request, handler);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();

   const auto sent_request =
       ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
   const auto sent_response =
       ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);

   EXPECT_EQ(response.value, sent_response.value);
   EXPECT_EQ(response.value, request.integer + 1);
   EXPECT_EQ(request.integer, sent_request.integer);
 }

 TEST(PwpbClientServerTestContext, ReceivesMultipleResponses) {
   PwpbClientServerTestContext<> ctx;
   test::TestService service;
   ctx.server().RegisterService(service);

   TestResponse::Message response1 = {};
   TestResponse::Message response2 = {};
   auto handler1 = [&response1](const TestResponse::Message& server_response,
                                pw::Status) { response1 = server_response; };
   auto handler2 = [&response2](const TestResponse::Message& server_response,
                                pw::Status) { response2 = server_response; };

   TestRequest::Message request1{.integer = 1, .status_code = OkStatus().code()};
   TestRequest::Message request2{.integer = 2, .status_code = OkStatus().code()};
   const auto call1 = test::GeneratedService::TestUnaryRpc(
       ctx.client(), ctx.channel().id(), request1, handler1);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();
   const auto call2 = test::GeneratedService::TestUnaryRpc(
       ctx.client(), ctx.channel().id(), request2, handler2);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();

   const auto sent_request1 =
       ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
   const auto sent_request2 =
       ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);
   const auto sent_response1 =
       ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
   const auto sent_response2 =
       ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);

   EXPECT_EQ(response1.value, request1.integer + 1);
   EXPECT_EQ(response2.value, request2.integer + 1);
   EXPECT_EQ(response1.value, sent_response1.value);
   EXPECT_EQ(response2.value, sent_response2.value);
   EXPECT_EQ(request1.integer, sent_request1.integer);
   EXPECT_EQ(request2.integer, sent_request2.integer);
 }

 TEST(PwpbClientServerTestContext,
      ReceivesMultipleResponsesWithPacketProcessor) {
   using ProtectedInt = std::pair<int, pw::sync::Mutex>;
   ProtectedInt server_counter{};
   auto server_processor = [&server_counter](
                               ClientServer& client_server,
                               pw::ConstByteSpan packet) -> pw::Status {
     server_counter.second.lock();
     ++server_counter.first;
     server_counter.second.unlock();
     return client_server.ProcessPacket(packet);
   };

   ProtectedInt client_counter{};
   auto client_processor = [&client_counter](
                               ClientServer& client_server,
                               pw::ConstByteSpan packet) -> pw::Status {
     client_counter.second.lock();
     ++client_counter.first;
     client_counter.second.unlock();
     return client_server.ProcessPacket(packet);
   };

   PwpbClientServerTestContext<> ctx(server_processor, client_processor);
   test::TestService service;
   ctx.server().RegisterService(service);

   TestResponse::Message response1 = {};
   TestResponse::Message response2 = {};
   auto handler1 = [&response1](const TestResponse::Message& server_response,
                                pw::Status) { response1 = server_response; };
   auto handler2 = [&response2](const TestResponse::Message& server_response,
                                pw::Status) { response2 = server_response; };

   TestRequest::Message request1{.integer = 1, .status_code = OkStatus().code()};
   TestRequest::Message request2{.integer = 2, .status_code = OkStatus().code()};
   const auto call1 = test::GeneratedService::TestUnaryRpc(
       ctx.client(), ctx.channel().id(), request1, handler1);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();
   const auto call2 = test::GeneratedService::TestUnaryRpc(
       ctx.client(), ctx.channel().id(), request2, handler2);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();

   const auto sent_request1 =
       ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
   const auto sent_request2 =
       ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);
   const auto sent_response1 =
       ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
   const auto sent_response2 =
       ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);

   EXPECT_EQ(response1.value, request1.integer + 1);
   EXPECT_EQ(response2.value, request2.integer + 1);
   EXPECT_EQ(response1.value, sent_response1.value);
   EXPECT_EQ(response2.value, sent_response2.value);
   EXPECT_EQ(request1.integer, sent_request1.integer);
   EXPECT_EQ(request2.integer, sent_request2.integer);

   server_counter.second.lock();
   EXPECT_EQ(server_counter.first, 2);
   server_counter.second.unlock();
   client_counter.second.lock();
   EXPECT_EQ(client_counter.first, 2);
   client_counter.second.unlock();
 }

 TEST(PwpbClientServerTestContext, ResponseWithCallbacks) {
   PwpbClientServerTestContext<> ctx;
   test::TestService service;
   ctx.server().RegisterService(service);

   TestRequest::Message request{};
   const auto call = test::GeneratedService::TestAnotherUnaryRpc(
       ctx.client(), ctx.channel().id(), request);
   // Force manual forwarding of packets as context is not threaded
   ctx.ForwardNewPackets();

   // To decode a response object that requires to set callbacks, pass it to the
   // response() method as a parameter.
   pw::Vector<uint32_t, 4> values{};

   TestResponse::Message response{};
   response.repeated_field.SetDecoder(
       [&values](TestResponse::StreamDecoder& decoder) {
         return decoder.ReadRepeatedField(values);
       });
   ctx.response<test::GeneratedService::TestAnotherUnaryRpc>(0, response);

   EXPECT_EQ(42, response.value);

   EXPECT_EQ(3u, values.size());
   EXPECT_EQ(7u, values[0]);
   EXPECT_EQ(8u, values[1]);
   EXPECT_EQ(9u, values[2]);
 }

 }  // namespace
 }  // namespace pw::rpc
	// Copyright 2022 The Pigweed Authors
	//
	// Licensed under the Apache License, Version 2.0 (the "License"); you may not
	// use this file except in compliance with the License. You may obtain a copy of
	// the License at
	//
	// https://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
	// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
	// License for the specific language governing permissions and limitations under
	// the License.

	#include <mutex>
	#include <utility>

	#include "pw_rpc/pwpb/client_server_testing.h"
	#include "pw_rpc_test_protos/test.rpc.pwpb.h"
	#include "pw_sync/mutex.h"
	#include "pw_unit_test/framework.h"

	namespace pw::rpc {
	namespace {

	namespace TestRequest = ::pw::rpc::test::pwpb::TestRequest;
	namespace TestResponse = ::pw::rpc::test::pwpb::TestResponse;
	namespace TestStreamResponse = ::pw::rpc::test::pwpb::TestStreamResponse;

	} // namespace

	namespace test {

	using GeneratedService = ::pw::rpc::test::pw_rpc::pwpb::TestService;

	class TestService final : public GeneratedService::Service<TestService> {
	public:
	Status TestUnaryRpc(const TestRequest::Message& request,
	TestResponse::Message& response) {
	response.value = request.integer + 1;
	return static_cast<Status::Code>(request.status_code);
	}

	Status TestAnotherUnaryRpc(const TestRequest::Message& request,
	TestResponse::Message& response) {
	response.value = 42;
	response.repeated_field.SetEncoder(
	[](TestResponse::StreamEncoder& encoder) {
	constexpr std::array<uint32_t, 3> kValues = {7, 8, 9};
	return encoder.WriteRepeatedField(kValues);
	});
	return static_cast<Status::Code>(request.status_code);
	}

	static void TestServerStreamRpc(const TestRequest::Message&,
	ServerWriter<TestStreamResponse::Message>&) {}

	void TestClientStreamRpc(
	ServerReader<TestRequest::Message, TestStreamResponse::Message>&) {}

	void TestBidirectionalStreamRpc(
	ServerReaderWriter<TestRequest::Message, TestStreamResponse::Message>&) {}
	};

	} // namespace test

	namespace {

	TEST(PwpbClientServerTestContext, ReceivesUnaryRpcResponse) {
	PwpbClientServerTestContext<> ctx;
	test::TestService service;
	ctx.server().RegisterService(service);

	TestResponse::Message response = {};
	auto handler = [&response](const TestResponse::Message& server_response,
	pw::Status) { response = server_response; };

	TestRequest::Message request{.integer = 1, .status_code = OkStatus().code()};
	auto call = test::GeneratedService::TestUnaryRpc(
	ctx.client(), ctx.channel().id(), request, handler);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();

	const auto sent_request =
	ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
	const auto sent_response =
	ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);

	EXPECT_EQ(response.value, sent_response.value);
	EXPECT_EQ(response.value, request.integer + 1);
	EXPECT_EQ(request.integer, sent_request.integer);
	}

	TEST(PwpbClientServerTestContext, ReceivesMultipleResponses) {
	PwpbClientServerTestContext<> ctx;
	test::TestService service;
	ctx.server().RegisterService(service);

	TestResponse::Message response1 = {};
	TestResponse::Message response2 = {};
	auto handler1 = [&response1](const TestResponse::Message& server_response,
	pw::Status) { response1 = server_response; };
	auto handler2 = [&response2](const TestResponse::Message& server_response,
	pw::Status) { response2 = server_response; };

	TestRequest::Message request1{.integer = 1, .status_code = OkStatus().code()};
	TestRequest::Message request2{.integer = 2, .status_code = OkStatus().code()};
	const auto call1 = test::GeneratedService::TestUnaryRpc(
	ctx.client(), ctx.channel().id(), request1, handler1);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();
	const auto call2 = test::GeneratedService::TestUnaryRpc(
	ctx.client(), ctx.channel().id(), request2, handler2);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();

	const auto sent_request1 =
	ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
	const auto sent_request2 =
	ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);
	const auto sent_response1 =
	ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
	const auto sent_response2 =
	ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);

	EXPECT_EQ(response1.value, request1.integer + 1);
	EXPECT_EQ(response2.value, request2.integer + 1);
	EXPECT_EQ(response1.value, sent_response1.value);
	EXPECT_EQ(response2.value, sent_response2.value);
	EXPECT_EQ(request1.integer, sent_request1.integer);
	EXPECT_EQ(request2.integer, sent_request2.integer);
	}

	TEST(PwpbClientServerTestContext,
	ReceivesMultipleResponsesWithPacketProcessor) {
	using ProtectedInt = std::pair<int, pw::sync::Mutex>;
	ProtectedInt server_counter{};
	auto server_processor = [&server_counter](
	ClientServer& client_server,
	pw::ConstByteSpan packet) -> pw::Status {
	server_counter.second.lock();
	++server_counter.first;
	server_counter.second.unlock();
	return client_server.ProcessPacket(packet);
	};

	ProtectedInt client_counter{};
	auto client_processor = [&client_counter](
	ClientServer& client_server,
	pw::ConstByteSpan packet) -> pw::Status {
	client_counter.second.lock();
	++client_counter.first;
	client_counter.second.unlock();
	return client_server.ProcessPacket(packet);
	};

	PwpbClientServerTestContext<> ctx(server_processor, client_processor);
	test::TestService service;
	ctx.server().RegisterService(service);

	TestResponse::Message response1 = {};
	TestResponse::Message response2 = {};
	auto handler1 = [&response1](const TestResponse::Message& server_response,
	pw::Status) { response1 = server_response; };
	auto handler2 = [&response2](const TestResponse::Message& server_response,
	pw::Status) { response2 = server_response; };

	TestRequest::Message request1{.integer = 1, .status_code = OkStatus().code()};
	TestRequest::Message request2{.integer = 2, .status_code = OkStatus().code()};
	const auto call1 = test::GeneratedService::TestUnaryRpc(
	ctx.client(), ctx.channel().id(), request1, handler1);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();
	const auto call2 = test::GeneratedService::TestUnaryRpc(
	ctx.client(), ctx.channel().id(), request2, handler2);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();

	const auto sent_request1 =
	ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
	const auto sent_request2 =
	ctx.request<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);
	const auto sent_response1 =
	ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(0);
	const auto sent_response2 =
	ctx.response<test::pw_rpc::pwpb::TestService::TestUnaryRpc>(1);

	EXPECT_EQ(response1.value, request1.integer + 1);
	EXPECT_EQ(response2.value, request2.integer + 1);
	EXPECT_EQ(response1.value, sent_response1.value);
	EXPECT_EQ(response2.value, sent_response2.value);
	EXPECT_EQ(request1.integer, sent_request1.integer);
	EXPECT_EQ(request2.integer, sent_request2.integer);

	server_counter.second.lock();
	EXPECT_EQ(server_counter.first, 2);
	server_counter.second.unlock();
	client_counter.second.lock();
	EXPECT_EQ(client_counter.first, 2);
	client_counter.second.unlock();
	}

	TEST(PwpbClientServerTestContext, ResponseWithCallbacks) {
	PwpbClientServerTestContext<> ctx;
	test::TestService service;
	ctx.server().RegisterService(service);

	TestRequest::Message request{};
	const auto call = test::GeneratedService::TestAnotherUnaryRpc(
	ctx.client(), ctx.channel().id(), request);
	// Force manual forwarding of packets as context is not threaded
	ctx.ForwardNewPackets();

	// To decode a response object that requires to set callbacks, pass it to the
	// response() method as a parameter.
	pw::Vector<uint32_t, 4> values{};

	TestResponse::Message response{};
	response.repeated_field.SetDecoder(
	[&values](TestResponse::StreamDecoder& decoder) {
	return decoder.ReadRepeatedField(values);
	});
	ctx.response<test::GeneratedService::TestAnotherUnaryRpc>(0, response);

	EXPECT_EQ(42, response.value);

	EXPECT_EQ(3u, values.size());
	EXPECT_EQ(7u, values[0]);
	EXPECT_EQ(8u, values[1]);
	EXPECT_EQ(9u, values[2]);
	}

	} // namespace
	} // namespace pw::rpc