solidity/test/Common.h

137 lines
4.8 KiB
C
Raw Normal View History

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/>.
*/
// SPDX-License-Identifier: GPL-3.0
2018-10-10 14:12:18 +00:00
#pragma once
#include <libsolutil/Exceptions.h>
#include <liblangutil/EVMVersion.h>
2021-12-20 18:03:48 +00:00
#include <liblangutil/Exceptions.h>
#include <libsolutil/Numeric.h>
2020-06-05 23:10:48 +00:00
#include <test/evmc/evmc.h>
2018-10-10 14:12:18 +00:00
#include <boost/filesystem/path.hpp>
#include <boost/program_options.hpp>
2018-10-10 14:12:18 +00:00
namespace solidity::test
2018-10-10 14:12:18 +00:00
{
#ifdef _WIN32
static constexpr auto evmoneFilename = "evmone.dll";
2023-05-09 15:59:00 +00:00
static constexpr auto evmoneDownloadLink = "https://github.com/ethereum/evmone/releases/download/v0.10.0/evmone-0.10.0-windows-amd64.zip";
2020-06-05 23:10:48 +00:00
static constexpr auto heraFilename = "hera.dll";
static constexpr auto heraDownloadLink = "https://github.com/ewasm/hera/archive/v0.6.0.tar.gz";
#elif defined(__APPLE__)
static constexpr auto evmoneFilename = "libevmone.dylib";
2023-05-09 15:59:00 +00:00
static constexpr auto evmoneDownloadLink = "https://github.com/ethereum/evmone/releases/download/v0.10.0/evmone-0.10.0-darwin-x86_64.tar.gz";
2020-06-05 23:10:48 +00:00
static constexpr auto heraFilename = "libhera.dylib";
static constexpr auto heraDownloadLink = "https://github.com/ewasm/hera/releases/download/v0.6.0/hera-0.6.0-darwin-x86_64.tar.gz";
#else
static constexpr auto evmoneFilename = "libevmone.so";
2023-05-09 15:59:00 +00:00
static constexpr auto evmoneDownloadLink = "https://github.com/ethereum/evmone/releases/download/v0.10.0/evmone-0.10.0-linux-x86_64.tar.gz";
2020-06-05 23:10:48 +00:00
static constexpr auto heraFilename = "libhera.so";
static constexpr auto heraDownloadLink = "https://github.com/ewasm/hera/releases/download/v0.6.0/hera-0.6.0-linux-x86_64.tar.gz";
#endif
struct ConfigException: public util::Exception {};
struct CommonOptions
{
/// Noncopyable.
CommonOptions(CommonOptions const&) = delete;
CommonOptions& operator=(CommonOptions const&) = delete;
2020-06-05 23:10:48 +00:00
std::vector<boost::filesystem::path> vmPaths;
boost::filesystem::path testPath;
2020-06-05 23:10:48 +00:00
bool ewasm = false;
bool optimize = false;
bool enforceCompileToEwasm = false;
bool enforceGasTest = false;
u256 enforceGasTestMinValue = 100000;
bool disableSemanticTests = false;
bool disableSMT = false;
bool useABIEncoderV1 = false;
bool showMessages = false;
bool showMetadata = false;
2021-12-20 18:03:48 +00:00
size_t batches = 1;
size_t selectedBatch = 0;
langutil::EVMVersion evmVersion() const;
std::optional<uint8_t> eofVersion() const { return m_eofVersion; }
virtual void addOptions();
// @returns true if the program should continue, false if it should exit immediately without
// reporting an error.
// Throws ConfigException or std::runtime_error if parsing fails.
virtual bool parse(int argc, char const* const* argv);
// Throws a ConfigException on error
virtual void validate() const;
/// @returns string with a key=value list of the options separated by comma
/// Ex.: "evmVersion=london, optimize=true, useABIEncoderV1=false"
virtual std::string toString(std::vector<std::string> const& _selectedOptions) const;
/// Helper to print the value of settings used
virtual void printSelectedOptions(std::ostream& _stream, std::string const& _linePrefix, std::vector<std::string> const& _selectedOptions) const;
static CommonOptions const& get();
static void setSingleton(std::unique_ptr<CommonOptions const>&& _instance);
CommonOptions(std::string caption = "");
2020-11-11 21:55:38 +00:00
virtual ~CommonOptions() {}
2020-06-05 23:10:48 +00:00
protected:
boost::program_options::options_description options;
private:
std::string evmVersionString;
std::optional<uint8_t> m_eofVersion;
static std::unique_ptr<CommonOptions const> m_singleton;
};
2018-10-10 14:12:18 +00:00
/// @return true if it is ok to treat the file located under the specified path as a semantic test.
/// I.e. if the test is located in the semantic test directory and is not excluded due to being a part of external sources.
/// Note: @p _testPath can be relative but must include at least the `/test/libsolidity/semanticTests/` part
bool isValidSemanticTestPath(boost::filesystem::path const& _testPath);
bool loadVMs(CommonOptions const& _options);
2021-12-20 18:03:48 +00:00
/**
* Component to help with splitting up all tests into batches.
*/
class Batcher
{
public:
Batcher(size_t _offset, size_t _batches):
m_offset(_offset),
m_batches(_batches)
{
solAssert(m_batches > 0 && m_offset < m_batches);
}
Batcher(Batcher const&) = delete;
Batcher& operator=(Batcher const&) = delete;
bool checkAndAdvance() { return (m_counter++) % m_batches == m_offset; }
private:
size_t const m_offset;
size_t const m_batches;
size_t m_counter = 0;
};
2018-10-10 14:12:18 +00:00
}