Fix SignalHandlerTest with ASAN
[folly.git] / folly / experimental / TestUtil.cpp
index d9bcd0429094f1ef0eaa67ca9816c768ed564e1e..987d605b3bb1483a4aa5d021516f8add7d01f695 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * limitations under the License.
  */
 
-#include "folly/experimental/TestUtil.h"
+#include <folly/experimental/TestUtil.h>
 
-#include <stdlib.h>
-#include <errno.h>
-#include <stdexcept>
-#include <system_error>
+#include <sys/stat.h>
+#include <sys/types.h>
 
-#include "folly/Format.h"
+#include <boost/regex.hpp>
+
+#include <folly/Exception.h>
+#include <folly/File.h>
+#include <folly/FileUtil.h>
+#include <folly/Memory.h>
+#include <folly/String.h>
+#include <folly/portability/Fcntl.h>
+
+#ifdef _WIN32
+#include <crtdbg.h> // @manual
+#endif
 
 namespace folly {
 namespace test {
 
-TemporaryFile::TemporaryFile(const char* prefix, Scope scope,
-                             bool closeOnDestruction)
-  : scope_(scope),
-    closeOnDestruction_(closeOnDestruction) {
-  static const char* suffix = ".XXXXXX";  // per mkstemp(3)
-  if (!prefix || prefix[0] == '\0') {
-    prefix = "temp";
+namespace {
+
+fs::path generateUniquePath(fs::path path, StringPiece namePrefix) {
+  if (path.empty()) {
+    path = fs::temp_directory_path();
   }
-  const char* dir = nullptr;
-  if (!strchr(prefix, '/')) {
-    // Not a full path, try getenv("TMPDIR") or "/tmp"
-    dir = getenv("TMPDIR");
-    if (!dir) {
-      dir = "/tmp";
-    }
-    // The "!" is a placeholder to ensure that &(path[0]) is null-terminated.
-    // This is the only standard-compliant way to get at a null-terminated
-    // non-const char string inside a std::string: put the null-terminator
-    // yourself.
-    path_ = format("{}/{}{}!", dir, prefix, suffix).str();
+  if (namePrefix.empty()) {
+    path /= fs::unique_path();
   } else {
-    path_ = format("{}{}!", prefix, suffix).str();
+    path /= fs::unique_path(
+        to<std::string>(namePrefix, ".%%%%-%%%%-%%%%-%%%%"));
   }
+  return path;
+}
 
-  // Replace the '!' with a null terminator, we'll get rid of it later
-  path_[path_.size() - 1] = '\0';
-
-  fd_ = mkstemp(&(path_[0]));
-  if (fd_ == -1) {
-    throw std::system_error(errno, std::system_category(),
-                            format("mkstemp failed: {}", path_).str().c_str());
-  }
+} // namespace
 
-  DCHECK_EQ(path_[path_.size() - 1], '\0');
-  path_.erase(path_.size() - 1);
+TemporaryFile::TemporaryFile(StringPiece namePrefix,
+                             fs::path dir,
+                             Scope scope,
+                             bool closeOnDestruction)
+  : scope_(scope),
+    closeOnDestruction_(closeOnDestruction),
+    fd_(-1),
+    path_(generateUniquePath(std::move(dir), namePrefix)) {
+  fd_ = open(path_.string().c_str(), O_RDWR | O_CREAT | O_EXCL, 0666);
+  checkUnixError(fd_, "open failed");
 
   if (scope_ == Scope::UNLINK_IMMEDIATELY) {
-    if (unlink(path_.c_str()) == -1) {
-      throw std::system_error(errno, std::system_category(),
-                              format("unlink failed: {}", path_).str().c_str());
+    boost::system::error_code ec;
+    fs::remove(path_, ec);
+    if (ec) {
+      LOG(WARNING) << "unlink on construction failed: " << ec;
+    } else {
+      path_.clear();
     }
-    path_.clear();  // path no longer available or meaningful
   }
 }
 
-const std::string& TemporaryFile::path() const {
+void TemporaryFile::close() {
+  if (::close(fd_) == -1) {
+    PLOG(ERROR) << "close failed";
+  }
+  fd_ = -1;
+}
+
+const fs::path& TemporaryFile::path() const {
   CHECK(scope_ != Scope::UNLINK_IMMEDIATELY);
   DCHECK(!path_.empty());
   return path_;
 }
 
-TemporaryFile::~TemporaryFile() {
+void TemporaryFile::reset() {
   if (fd_ != -1 && closeOnDestruction_) {
-    if (close(fd_) == -1) {
-      PLOG(ERROR) << "close failed";
+    if (::close(fd_) == -1) {
+      PLOG(ERROR) << "close failed (fd = " << fd_ << "): ";
     }
   }
 
   // If we previously failed to unlink() (UNLINK_IMMEDIATELY), we'll
   // try again here.
   if (scope_ != Scope::PERMANENT && !path_.empty()) {
-    if (unlink(path_.c_str()) == -1) {
-      PLOG(ERROR) << "unlink(" << path_ << ") failed";
+    boost::system::error_code ec;
+    fs::remove(path_, ec);
+    if (ec) {
+      LOG(WARNING) << "unlink on destruction failed: " << ec;
     }
   }
 }
 
-}  // namespace test
-}  // namespace folly
+TemporaryFile::~TemporaryFile() {
+  reset();
+}
+
+TemporaryDirectory::TemporaryDirectory(
+    StringPiece namePrefix,
+    fs::path dir,
+    Scope scope)
+    : scope_(scope),
+      path_(std::make_unique<fs::path>(
+          generateUniquePath(std::move(dir), namePrefix))) {
+  fs::create_directory(path());
+}
+
+TemporaryDirectory::~TemporaryDirectory() {
+  if (scope_ == Scope::DELETE_ON_DESTRUCTION && path_ != nullptr) {
+    boost::system::error_code ec;
+    fs::remove_all(path(), ec);
+    if (ec) {
+      LOG(WARNING) << "recursive delete on destruction failed: " << ec;
+    }
+  }
+}
+
+ChangeToTempDir::ChangeToTempDir() {
+  orig_ = fs::current_path();
+  fs::current_path(path());
+}
+
+ChangeToTempDir::~ChangeToTempDir() {
+  if (!orig_.empty()) {
+    fs::current_path(orig_);
+  }
+}
+
+namespace detail {
+
+SavedState disableInvalidParameters() {
+#ifdef _WIN32
+  SavedState ret;
+  ret.previousThreadLocalHandler = _set_thread_local_invalid_parameter_handler(
+      [](const wchar_t*,
+         const wchar_t*,
+         const wchar_t*,
+         unsigned int,
+         uintptr_t) {});
+  ret.previousCrtReportMode = _CrtSetReportMode(_CRT_ASSERT, 0);
+  return ret;
+#else
+  return SavedState();
+#endif
+}
+
+#ifdef _WIN32
+void enableInvalidParameters(SavedState state) {
+  _set_thread_local_invalid_parameter_handler(
+      (_invalid_parameter_handler)state.previousThreadLocalHandler);
+  _CrtSetReportMode(_CRT_ASSERT, state.previousCrtReportMode);
+}
+#else
+void enableInvalidParameters(SavedState) {}
+#endif
+
+bool hasPCREPatternMatch(StringPiece pattern, StringPiece target) {
+  return boost::regex_match(
+    target.begin(),
+    target.end(),
+    boost::regex(pattern.begin(), pattern.end())
+  );
+}
+
+bool hasNoPCREPatternMatch(StringPiece pattern, StringPiece target) {
+  return !hasPCREPatternMatch(pattern, target);
+}
+
+} // namespace detail
+
+CaptureFD::CaptureFD(int fd, ChunkCob chunk_cob)
+    : chunkCob_(std::move(chunk_cob)), fd_(fd), readOffset_(0) {
+  oldFDCopy_ = dup(fd_);
+  PCHECK(oldFDCopy_ != -1) << "Could not copy FD " << fd_;
+
+  int file_fd = open(file_.path().string().c_str(), O_WRONLY|O_CREAT, 0600);
+  PCHECK(dup2(file_fd, fd_) != -1) << "Could not replace FD " << fd_
+    << " with " << file_fd;
+  PCHECK(close(file_fd) != -1) << "Could not close " << file_fd;
+}
+
+void CaptureFD::release() {
+  if (oldFDCopy_ != fd_) {
+    readIncremental();  // Feed chunkCob_
+    PCHECK(dup2(oldFDCopy_, fd_) != -1) << "Could not restore old FD "
+      << oldFDCopy_ << " into " << fd_;
+    PCHECK(close(oldFDCopy_) != -1) << "Could not close " << oldFDCopy_;
+    oldFDCopy_ = fd_;  // Make this call idempotent
+  }
+}
+
+CaptureFD::~CaptureFD() {
+  release();
+}
+
+std::string CaptureFD::read() const {
+  std::string contents;
+  std::string filename = file_.path().string();
+  PCHECK(folly::readFile(filename.c_str(), contents));
+  return contents;
+}
+
+std::string CaptureFD::readIncremental() {
+  std::string filename = file_.path().string();
+  // Yes, I know that I could just keep the file open instead. So sue me.
+  folly::File f(openNoInt(filename.c_str(), O_RDONLY), true);
+  auto size = size_t(lseek(f.fd(), 0, SEEK_END) - readOffset_);
+  std::unique_ptr<char[]> buf(new char[size]);
+  auto bytes_read = folly::preadFull(f.fd(), buf.get(), size, readOffset_);
+  PCHECK(ssize_t(size) == bytes_read);
+  readOffset_ += off_t(size);
+  chunkCob_(StringPiece(buf.get(), buf.get() + size));
+  return std::string(buf.get(), size);
+}
+
+} // namespace test
+} // namespace folly