// Copyright 2022-2023 Google LLC // // 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 "sharing/incoming_frames_reader.h" #include #include #include #include #include "gtest/gtest.h" #include "absl/synchronization/notification.h" #include "absl/time/time.h" #include "internal/test/fake_clock.h" #include "internal/test/fake_task_runner.h" #include "sharing/fake_nearby_connection.h" #include "sharing/internal/public/context.h" #include "sharing/internal/test/fake_context.h" #include "sharing/nearby_sharing_decoder_impl.h" #include "sharing/proto/wire_format.pb.h" namespace nearby { namespace sharing { namespace { using ::nearby::sharing::service::proto::V1Frame; constexpr absl::Duration kTimeout = absl::Milliseconds(1000); std::optional> GetIntroductionFrame() { nearby::sharing::service::proto::Frame frame = nearby::sharing::service::proto::Frame(); frame.set_version(nearby::sharing::service::proto::Frame::V1); V1Frame* v1frame = frame.mutable_v1(); v1frame->set_type(service::proto::V1Frame::INTRODUCTION); v1frame->mutable_introduction(); std::vector data; data.resize(frame.ByteSize()); if (frame.SerializeToArray(data.data(), data.size())) { return data; } return std::nullopt; } std::optional> GetCancelFrame() { nearby::sharing::service::proto::Frame frame = nearby::sharing::service::proto::Frame(); frame.set_version(nearby::sharing::service::proto::Frame::V1); V1Frame* v1frame = frame.mutable_v1(); v1frame->set_type(service::proto::V1Frame::CANCEL); std::vector data; data.resize(frame.ByteSize()); if (frame.SerializeToArray(data.data(), data.size())) { return data; } return std::nullopt; } std::optional> GetInvalidFrame() { std::vector data; data.push_back(0xff); data.push_back(0x00); data.push_back(0x02); return data; } class IncomingFramesReaderTest : public testing::Test { public: IncomingFramesReaderTest() = default; ~IncomingFramesReaderTest() override = default; void SetUp() override { FakeTaskRunner::ResetPendingTasksCount(); frames_reader_ = std::make_shared( context(), &nearby_sharing_decoder_, &fake_nearby_connection_); } FakeNearbyConnection& connection() { return fake_nearby_connection_; } IncomingFramesReader* frames_reader() { return frames_reader_.get(); } void FastForward(absl::Duration delta) { FakeClock* fake_clock = reinterpret_cast(context()->GetClock()); fake_clock->FastForward(delta); } void Sync() { EXPECT_TRUE( FakeTaskRunner::WaitForRunningTasksWithTimeout(absl::Seconds(1))); } void ReleaseFrameReader() { frames_reader_.reset(); } private: FakeNearbyConnection fake_nearby_connection_; NearbySharingDecoderImpl nearby_sharing_decoder_; std::shared_ptr frames_reader_ = nullptr; Context* context() { static Context* context = new FakeContext(); return context; } }; TEST_F(IncomingFramesReaderTest, ReadTimedOut) { absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame, std::nullopt); notification.Notify(); }, kTimeout); Sync(); FastForward(kTimeout); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); // Ensure that the OnDataReadFromConnection callback is not run since the // read timed out. EXPECT_FALSE(connection().has_read_callback_been_run()); // Ensure that the IncomingFramesReader does not close the connection. EXPECT_FALSE(connection().IsClosed()); } TEST_F(IncomingFramesReaderTest, ReadAnyFrameSuccessful) { std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); absl::Notification notification; frames_reader()->ReadFrame([&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); notification.Notify(); }); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReadSuccessful) { std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); notification.Notify(); }, kTimeout); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReadSuccessful_JumbledFramesOrdering) { std::optional> cancel_frame = GetCancelFrame(); ASSERT_TRUE(cancel_frame.has_value()); connection().AppendReadableData(*cancel_frame); std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); notification.Notify(); }, kTimeout); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, JumbledFramesOrdering_ReadFromCache) { std::optional> cancel_frame = GetCancelFrame(); ASSERT_TRUE(cancel_frame.has_value()); connection().AppendReadableData(*cancel_frame); std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); notification.Notify(); }, kTimeout); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); // Reading any frame should return CancelFrame. absl::Notification cancel_notification; frames_reader()->ReadFrame([&](std::optional frame) { ASSERT_NE(frame, std::nullopt); EXPECT_EQ(frame->type(), service::proto::V1Frame::CANCEL); cancel_notification.Notify(); }); EXPECT_TRUE(cancel_notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReadAfterConnectionClosed) { absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame, std::nullopt); notification.Notify(); }, kTimeout); Sync(); connection().Close(); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReadTwoFramesWithTimeoutSuccessfully) { absl::Notification notification; frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); }, kTimeout); frames_reader()->ReadFrame( service::proto::V1Frame::CANCEL, [&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::CANCEL); notification.Notify(); }, kTimeout); std::optional> cancel_frame = GetCancelFrame(); ASSERT_TRUE(cancel_frame.has_value()); connection().AppendReadableData(*cancel_frame); std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); Sync(); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReadTwoFramesWithoutTimeoutSuccessfully) { absl::Notification notification; frames_reader()->ReadFrame([&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::INTRODUCTION); }); frames_reader()->ReadFrame([&](std::optional frame) { EXPECT_EQ(frame->type(), service::proto::V1Frame::CANCEL); notification.Notify(); }); std::optional> introduction_frame = GetIntroductionFrame(); ASSERT_TRUE(introduction_frame.has_value()); connection().AppendReadableData(*introduction_frame); std::optional> cancel_frame = GetCancelFrame(); ASSERT_TRUE(cancel_frame.has_value()); connection().AppendReadableData(*cancel_frame); Sync(); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } TEST_F(IncomingFramesReaderTest, ReleaseFrameReaderDuringRead) { frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame, std::nullopt); }, kTimeout); frames_reader()->ReadFrame( service::proto::V1Frame::INTRODUCTION, [&](std::optional frame) { EXPECT_EQ(frame, std::nullopt); }, kTimeout); ReleaseFrameReader(); EXPECT_EQ(frames_reader(), nullptr); } TEST_F(IncomingFramesReaderTest, ReadInvalidFrame) { absl::Notification notification; frames_reader()->ReadFrame([&](std::optional frame) { EXPECT_EQ(frame, std::nullopt); notification.Notify(); }); std::optional> invalid_frame = GetInvalidFrame(); ASSERT_TRUE(invalid_frame.has_value()); connection().AppendReadableData(*invalid_frame); Sync(); EXPECT_TRUE(notification.WaitForNotificationWithTimeout(kTimeout)); } } // namespace } // namespace sharing } // namespace nearby