[flang] Move buffer runtime test to GTest

[ashermancinelli]

Summary

Move buffer unit test from Runtime directory to RuntimeGtest directory and use GTest. Test coverage is only maintained.

[ashermancinelli]

@awarzynski This is just the minimum to pull the test into gtest. I would like to add documentation and death tests for failure conditions - do you have any suggestions for this? I think once we have those two criteria met we can add more reviewers.

[awarzynski]

Apologies for taking so long to comment!

In D102335#2754515, @ashermancinelli wrote:

@awarzynski This is just the minimum to pull the test into gtest. I would like to add documentation and death tests for failure conditions - do you have any suggestions for this? I think once we have those two criteria met we can add more reviewers.

IMHO, this is sufficient. I've tried to produce a death test, but this particular API makes it tricky (i.e. I'm finding it hard to make it crash), which is a good thing!

I'm in favor of merging this as is. The only thing that's missing is the standard LLVM header at the top.

[ashermancinelli]

@awarzynski Sounds good! I'll add a few more reviewers and wait a bit before merging.

[awarzynski]

flang/unittests/RuntimeGTest/BufferTest.cpp

9

Missing LLVM header ;-)

[ashermancinelli]

Add LLVM header comment to buffer test.

flang/unittests/Runtime/CMakeLists.txt

 target_link_libraries(external-hello-world
   FortranRuntime
 )
 
 add_flang_nongtest_unittest(external-io
   RuntimeTesting
   FortranRuntime
 )
-
-add_flang_nongtest_unittest(buffer
-  RuntimeTesting
-  FortranRuntime
-)

flang/unittests/RuntimeGTest/BufferTest.cpp

+//===-- flang/unittests/RuntimeGTest/BufferTest.cpp -------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
 #include "../../runtime/buffer.h"
-#include "testing.h"
+#include "CrashHandlerFixture.h"
+#include "gtest/gtest.h"
 #include <algorithm>
 #include <cstdint>
 #include <cstring>
 #include <memory>
 
-static constexpr std::size_t tinyBuffer{32};
+static constexpr std::size_t tinyBufferSize{32};
 using FileOffset = std::int64_t;
 using namespace Fortran::runtime;
 using namespace Fortran::runtime::io;
 
-class Store : public FileFrame<Store, tinyBuffer> {
+class Store : public FileFrame<Store, tinyBufferSize> {
 public:
   explicit Store(std::size_t bytes = 65536) : bytes_{bytes} {
     data_.reset(new char[bytes]);
     std::memset(&data_[0], 0, bytes);
   }
   std::size_t bytes() const { return bytes_; }
   void set_enforceSequence(bool yes = true) { enforceSequence_ = yes; }
   void set_expect(FileOffset to) { expect_ = to; }
private:
   std::size_t bytes_;
   std::unique_ptr<char[]> data_;
   bool enforceSequence_{false};
   FileOffset expect_{0};
 };
 
 inline int ChunkSize(int j, int most) {
   // 31, 1, 29, 3, 27, ...
-  j %= tinyBuffer;
-  auto chunk{
-      static_cast<int>(((j % 2) ? j : (tinyBuffer - 1 - j)) % tinyBuffer)};
+  j %= tinyBufferSize;
+  auto chunk{static_cast<int>(
+      ((j % 2) ? j : (tinyBufferSize - 1 - j)) % tinyBufferSize)};
   return std::min(chunk, most);
 }
 
 inline int ValueFor(int at) { return (at ^ (at >> 8)) & 0xff; }
 
-int main() {
-  StartTests();
+struct BufferTests : CrashHandlerFixture {};
+
+TEST(BufferTests, TestFrameBufferReadAndWrite) {
   Terminator terminator{__FILE__, __LINE__};
   IoErrorHandler handler{terminator};
   Store store;
   store.set_enforceSequence(true);
   const auto bytes{static_cast<FileOffset>(store.bytes())};
   // Fill with an assortment of chunks
   int at{0}, j{0};
   while (at < bytes) {
     auto chunk{ChunkSize(j, static_cast<int>(bytes - at))};
     store.WriteFrame(at, chunk, handler);
     char *to{store.Frame()};
     for (int k{0}; k < chunk; ++k) {
       to[k] = ValueFor(at + k);
     }
     at += chunk;
     ++j;
   }
   store.Flush(handler);
   // Validate
   store.set_expect(0);
   at = 0;
   while (at < bytes) {
     auto chunk{ChunkSize(j, static_cast<int>(bytes - at))};
     std::size_t frame{store.ReadFrame(at, chunk, handler)};
-    if (frame < static_cast<std::size_t>(chunk)) {
-      Fail() << "Badly-sized ReadFrame at " << at << ", chunk=" << chunk
-             << ", got " << frame << '\n';
-      break;
-    }
+    ASSERT_GE(frame, static_cast<std::size_t>(chunk))
+        << "Badly-sized ReadFrame at " << at << ", chunk=" << chunk << ", got "
+        << frame << '\n';
+
     const char *from{store.Frame()};
     for (int k{0}; k < chunk; ++k) {
       auto expect{static_cast<char>(ValueFor(at + k))};
-      if (from[k] != expect) {
-        Fail() << "At " << at << '+' << k << '(' << (at + k) << "), read "
-               << (from[k] & 0xff) << ", expected " << static_cast<int>(expect)
-               << '\n';
-      }
-    }
+      ASSERT_EQ(from[k], expect)
+          << "At " << at << '+' << k << '(' << (at + k) << "), read "
     at += chunk;
     ++j;
   }
-  return EndTests();
 }

flang/unittests/RuntimeGTest/CMakeLists.txt

 add_flang_unittest(FlangRuntimeTests
+  BufferTest.cpp
   CharacterTest.cpp
   CrashHandlerFixture.cpp
   Format.cpp
   ListInputTest.cpp
   Matmul.cpp
   MiscIntrinsic.cpp
   Namelist.cpp
   Numeric.cpp