aos/events/logging/buffer_encoder_test.cc

#include "aos/events/logging/buffer_encoder.h"

#include <algorithm>
#include <fstream>
#include <string>

#include "glog/logging.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

#include "aos/events/logging/buffer_encoder_param_test.h"

namespace aos::logger::testing {

class DummyEncoderTest : public BufferEncoderBaseTest {};

constexpr size_t kEncoderBufferSize = 4 * 1024 * 1024;

// Tests that buffers are concatenated without being modified.
TEST_F(DummyEncoderTest, QueuesBuffersAsIs) {
  DummyEncoder encoder(BufferEncoderBaseTest::kMaxMessageSize,
                       kEncoderBufferSize);
  const auto expected = CreateAndEncode(100, &encoder);
  std::vector<uint8_t> data = Flatten(expected);

  auto queue = encoder.queue();
  ASSERT_EQ(queue.size(), 1u);
  EXPECT_EQ(queue[0], absl::Span<const uint8_t>(data));
}

// Tests that buffers are concatenated without being modified.
TEST_F(DummyEncoderTest, CoppiesBuffersAsIs) {
  DummyEncoder encoder(BufferEncoderBaseTest::kMaxMessageSize,
                       kEncoderBufferSize);
  const auto expected = CreateAndEncode(100, &encoder);
  std::vector<uint8_t> data = Flatten(expected);

  auto queue = encoder.queue();
  ASSERT_EQ(queue.size(), 1u);
  EXPECT_EQ(queue[0], absl::Span<const uint8_t>(data));
}

// Checks that DummyDecoder can read into a buffer.
TEST(DummyDecoderTest, ReadsIntoExactBuffer) {
  static const std::string kTestString{"Just some random words."};

  const char *const test_dir = CHECK_NOTNULL(getenv("TEST_TMPDIR"));
  const std::string file_path = std::string(test_dir) + "/foo";
  std::ofstream(file_path, std::ios::binary) << kTestString;

  // Read the contents of the file into the buffer.
  DummyDecoder dummy_decoder(file_path.c_str());
  std::vector<uint8_t> buffer(kTestString.size());
  const size_t count = dummy_decoder.Read(&*buffer.begin(), &*buffer.end());
  ASSERT_EQ(std::string(buffer.data(), buffer.data() + count), kTestString);

  for (int i = 0; i < 10; ++i) {
    // Verify that there is no more data to read from the file.
    ASSERT_EQ(dummy_decoder.Read(&*buffer.begin(), &*buffer.end()), 0);
  }
}

// Checks that DummyDecoder can read into a buffer that can accommodate all the
// data in the file.
TEST(DummyDecoderTest, ReadsIntoLargerBuffer) {
  static const std::string kTestString{"Just some random words."};

  const char *const test_dir = CHECK_NOTNULL(getenv("TEST_TMPDIR"));
  const std::string file_path = std::string(test_dir) + "/foo";
  std::ofstream(file_path, std::ios::binary) << kTestString;

  DummyDecoder dummy_decoder(file_path.c_str());
  std::vector<uint8_t> buffer(100);
  const size_t count = dummy_decoder.Read(&*buffer.begin(), &*buffer.end());
  buffer.resize(count);
  ASSERT_EQ(std::string(buffer.data(), buffer.data() + count), kTestString);

  // Verify that there is no more data to read from the file.
  ASSERT_EQ(dummy_decoder.Read(&*buffer.begin(), &*buffer.end()), 0);
}

// Checks that DummyDecoder can repeatedly read the contents of the file into a
// smaller buffer until there is no more to read.
TEST(DummyDecoderTest, ReadsRepeatedlyIntoSmallerBuffer) {
  static const std::string kTestString{"Just some random words."};

  const char *const test_dir = CHECK_NOTNULL(getenv("TEST_TMPDIR"));
  const std::string file_path = std::string(test_dir) + "/foo";
  std::ofstream(file_path, std::ios::binary) << kTestString;

  DummyDecoder dummy_decoder(file_path.c_str());
  std::vector<uint8_t> buffer((kTestString.size() + 1) / 2);

  {
    // Read into our buffer once, and verify the contents.
    const size_t count = dummy_decoder.Read(&*buffer.begin(), &*buffer.end());
    ASSERT_EQ(std::string(buffer.data(), buffer.data() + count),
              kTestString.substr(0, buffer.size()));
  }

  {
    // Read into the same buffer again, and verify the contents.
    const size_t count = dummy_decoder.Read(&*buffer.begin(), &*buffer.end());
    ASSERT_EQ(
        std::string(buffer.data(), buffer.data() + count),
        kTestString.substr(buffer.size(), kTestString.size() - buffer.size()));
  }

  // Verify that there is no more data to read from the file.
  ASSERT_EQ(dummy_decoder.Read(&*buffer.begin(), &*buffer.end()), 0);
}

INSTANTIATE_TEST_SUITE_P(
    Dummy, BufferEncoderTest,
    ::testing::Combine(::testing::Values([](size_t max_buffer_size) {
                         return std::make_unique<DummyEncoder>(
                             max_buffer_size, kEncoderBufferSize);
                       }),
                       ::testing::Values([](std::string_view filename) {
                         return std::make_unique<DummyDecoder>(filename);
                       }),
                       ::testing::Range(0, 100)));

// Tests that SpanCopier copies as expected.
TEST(SpanCopierTest, Matches) {
  std::vector<uint8_t> data;
  for (int i = 0; i < 32; ++i) {
    data.push_back(i);
  }

  CHECK_EQ(data.size(), 32u);

  for (int i = 0; i < 32; i += 8) {
    for (int j = i; j < 32; j += 8) {
      std::vector<uint8_t> destination(data.size(), 0);
      DataEncoder::SpanCopier copier(
          absl::Span<const uint8_t>(data.data(), data.size()));

      copier.Copy(destination.data(), i, j);

      size_t index = 0;
      for (int k = i; k < j; ++k) {
        EXPECT_EQ(destination[index], k);
        ++index;
      }
      for (; index < destination.size(); ++index) {
        EXPECT_EQ(destination[index], 0u);
      }
    }
  }
}

}  // namespace aos::logger::testing