David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 1 | // Copyright 2020 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_blob_store/blob_store.h" |
| 16 | |
| 17 | #include <array> |
| 18 | #include <cstddef> |
| 19 | #include <cstring> |
| 20 | #include <span> |
| 21 | |
| 22 | #include "gtest/gtest.h" |
| 23 | #include "pw_kvs/crc16_checksum.h" |
| 24 | #include "pw_kvs/fake_flash_memory.h" |
| 25 | #include "pw_kvs/flash_memory.h" |
| 26 | #include "pw_kvs/test_key_value_store.h" |
| 27 | #include "pw_log/log.h" |
| 28 | #include "pw_random/xor_shift.h" |
| 29 | |
| 30 | namespace pw::blob_store { |
| 31 | namespace { |
| 32 | |
| 33 | class BlobStoreTest : public ::testing::Test { |
| 34 | protected: |
| 35 | BlobStoreTest() : flash_(kFlashAlignment), partition_(&flash_) {} |
| 36 | |
| 37 | void InitFlashTo(std::span<const std::byte> contents) { |
| 38 | partition_.Erase(); |
| 39 | std::memcpy(flash_.buffer().data(), contents.data(), contents.size()); |
| 40 | } |
| 41 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 42 | void InitSourceBufferToRandom(uint64_t seed, |
| 43 | size_t init_size_bytes = kBlobDataSize) { |
| 44 | ASSERT_LE(init_size_bytes, source_buffer_.size()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 45 | random::XorShiftStarRng64 rng(seed); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 46 | |
| 47 | std::memset(source_buffer_.data(), |
| 48 | static_cast<int>(flash_.erased_memory_content()), |
| 49 | source_buffer_.size()); |
| 50 | rng.Get(std::span(source_buffer_).first(init_size_bytes)); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 51 | } |
| 52 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 53 | void InitSourceBufferToFill(char fill, |
| 54 | size_t fill_size_bytes = kBlobDataSize) { |
| 55 | ASSERT_LE(fill_size_bytes, source_buffer_.size()); |
| 56 | std::memset(source_buffer_.data(), |
| 57 | static_cast<int>(flash_.erased_memory_content()), |
| 58 | source_buffer_.size()); |
| 59 | std::memset(source_buffer_.data(), fill, fill_size_bytes); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 60 | } |
| 61 | |
| 62 | // Fill the source buffer with random pattern based on given seed, written to |
| 63 | // BlobStore in specified chunk size. |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 64 | void WriteTestBlock(size_t write_size_bytes = kBlobDataSize) { |
| 65 | ASSERT_LE(write_size_bytes, source_buffer_.size()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 66 | constexpr size_t kBufferSize = 256; |
| 67 | kvs::ChecksumCrc16 checksum; |
| 68 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 69 | ConstByteSpan write_data = |
| 70 | std::span(source_buffer_).first(write_size_bytes); |
| 71 | |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 72 | char name[16] = {}; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 73 | snprintf(name, sizeof(name), "TestBlobBlock"); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 74 | |
| 75 | BlobStoreBuffer<kBufferSize> blob( |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 76 | name, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 77 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 78 | |
| 79 | BlobStore::BlobWriter writer(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 80 | EXPECT_EQ(OkStatus(), writer.Open()); |
| 81 | ASSERT_EQ(OkStatus(), writer.Write(write_data)); |
| 82 | EXPECT_EQ(OkStatus(), writer.Close()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 83 | |
| 84 | // Use reader to check for valid data. |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 85 | BlobStore::BlobReader reader(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 86 | ASSERT_EQ(OkStatus(), reader.Open()); |
David Rogers | 0fadf44 | 2020-09-18 10:38:15 -0700 | [diff] [blame] | 87 | Result<ConstByteSpan> result = reader.GetMemoryMappedBlob(); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 88 | ASSERT_TRUE(result.ok()); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 89 | EXPECT_EQ(write_size_bytes, result.value().size_bytes()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 90 | VerifyFlash(result.value().first(write_size_bytes)); |
| 91 | VerifyFlash(flash_.buffer().first(write_size_bytes)); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 92 | EXPECT_EQ(OkStatus(), reader.Close()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 93 | } |
| 94 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 95 | // Open a new blob instance and read the blob using the given read chunk size. |
| 96 | void ChunkReadTest(size_t read_chunk_size) { |
| 97 | kvs::ChecksumCrc16 checksum; |
| 98 | |
| 99 | VerifyFlash(flash_.buffer()); |
| 100 | |
| 101 | char name[16] = "TestBlobBlock"; |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 102 | constexpr size_t kBufferSize = 16; |
| 103 | BlobStoreBuffer<kBufferSize> blob( |
| 104 | name, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 105 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 106 | |
| 107 | // Use reader to check for valid data. |
| 108 | BlobStore::BlobReader reader1(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 109 | ASSERT_EQ(OkStatus(), reader1.Open()); |
Ewout van Bekkum | fa1fc66 | 2020-10-16 16:11:13 -0700 | [diff] [blame] | 110 | Result<ConstByteSpan> possible_blob = reader1.GetMemoryMappedBlob(); |
| 111 | ASSERT_TRUE(possible_blob.ok()); |
| 112 | VerifyFlash(possible_blob.value()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 113 | EXPECT_EQ(OkStatus(), reader1.Close()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 114 | |
| 115 | BlobStore::BlobReader reader(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 116 | ASSERT_EQ(OkStatus(), reader.Open()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 117 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 118 | std::array<std::byte, kBlobDataSize> read_buffer; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 119 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 120 | ByteSpan read_span = read_buffer; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 121 | while (read_span.size_bytes() > 0) { |
| 122 | size_t read_size = std::min(read_span.size_bytes(), read_chunk_size); |
| 123 | |
| 124 | PW_LOG_DEBUG("Do write of %u bytes, %u bytes remain", |
| 125 | static_cast<unsigned>(read_size), |
| 126 | static_cast<unsigned>(read_span.size_bytes())); |
| 127 | |
| 128 | ASSERT_EQ(read_span.size_bytes(), reader.ConservativeReadLimit()); |
| 129 | auto result = reader.Read(read_span.first(read_size)); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 130 | ASSERT_EQ(result.status(), OkStatus()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 131 | read_span = read_span.subspan(read_size); |
| 132 | } |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 133 | EXPECT_EQ(OkStatus(), reader.Close()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 134 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 135 | VerifyFlash(read_buffer); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 136 | } |
| 137 | |
David Rogers | 0fadf44 | 2020-09-18 10:38:15 -0700 | [diff] [blame] | 138 | void VerifyFlash(ConstByteSpan verify_bytes, size_t offset = 0) { |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 139 | // Should be defined as same size. |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 140 | EXPECT_EQ(source_buffer_.size(), flash_.buffer().size_bytes()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 141 | |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 142 | // Can't allow it to march off the end of source_buffer_. |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 143 | ASSERT_LE((verify_bytes.size_bytes() + offset), source_buffer_.size()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 144 | |
| 145 | for (size_t i = 0; i < verify_bytes.size_bytes(); i++) { |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 146 | ASSERT_EQ(source_buffer_[i + offset], verify_bytes[i]); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 147 | } |
| 148 | } |
| 149 | |
| 150 | static constexpr size_t kFlashAlignment = 16; |
| 151 | static constexpr size_t kSectorSize = 2048; |
| 152 | static constexpr size_t kSectorCount = 2; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 153 | static constexpr size_t kBlobDataSize = (kSectorCount * kSectorSize); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 154 | |
| 155 | kvs::FakeFlashMemoryBuffer<kSectorSize, kSectorCount> flash_; |
| 156 | kvs::FlashPartition partition_; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 157 | std::array<std::byte, kBlobDataSize> source_buffer_; |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 158 | }; |
| 159 | |
| 160 | TEST_F(BlobStoreTest, Init_Ok) { |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 161 | // TODO: Do init test with flash/kvs explicitly in the different possible |
| 162 | // entry states. |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 163 | constexpr size_t kBufferSize = 256; |
| 164 | BlobStoreBuffer<kBufferSize> blob( |
| 165 | "Blob_OK", partition_, nullptr, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 166 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 167 | } |
| 168 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 169 | TEST_F(BlobStoreTest, IsOpen) { |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 170 | constexpr size_t kBufferSize = 256; |
| 171 | BlobStoreBuffer<kBufferSize> blob( |
| 172 | "Blob_open", partition_, nullptr, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 173 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 174 | |
| 175 | BlobStore::DeferredWriter deferred_writer(blob); |
| 176 | EXPECT_EQ(false, deferred_writer.IsOpen()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 177 | EXPECT_EQ(OkStatus(), deferred_writer.Open()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 178 | EXPECT_EQ(true, deferred_writer.IsOpen()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 179 | EXPECT_EQ(OkStatus(), deferred_writer.Close()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 180 | EXPECT_EQ(false, deferred_writer.IsOpen()); |
| 181 | |
| 182 | BlobStore::BlobWriter writer(blob); |
| 183 | EXPECT_EQ(false, writer.IsOpen()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 184 | EXPECT_EQ(OkStatus(), writer.Open()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 185 | EXPECT_EQ(true, writer.IsOpen()); |
| 186 | |
| 187 | // Need to write something, so the blob reader is able to open. |
| 188 | std::array<std::byte, 64> tmp_buffer = {}; |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 189 | EXPECT_EQ(OkStatus(), writer.Write(tmp_buffer)); |
| 190 | EXPECT_EQ(OkStatus(), writer.Close()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 191 | EXPECT_EQ(false, writer.IsOpen()); |
| 192 | |
| 193 | BlobStore::BlobReader reader(blob); |
| 194 | EXPECT_EQ(false, reader.IsOpen()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 195 | ASSERT_EQ(OkStatus(), reader.Open()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 196 | EXPECT_EQ(true, reader.IsOpen()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 197 | EXPECT_EQ(OkStatus(), reader.Close()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 198 | EXPECT_EQ(false, reader.IsOpen()); |
| 199 | } |
| 200 | |
David Rogers | 175851f | 2020-09-22 16:25:34 -0700 | [diff] [blame] | 201 | TEST_F(BlobStoreTest, Discard) { |
| 202 | InitSourceBufferToRandom(0x8675309); |
| 203 | WriteTestBlock(); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 204 | constexpr char blob_title[] = "TestBlobBlock"; |
| 205 | std::array<std::byte, 64> tmp_buffer = {}; |
David Rogers | 175851f | 2020-09-22 16:25:34 -0700 | [diff] [blame] | 206 | |
| 207 | kvs::ChecksumCrc16 checksum; |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 208 | |
| 209 | // TODO: Do this test with flash/kvs in the different entry state |
| 210 | // combinations. |
| 211 | |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 212 | constexpr size_t kBufferSize = 256; |
| 213 | BlobStoreBuffer<kBufferSize> blob( |
| 214 | blob_title, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 215 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 175851f | 2020-09-22 16:25:34 -0700 | [diff] [blame] | 216 | |
| 217 | BlobStore::BlobWriter writer(blob); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 218 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 219 | EXPECT_EQ(OkStatus(), writer.Open()); |
| 220 | EXPECT_EQ(OkStatus(), writer.Write(tmp_buffer)); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 221 | |
| 222 | // The write does an implicit erase so there should be no key for this blob. |
Wyatt Hepler | f276c6b | 2020-11-11 21:13:38 -0800 | [diff] [blame] | 223 | EXPECT_EQ(Status::NotFound(), |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 224 | kvs::TestKvs().Get(blob_title, tmp_buffer).status()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 225 | EXPECT_EQ(OkStatus(), writer.Close()); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 226 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 227 | EXPECT_EQ(OkStatus(), kvs::TestKvs().Get(blob_title, tmp_buffer).status()); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 228 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 229 | EXPECT_EQ(OkStatus(), writer.Open()); |
| 230 | EXPECT_EQ(OkStatus(), writer.Discard()); |
| 231 | EXPECT_EQ(OkStatus(), writer.Close()); |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 232 | |
Wyatt Hepler | f276c6b | 2020-11-11 21:13:38 -0800 | [diff] [blame] | 233 | EXPECT_EQ(Status::NotFound(), |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 234 | kvs::TestKvs().Get(blob_title, tmp_buffer).status()); |
David Rogers | 175851f | 2020-09-22 16:25:34 -0700 | [diff] [blame] | 235 | } |
| 236 | |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 237 | TEST_F(BlobStoreTest, MultipleErase) { |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 238 | constexpr size_t kBufferSize = 256; |
| 239 | BlobStoreBuffer<kBufferSize> blob( |
| 240 | "Blob_OK", partition_, nullptr, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 241 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 242 | |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 243 | BlobStore::BlobWriter writer(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 244 | EXPECT_EQ(OkStatus(), writer.Open()); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 245 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 246 | EXPECT_EQ(OkStatus(), writer.Erase()); |
| 247 | EXPECT_EQ(OkStatus(), writer.Erase()); |
| 248 | EXPECT_EQ(OkStatus(), writer.Erase()); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 249 | } |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 250 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 251 | TEST_F(BlobStoreTest, OffsetRead) { |
| 252 | InitSourceBufferToRandom(0x11309); |
| 253 | WriteTestBlock(); |
| 254 | |
| 255 | constexpr size_t kOffset = 10; |
| 256 | ASSERT_LT(kOffset, kBlobDataSize); |
| 257 | |
| 258 | kvs::ChecksumCrc16 checksum; |
| 259 | |
| 260 | char name[16] = "TestBlobBlock"; |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 261 | constexpr size_t kBufferSize = 16; |
| 262 | BlobStoreBuffer<kBufferSize> blob( |
| 263 | name, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 264 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 265 | BlobStore::BlobReader reader(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 266 | ASSERT_EQ(OkStatus(), reader.Open(kOffset)); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 267 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 268 | std::array<std::byte, kBlobDataSize - kOffset> read_buffer; |
| 269 | ByteSpan read_span = read_buffer; |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 270 | ASSERT_EQ(read_span.size_bytes(), reader.ConservativeReadLimit()); |
| 271 | |
| 272 | auto result = reader.Read(read_span); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 273 | ASSERT_EQ(result.status(), OkStatus()); |
| 274 | EXPECT_EQ(OkStatus(), reader.Close()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 275 | VerifyFlash(read_buffer, kOffset); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | TEST_F(BlobStoreTest, InvalidReadOffset) { |
| 279 | InitSourceBufferToRandom(0x11309); |
| 280 | WriteTestBlock(); |
| 281 | |
| 282 | constexpr size_t kOffset = kBlobDataSize; |
| 283 | |
| 284 | kvs::ChecksumCrc16 checksum; |
| 285 | |
| 286 | char name[16] = "TestBlobBlock"; |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 287 | constexpr size_t kBufferSize = 16; |
| 288 | BlobStoreBuffer<kBufferSize> blob( |
| 289 | name, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 290 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 291 | BlobStore::BlobReader reader(blob); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 292 | ASSERT_EQ(Status::InvalidArgument(), reader.Open(kOffset)); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 293 | } |
| 294 | |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 295 | // Test reading with a read buffer larger than the available data in the |
| 296 | TEST_F(BlobStoreTest, ReadBufferIsLargerThanData) { |
| 297 | InitSourceBufferToRandom(0x57326); |
| 298 | |
| 299 | constexpr size_t kWriteBytes = 64; |
| 300 | WriteTestBlock(kWriteBytes); |
| 301 | |
| 302 | kvs::ChecksumCrc16 checksum; |
| 303 | |
| 304 | char name[16] = "TestBlobBlock"; |
David Rogers | 1f08acb | 2020-11-17 23:11:58 -0800 | [diff] [blame] | 305 | constexpr size_t kBufferSize = 16; |
| 306 | BlobStoreBuffer<kBufferSize> blob( |
| 307 | name, partition_, &checksum, kvs::TestKvs(), kBufferSize); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 308 | EXPECT_EQ(OkStatus(), blob.Init()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 309 | BlobStore::BlobReader reader(blob); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 310 | ASSERT_EQ(OkStatus(), reader.Open()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 311 | EXPECT_EQ(kWriteBytes, reader.ConservativeReadLimit()); |
| 312 | |
| 313 | std::array<std::byte, kWriteBytes + 10> read_buffer; |
| 314 | ByteSpan read_span = read_buffer; |
| 315 | |
| 316 | auto result = reader.Read(read_span); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 317 | ASSERT_EQ(result.status(), OkStatus()); |
| 318 | EXPECT_EQ(OkStatus(), reader.Close()); |
David Rogers | 84e0dec | 2020-11-24 14:33:18 -0800 | [diff] [blame] | 319 | } |
| 320 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 321 | TEST_F(BlobStoreTest, ChunkRead1) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 322 | InitSourceBufferToRandom(0x8675309); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 323 | WriteTestBlock(); |
| 324 | ChunkReadTest(1); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 325 | } |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 326 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 327 | TEST_F(BlobStoreTest, ChunkRead3) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 328 | InitSourceBufferToFill(0); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 329 | WriteTestBlock(); |
| 330 | ChunkReadTest(3); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 331 | } |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 332 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 333 | TEST_F(BlobStoreTest, ChunkRead4) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 334 | InitSourceBufferToFill(1); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 335 | WriteTestBlock(); |
| 336 | ChunkReadTest(4); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 337 | } |
| 338 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 339 | TEST_F(BlobStoreTest, ChunkRead5) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 340 | InitSourceBufferToFill(0xff); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 341 | WriteTestBlock(); |
| 342 | ChunkReadTest(5); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 343 | } |
| 344 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 345 | TEST_F(BlobStoreTest, ChunkRead16) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 346 | InitSourceBufferToRandom(0x86); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 347 | WriteTestBlock(); |
| 348 | ChunkReadTest(16); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 349 | } |
| 350 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 351 | TEST_F(BlobStoreTest, ChunkRead64) { |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 352 | InitSourceBufferToRandom(0x9); |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 353 | WriteTestBlock(); |
| 354 | ChunkReadTest(64); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 355 | } |
| 356 | |
David Rogers | 1039584 | 2020-09-16 15:39:35 -0700 | [diff] [blame] | 357 | TEST_F(BlobStoreTest, ChunkReadFull) { |
| 358 | InitSourceBufferToRandom(0x9); |
| 359 | WriteTestBlock(); |
| 360 | ChunkReadTest(kBlobDataSize); |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 361 | } |
| 362 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 363 | TEST_F(BlobStoreTest, PartialBufferThenClose) { |
| 364 | // Do write of only a partial chunk, which will only have bytes in buffer |
| 365 | // (none written to flash) at close. |
| 366 | size_t data_bytes = 12; |
| 367 | InitSourceBufferToRandom(0x111, data_bytes); |
| 368 | WriteTestBlock(data_bytes); |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 369 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 370 | // Do write with several full chunks and then some partial. |
| 371 | data_bytes = 158; |
| 372 | InitSourceBufferToRandom(0x3222, data_bytes); |
| 373 | } |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 374 | |
David Rogers | 22f7b3e | 2020-10-07 23:58:11 -0700 | [diff] [blame] | 375 | // Test to do write/close, write/close multiple times. |
| 376 | TEST_F(BlobStoreTest, MultipleWrites) { |
| 377 | InitSourceBufferToRandom(0x1121); |
| 378 | WriteTestBlock(); |
| 379 | InitSourceBufferToRandom(0x515); |
| 380 | WriteTestBlock(); |
| 381 | InitSourceBufferToRandom(0x4321); |
| 382 | WriteTestBlock(); |
| 383 | } |
David Rogers | 5aa32ab | 2020-09-08 14:39:24 -0700 | [diff] [blame] | 384 | |
David Rogers | 9692257 | 2020-08-04 10:24:57 -0700 | [diff] [blame] | 385 | } // namespace |
| 386 | } // namespace pw::blob_store |