solidity/test/TestCase.cpp

154 lines
4.7 KiB
C++
Raw Normal View History

/*
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
2020-02-18 16:13:13 +00:00
#include <test/Common.h>
#include <test/TestCase.h>
#include <libsolutil/AnsiColorized.h>
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <iostream>
#include <stdexcept>
using namespace std;
using namespace solidity;
using namespace solidity::frontend;
using namespace solidity::frontend::test;
void TestCase::printSettings(ostream& _stream, const string& _linePrefix, const bool)
{
2020-03-06 00:22:51 +00:00
auto& settings = m_reader.settings();
if (settings.empty())
return;
_stream << _linePrefix << "// ====" << endl;
2020-03-06 00:22:51 +00:00
for (auto const& setting: settings)
_stream << _linePrefix << "// " << setting.first << ": " << setting.second << endl;
}
void TestCase::printUpdatedSettings(std::ostream& _stream, std::string const& _linePrefix)
{
printSettings(_stream, _linePrefix);
}
bool TestCase::isTestFilename(boost::filesystem::path const& _filename)
{
2018-10-09 13:43:55 +00:00
string extension = _filename.extension().string();
return (extension == ".sol" || extension == ".yul") &&
!boost::starts_with(_filename.string(), "~") &&
!boost::starts_with(_filename.string(), ".");
}
2020-02-18 16:13:13 +00:00
bool TestCase::shouldRun()
{
2020-03-06 00:22:51 +00:00
m_reader.ensureAllSettingsRead();
2020-02-18 16:13:13 +00:00
return m_shouldRun;
}
void TestCase::expect(string::iterator& _it, string::iterator _end, string::value_type _c)
{
if (_it == _end || *_it != _c)
throw runtime_error(string("Invalid test expectation. Expected: \"") + _c + "\".");
++_it;
}
void TestCase::printIndented(ostream& _stream, string const& _output, string const& _linePrefix) const
{
stringstream output(_output);
string line;
while (getline(output, line))
if (line.empty())
// Avoid trailing spaces.
_stream << boost::trim_right_copy(_linePrefix) << endl;
else
_stream << _linePrefix << line << endl;
}
void TestCase::printSource(ostream& _stream, string const& _linePrefix, bool const) const
{
printIndented(_stream, m_source, _linePrefix);
}
void TestCase::printUpdatedExpectations(ostream& _stream, string const& _linePrefix) const
{
printIndented(_stream, m_obtainedResult, _linePrefix);
}
TestCase::TestResult TestCase::checkResult(std::ostream& _stream, const std::string& _linePrefix, bool const _formatted)
{
if (m_expectation != m_obtainedResult)
{
string nextIndentLevel = _linePrefix + " ";
util::AnsiColorized(_stream, _formatted, {util::formatting::BOLD, util::formatting::CYAN})
<< _linePrefix << "Expected result:" << endl;
// TODO could compute a simple diff with highlighted lines
printIndented(_stream, m_expectation, nextIndentLevel);
util::AnsiColorized(_stream, _formatted, {util::formatting::BOLD, util::formatting::CYAN})
<< _linePrefix << "Obtained result:" << endl;
printIndented(_stream, m_obtainedResult, nextIndentLevel);
return TestResult::Failure;
}
return TestResult::Success;
}
2020-03-06 00:22:51 +00:00
EVMVersionRestrictedTestCase::EVMVersionRestrictedTestCase(string const& _filename):
TestCase(_filename)
{
string versionString = m_reader.stringSetting("EVMVersion", "any");
if (versionString == "any")
2020-02-18 16:13:13 +00:00
return;
string comparator;
size_t versionBegin = 0;
for (auto character: versionString)
if (!isalpha(character))
{
comparator += character;
versionBegin++;
}
else
break;
versionString = versionString.substr(versionBegin);
std::optional<langutil::EVMVersion> version = langutil::EVMVersion::fromString(versionString);
if (!version)
BOOST_THROW_EXCEPTION(runtime_error{"Invalid EVM version: \"" + versionString + "\""});
2020-02-18 16:13:13 +00:00
langutil::EVMVersion evmVersion = solidity::test::CommonOptions::get().evmVersion();
bool comparisonResult;
if (comparator == ">")
2020-02-18 16:13:13 +00:00
comparisonResult = evmVersion > version;
else if (comparator == ">=")
2020-02-18 16:13:13 +00:00
comparisonResult = evmVersion >= version;
else if (comparator == "<")
2020-02-18 16:13:13 +00:00
comparisonResult = evmVersion < version;
else if (comparator == "<=")
2020-02-18 16:13:13 +00:00
comparisonResult = evmVersion <= version;
else if (comparator == "=")
2020-02-18 16:13:13 +00:00
comparisonResult = evmVersion == version;
else if (comparator == "!")
2020-02-18 16:13:13 +00:00
comparisonResult = !(evmVersion == version);
else
BOOST_THROW_EXCEPTION(runtime_error{"Invalid EVM comparator: \"" + comparator + "\""});
2020-02-18 16:13:13 +00:00
if (!comparisonResult)
m_shouldRun = false;
}