2018-10-10 14:12:18 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2018-10-10 14:12:18 +00:00
|
|
|
|
2020-01-14 16:48:17 +00:00
|
|
|
#include <stdexcept>
|
2020-06-05 23:10:48 +00:00
|
|
|
#include <iostream>
|
2018-10-10 14:12:18 +00:00
|
|
|
#include <test/Common.h>
|
|
|
|
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/Assertions.h>
|
2018-10-10 14:12:18 +00:00
|
|
|
#include <boost/filesystem.hpp>
|
2019-02-19 16:34:59 +00:00
|
|
|
#include <boost/program_options.hpp>
|
2018-10-10 14:12:18 +00:00
|
|
|
|
|
|
|
namespace fs = boost::filesystem;
|
2019-02-19 16:34:59 +00:00
|
|
|
namespace po = boost::program_options;
|
2018-10-10 14:12:18 +00:00
|
|
|
|
2019-12-23 15:50:30 +00:00
|
|
|
namespace solidity::test
|
2018-10-10 14:12:18 +00:00
|
|
|
{
|
|
|
|
|
2020-12-08 20:06:10 +00:00
|
|
|
namespace
|
|
|
|
{
|
|
|
|
|
2019-02-19 16:34:59 +00:00
|
|
|
/// If non-empty returns the value of the env. variable ETH_TEST_PATH, otherwise
|
|
|
|
/// it tries to find a path that contains the directories "libsolidity/syntaxTests"
|
|
|
|
/// and returns it if found.
|
|
|
|
/// The routine searches in the current directory, and inside the "test" directory
|
|
|
|
/// starting from the current directory and up to three levels up.
|
|
|
|
/// @returns the path of the first match or an empty path if not found.
|
|
|
|
boost::filesystem::path testPath()
|
2018-10-10 14:12:18 +00:00
|
|
|
{
|
2019-02-19 12:24:04 +00:00
|
|
|
if (auto path = getenv("ETH_TEST_PATH"))
|
|
|
|
return path;
|
|
|
|
|
2018-10-10 14:12:18 +00:00
|
|
|
auto const searchPath =
|
|
|
|
{
|
|
|
|
fs::current_path() / ".." / ".." / ".." / "test",
|
|
|
|
fs::current_path() / ".." / ".." / "test",
|
|
|
|
fs::current_path() / ".." / "test",
|
|
|
|
fs::current_path() / "test",
|
|
|
|
fs::current_path()
|
|
|
|
};
|
|
|
|
for (auto const& basePath: searchPath)
|
|
|
|
{
|
|
|
|
fs::path syntaxTestPath = basePath / "libsolidity" / "syntaxTests";
|
|
|
|
if (fs::exists(syntaxTestPath) && fs::is_directory(syntaxTestPath))
|
|
|
|
return basePath;
|
|
|
|
}
|
|
|
|
return {};
|
|
|
|
}
|
|
|
|
|
2020-06-05 23:10:48 +00:00
|
|
|
std::string envOrDefaultPath(std::string const& env_name, std::string const& lib_name)
|
2019-02-19 16:34:59 +00:00
|
|
|
{
|
2020-06-05 23:10:48 +00:00
|
|
|
if (auto path = getenv(env_name.c_str()))
|
2019-02-19 16:34:59 +00:00
|
|
|
return path;
|
2019-07-17 06:22:14 +00:00
|
|
|
|
|
|
|
auto const searchPath =
|
|
|
|
{
|
|
|
|
fs::path("/usr/local/lib"),
|
|
|
|
fs::path("/usr/lib"),
|
|
|
|
fs::current_path() / "deps",
|
|
|
|
fs::current_path() / "deps" / "lib",
|
|
|
|
fs::current_path() / ".." / "deps",
|
|
|
|
fs::current_path() / ".." / "deps" / "lib",
|
|
|
|
fs::current_path() / ".." / ".." / "deps",
|
|
|
|
fs::current_path() / ".." / ".." / "deps" / "lib",
|
|
|
|
fs::current_path()
|
|
|
|
};
|
|
|
|
for (auto const& basePath: searchPath)
|
|
|
|
{
|
2020-06-05 23:10:48 +00:00
|
|
|
fs::path p = basePath / lib_name;
|
2019-07-17 06:22:14 +00:00
|
|
|
if (fs::exists(p))
|
|
|
|
return p.string();
|
|
|
|
}
|
|
|
|
return {};
|
2019-02-19 16:34:59 +00:00
|
|
|
}
|
|
|
|
|
2020-12-08 20:06:10 +00:00
|
|
|
}
|
|
|
|
|
2019-02-19 16:34:59 +00:00
|
|
|
CommonOptions::CommonOptions(std::string _caption):
|
|
|
|
options(_caption,
|
|
|
|
po::options_description::m_default_line_length,
|
|
|
|
po::options_description::m_default_line_length - 23
|
|
|
|
)
|
|
|
|
{
|
|
|
|
options.add_options()
|
2019-03-15 16:22:04 +00:00
|
|
|
("evm-version", po::value(&evmVersionString), "which evm version to use")
|
2019-12-23 15:50:30 +00:00
|
|
|
("testpath", po::value<fs::path>(&this->testPath)->default_value(solidity::test::testPath()), "path to test files")
|
2020-06-05 23:10:48 +00:00
|
|
|
("vm", po::value<std::vector<fs::path>>(&vmPaths), "path to evmc library, can be supplied multiple times.")
|
|
|
|
("ewasm", po::bool_switch(&ewasm), "tries to automatically find an ewasm vm and enable ewasm test-execution.")
|
2020-01-14 16:48:17 +00:00
|
|
|
("no-smt", po::bool_switch(&disableSMT), "disable SMT checker")
|
|
|
|
("optimize", po::bool_switch(&optimize), "enables optimization")
|
2020-04-17 20:24:33 +00:00
|
|
|
("enforce-via-yul", po::bool_switch(&enforceViaYul), "Enforce compiling all tests via yul to see if additional tests can be activated.")
|
2020-11-19 15:58:41 +00:00
|
|
|
("abiencoderv1", po::bool_switch(&useABIEncoderV1), "enables abi encoder v1")
|
2020-03-11 02:07:11 +00:00
|
|
|
("show-messages", po::bool_switch(&showMessages), "enables message output")
|
|
|
|
("show-metadata", po::bool_switch(&showMetadata), "enables metadata output");
|
2019-02-19 16:34:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void CommonOptions::validate() const
|
|
|
|
{
|
|
|
|
assertThrow(
|
|
|
|
!testPath.empty(),
|
|
|
|
ConfigException,
|
|
|
|
"No test path specified. The --testpath argument must not be empty when given."
|
|
|
|
);
|
|
|
|
assertThrow(
|
|
|
|
fs::exists(testPath),
|
|
|
|
ConfigException,
|
|
|
|
"Invalid test path specified."
|
|
|
|
);
|
2018-10-10 14:12:18 +00:00
|
|
|
|
2019-02-19 16:34:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool CommonOptions::parse(int argc, char const* const* argv)
|
|
|
|
{
|
|
|
|
po::variables_map arguments;
|
|
|
|
|
|
|
|
po::command_line_parser cmdLineParser(argc, argv);
|
|
|
|
cmdLineParser.options(options);
|
2020-01-06 14:28:20 +00:00
|
|
|
auto parsedOptions = cmdLineParser.run();
|
|
|
|
po::store(parsedOptions, arguments);
|
2019-02-19 16:34:59 +00:00
|
|
|
po::notify(arguments);
|
|
|
|
|
2020-01-06 14:28:20 +00:00
|
|
|
for (auto const& parsedOption: parsedOptions.options)
|
|
|
|
if (parsedOption.position_key >= 0)
|
|
|
|
{
|
2020-01-09 13:49:11 +00:00
|
|
|
if (
|
|
|
|
parsedOption.original_tokens.empty() ||
|
|
|
|
(parsedOption.original_tokens.size() == 1 && parsedOption.original_tokens.front().empty())
|
|
|
|
)
|
|
|
|
continue; // ignore empty options
|
2020-01-06 14:28:20 +00:00
|
|
|
std::stringstream errorMessage;
|
|
|
|
errorMessage << "Unrecognized option: ";
|
|
|
|
for (auto const& token: parsedOption.original_tokens)
|
|
|
|
errorMessage << token;
|
2021-02-18 23:49:34 +00:00
|
|
|
BOOST_THROW_EXCEPTION(std::runtime_error(errorMessage.str()));
|
2020-01-06 14:28:20 +00:00
|
|
|
}
|
|
|
|
|
2020-06-05 23:10:48 +00:00
|
|
|
if (vmPaths.empty())
|
|
|
|
{
|
|
|
|
std::string evmone = envOrDefaultPath("ETH_EVMONE", evmoneFilename);
|
|
|
|
if (!evmone.empty())
|
|
|
|
vmPaths.emplace_back(evmone);
|
|
|
|
else
|
|
|
|
{
|
|
|
|
std::cout << "Unable to find " << solidity::test::evmoneFilename
|
|
|
|
<< ". Please provide the path using --vm <path>." << std::endl;
|
|
|
|
std::cout << "You can download it at" << std::endl;
|
|
|
|
std::cout << solidity::test::evmoneDownloadLink << std::endl;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (ewasm) {
|
|
|
|
std::string hera = envOrDefaultPath("ETH_HERA", heraFilename);
|
|
|
|
if (!hera.empty())
|
|
|
|
vmPaths.emplace_back(hera);
|
|
|
|
else {
|
|
|
|
std::cout << "Unable to find " << solidity::test::heraFilename
|
|
|
|
<< ". Please provide the path using --vm <path>." << std::endl;
|
|
|
|
std::cout << "You can download it at" << std::endl;
|
|
|
|
std::cout << solidity::test::heraDownloadLink << std::endl;
|
|
|
|
std::cout << "Ewasm tests disabled." << std::endl;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-02-19 16:34:59 +00:00
|
|
|
return true;
|
2018-10-10 14:12:18 +00:00
|
|
|
}
|
2019-02-19 16:34:59 +00:00
|
|
|
|
2019-03-15 16:22:04 +00:00
|
|
|
|
|
|
|
langutil::EVMVersion CommonOptions::evmVersion() const
|
|
|
|
{
|
|
|
|
if (!evmVersionString.empty())
|
|
|
|
{
|
|
|
|
auto version = langutil::EVMVersion::fromString(evmVersionString);
|
|
|
|
if (!version)
|
2021-02-18 23:49:34 +00:00
|
|
|
BOOST_THROW_EXCEPTION(std::runtime_error("Invalid EVM version: " + evmVersionString));
|
2019-03-15 16:22:04 +00:00
|
|
|
return *version;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
return langutil::EVMVersion();
|
|
|
|
}
|
|
|
|
|
2020-01-14 16:48:17 +00:00
|
|
|
|
|
|
|
CommonOptions const& CommonOptions::get()
|
|
|
|
{
|
|
|
|
if (!m_singleton)
|
2021-02-18 23:49:34 +00:00
|
|
|
BOOST_THROW_EXCEPTION(std::runtime_error("Options not yet constructed!"));
|
2020-01-14 16:48:17 +00:00
|
|
|
|
|
|
|
return *m_singleton;
|
|
|
|
}
|
|
|
|
|
|
|
|
void CommonOptions::setSingleton(std::unique_ptr<CommonOptions const>&& _instance)
|
|
|
|
{
|
|
|
|
m_singleton = std::move(_instance);
|
|
|
|
}
|
|
|
|
|
|
|
|
std::unique_ptr<CommonOptions const> CommonOptions::m_singleton = nullptr;
|
|
|
|
|
2019-02-19 16:34:59 +00:00
|
|
|
}
|