mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
361 lines
11 KiB
C++
361 lines
11 KiB
C++
/*
|
|
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/>.
|
|
*/
|
|
|
|
#include <test/libsolidity/SemanticTest.h>
|
|
#include <libsolutil/Whiskers.h>
|
|
#include <libyul/Exceptions.h>
|
|
#include <test/Common.h>
|
|
#include <boost/algorithm/string.hpp>
|
|
#include <boost/algorithm/string/predicate.hpp>
|
|
#include <boost/algorithm/string/trim.hpp>
|
|
#include <boost/throw_exception.hpp>
|
|
|
|
#include <algorithm>
|
|
#include <cctype>
|
|
#include <fstream>
|
|
#include <memory>
|
|
#include <stdexcept>
|
|
|
|
using namespace std;
|
|
using namespace solidity;
|
|
using namespace solidity::yul;
|
|
using namespace solidity::util;
|
|
using namespace solidity::util::formatting;
|
|
using namespace solidity::frontend::test;
|
|
using namespace boost;
|
|
using namespace boost::algorithm;
|
|
using namespace boost::unit_test;
|
|
namespace fs = boost::filesystem;
|
|
|
|
|
|
SemanticTest::SemanticTest(string const& _filename, langutil::EVMVersion _evmVersion, vector<boost::filesystem::path> const& _vmPaths, bool enforceViaYul):
|
|
SolidityExecutionFramework(_evmVersion, _vmPaths),
|
|
EVMVersionRestrictedTestCase(_filename),
|
|
m_sources(m_reader.sources()),
|
|
m_lineOffset(m_reader.lineNumber()),
|
|
m_enforceViaYul(enforceViaYul)
|
|
{
|
|
string choice = m_reader.stringSetting("compileViaYul", "default");
|
|
if (choice == "also")
|
|
{
|
|
m_runWithYul = true;
|
|
m_runWithoutYul = true;
|
|
}
|
|
else if (choice == "true")
|
|
{
|
|
m_runWithYul = true;
|
|
m_runWithoutYul = false;
|
|
}
|
|
else if (choice == "false")
|
|
{
|
|
m_runWithYul = false;
|
|
m_runWithoutYul = true;
|
|
// Do not try to run via yul if explicitly denied.
|
|
m_enforceViaYul = false;
|
|
}
|
|
else if (choice == "default")
|
|
{
|
|
m_runWithYul = false;
|
|
m_runWithoutYul = true;
|
|
}
|
|
else
|
|
BOOST_THROW_EXCEPTION(runtime_error("Invalid compileViaYul value: " + choice + "."));
|
|
|
|
string compileToEwasm = m_reader.stringSetting("compileToEwasm", "false");
|
|
if (compileToEwasm == "also")
|
|
m_runWithEwasm = true;
|
|
else if (compileToEwasm == "false")
|
|
m_runWithEwasm = false;
|
|
else
|
|
BOOST_THROW_EXCEPTION(runtime_error("Invalid compileToEwasm value: " + compileToEwasm + "."));
|
|
|
|
if (m_runWithEwasm && !m_runWithYul)
|
|
BOOST_THROW_EXCEPTION(runtime_error("Invalid compileToEwasm value: " + compileToEwasm + ", compileViaYul need to be enabled."));
|
|
|
|
// run ewasm tests only, if an ewasm evmc vm was defined
|
|
if (m_runWithEwasm && !m_supportsEwasm)
|
|
m_runWithEwasm = false;
|
|
|
|
m_runWithABIEncoderV1Only = m_reader.boolSetting("ABIEncoderV1Only", false);
|
|
if (m_runWithABIEncoderV1Only && solidity::test::CommonOptions::get().useABIEncoderV2)
|
|
m_shouldRun = false;
|
|
|
|
auto revertStrings = revertStringsFromString(m_reader.stringSetting("revertStrings", "default"));
|
|
soltestAssert(revertStrings, "Invalid revertStrings setting.");
|
|
m_revertStrings = revertStrings.value();
|
|
|
|
m_allowNonExistingFunctions = m_reader.boolSetting("allowNonExistingFunctions", false);
|
|
|
|
parseExpectations(m_reader.stream());
|
|
soltestAssert(!m_tests.empty(), "No tests specified in " + _filename);
|
|
}
|
|
|
|
TestCase::TestResult SemanticTest::run(ostream& _stream, string const& _linePrefix, bool _formatted)
|
|
{
|
|
TestResult result = TestResult::Success;
|
|
bool compileViaYul = m_runWithYul || m_enforceViaYul;
|
|
|
|
if (m_runWithoutYul)
|
|
result = runTest(_stream, _linePrefix, _formatted, false, false);
|
|
|
|
if (compileViaYul && result == TestResult::Success)
|
|
result = runTest(_stream, _linePrefix, _formatted, true, false);
|
|
|
|
if (m_runWithEwasm && result == TestResult::Success)
|
|
result = runTest(_stream, _linePrefix, _formatted, true, true);
|
|
|
|
return result;
|
|
}
|
|
|
|
TestCase::TestResult SemanticTest::runTest(ostream& _stream, string const& _linePrefix, bool _formatted, bool _compileViaYul, bool _compileToEwasm)
|
|
{
|
|
try
|
|
{
|
|
bool success = true;
|
|
|
|
if (_compileViaYul && _compileToEwasm)
|
|
selectVM(evmc_capabilities::EVMC_CAPABILITY_EWASM);
|
|
else
|
|
selectVM(evmc_capabilities::EVMC_CAPABILITY_EVM1);
|
|
|
|
reset();
|
|
|
|
m_compileViaYul = _compileViaYul;
|
|
if (_compileToEwasm)
|
|
{
|
|
soltestAssert(m_compileViaYul, "");
|
|
m_compileToEwasm = _compileToEwasm;
|
|
}
|
|
|
|
m_compileViaYulCanBeSet = false;
|
|
|
|
if (_compileViaYul)
|
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Running via Yul:" << endl;
|
|
|
|
for (auto& test: m_tests)
|
|
test.reset();
|
|
|
|
map<string, solidity::test::Address> libraries;
|
|
|
|
bool constructed = false;
|
|
|
|
for (auto& test: m_tests)
|
|
{
|
|
if (constructed)
|
|
{
|
|
soltestAssert(!test.call().isLibrary, "Libraries have to be deployed before any other call.");
|
|
soltestAssert(
|
|
!test.call().isConstructor,
|
|
"Constructor has to be the first function call expect for library deployments.");
|
|
}
|
|
else if (test.call().isLibrary)
|
|
{
|
|
soltestAssert(
|
|
deploy(test.call().signature, 0, {}, libraries) && m_transactionSuccessful,
|
|
"Failed to deploy library " + test.call().signature);
|
|
libraries[test.call().signature] = m_contractAddress;
|
|
continue;
|
|
}
|
|
else
|
|
{
|
|
if (test.call().isConstructor)
|
|
deploy("", test.call().value.value, test.call().arguments.rawBytes(), libraries);
|
|
else
|
|
soltestAssert(deploy("", 0, bytes(), libraries), "Failed to deploy contract.");
|
|
constructed = true;
|
|
}
|
|
|
|
if (test.call().isConstructor)
|
|
{
|
|
if (m_transactionSuccessful == test.call().expectations.failure)
|
|
success = false;
|
|
|
|
test.setFailure(!m_transactionSuccessful);
|
|
test.setRawBytes(bytes());
|
|
}
|
|
else
|
|
{
|
|
bytes output;
|
|
if (test.call().useCallWithoutSignature)
|
|
output = callLowLevel(test.call().arguments.rawBytes(), test.call().value.value);
|
|
else
|
|
{
|
|
soltestAssert(
|
|
m_allowNonExistingFunctions || m_compiler.methodIdentifiers(m_compiler.lastContractName())
|
|
.isMember(test.call().signature),
|
|
"The function " + test.call().signature + " is not known to the compiler");
|
|
|
|
output = callContractFunctionWithValueNoEncoding(
|
|
test.call().signature, test.call().value.value, test.call().arguments.rawBytes()
|
|
);
|
|
}
|
|
|
|
if ((m_transactionSuccessful == test.call().expectations.failure)
|
|
|| (output != test.call().expectations.rawBytes()))
|
|
success = false;
|
|
|
|
test.setFailure(!m_transactionSuccessful);
|
|
test.setRawBytes(std::move(output));
|
|
test.setContractABI(m_compiler.contractABI(m_compiler.lastContractName()));
|
|
}
|
|
}
|
|
|
|
if (success && !m_runWithYul && _compileViaYul)
|
|
{
|
|
m_compileViaYulCanBeSet = true;
|
|
AnsiColorized(_stream, _formatted, {BOLD, YELLOW}) <<
|
|
_linePrefix << endl <<
|
|
_linePrefix << "Test can pass via Yul and marked with compileViaYul: false." << endl;
|
|
return TestResult::Failure;
|
|
}
|
|
|
|
if (!success && (m_runWithYul || !_compileViaYul))
|
|
{
|
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Expected result:" << endl;
|
|
for (auto const& test: m_tests)
|
|
{
|
|
ErrorReporter errorReporter;
|
|
_stream << test.format(errorReporter, _linePrefix, false, _formatted) << endl;
|
|
_stream << errorReporter.format(_linePrefix, _formatted);
|
|
}
|
|
_stream << endl;
|
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Obtained result:" << endl;
|
|
for (auto const& test: m_tests)
|
|
{
|
|
ErrorReporter errorReporter;
|
|
_stream << test.format(errorReporter, _linePrefix, true, _formatted) << endl;
|
|
_stream << errorReporter.format(_linePrefix, _formatted);
|
|
}
|
|
AnsiColorized(_stream, _formatted, {BOLD, RED})
|
|
<< _linePrefix << endl
|
|
<< _linePrefix << "Attention: Updates on the test will apply the detected format displayed." << endl;
|
|
if (_compileViaYul && m_runWithoutYul)
|
|
{
|
|
_stream << _linePrefix << endl << _linePrefix;
|
|
AnsiColorized(_stream, _formatted, {RED_BACKGROUND}) << "Note that the test passed without Yul.";
|
|
_stream << endl;
|
|
}
|
|
else if (!_compileViaYul && m_runWithYul)
|
|
AnsiColorized(_stream, _formatted, {BOLD, YELLOW})
|
|
<< _linePrefix << endl
|
|
<< _linePrefix << "Note that the test also has to pass via Yul." << endl;
|
|
return TestResult::Failure;
|
|
}
|
|
}
|
|
catch (WhiskersError const&)
|
|
{
|
|
// this is an error in Whiskers template, so should be thrown anyway
|
|
throw;
|
|
}
|
|
catch (YulException const&)
|
|
{
|
|
// this should be an error in yul compilation or translation
|
|
throw;
|
|
}
|
|
catch (boost::exception const&)
|
|
{
|
|
if (!_compileViaYul || m_runWithYul)
|
|
throw;
|
|
}
|
|
catch (std::exception const&)
|
|
{
|
|
if (!_compileViaYul || m_runWithYul)
|
|
throw;
|
|
}
|
|
catch (...)
|
|
{
|
|
if (!_compileViaYul || m_runWithYul)
|
|
throw;
|
|
}
|
|
|
|
return TestResult::Success;
|
|
}
|
|
|
|
void SemanticTest::printSource(ostream& _stream, string const& _linePrefix, bool _formatted) const
|
|
{
|
|
if (m_sources.sources.empty())
|
|
return;
|
|
|
|
bool outputNames = (m_sources.sources.size() != 1 || !m_sources.sources.begin()->first.empty());
|
|
|
|
for (auto const& [name, source]: m_sources.sources)
|
|
if (_formatted)
|
|
{
|
|
if (source.empty())
|
|
continue;
|
|
|
|
if (outputNames)
|
|
_stream << _linePrefix << formatting::CYAN << "==== Source: " << name << " ====" << formatting::RESET << endl;
|
|
vector<char const*> sourceFormatting(source.length(), formatting::RESET);
|
|
|
|
_stream << _linePrefix << sourceFormatting.front() << source.front();
|
|
for (size_t i = 1; i < source.length(); i++)
|
|
{
|
|
if (sourceFormatting[i] != sourceFormatting[i - 1])
|
|
_stream << sourceFormatting[i];
|
|
if (source[i] != '\n')
|
|
_stream << source[i];
|
|
else
|
|
{
|
|
_stream << formatting::RESET << endl;
|
|
if (i + 1 < source.length())
|
|
_stream << _linePrefix << sourceFormatting[i];
|
|
}
|
|
}
|
|
_stream << formatting::RESET;
|
|
}
|
|
else
|
|
{
|
|
if (outputNames)
|
|
_stream << _linePrefix << "==== Source: " + name << " ====" << endl;
|
|
stringstream stream(source);
|
|
string line;
|
|
while (getline(stream, line))
|
|
_stream << _linePrefix << line << endl;
|
|
}
|
|
}
|
|
|
|
void SemanticTest::printUpdatedExpectations(ostream& _stream, string const&) const
|
|
{
|
|
for (auto const& test: m_tests)
|
|
_stream << test.format("", true, false) << endl;
|
|
}
|
|
|
|
void SemanticTest::printUpdatedSettings(ostream& _stream, string const& _linePrefix)
|
|
{
|
|
auto& settings = m_reader.settings();
|
|
if (settings.empty() && !m_compileViaYulCanBeSet)
|
|
return;
|
|
|
|
_stream << _linePrefix << "// ====" << endl;
|
|
if (m_compileViaYulCanBeSet)
|
|
_stream << _linePrefix << "// compileViaYul: also\n";
|
|
for (auto const& setting: settings)
|
|
if (!m_compileViaYulCanBeSet || setting.first != "compileViaYul")
|
|
_stream << _linePrefix << "// " << setting.first << ": " << setting.second << endl;
|
|
}
|
|
|
|
void SemanticTest::parseExpectations(istream& _stream)
|
|
{
|
|
TestFileParser parser{_stream};
|
|
auto functionCalls = parser.parseFunctionCalls(m_lineOffset);
|
|
std::move(functionCalls.begin(), functionCalls.end(), back_inserter(m_tests));
|
|
}
|
|
|
|
bool SemanticTest::deploy(string const& _contractName, u256 const& _value, bytes const& _arguments, map<string, solidity::test::Address> const& _libraries)
|
|
{
|
|
auto output = compileAndRunWithoutCheck(m_sources.sources, _value, _contractName, _arguments, _libraries);
|
|
return !output.empty() && m_transactionSuccessful;
|
|
}
|