sapling/eden/fs/config/test/CachedParsedFileMonitorTest.cpp

/*
 *  Copyright (c) 2016-present, Facebook, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  LICENSE file in the root directory of this source tree. An additional grant
 *  of patent rights can be found in the PATENTS file in the same directory.
 *
 */
#include "eden/fs/config/EdenConfig.h"

#include <folly/FileUtil.h>
#include <folly/experimental/TestUtil.h>
#include <folly/test/TestUtils.h>
#include <gtest/gtest.h>

#include "eden/fs/config/CachedParsedFileMonitor.h"
#include "eden/fs/model/git/GitIgnore.h"
#include "eden/fs/model/git/GitIgnoreFileParser.h"
#include "eden/fs/utils/PathFuncs.h"

using facebook::eden::AbsolutePath;
using facebook::eden::CachedParsedFileMonitor;
using facebook::eden::GitIgnore;
using facebook::eden::GitIgnoreFileParser;
using facebook::eden::RelativePath;
using folly::test::TemporaryDirectory;
using namespace std::chrono_literals;

namespace {
static constexpr folly::StringPiece kErrorFileContents{"THROW ERROR:"};

/**
 * A simple FileParser for test purposes. It reads in the entire file into a
 * string. If the file contents are of form "THROW ERROR:INT", the parse
 * result will be ERROR_NUM.
 */
class TestFileParser {
 public:
  using value_type = std::string;

  /**
   * Parse entire file into a string.
   * @return the string on success or non-zero error code on failure.
   */
  folly::Expected<std::string, int> operator()(
      int fileDescriptor,
      facebook::eden::AbsolutePathPiece filePath) const {
    try {
      std::string fileContents;
      auto in = folly::File(fileDescriptor); // throws if file does not exist
      if (!folly::readFile(in.fd(), fileContents)) {
        return folly::makeUnexpected<int>((int)errno);
      }

      if (fileContents.find(kErrorFileContents.str()) == 0) {
        auto errorString = fileContents.substr(kErrorFileContents.size());
        auto errorNum = std::stoi(errorString);
        return folly::makeUnexpected<int>((int)errorNum);
      }

      return fileContents;
    } catch (const std::system_error& ex) {
      XLOG(WARNING) << "error reading file " << filePath
                    << folly::exceptionStr(ex);
      return folly::makeUnexpected<int>((int)errno);
    } catch (const std::exception& ex) {
      XLOG(WARNING) << "error reading file " << filePath
                    << folly::exceptionStr(ex);
      return folly::makeUnexpected<int>((int)errno);
    }
  }
};

class CachedParsedFileMonitorTest : public ::testing::Test {
 protected:
  // Top level directory to hold test artifacts
  static constexpr folly::StringPiece fcTestName_{"FileChangeTest"};
  std::unique_ptr<TemporaryDirectory> rootTestDir_;

  static constexpr folly::StringPiece dataOne_{"this is file one"};
  static constexpr folly::StringPiece dataTwo_{"this is file two"};
  static constexpr int invalidParseErrorCode_{99};
  const std::string invalidParseDataOne_{
      kErrorFileContents.str() +
      folly::to<std::string>(invalidParseErrorCode_)};
  static constexpr folly::StringPiece gitIgnoreDataOne_ = R"(
*.com
*.class
*.dll
*.exe
*.o
*.so)";
  boost::filesystem::path pathOne_;
  boost::filesystem::path pathTwo_;
  boost::filesystem::path invalidParsePathOne_;
  boost::filesystem::path gitIgnorePathOne_;
  boost::filesystem::path bogusPathOne_;
  boost::filesystem::path bogusPathTwo_;
  void SetUp() override {
    rootTestDir_ = std::make_unique<TemporaryDirectory>(fcTestName_);

    pathOne_ = rootTestDir_->path() / "file.one";
    folly::writeFile(dataOne_, pathOne_.c_str());

    pathTwo_ = rootTestDir_->path() / "file.two";
    folly::writeFile(dataTwo_, pathTwo_.c_str());

    invalidParsePathOne_ = rootTestDir_->path() / "invalidParse.one";
    folly::writeFile(invalidParseDataOne_, invalidParsePathOne_.c_str());

    gitIgnorePathOne_ = rootTestDir_->path() / "gitignore.one";
    folly::writeFile(gitIgnoreDataOne_, gitIgnorePathOne_.c_str());

    bogusPathOne_ = rootTestDir_->path() / "THIS_IS_BOGUS";
  }
  void TearDown() override {
    rootTestDir_.reset();
  }
}; // namespace
} // namespace

TEST_F(CachedParsedFileMonitorTest, baseIsChangedTest) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{pathOne_.c_str()}, 0s);

  // Check the correct file data is returned
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);
}

TEST_F(CachedParsedFileMonitorTest, updateNameTest) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{pathOne_.c_str()}, 0s);

  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // If we ask for a different file, we should get updated file contents
  // immediately. This is true, even though we have a throttle.
  rslt = fcm->getFileContents(AbsolutePath{pathTwo_.c_str()});
  EXPECT_EQ(rslt.value(), dataTwo_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents(AbsolutePath{pathTwo_.c_str()});
  EXPECT_EQ(rslt.value(), dataTwo_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, fileDoesNotExist) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{bogusPathOne_.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 1);
}

