Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [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_kvs/checksum.h" |
| 16 | |
| 17 | #include "gtest/gtest.h" |
| 18 | #include "pw_kvs/crc16_checksum.h" |
| 19 | |
| 20 | namespace pw::kvs { |
| 21 | namespace { |
| 22 | |
| 23 | using std::byte; |
| 24 | |
| 25 | constexpr std::string_view kString = |
| 26 | "In the beginning the Universe was created. This has made a lot of " |
| 27 | "people very angry and been widely regarded as a bad move."; |
| 28 | constexpr uint16_t kStringCrc = 0xC184; |
| 29 | |
| 30 | TEST(Checksum, UpdateAndVerify) { |
| 31 | ChecksumCrc16 crc16_algo; |
| 32 | ChecksumAlgorithm& algo = crc16_algo; |
| 33 | |
| 34 | algo.Update(kString.data(), kString.size()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 35 | EXPECT_EQ(OkStatus(), algo.Verify(std::as_bytes(std::span(&kStringCrc, 1)))); |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 36 | } |
| 37 | |
| 38 | TEST(Checksum, Verify_Failure) { |
| 39 | ChecksumCrc16 algo; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 40 | EXPECT_EQ(Status::DataLoss(), |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 41 | algo.Verify(std::as_bytes(std::span(kString.data(), 2)))); |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 42 | } |
| 43 | |
| 44 | TEST(Checksum, Verify_InvalidSize) { |
| 45 | ChecksumCrc16 algo; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 46 | EXPECT_EQ(Status::InvalidArgument(), algo.Verify({})); |
| 47 | EXPECT_EQ(Status::InvalidArgument(), |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 48 | algo.Verify(std::as_bytes(std::span(kString.substr(0, 1))))); |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 49 | } |
| 50 | |
| 51 | TEST(Checksum, Verify_LargerState_ComparesToTruncatedData) { |
| 52 | byte crc[3] = {byte{0x84}, byte{0xC1}, byte{0x33}}; |
| 53 | ChecksumCrc16 algo; |
| 54 | ASSERT_GT(sizeof(crc), algo.size_bytes()); |
| 55 | |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 56 | algo.Update(std::as_bytes(std::span(kString))); |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 57 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 58 | EXPECT_EQ(OkStatus(), algo.Verify(crc)); |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | TEST(Checksum, Reset) { |
| 62 | ChecksumCrc16 crc_algo; |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 63 | crc_algo.Update(std::as_bytes(std::span(kString))); |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 64 | crc_algo.Reset(); |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 65 | |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 66 | std::span state = crc_algo.Finish(); |
Alexei Frolov | 5603462 | 2020-02-07 13:17:00 -0800 | [diff] [blame] | 67 | EXPECT_EQ(state[0], byte{0xFF}); |
| 68 | EXPECT_EQ(state[1], byte{0xFF}); |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 69 | } |
| 70 | |
Wyatt Hepler | 613625e | 2020-03-05 14:56:08 -0800 | [diff] [blame] | 71 | TEST(IgnoreChecksum, NeverUpdate_VerifyWithoutData) { |
| 72 | IgnoreChecksum checksum; |
| 73 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 74 | EXPECT_EQ(OkStatus(), checksum.Verify({})); |
Wyatt Hepler | 613625e | 2020-03-05 14:56:08 -0800 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | TEST(IgnoreChecksum, NeverUpdate_VerifyWithData) { |
| 78 | IgnoreChecksum checksum; |
| 79 | |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 80 | EXPECT_EQ(OkStatus(), checksum.Verify(std::as_bytes(std::span(kString)))); |
Wyatt Hepler | 613625e | 2020-03-05 14:56:08 -0800 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | TEST(IgnoreChecksum, AfterUpdate_Verify) { |
| 84 | IgnoreChecksum checksum; |
| 85 | |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 86 | checksum.Update(std::as_bytes(std::span(kString))); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 87 | EXPECT_EQ(OkStatus(), checksum.Verify({})); |
Wyatt Hepler | 613625e | 2020-03-05 14:56:08 -0800 | [diff] [blame] | 88 | } |
| 89 | |
Wyatt Hepler | c656af2 | 2020-02-12 14:49:14 -0800 | [diff] [blame] | 90 | constexpr size_t kAlignment = 10; |
| 91 | |
| 92 | constexpr std::string_view kData = |
| 93 | "123456789_123456789_123456789_123456789_123456789_" // 50 |
| 94 | "123456789_123456789_123456789_123456789_123456789_"; // 100 |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 95 | const std::span<const byte> kBytes = std::as_bytes(std::span(kData)); |
Wyatt Hepler | c656af2 | 2020-02-12 14:49:14 -0800 | [diff] [blame] | 96 | |
| 97 | class PickyChecksum final : public AlignedChecksum<kAlignment, 32> { |
| 98 | public: |
| 99 | PickyChecksum() : AlignedChecksum(data_), data_{}, size_(0) {} |
| 100 | |
| 101 | void Reset() override {} |
| 102 | |
| 103 | void FinalizeAligned() override { EXPECT_EQ(kData.size(), size_); } |
| 104 | |
Wyatt Hepler | e2cbadf | 2020-06-22 11:21:45 -0700 | [diff] [blame] | 105 | void UpdateAligned(std::span<const std::byte> data) override { |
Wyatt Hepler | c656af2 | 2020-02-12 14:49:14 -0800 | [diff] [blame] | 106 | ASSERT_EQ(data.size() % kAlignment, 0u); |
| 107 | EXPECT_EQ(kData.substr(0, data.size()), |
| 108 | std::string_view(reinterpret_cast<const char*>(data.data()), |
| 109 | data.size())); |
| 110 | |
| 111 | std::memcpy(&data_[size_], data.data(), data.size()); |
| 112 | size_ += data.size(); |
| 113 | } |
| 114 | |
| 115 | private: |
| 116 | std::byte data_[kData.size()]; |
| 117 | size_t size_; |
| 118 | }; |
| 119 | |
| 120 | TEST(AlignedChecksum, MaintainsAlignment) { |
| 121 | PickyChecksum checksum; |
| 122 | |
| 123 | // Write values smaller than the alignment. |
| 124 | checksum.Update(kBytes.subspan(0, 1)); |
| 125 | checksum.Update(kBytes.subspan(1, 9)); |
| 126 | |
| 127 | // Write values larger than the alignment but smaller than the buffer. |
| 128 | checksum.Update(kBytes.subspan(10, 11)); |
| 129 | |
| 130 | // Exactly fill the remainder of the buffer. |
| 131 | checksum.Update(kBytes.subspan(21, 11)); |
| 132 | |
| 133 | // Fill the buffer more than once. |
| 134 | checksum.Update(kBytes.subspan(32, 66)); |
| 135 | |
| 136 | // Write nothing. |
| 137 | checksum.Update(kBytes.subspan(98, 0)); |
| 138 | |
| 139 | // Write the remaining data. |
| 140 | checksum.Update(kBytes.subspan(98, 2)); |
| 141 | |
| 142 | auto state = checksum.Finish(); |
| 143 | EXPECT_EQ(std::string_view(reinterpret_cast<const char*>(state.data()), |
| 144 | state.size()), |
| 145 | kData); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 146 | EXPECT_EQ(OkStatus(), checksum.Verify(kBytes)); |
Wyatt Hepler | c656af2 | 2020-02-12 14:49:14 -0800 | [diff] [blame] | 147 | } |
| 148 | |
Wyatt Hepler | ec4b935 | 2020-01-31 15:51:50 -0800 | [diff] [blame] | 149 | } // namespace |
| 150 | } // namespace pw::kvs |