folly/test/FileUtilTest.cpp

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <folly/FileUtil.h>
  18 #include <folly/detail/FileUtilDetail.h>
  19
  20 #include <deque>
  21
  22 #include <glog/logging.h>
  23 #include <gflags/gflags.h>
  24 #include <gtest/gtest.h>
  25
  26 #include <folly/Benchmark.h>
  27 #include <folly/Range.h>
  28 #include <folly/String.h>
  29
  30 namespace folly { namespace test {
  31
  32 using namespace fileutil_detail;
  33 using namespace std;
  34
  35 namespace {
  36
  37 class Reader {
  38  public:
  39   Reader(off_t offset, StringPiece data, std::deque<ssize_t> spec);
  40
  41   // write-like
  42   ssize_t operator()(int fd, void* buf, size_t count);
  43
  44   // pwrite-like
  45   ssize_t operator()(int fd, void* buf, size_t count, off_t offset);
  46
  47   // writev-like
  48   ssize_t operator()(int fd, const iovec* iov, int count);
  49
  50   // pwritev-like
  51   ssize_t operator()(int fd, const iovec* iov, int count, off_t offset);
  52
  53   const std::deque<ssize_t> spec() const { return spec_; }
  54
  55  private:
  56   ssize_t nextSize();
  57
  58   off_t offset_;
  59   StringPiece data_;
  60   std::deque<ssize_t> spec_;
  61 };
  62
  63 Reader::Reader(off_t offset, StringPiece data, std::deque<ssize_t> spec)
  64   : offset_(offset),
  65     data_(data),
  66     spec_(std::move(spec)) {
  67 }
  68
  69 ssize_t Reader::nextSize() {
  70   if (spec_.empty()) {
  71     throw std::runtime_error("spec empty");
  72   }
  73   ssize_t n = spec_.front();
  74   spec_.pop_front();
  75   if (n <= 0) {
  76     if (n == -1) {
  77       errno = EIO;
  78     }
  79     spec_.clear();  // so we fail if called again
  80   } else {
  81     offset_ += n;
  82   }
  83   return n;
  84 }
  85
  86 ssize_t Reader::operator()(int fd, void* buf, size_t count) {
  87   ssize_t n = nextSize();
  88   if (n <= 0) {
  89     return n;
  90   }
  91   if (size_t(n) > count) {
  92     throw std::runtime_error("requested count too small");
  93   }
  94   memcpy(buf, data_.data(), n);
  95   data_.advance(n);
  96   return n;
  97 }
  98
  99 ssize_t Reader::operator()(int fd, void* buf, size_t count, off_t offset) {
 100   EXPECT_EQ(offset_, offset);
 101   return operator()(fd, buf, count);
 102 }
 103
 104 ssize_t Reader::operator()(int fd, const iovec* iov, int count) {
 105   ssize_t n = nextSize();
 106   if (n <= 0) {
 107     return n;
 108   }
 109   ssize_t remaining = n;
 110   for (; count != 0 && remaining != 0; ++iov, --count) {
 111     ssize_t len = std::min(remaining, ssize_t(iov->iov_len));
 112     memcpy(iov->iov_base, data_.data(), len);
 113     data_.advance(len);
 114     remaining -= len;
 115   }
 116   if (remaining != 0) {
 117     throw std::runtime_error("requested total size too small");
 118   }
 119   return n;
 120 }
 121
 122 ssize_t Reader::operator()(int fd, const iovec* iov, int count, off_t offset) {
 123   EXPECT_EQ(offset_, offset);
 124   return operator()(fd, iov, count);
 125 }
 126
 127 }  // namespace
 128
 129 class FileUtilTest : public ::testing::Test {
 130  protected:
 131   FileUtilTest();
 132
 133   Reader reader(std::deque<ssize_t> spec);
 134
 135   std::string in_;
 136   std::vector<std::pair<size_t, Reader>> readers_;
 137 };
 138
 139 FileUtilTest::FileUtilTest()
 140   : in_("1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ") {
 141   CHECK_EQ(62, in_.size());
 142
 143   readers_.emplace_back(0, reader({0}));
 144   readers_.emplace_back(62, reader({62}));
 145   readers_.emplace_back(62, reader({62, -1}));  // error after end (not called)
 146   readers_.emplace_back(61, reader({61, 0}));
 147   readers_.emplace_back(-1, reader({61, -1}));  // error before end
 148   readers_.emplace_back(62, reader({31, 31}));
 149   readers_.emplace_back(62, reader({1, 10, 20, 10, 1, 20}));
 150   readers_.emplace_back(61, reader({1, 10, 20, 10, 20, 0}));
 151   readers_.emplace_back(41, reader({1, 10, 20, 10, 0}));
 152   readers_.emplace_back(-1, reader({1, 10, 20, 10, 20, -1}));
 153 }
 154
 155 Reader FileUtilTest::reader(std::deque<ssize_t> spec) {
 156   return Reader(42, in_, std::move(spec));
 157 }
 158
 159 TEST_F(FileUtilTest, read) {
 160   for (auto& p : readers_) {
 161     std::string out(in_.size(), '\0');
 162     EXPECT_EQ(p.first, wrapFull(p.second, 0, &out[0], out.size()));
 163     if (p.first != (typeof(p.first))(-1)) {
 164       EXPECT_EQ(in_.substr(0, p.first), out.substr(0, p.first));
 165     }
 166   }
 167 }
 168
 169 TEST_F(FileUtilTest, pread) {
 170   for (auto& p : readers_) {
 171     std::string out(in_.size(), '\0');
 172     EXPECT_EQ(p.first, wrapFull(p.second, 0, &out[0], out.size(), off_t(42)));
 173     if (p.first != (typeof(p.first))(-1)) {
 174       EXPECT_EQ(in_.substr(0, p.first), out.substr(0, p.first));
 175     }
 176   }
 177 }
 178
 179 class IovecBuffers {
 180  public:
 181   explicit IovecBuffers(std::initializer_list<size_t> sizes);
 182
 183   std::vector<iovec> iov() const { return iov_; }  // yes, make a copy
 184   std::string join() const { return folly::join("", buffers_); }
 185   size_t size() const;
 186
 187  private:
 188   std::vector<std::string> buffers_;
 189   std::vector<iovec> iov_;
 190 };
 191
 192 IovecBuffers::IovecBuffers(std::initializer_list<size_t> sizes) {
 193   iov_.reserve(sizes.size());
 194   for (auto& s : sizes) {
 195     buffers_.push_back(std::string(s, '\0'));
 196   }
 197   for (auto& b : buffers_) {
 198     iovec iov;
 199     iov.iov_base = &b[0];
 200     iov.iov_len = b.size();
 201     iov_.push_back(iov);
 202   }
 203 }
 204
 205 size_t IovecBuffers::size() const {
 206   size_t s = 0;
 207   for (auto& b : buffers_) {
 208     s += b.size();
 209   }
 210   return s;
 211 }
 212
 213 TEST_F(FileUtilTest, readv) {
 214   for (auto& p : readers_) {
 215     IovecBuffers buf({12, 19, 31});
 216     ASSERT_EQ(62, buf.size());
 217
 218     auto iov = buf.iov();
 219     EXPECT_EQ(p.first, wrapvFull(p.second, 0, iov.data(), iov.size()));
 220     if (p.first != (typeof(p.first))(-1)) {
 221       EXPECT_EQ(in_.substr(0, p.first), buf.join().substr(0, p.first));
 222     }
 223   }
 224 }
 225
 226 #if FOLLY_HAVE_PREADV
 227 TEST_F(FileUtilTest, preadv) {
 228   for (auto& p : readers_) {
 229     IovecBuffers buf({12, 19, 31});
 230     ASSERT_EQ(62, buf.size());
 231
 232     auto iov = buf.iov();
 233     EXPECT_EQ(p.first,
 234               wrapvFull(p.second, 0, iov.data(), iov.size(), off_t(42)));
 235     if (p.first != (typeof(p.first))(-1)) {
 236       EXPECT_EQ(in_.substr(0, p.first), buf.join().substr(0, p.first));
 237     }
 238   }
 239 }
 240 #endif
 241
 242 TEST(String, readFile) {
 243   srand(time(nullptr));
 244   const string tmpPrefix = to<string>("/tmp/folly-file-util-test-",
 245                                       getpid(), "-", rand(), "-");
 246   const string afile = tmpPrefix + "myfile";
 247   const string emptyFile = tmpPrefix + "myfile2";
 248
 249   SCOPE_EXIT {
 250     unlink(afile.c_str());
 251     unlink(emptyFile.c_str());
 252   };
 253
 254   EXPECT_TRUE(writeFile(string(), emptyFile.c_str()));
 255   EXPECT_TRUE(writeFile(StringPiece("bar"), afile.c_str()));
 256
 257   {
 258     string contents;
 259     EXPECT_TRUE(readFile(emptyFile.c_str(), contents));
 260     EXPECT_EQ(contents, "");
 261     EXPECT_TRUE(readFile(afile.c_str(), contents, 0));
 262     EXPECT_EQ("", contents);
 263     EXPECT_TRUE(readFile(afile.c_str(), contents, 2));
 264     EXPECT_EQ("ba", contents);
 265     EXPECT_TRUE(readFile(afile.c_str(), contents));
 266     EXPECT_EQ("bar", contents);
 267   }
 268   {
 269     vector<unsigned char> contents;
 270     EXPECT_TRUE(readFile(emptyFile.c_str(), contents));
 271     EXPECT_EQ(vector<unsigned char>(), contents);
 272     EXPECT_TRUE(readFile(afile.c_str(), contents, 0));
 273     EXPECT_EQ(vector<unsigned char>(), contents);
 274     EXPECT_TRUE(readFile(afile.c_str(), contents, 2));
 275     EXPECT_EQ(vector<unsigned char>({'b', 'a'}), contents);
 276     EXPECT_TRUE(readFile(afile.c_str(), contents));
 277     EXPECT_EQ(vector<unsigned char>({'b', 'a', 'r'}), contents);
 278   }
 279 }
 280
 281 }}  // namespaces
 282
 283 int main(int argc, char *argv[]) {
 284   testing::InitGoogleTest(&argc, argv);
 285   gflags::ParseCommandLineFlags(&argc, &argv, true);
 286   return RUN_ALL_TESTS();
 287 }