blob: 24e59e832f2ede3f94bc1792a0cce2971c2584cc [file] [log] [blame]
// Copyright 2020 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 "pw_checksum/crc32.h"
#include <string_view>
#include "gtest/gtest.h"
#include "public/pw_checksum/crc32.h"
#include "pw_bytes/array.h"
#include "pw_span/span.h"
namespace pw::checksum {
namespace {
// The expected CRC32 values were calculated using
//
// http://www.sunshine2k.de/coding/javascript/crc/crc_js.html
//
// with polynomial 0x4C11DB7, initial value 0xFFFFFFFF.
constexpr auto kBytes = bytes::Array<1, 2, 3, 4, 5, 6, 7, 8, 9>();
constexpr auto kBytesPart0 = bytes::Array<1, 2, 3, 4, 5>();
constexpr auto kBytesPart1 = bytes::Array<6, 7, 8, 9>();
constexpr uint32_t kBufferCrc = 0x40EFAB9E;
constexpr std::string_view kString =
"In the beginning the Universe was created. This has made a lot of "
"people very angry and been widely regarded as a bad move.";
constexpr uint32_t kStringCrc = 0x9EC87F88;
TEST(Crc32, Empty) {
EXPECT_EQ(Crc32::Calculate(span<std::byte>()), PW_CHECKSUM_EMPTY_CRC32);
EXPECT_EQ(Crc32EightBit::Calculate(span<std::byte>()),
PW_CHECKSUM_EMPTY_CRC32);
EXPECT_EQ(Crc32FourBit::Calculate(span<std::byte>()),
PW_CHECKSUM_EMPTY_CRC32);
EXPECT_EQ(Crc32OneBit::Calculate(span<std::byte>()), PW_CHECKSUM_EMPTY_CRC32);
}
TEST(Crc32, Buffer) {
EXPECT_EQ(Crc32::Calculate(as_bytes(span(kBytes))), kBufferCrc);
EXPECT_EQ(Crc32EightBit::Calculate(as_bytes(span(kBytes))), kBufferCrc);
EXPECT_EQ(Crc32FourBit::Calculate(as_bytes(span(kBytes))), kBufferCrc);
EXPECT_EQ(Crc32OneBit::Calculate(as_bytes(span(kBytes))), kBufferCrc);
}
TEST(Crc32, String) {
EXPECT_EQ(Crc32::Calculate(as_bytes(span(kString))), kStringCrc);
EXPECT_EQ(Crc32EightBit::Calculate(as_bytes(span(kString))), kStringCrc);
EXPECT_EQ(Crc32FourBit::Calculate(as_bytes(span(kString))), kStringCrc);
EXPECT_EQ(Crc32OneBit::Calculate(as_bytes(span(kString))), kStringCrc);
}
template <typename CrcVariant>
void TestByByte() {
CrcVariant crc;
for (std::byte b : kBytes) {
crc.Update(b);
}
EXPECT_EQ(crc.value(), kBufferCrc);
}
TEST(Crc32Class, ByteByByte) {
TestByByte<Crc32>();
TestByByte<Crc32EightBit>();
TestByByte<Crc32FourBit>();
TestByByte<Crc32OneBit>();
}
template <typename CrcVariant>
void TestBuffer() {
CrcVariant crc32;
crc32.Update(as_bytes(span(kBytes)));
EXPECT_EQ(crc32.value(), kBufferCrc);
}
TEST(Crc32Class, Buffer) {
TestBuffer<Crc32>();
TestBuffer<Crc32EightBit>();
TestBuffer<Crc32FourBit>();
TestBuffer<Crc32OneBit>();
}
template <typename CrcVariant>
void TestBufferAppend() {
CrcVariant crc32;
crc32.Update(kBytesPart0);
crc32.Update(kBytesPart1);
EXPECT_EQ(crc32.value(), kBufferCrc);
}
TEST(Crc32Class, BufferAppend) {
TestBufferAppend<Crc32>();
TestBufferAppend<Crc32EightBit>();
TestBufferAppend<Crc32FourBit>();
TestBufferAppend<Crc32OneBit>();
}
template <typename CrcVariant>
void TestString() {
CrcVariant crc32;
crc32.Update(as_bytes(span(kString)));
EXPECT_EQ(crc32.value(), kStringCrc);
}
TEST(Crc32Class, String) {
TestString<Crc32>();
TestString<Crc32EightBit>();
TestString<Crc32FourBit>();
TestString<Crc32OneBit>();
}
extern "C" uint32_t CallChecksumCrc32(const void* data, size_t size_bytes);
extern "C" uint32_t CallChecksumCrc32Append(const void* data,
size_t size_bytes,
uint32_t value);
TEST(Crc32FromC, Buffer) {
EXPECT_EQ(CallChecksumCrc32(kBytes.data(), kBytes.size()), kBufferCrc);
}
TEST(Crc32FromC, String) {
EXPECT_EQ(CallChecksumCrc32(kString.data(), kString.size()), kStringCrc);
}
TEST(Crc32AppendFromC, Buffer) {
uint32_t crc = PW_CHECKSUM_EMPTY_CRC32;
for (std::byte b : kBytes) {
crc = CallChecksumCrc32Append(&b, 1, crc);
}
EXPECT_EQ(crc, kBufferCrc);
}
TEST(Crc32AppendFromC, String) {
EXPECT_EQ(CallChecksumCrc32Append(
kString.data(), kString.size(), PW_CHECKSUM_EMPTY_CRC32),
kStringCrc);
}
} // namespace
} // namespace pw::checksum