libstdc++-v3/testsuite/util/testsuite_fs.h

   1 // -*- C++ -*-
   2 // Filesystem utils for the C++ library testsuite.
   3 //
   4 // Copyright (C) 2014-2019 Free Software Foundation, Inc.
   5 //
   6 // This file is part of the GNU ISO C++ Library.  This library is free
   7 // software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the
   9 // Free Software Foundation; either version 3, or (at your option)
  10 // any later version.
  11 //
  12 // This library is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with this library; see the file COPYING3.  If not see
  19 // <http://www.gnu.org/licenses/>.
  20 //
  21
  22 #ifndef _TESTSUITE_FS_H
  23 #define _TESTSUITE_FS_H 1
  24
  25 // Assume we want std::filesystem in C++17, unless USE_FILESYSTEM_TS defined:
  26 #if __cplusplus >= 201703L && ! defined USE_FILESYSTEM_TS
  27 #include <filesystem>
  28 namespace test_fs = std::filesystem;
  29 #else
  30 #include <experimental/filesystem>
  31 namespace test_fs = std::experimental::filesystem;
  32 #endif
  33 #include <algorithm>
  34 #include <fstream>
  35 #include <string>
  36 #include <cstdio>
  37 #include <stdlib.h>
  38 #include <unistd.h>
  39
  40 namespace __gnu_test
  41 {
  42 #define PATH_CHK(p1, p2, fn) \
  43     if ( p1.fn() != p2.fn() ) \
  44       throw test_fs::filesystem_error("comparing '" #fn "' failed", p1, p2, \
  45           std::make_error_code(std::errc::invalid_argument) )
  46
  47   void
  48   compare_paths(const test_fs::path& p1,
  49                 const test_fs::path& p2)
  50   {
  51     PATH_CHK( p1, p2, native );
  52     PATH_CHK( p1, p2, string );
  53     PATH_CHK( p1, p2, empty );
  54     PATH_CHK( p1, p2, has_root_path );
  55     PATH_CHK( p1, p2, has_root_name );
  56     PATH_CHK( p1, p2, has_root_directory );
  57     PATH_CHK( p1, p2, has_relative_path );
  58     PATH_CHK( p1, p2, has_parent_path );
  59     PATH_CHK( p1, p2, has_filename );
  60     PATH_CHK( p1, p2, has_stem );
  61     PATH_CHK( p1, p2, has_extension );
  62     PATH_CHK( p1, p2, is_absolute );
  63     PATH_CHK( p1, p2, is_relative );
  64     auto d1 = std::distance(p1.begin(), p1.end());
  65     auto d2 = std::distance(p2.begin(), p2.end());
  66     if (d1 != d2)
  67       throw test_fs::filesystem_error(
  68           "distance(begin1, end1) != distance(begin2, end2)", p1, p2,
  69           std::make_error_code(std::errc::invalid_argument) );
  70     if (!std::equal(p1.begin(), p1.end(), p2.begin(), p2.end()))
  71       throw test_fs::filesystem_error(
  72           "!equal(begin1, end1, begin2, end2)", p1, p2,
  73           std::make_error_code(std::errc::invalid_argument) );
  74
  75   }
  76
  77   const std::string test_paths[] = {
  78     "", "/", "//", "/.", "/./", "/a", "/a/", "/a//", "/a/b/c/d", "/a//b",
  79     "a", "a/b", "a/b/", "a/b/c", "a/b/c.d", "a/b/..", "a/b/c.", "a/b/.c"
  80   };
  81
  82   test_fs::path
  83   root_path()
  84   {
  85 #if defined(__MING32__) || defined(__MINGW64__)
  86     return L"c:/";
  87 #else
  88     return "/";
  89 #endif
  90   }
  91
  92   // This is NOT supposed to be a secure way to get a unique name!
  93   // We just need a path that doesn't exist for testing purposes.
  94   test_fs::path
  95   nonexistent_path(std::string file = __builtin_FILE())
  96   {
  97     // Include the caller's filename to help identify tests that fail to
  98     // clean up the files they create.
  99     // Remove .cc extension:
 100     if (file.length() > 3 && file.compare(file.length() - 3, 3, ".cc") == 0)
 101       file.resize(file.length() - 3);
 102     // And directory:
 103     auto pos = file.find_last_of("/\\");
 104     if (pos != file.npos)
 105       file.erase(0, pos+1);
 106
 107     test_fs::path p;
 108 #if defined(_GNU_SOURCE) || _XOPEN_SOURCE >= 500 || _POSIX_C_SOURCE >= 200112L
 109     char tmp[] = "filesystem-test.XXXXXX";
 110     int fd = ::mkstemp(tmp);
 111     if (fd == -1)
 112       throw test_fs::filesystem_error("mkstemp failed",
 113           std::error_code(errno, std::generic_category()));
 114     ::unlink(tmp);
 115     ::close(fd);
 116     if (!file.empty())
 117       file.insert(0, 1, '-');
 118     file.insert(0, tmp);
 119     p = file;
 120 #else
 121     if (file.length() > 64)
 122       file.resize(64);
 123     char buf[128];
 124     static int counter;
 125 #if _GLIBCXX_USE_C99_STDIO
 126     std::snprintf(buf, 128,
 127 #else
 128     std::sprintf(buf,
 129 #endif
 130       "filesystem-test.%d.%lu-%s", counter++, (unsigned long) ::getpid(),
 131       file.c_str());
 132     p = buf;
 133 #endif
 134     return p;
 135   }
 136
 137   // RAII helper to remove a file on scope exit.
 138   struct scoped_file
 139   {
 140     using path_type = test_fs::path;
 141
 142     enum adopt_file_t { adopt_file };
 143
 144     explicit
 145     scoped_file(const path_type& p = nonexistent_path()) : path(p)
 146     { std::ofstream{p.c_str()}; }
 147
 148     scoped_file(path_type p, adopt_file_t) : path(p) { }
 149
 150     ~scoped_file() { if (!path.empty()) remove(path); }
 151
 152     scoped_file(scoped_file&&) = default;
 153     scoped_file& operator=(scoped_file&&) = default;
 154
 155     path_type path;
 156   };
 157
 158 } // namespace __gnu_test
 159 #endif