src/tint/utils/bytes/buffer_reader_test.cc

// Copyright 2024 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "src/tint/utils/bytes/buffer_reader.h"

#include <array>
#include <span>

#include "gtest/gtest.h"

namespace tint::bytes {
namespace {

template <typename... ARGS>
auto Data(ARGS... args) {
    return std::array{std::byte{static_cast<uint8_t>(args)}...};
}

TEST(BufferReaderTest, IntegerBigEndian) {
    auto data = Data(0x10, 0x20, 0x30, 0x40);

    BufferReader u32_reader{data};
    EXPECT_FALSE(u32_reader.IsEOF());
    auto u32 = u32_reader.Int<uint32_t>(std::endian::big);
    EXPECT_EQ(u32, 0x10203040u);
    EXPECT_TRUE(u32_reader.IsEOF());

    BufferReader i32_reader{data};
    EXPECT_FALSE(i32_reader.IsEOF());
    auto i32 = i32_reader.Int<int32_t>(std::endian::big);
    EXPECT_EQ(i32, 0x10203040);
    EXPECT_TRUE(i32_reader.IsEOF());
}

TEST(BufferReaderTest, IntegerBigEndian_TooShort) {
    auto data = Data(0x10, 0x20);

    BufferReader u32_reader{data};
    EXPECT_FALSE(u32_reader.IsEOF());
    auto u32 = u32_reader.Int<uint32_t>(std::endian::big);
    EXPECT_NE(u32, Success);
    EXPECT_TRUE(u32_reader.IsEOF());

    BufferReader i32_reader{data};
    EXPECT_FALSE(i32_reader.IsEOF());
    auto i32 = i32_reader.Int<int32_t>(std::endian::big);
    EXPECT_NE(i32, Success);
    EXPECT_TRUE(i32_reader.IsEOF());
}

TEST(BufferReaderTest, IntegerLittleEndian) {
    auto data = Data(0x10, 0x20, 0x30, 0x40);

    BufferReader u32_reader{data};
    EXPECT_FALSE(u32_reader.IsEOF());
    auto u32 = u32_reader.Int<uint32_t>(std::endian::little);
    EXPECT_EQ(u32, 0x40302010u);
    EXPECT_TRUE(u32_reader.IsEOF());

    BufferReader i32_reader{data};
    EXPECT_FALSE(i32_reader.IsEOF());
    auto i32 = i32_reader.Int<int32_t>(std::endian::little);
    EXPECT_EQ(i32, 0x40302010);
    EXPECT_TRUE(i32_reader.IsEOF());
}

TEST(BufferReaderTest, IntegerLittleEndian_TooShort) {
    auto data = Data(0x30, 0x40);

    BufferReader u32_reader{data};
    EXPECT_FALSE(u32_reader.IsEOF());
    auto u32 = u32_reader.Int<uint32_t>(std::endian::little);
    EXPECT_NE(u32, Success);
    EXPECT_TRUE(u32_reader.IsEOF());

    BufferReader i32_reader{data};
    EXPECT_FALSE(i32_reader.IsEOF());
    auto i32 = i32_reader.Int<int32_t>(std::endian::little);
    EXPECT_NE(i32, Success);
    EXPECT_TRUE(i32_reader.IsEOF());
}

TEST(BufferReaderTest, Float) {
    auto data = Data(0x00, 0x00, 0x08, 0x41);

    BufferReader f32_reader{data};
    EXPECT_FALSE(f32_reader.IsEOF());
    auto f32 = f32_reader.Float<float>();
    ASSERT_EQ(f32, Success);
    EXPECT_EQ(f32.Get(), 8.5f);
    EXPECT_TRUE(f32_reader.IsEOF());
}

TEST(BufferReaderTest, Float_TooShort) {
    auto data = Data(0x08, 0x41);

    BufferReader f32_reader{data};
    EXPECT_FALSE(f32_reader.IsEOF());
    auto f32 = f32_reader.Float<float>();
    EXPECT_NE(f32, Success);
    EXPECT_TRUE(f32_reader.IsEOF());
}

}  // namespace
}  // namespace tint::bytes