TEST_F(CachedParsedFileMonitorTest, updateNameToFileNonExistToExist) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{bogusPathOne_.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Different file name, we should see the updated file contents immediately.
  rslt = fcm->getFileContents(AbsolutePath{pathOne_.c_str()});
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, updateNameFileExistToNonExist) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{pathOne_.c_str()}, 0s);

  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // If we ask for a different file (that does not exist) we should get
  // an error code immediately.
  rslt = fcm->getFileContents(AbsolutePath{bogusPathOne_.c_str()});
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, updateFileNonExistToExist) {
  auto path =
      AbsolutePath{(rootTestDir_->path() / "NonExistToExist.txt").c_str()};
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Over-write data in file with valid data
  folly::writeFileAtomic(path.c_str(), dataOne_);

  // We should see the updated results (no throttle)
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, updateFileExistToNonExist) {
  auto path =
      AbsolutePath{(rootTestDir_->path() / "ExistToNonExist.txt").c_str()};

  // Create a test file that we will subsequently delete
  folly::writeFileAtomic(path.c_str(), dataOne_);

  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Delete file
  remove(path.c_str());

  // We should see the updated results (no throttle)
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, fileParseError) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{invalidParsePathOne_.c_str()}, 10s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
}

TEST_F(CachedParsedFileMonitorTest, updateFileParseErrorToNoError) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{invalidParsePathOne_.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Over-write data in file with valid data
  folly::writeFileAtomic(invalidParsePathOne_.c_str(), dataOne_);

  // We should see the updated results (no throttle)
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Over-write data in file with invalid data
  folly::writeFileAtomic(invalidParsePathOne_.c_str(), invalidParseDataOne_);

  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
  EXPECT_EQ(fcm->getUpdateCount(), 3);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
  EXPECT_EQ(fcm->getUpdateCount(), 3);
}

TEST_F(CachedParsedFileMonitorTest, updateNoErrorToFileParseError) {
  auto path =
      AbsolutePath{(rootTestDir_->path() / "UpdateNoErrorToError.txt").c_str()};

  // Create file with valid data
  folly::writeFileAtomic(path.c_str(), dataOne_);

  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 0s);
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // Over-write data in file with invalid data
  folly::writeFileAtomic(path.c_str(), invalidParseDataOne_);

  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);

  // Make sure same results - and no reload
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), invalidParseErrorCode_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, modifyThrottleTest) {
  auto path =
      AbsolutePath{(rootTestDir_->path() / "modifyThrottleTest.txt").c_str()};

  // Create file with valid data
  folly::writeFileAtomic(path.c_str(), dataOne_);

  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 10s);

  // Create a new CachedParsedFileMonitor and we will see the updates.
  auto noThrottleFcm =
      std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
          AbsolutePath{path.c_str()}, 0s);

  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  auto noThrottleRslt = noThrottleFcm->getFileContents();
  EXPECT_EQ(noThrottleRslt.value(), dataOne_);
  EXPECT_EQ(noThrottleFcm->getUpdateCount(), 1);

  // Over-write data in file
  folly::writeFileAtomic(path.c_str(), dataTwo_);

  // Throttle does not see results
  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  // No throttle should see the results
  noThrottleRslt = noThrottleFcm->getFileContents();
  EXPECT_EQ(noThrottleRslt.value(), dataTwo_);
  EXPECT_EQ(noThrottleFcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, modifyTest) {
  auto path = AbsolutePath{(rootTestDir_->path() / "modifyTest.txt").c_str()};

  // Create file with valid data
  folly::writeFileAtomic(path.c_str(), dataOne_);

  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 10ms);

  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  folly::writeFileAtomic(path.c_str(), dataTwo_);
  // Over-write data in file
  // Sleep over our throttle. We could increase sleep time if the o/s sleep
  // is not accurate enough (and we are seeing false positives).
  /* sleep override */
  sleep(1);

  rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataTwo_);
  EXPECT_EQ(fcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, moveTest) {
  auto path = AbsolutePath{(rootTestDir_->path() / "moveTest.txt").c_str()};

  // Create file with valid data
  folly::writeFileAtomic(path.c_str(), dataOne_);

  auto fcm = std::make_shared<CachedParsedFileMonitor<TestFileParser>>(
      AbsolutePath{path.c_str()}, 0s);

  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataOne_);
  EXPECT_EQ(fcm->getUpdateCount(), 1);

  auto otherFcm = std::move(fcm);

  folly::writeFileAtomic(path.c_str(), dataTwo_);

  rslt = otherFcm->getFileContents();
  EXPECT_EQ(rslt.value(), dataTwo_);
  EXPECT_EQ(otherFcm->getUpdateCount(), 2);
}

TEST_F(CachedParsedFileMonitorTest, gitParserTest) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<GitIgnoreFileParser>>(
      AbsolutePath{gitIgnorePathOne_.c_str()}, 10s);

  // Check the correct file data is returned
  auto rslt = fcm->getFileContents();
  EXPECT_FALSE(rslt.value().empty());
}

TEST_F(CachedParsedFileMonitorTest, gitParserEmptyTest) {
  auto fcm = std::make_shared<CachedParsedFileMonitor<GitIgnoreFileParser>>(
      AbsolutePath{bogusPathOne_.c_str()}, 10s);

  // Check the correct file data is returned
  auto rslt = fcm->getFileContents();
  EXPECT_EQ(rslt.error(), ENOENT);
}