FilesystemUtils.cpp

/*
	This file is part of solidity.

	solidity 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.

	solidity 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 solidity.  If not, see <http://www.gnu.org/licenses/>.
*/
// SPDX-License-Identifier: GPL-3.0

#include <test/FilesystemUtils.h>

#include <test/libsolidity/util/SoltestErrors.h>

#include <fstream>

using namespace solidity;
using namespace solidity::test;

void solidity::test::createFilesWithParentDirs(std::set<boost::filesystem::path> const& _paths, std::string const& _content)
{
	for (boost::filesystem::path const& path: _paths)
	{
		if (!path.parent_path().empty())
			boost::filesystem::create_directories(path.parent_path());

		// Use binary mode to avoid line ending conversion on Windows.
		std::ofstream newFile(path.string(), std::ofstream::binary);
		newFile << _content;

		if (newFile.fail() || !boost::filesystem::exists(path))
			BOOST_THROW_EXCEPTION(std::runtime_error("Failed to create an empty file: \"" + path.string() + "\"."));
	}
}

void solidity::test::createFileWithContent(boost::filesystem::path const& _path, std::string const& _content)
{
	if (boost::filesystem::is_regular_file(_path))
		BOOST_THROW_EXCEPTION(std::runtime_error("File already exists: \"" + _path.string() + "\"."));

	// Use binary mode to avoid line ending conversion on Windows.
	std::ofstream newFile(_path.string(), std::ofstream::binary);
	if (newFile.fail() || !boost::filesystem::is_regular_file(_path))
		BOOST_THROW_EXCEPTION(std::runtime_error("Failed to create a file: \"" + _path.string() + "\"."));

	newFile << _content;
}

bool solidity::test::createSymlinkIfSupportedByFilesystem(
	boost::filesystem::path _targetPath,
	boost::filesystem::path const& _linkName,
	bool _directorySymlink
)
{
	boost::system::error_code symlinkCreationError;

	// NOTE: On Windows / works as a separator in a symlink target only if the target is absolute.
	// Convert path separators to native ones to avoid this problem.
	_targetPath.make_preferred();

	if (_directorySymlink)
		boost::filesystem::create_directory_symlink(_targetPath, _linkName, symlinkCreationError);
	else
		boost::filesystem::create_symlink(_targetPath, _linkName, symlinkCreationError);

	if (!symlinkCreationError)
		return true;
	else if (
		symlinkCreationError == boost::system::errc::not_supported ||
		symlinkCreationError == boost::system::errc::operation_not_supported
	)
		return false;
	else
		BOOST_THROW_EXCEPTION(std::runtime_error(
			"Failed to create a symbolic link: \"" + _linkName.string() + "\""
			" -> " + _targetPath.string() + "\"."
			" " + symlinkCreationError.message() + "."
		));
}