mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
317 lines
8.8 KiB
C++
317 lines
8.8 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/SyntaxTest.h>
|
|
#include <test/Options.h>
|
|
#include <boost/algorithm/string.hpp>
|
|
#include <boost/algorithm/string/predicate.hpp>
|
|
#include <boost/throw_exception.hpp>
|
|
#include <fstream>
|
|
#include <memory>
|
|
#include <stdexcept>
|
|
|
|
using namespace langutil;
|
|
using namespace dev::solidity;
|
|
using namespace dev::solidity::test;
|
|
using namespace dev::formatting;
|
|
using namespace dev;
|
|
using namespace std;
|
|
namespace fs = boost::filesystem;
|
|
using namespace boost::unit_test;
|
|
|
|
namespace
|
|
{
|
|
|
|
int parseUnsignedInteger(string::iterator& _it, string::iterator _end)
|
|
{
|
|
if (_it == _end || !isdigit(*_it))
|
|
throw runtime_error("Invalid test expectation. Source location expected.");
|
|
int result = 0;
|
|
while (_it != _end && isdigit(*_it))
|
|
{
|
|
result *= 10;
|
|
result += *_it - '0';
|
|
++_it;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
}
|
|
|
|
SyntaxTest::SyntaxTest(string const& _filename, langutil::EVMVersion _evmVersion, bool _parserErrorRecovery): m_evmVersion(_evmVersion)
|
|
{
|
|
ifstream file(_filename);
|
|
if (!file)
|
|
BOOST_THROW_EXCEPTION(runtime_error("Cannot open test contract: \"" + _filename + "\"."));
|
|
file.exceptions(ios::badbit);
|
|
|
|
m_sources = parseSourcesAndSettings(file);
|
|
|
|
if (m_settings.count("optimize-yul"))
|
|
{
|
|
if (m_settings["optimize-yul"] == "true")
|
|
{
|
|
m_validatedSettings["optimize-yul"] = "true";
|
|
m_settings.erase("optimize-yul");
|
|
}
|
|
else if (m_settings["optimize-yul"] == "false")
|
|
{
|
|
m_validatedSettings["optimize-yul"] = "false";
|
|
m_settings.erase("optimize-yul");
|
|
m_optimiseYul = false;
|
|
}
|
|
}
|
|
m_expectations = parseExpectations(file);
|
|
m_parserErrorRecovery = _parserErrorRecovery;
|
|
}
|
|
|
|
TestCase::TestResult SyntaxTest::run(ostream& _stream, string const& _linePrefix, bool _formatted)
|
|
{
|
|
string const versionPragma = "pragma solidity >=0.0;\n";
|
|
compiler().reset();
|
|
auto sourcesWithPragma = m_sources;
|
|
for (auto& source: sourcesWithPragma)
|
|
source.second = versionPragma + source.second;
|
|
compiler().setSources(sourcesWithPragma);
|
|
compiler().setEVMVersion(m_evmVersion);
|
|
compiler().setParserErrorRecovery(m_parserErrorRecovery);
|
|
compiler().setOptimiserSettings(
|
|
m_optimiseYul ?
|
|
OptimiserSettings::full() :
|
|
OptimiserSettings::minimal()
|
|
);
|
|
if (compiler().parse())
|
|
if (compiler().analyze())
|
|
try
|
|
{
|
|
if (!compiler().compile())
|
|
BOOST_THROW_EXCEPTION(runtime_error("Compilation failed even though analysis was successful."));
|
|
}
|
|
catch (UnimplementedFeatureError const& _e)
|
|
{
|
|
m_errorList.emplace_back(SyntaxTestError{
|
|
"UnimplementedFeatureError",
|
|
errorMessage(_e),
|
|
"",
|
|
-1,
|
|
-1
|
|
});
|
|
}
|
|
|
|
for (auto const& currentError: filterErrors(compiler().errors(), true))
|
|
{
|
|
int locationStart = -1, locationEnd = -1;
|
|
string sourceName;
|
|
if (auto location = boost::get_error_info<errinfo_sourceLocation>(*currentError))
|
|
{
|
|
// ignore the version pragma inserted by the testing tool when calculating locations.
|
|
if (location->start >= static_cast<int>(versionPragma.size()))
|
|
locationStart = location->start - versionPragma.size();
|
|
if (location->end >= static_cast<int>(versionPragma.size()))
|
|
locationEnd = location->end - versionPragma.size();
|
|
if (location->source)
|
|
sourceName = location->source->name();
|
|
}
|
|
m_errorList.emplace_back(SyntaxTestError{
|
|
currentError->typeName(),
|
|
errorMessage(*currentError),
|
|
sourceName,
|
|
locationStart,
|
|
locationEnd
|
|
});
|
|
}
|
|
|
|
return printExpectationAndError(_stream, _linePrefix, _formatted) ? TestResult::Success : TestResult::Failure;
|
|
}
|
|
|
|
bool SyntaxTest::printExpectationAndError(ostream& _stream, string const& _linePrefix, bool _formatted)
|
|
{
|
|
if (m_expectations != m_errorList)
|
|
{
|
|
string nextIndentLevel = _linePrefix + " ";
|
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Expected result:" << endl;
|
|
printErrorList(_stream, m_expectations, nextIndentLevel, _formatted);
|
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Obtained result:" << endl;
|
|
printErrorList(_stream, m_errorList, nextIndentLevel, _formatted);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void SyntaxTest::printSource(ostream& _stream, string const& _linePrefix, bool _formatted) const
|
|
{
|
|
|
|
if (m_sources.empty())
|
|
return;
|
|
|
|
bool outputSourceNames = true;
|
|
if (m_sources.size() == 1 && m_sources.begin()->first.empty())
|
|
outputSourceNames = false;
|
|
|
|
if (_formatted)
|
|
{
|
|
for (auto const& [name, source]: m_sources)
|
|
{
|
|
if (outputSourceNames)
|
|
_stream << _linePrefix << formatting::CYAN << "==== Source: " << name << " ====" << formatting::RESET << endl;
|
|
vector<char const*> sourceFormatting(source.length(), formatting::RESET);
|
|
for (auto const& error: m_errorList)
|
|
if (error.sourceName == name && error.locationStart >= 0 && error.locationEnd >= 0)
|
|
{
|
|
assert(static_cast<size_t>(error.locationStart) <= source.length());
|
|
assert(static_cast<size_t>(error.locationEnd) <= source.length());
|
|
bool isWarning = error.type == "Warning";
|
|
for (int i = error.locationStart; i < error.locationEnd; i++)
|
|
if (isWarning)
|
|
{
|
|
if (sourceFormatting[i] == formatting::RESET)
|
|
sourceFormatting[i] = formatting::ORANGE_BACKGROUND_256;
|
|
}
|
|
else
|
|
sourceFormatting[i] = formatting::RED_BACKGROUND;
|
|
}
|
|
|
|
_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
|
|
for (auto const& [name, source]: m_sources)
|
|
{
|
|
if (outputSourceNames)
|
|
_stream << _linePrefix << "==== Source: " + name << " ====" << endl;
|
|
stringstream stream(source);
|
|
string line;
|
|
while (getline(stream, line))
|
|
_stream << _linePrefix << line << endl;
|
|
}
|
|
}
|
|
|
|
void SyntaxTest::printErrorList(
|
|
ostream& _stream,
|
|
vector<SyntaxTestError> const& _errorList,
|
|
string const& _linePrefix,
|
|
bool _formatted
|
|
)
|
|
{
|
|
if (_errorList.empty())
|
|
AnsiColorized(_stream, _formatted, {BOLD, GREEN}) << _linePrefix << "Success" << endl;
|
|
else
|
|
for (auto const& error: _errorList)
|
|
{
|
|
{
|
|
AnsiColorized scope(_stream, _formatted, {BOLD, (error.type == "Warning") ? YELLOW : RED});
|
|
_stream << _linePrefix;
|
|
_stream << error.type << ": ";
|
|
}
|
|
if (!error.sourceName.empty() || error.locationStart >= 0 || error.locationEnd >= 0)
|
|
{
|
|
_stream << "(";
|
|
if (!error.sourceName.empty())
|
|
_stream << error.sourceName << ":";
|
|
if (error.locationStart >= 0)
|
|
_stream << error.locationStart;
|
|
_stream << "-";
|
|
if (error.locationEnd >= 0)
|
|
_stream << error.locationEnd;
|
|
_stream << "): ";
|
|
}
|
|
_stream << error.message << endl;
|
|
}
|
|
}
|
|
|
|
string SyntaxTest::errorMessage(Exception const& _e)
|
|
{
|
|
if (_e.comment() && !_e.comment()->empty())
|
|
return boost::replace_all_copy(*_e.comment(), "\n", "\\n");
|
|
else
|
|
return "NONE";
|
|
}
|
|
|
|
vector<SyntaxTestError> SyntaxTest::parseExpectations(istream& _stream)
|
|
{
|
|
vector<SyntaxTestError> expectations;
|
|
string line;
|
|
while (getline(_stream, line))
|
|
{
|
|
auto it = line.begin();
|
|
|
|
skipSlashes(it, line.end());
|
|
skipWhitespace(it, line.end());
|
|
|
|
if (it == line.end()) continue;
|
|
|
|
auto typeBegin = it;
|
|
while (it != line.end() && *it != ':')
|
|
++it;
|
|
string errorType(typeBegin, it);
|
|
|
|
// skip colon
|
|
if (it != line.end()) it++;
|
|
|
|
skipWhitespace(it, line.end());
|
|
|
|
int locationStart = -1;
|
|
int locationEnd = -1;
|
|
std::string sourceName;
|
|
|
|
if (it != line.end() && *it == '(')
|
|
{
|
|
++it;
|
|
if (it != line.end() && !isdigit(*it))
|
|
{
|
|
auto sourceNameStart = it;
|
|
while (it != line.end() && *it != ':')
|
|
++it;
|
|
sourceName = std::string(sourceNameStart, it);
|
|
expect(it, line.end(), ':');
|
|
}
|
|
locationStart = parseUnsignedInteger(it, line.end());
|
|
expect(it, line.end(), '-');
|
|
locationEnd = parseUnsignedInteger(it, line.end());
|
|
expect(it, line.end(), ')');
|
|
expect(it, line.end(), ':');
|
|
}
|
|
|
|
skipWhitespace(it, line.end());
|
|
|
|
string errorMessage(it, line.end());
|
|
expectations.emplace_back(SyntaxTestError{
|
|
move(errorType),
|
|
move(errorMessage),
|
|
move(sourceName),
|
|
locationStart,
|
|
locationEnd
|
|
});
|
|
}
|
|
return expectations;
|
|
}
|