Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 1 | // Copyright 2022 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
| 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
| 14 | |
| 15 | #include "pw_transfer/transfer_thread.h" |
| 16 | |
| 17 | #include "gtest/gtest.h" |
| 18 | #include "pw_assert/check.h" |
| 19 | #include "pw_bytes/array.h" |
| 20 | #include "pw_rpc/raw/client_testing.h" |
| 21 | #include "pw_rpc/raw/test_method_context.h" |
Dennis Kormalev | 801d66a | 2022-06-24 18:46:32 +0000 | [diff] [blame] | 22 | #include "pw_rpc/test_helpers.h" |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 23 | #include "pw_thread/thread.h" |
| 24 | #include "pw_thread_stl/options.h" |
| 25 | #include "pw_transfer/handler.h" |
| 26 | #include "pw_transfer/transfer.h" |
| 27 | #include "pw_transfer/transfer.raw_rpc.pb.h" |
| 28 | #include "pw_transfer_private/chunk_testing.h" |
| 29 | |
| 30 | namespace pw::transfer::test { |
| 31 | namespace { |
| 32 | |
| 33 | using internal::Chunk; |
| 34 | |
| 35 | // TODO(frolv): Have a generic way to obtain a thread for testing on any system. |
| 36 | thread::Options& TransferThreadOptions() { |
| 37 | static thread::stl::Options options; |
| 38 | return options; |
| 39 | } |
| 40 | |
| 41 | class TransferThreadTest : public ::testing::Test { |
| 42 | public: |
| 43 | TransferThreadTest() |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 44 | : ctx_(transfer_thread_, 512), |
Alexei Frolov | 7278d99 | 2022-03-09 09:05:42 -0800 | [diff] [blame] | 45 | max_parameters_(chunk_buffer_.size(), |
| 46 | chunk_buffer_.size(), |
| 47 | cfg::kDefaultExtendWindowDivisor), |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 48 | transfer_thread_(chunk_buffer_, encode_buffer_), |
| 49 | system_thread_(TransferThreadOptions(), transfer_thread_) {} |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 50 | |
Ted Pudlik | 26c7a13 | 2022-06-29 21:10:34 +0000 | [diff] [blame] | 51 | ~TransferThreadTest() override { |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 52 | transfer_thread_.Terminate(); |
| 53 | system_thread_.join(); |
| 54 | } |
| 55 | |
| 56 | protected: |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 57 | PW_RAW_TEST_METHOD_CONTEXT(TransferService, Read) ctx_; |
| 58 | |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 59 | std::array<std::byte, 64> chunk_buffer_; |
| 60 | std::array<std::byte, 64> encode_buffer_; |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 61 | |
| 62 | rpc::RawClientTestContext<> rpc_client_context_; |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 63 | internal::TransferParameters max_parameters_; |
| 64 | |
| 65 | transfer::Thread<1, 1> transfer_thread_; |
| 66 | |
| 67 | thread::Thread system_thread_; |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 68 | }; |
| 69 | |
| 70 | class SimpleReadTransfer final : public ReadOnlyHandler { |
| 71 | public: |
Alexei Frolov | 5ceb57e | 2022-03-28 11:21:03 -0700 | [diff] [blame] | 72 | SimpleReadTransfer(uint32_t session_id, ConstByteSpan data) |
| 73 | : ReadOnlyHandler(session_id), |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 74 | prepare_read_called(false), |
| 75 | finalize_read_called(false), |
| 76 | finalize_read_status(Status::Unknown()), |
| 77 | reader_(data) {} |
| 78 | |
| 79 | Status PrepareRead() final { |
| 80 | PW_CHECK_OK(reader_.Seek(0)); |
| 81 | set_reader(reader_); |
| 82 | prepare_read_called = true; |
| 83 | return OkStatus(); |
| 84 | } |
| 85 | |
| 86 | void FinalizeRead(Status status) final { |
| 87 | finalize_read_called = true; |
| 88 | finalize_read_status = status; |
| 89 | } |
| 90 | |
| 91 | bool prepare_read_called; |
| 92 | bool finalize_read_called; |
| 93 | Status finalize_read_status; |
| 94 | |
| 95 | private: |
| 96 | stream::MemoryReader reader_; |
| 97 | }; |
| 98 | |
| 99 | constexpr auto kData = bytes::Initialized<32>([](size_t i) { return i; }); |
| 100 | |
| 101 | TEST_F(TransferThreadTest, AddTransferHandler) { |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 102 | auto reader_writer = ctx_.reader_writer(); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 103 | transfer_thread_.SetServerReadStream(reader_writer); |
| 104 | |
| 105 | SimpleReadTransfer handler(3, kData); |
| 106 | transfer_thread_.AddTransferHandler(handler); |
| 107 | |
| 108 | transfer_thread_.StartServerTransfer(internal::TransferType::kTransmit, |
| 109 | 3, |
| 110 | 3, |
| 111 | max_parameters_, |
| 112 | std::chrono::seconds(2), |
| 113 | 0); |
| 114 | |
| 115 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 116 | |
| 117 | EXPECT_TRUE(handler.prepare_read_called); |
Erik Gilling | faf42d6 | 2022-04-26 22:34:13 +0000 | [diff] [blame] | 118 | |
| 119 | transfer_thread_.RemoveTransferHandler(handler); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | TEST_F(TransferThreadTest, RemoveTransferHandler) { |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 123 | auto reader_writer = ctx_.reader_writer(); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 124 | transfer_thread_.SetServerReadStream(reader_writer); |
| 125 | |
| 126 | SimpleReadTransfer handler(3, kData); |
| 127 | transfer_thread_.AddTransferHandler(handler); |
| 128 | transfer_thread_.RemoveTransferHandler(handler); |
| 129 | |
| 130 | transfer_thread_.StartServerTransfer(internal::TransferType::kTransmit, |
| 131 | 3, |
| 132 | 3, |
| 133 | max_parameters_, |
| 134 | std::chrono::seconds(2), |
| 135 | 0); |
| 136 | |
| 137 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 138 | |
| 139 | EXPECT_FALSE(handler.prepare_read_called); |
| 140 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 141 | ASSERT_EQ(ctx_.total_responses(), 1u); |
| 142 | auto chunk = DecodeChunk(ctx_.response()); |
Alexei Frolov | 42efd50 | 2022-04-26 18:45:35 -0700 | [diff] [blame] | 143 | EXPECT_EQ(chunk.session_id(), 3u); |
| 144 | ASSERT_TRUE(chunk.status().has_value()); |
| 145 | EXPECT_EQ(chunk.status().value(), Status::NotFound()); |
Erik Gilling | faf42d6 | 2022-04-26 22:34:13 +0000 | [diff] [blame] | 146 | |
| 147 | transfer_thread_.RemoveTransferHandler(handler); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 148 | } |
| 149 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 150 | TEST_F(TransferThreadTest, ProcessChunk_SendsWindow) { |
| 151 | auto reader_writer = ctx_.reader_writer(); |
| 152 | transfer_thread_.SetServerReadStream(reader_writer); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 153 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 154 | SimpleReadTransfer handler(3, kData); |
| 155 | transfer_thread_.AddTransferHandler(handler); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 156 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 157 | transfer_thread_.StartServerTransfer(internal::TransferType::kTransmit, |
| 158 | 3, |
| 159 | 3, |
| 160 | max_parameters_, |
| 161 | std::chrono::seconds(2), |
| 162 | 0); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 163 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 164 | rpc::test::WaitForPackets(ctx_.output(), 2, [this] { |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 165 | transfer_thread_.ProcessServerChunk( |
Alexei Frolov | 42efd50 | 2022-04-26 18:45:35 -0700 | [diff] [blame] | 166 | EncodeChunk(Chunk(internal::ProtocolVersion::kLegacy, |
| 167 | Chunk::Type::kParametersRetransmit) |
| 168 | .set_session_id(3) |
| 169 | .set_window_end_offset(16) |
| 170 | .set_max_chunk_size_bytes(8) |
| 171 | .set_offset(0))); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 172 | }); |
| 173 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 174 | ASSERT_EQ(ctx_.total_responses(), 2u); |
| 175 | auto chunk = DecodeChunk(ctx_.responses()[0]); |
Alexei Frolov | 42efd50 | 2022-04-26 18:45:35 -0700 | [diff] [blame] | 176 | EXPECT_EQ(chunk.session_id(), 3u); |
| 177 | EXPECT_EQ(chunk.offset(), 0u); |
| 178 | EXPECT_EQ(chunk.payload().size(), 8u); |
| 179 | EXPECT_EQ( |
| 180 | std::memcmp(chunk.payload().data(), kData.data(), chunk.payload().size()), |
| 181 | 0); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 182 | |
Wyatt Hepler | 9639d1c | 2022-02-08 22:47:28 -0800 | [diff] [blame] | 183 | chunk = DecodeChunk(ctx_.responses()[1]); |
Alexei Frolov | 42efd50 | 2022-04-26 18:45:35 -0700 | [diff] [blame] | 184 | EXPECT_EQ(chunk.session_id(), 3u); |
| 185 | EXPECT_EQ(chunk.offset(), 8u); |
| 186 | EXPECT_EQ(chunk.payload().size(), 8u); |
| 187 | EXPECT_EQ( |
| 188 | std::memcmp( |
| 189 | chunk.payload().data(), kData.data() + 8, chunk.payload().size()), |
| 190 | 0); |
Erik Gilling | faf42d6 | 2022-04-26 22:34:13 +0000 | [diff] [blame] | 191 | |
| 192 | transfer_thread_.RemoveTransferHandler(handler); |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 193 | } |
| 194 | |
Alexei Frolov | 9af45f5 | 2022-08-03 18:01:22 +0000 | [diff] [blame^] | 195 | TEST_F(TransferThreadTest, StartTransferExhausted_Server) { |
| 196 | auto reader_writer = ctx_.reader_writer(); |
| 197 | transfer_thread_.SetServerReadStream(reader_writer); |
| 198 | |
| 199 | SimpleReadTransfer handler3(3, kData); |
| 200 | SimpleReadTransfer handler4(4, kData); |
| 201 | transfer_thread_.AddTransferHandler(handler3); |
| 202 | transfer_thread_.AddTransferHandler(handler4); |
| 203 | |
| 204 | transfer_thread_.StartServerTransfer(internal::TransferType::kTransmit, |
| 205 | 3, |
| 206 | 3, |
| 207 | max_parameters_, |
| 208 | std::chrono::seconds(2), |
| 209 | 0); |
| 210 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 211 | |
| 212 | // First transfer starts correctly. |
| 213 | EXPECT_TRUE(handler3.prepare_read_called); |
| 214 | EXPECT_FALSE(handler4.prepare_read_called); |
| 215 | |
| 216 | // Try to start a simultaneous transfer to resource 4, for which the thread |
| 217 | // does not have an available context. |
| 218 | transfer_thread_.StartServerTransfer(internal::TransferType::kTransmit, |
| 219 | 4, |
| 220 | 4, |
| 221 | max_parameters_, |
| 222 | std::chrono::seconds(2), |
| 223 | 0); |
| 224 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 225 | |
| 226 | EXPECT_FALSE(handler4.prepare_read_called); |
| 227 | |
| 228 | ASSERT_EQ(ctx_.total_responses(), 1u); |
| 229 | auto chunk = DecodeChunk(ctx_.response()); |
| 230 | EXPECT_EQ(chunk.session_id(), 4u); |
| 231 | ASSERT_TRUE(chunk.status().has_value()); |
| 232 | EXPECT_EQ(chunk.status().value(), Status::ResourceExhausted()); |
| 233 | |
| 234 | transfer_thread_.RemoveTransferHandler(handler3); |
| 235 | transfer_thread_.RemoveTransferHandler(handler4); |
| 236 | } |
| 237 | |
| 238 | TEST_F(TransferThreadTest, StartTransferExhausted_Client) { |
| 239 | rpc::RawClientReaderWriter read_stream = pw_rpc::raw::Transfer::Read( |
| 240 | rpc_client_context_.client(), rpc_client_context_.channel().id()); |
| 241 | transfer_thread_.SetClientReadStream(read_stream); |
| 242 | |
| 243 | Status status3 = Status::Unknown(); |
| 244 | Status status4 = Status::Unknown(); |
| 245 | |
| 246 | stream::MemoryWriterBuffer<16> buffer3; |
| 247 | stream::MemoryWriterBuffer<16> buffer4; |
| 248 | |
| 249 | transfer_thread_.StartClientTransfer( |
| 250 | internal::TransferType::kReceive, |
| 251 | 3, |
| 252 | 3, |
| 253 | &buffer3, |
| 254 | max_parameters_, |
| 255 | [&status3](Status status) { status3 = status; }, |
| 256 | std::chrono::seconds(2), |
| 257 | 0); |
| 258 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 259 | |
| 260 | EXPECT_EQ(status3, Status::Unknown()); |
| 261 | EXPECT_EQ(status4, Status::Unknown()); |
| 262 | |
| 263 | // Try to start a simultaneous transfer to resource 4, for which the thread |
| 264 | // does not have an available context. |
| 265 | transfer_thread_.StartClientTransfer( |
| 266 | internal::TransferType::kReceive, |
| 267 | 4, |
| 268 | 4, |
| 269 | &buffer4, |
| 270 | max_parameters_, |
| 271 | [&status4](Status status) { status4 = status; }, |
| 272 | std::chrono::seconds(2), |
| 273 | 0); |
| 274 | transfer_thread_.WaitUntilEventIsProcessed(); |
| 275 | |
| 276 | EXPECT_EQ(status3, Status::Unknown()); |
| 277 | EXPECT_EQ(status4, Status::ResourceExhausted()); |
| 278 | } |
| 279 | |
Alexei Frolov | 22ee114 | 2022-02-03 13:59:01 -0800 | [diff] [blame] | 280 | } // namespace |
| 281 | } // namespace pw::transfer::test |