Program Listing for File helpers.hpp

↰ Return to documentation for file (tests/unit/helpers/helpers.hpp)

/*
  Copyright 2018-2024, Barcelona Supercomputing Center (BSC), Spain
  Copyright 2015-2024, Johannes Gutenberg Universitaet Mainz, Germany

  This software was partially supported by the
  EC H2020 funded project NEXTGenIO (Project ID: 671951, www.nextgenio.eu).

  This software was partially supported by the
  ADA-FS project under the SPPEXA project funded by the DFG.

  This file is part of GekkoFS.

  GekkoFS is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  GekkoFS is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with GekkoFS.  If not, see <https://www.gnu.org/licenses/>.

  SPDX-License-Identifier: GPL-3.0-or-later
*/

#ifndef GKFS_TESTS_HELPERS
#define GKFS_TESTS_HELPERS

#include <filesystem>
#include <fstream>
#include <vector>

namespace fs = std::filesystem;

namespace helpers {

std::string
random_string(std::size_t length);


inline void
load_string_file(const fs::path& filename, std::string& str) {

    std::ifstream file;
    file.exceptions(std::ios_base::failbit | std::ios_base::badbit);
    file.open(filename, std::ios_base::binary);

    auto sz = static_cast<std::size_t>(fs::file_size(filename));
    str.resize(sz, '\0');
    file.read(&str[0], static_cast<std::streamsize>(sz));
}

struct temporary_directory {

    temporary_directory();

    ~temporary_directory();

    [[nodiscard]] fs::path
    dirname() const;

    fs::path dirname_;
};

struct temporary_file {

    explicit temporary_file(fs::path filename);

    temporary_file(fs::path filename, const std::string_view& text);

    ~temporary_file();

    void
    write(const std::string_view& text);

    void
    write(const std::vector<char>& data);

    fs::path
    filename() const;

    std::size_t
    size() const;

    fs::path filename_;
    std::ofstream ofs_;
};

} // namespace helpers

#endif // GKFS_TESTS_HELPERS