test.cpp

/**
 * Copyright (c) 2011-2025 libbitcoin developers (see AUTHORS)
 *
 * This file is part of libbitcoin.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include "test.hpp"

namespace std {

std::ostream& operator<<(std::ostream& stream,
    const data_slice& slice) NOEXCEPT
{
    // Avoid serialize() here for its own test benefit.
    // stream << serialize(slice);
    BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
    stream << encode_base16(slice);
    BC_POP_WARNING()
    return stream;
}

} // namespace std

namespace test {

const std::string directory = "tests";

bool clear(const std::filesystem::path& file_directory) NOEXCEPT
{
    // remove_all returns count removed, and error code if fails.
    // create_directories returns true if path exists or created.
    // used for setup, with no expectations of file/directory existence.
    const auto path = to_extended_path(file_directory);
    code ec;
    BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
    std::filesystem::remove_all(path, ec);
    return !ec && std::filesystem::create_directories(path, ec);
    BC_POP_WARNING()
}

bool create(const std::filesystem::path& file_path) NOEXCEPT
{
    // Creates and returns true if file already existed (and no error).
    BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
    std::ofstream file(to_extended_path(file_path));
    return file.good();
    BC_POP_WARNING()
}

bool exists(const std::filesystem::path& file_path) NOEXCEPT
{
    // Returns true only if file existed.
    BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
    std::ifstream file(to_extended_path(file_path));
    return file.good();
    BC_POP_WARNING()
}

bool remove(const std::filesystem::path& file_path) NOEXCEPT
{
    // Deletes and returns false if file did not exist (or error).
    code ec;
    BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
    return std::filesystem::remove(to_extended_path(file_path), ec);
    BC_POP_WARNING()
}

} // namespace test