folly/experimental/TestUtil.h

   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 #ifndef FOLLY_TESTUTIL_H_
  18 #define FOLLY_TESTUTIL_H_
  19
  20 #include <string>
  21 #include <folly/Range.h>
  22 #include <folly/experimental/io/FsUtil.h>
  23
  24 namespace folly {
  25 namespace test {
  26
  27 /**
  28  * Temporary file.
  29  *
  30  * By default, the file is created in a system-specific location (the value
  31  * of the TMPDIR environment variable, or /tmp), but you can override that
  32  * with a different (non-empty) directory passed to the constructor.
  33  *
  34  * By default, the file is closed and deleted when the TemporaryFile object
  35  * is destroyed, but both these behaviors can be overridden with arguments
  36  * to the constructor.
  37  */
  38 class TemporaryFile {
  39  public:
  40   enum class Scope {
  41     PERMANENT,
  42     UNLINK_IMMEDIATELY,
  43     UNLINK_ON_DESTRUCTION
  44   };
  45   explicit TemporaryFile(StringPiece namePrefix = StringPiece(),
  46                          fs::path dir = fs::path(),
  47                          Scope scope = Scope::UNLINK_ON_DESTRUCTION,
  48                          bool closeOnDestruction = true);
  49   ~TemporaryFile();
  50
  51   // Movable, but not copiable
  52   TemporaryFile(TemporaryFile&&) = default;
  53   TemporaryFile& operator=(TemporaryFile&&) = default;
  54
  55   int fd() const { return fd_; }
  56   const fs::path& path() const;
  57
  58  private:
  59   Scope scope_;
  60   bool closeOnDestruction_;
  61   int fd_;
  62   fs::path path_;
  63 };
  64
  65 /**
  66  * Temporary directory.
  67  *
  68  * By default, the temporary directory is created in a system-specific
  69  * location (the value of the TMPDIR environment variable, or /tmp), but you
  70  * can override that with a non-empty directory passed to the constructor.
  71  *
  72  * By default, the directory is recursively deleted when the TemporaryDirectory
  73  * object is destroyed, but that can be overridden with an argument
  74  * to the constructor.
  75  */
  76
  77 class TemporaryDirectory {
  78  public:
  79   enum class Scope {
  80     PERMANENT,
  81     DELETE_ON_DESTRUCTION
  82   };
  83   explicit TemporaryDirectory(StringPiece namePrefix = StringPiece(),
  84                               fs::path dir = fs::path(),
  85                               Scope scope = Scope::DELETE_ON_DESTRUCTION);
  86   ~TemporaryDirectory();
  87
  88   // Movable, but not copiable
  89   TemporaryDirectory(TemporaryDirectory&&) = default;
  90   TemporaryDirectory& operator=(TemporaryDirectory&&) = default;
  91
  92   const fs::path& path() const { return path_; }
  93
  94  private:
  95   Scope scope_;
  96   fs::path path_;
  97 };
  98
  99 /**
 100  * Changes into a temporary directory, and deletes it with all its contents
 101  * upon destruction, also changing back to the original working directory.
 102  */
 103 class ChangeToTempDir {
 104 public:
 105   ChangeToTempDir();
 106   ~ChangeToTempDir();
 107
 108   // Movable, but not copiable
 109   ChangeToTempDir(ChangeToTempDir&&) = default;
 110   ChangeToTempDir& operator=(ChangeToTempDir&&) = default;
 111
 112   const fs::path& path() const { return dir_.path(); }
 113
 114 private:
 115   fs::path initialPath_;
 116   TemporaryDirectory dir_;
 117 };
 118
 119 }  // namespace test
 120 }  // namespace folly
 121
 122 #endif /* FOLLY_TESTUTIL_H_ */