mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Adds semantic tests to test framework and isoltest.
This commit is contained in:
parent
190634e1f9
commit
dacad629ef
@ -139,9 +139,16 @@ string IPCSocket::sendRequest(string const& _req)
|
|||||||
|
|
||||||
RPCSession& RPCSession::instance(const string& _path)
|
RPCSession& RPCSession::instance(const string& _path)
|
||||||
{
|
{
|
||||||
static RPCSession session(_path);
|
try
|
||||||
BOOST_REQUIRE_EQUAL(session.m_ipcSocket.path(), _path);
|
{
|
||||||
return session;
|
static RPCSession session(_path);
|
||||||
|
BOOST_REQUIRE_EQUAL(session.m_ipcSocket.path(), _path);
|
||||||
|
return session;
|
||||||
|
}
|
||||||
|
catch (std::exception const&)
|
||||||
|
{
|
||||||
|
BOOST_THROW_EXCEPTION(std::runtime_error("Error creating RPC session for socket: " + _path));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
string RPCSession::eth_getCode(string const& _address, string const& _blockNumber)
|
string RPCSession::eth_getCode(string const& _address, string const& _blockNumber)
|
||||||
|
@ -30,6 +30,14 @@ namespace solidity
|
|||||||
namespace test
|
namespace test
|
||||||
{
|
{
|
||||||
|
|
||||||
|
#define soltestAssert(CONDITION, DESCRIPTION) \
|
||||||
|
do \
|
||||||
|
{ \
|
||||||
|
if (!(CONDITION)) \
|
||||||
|
BOOST_THROW_EXCEPTION(runtime_error(DESCRIPTION)); \
|
||||||
|
} \
|
||||||
|
while (false)
|
||||||
|
|
||||||
/** Common superclass of SyntaxTest and SemanticsTest. */
|
/** Common superclass of SyntaxTest and SemanticsTest. */
|
||||||
class TestCase
|
class TestCase
|
||||||
{
|
{
|
||||||
|
@ -74,11 +74,13 @@ int registerTests(
|
|||||||
boost::unit_test::test_suite& _suite,
|
boost::unit_test::test_suite& _suite,
|
||||||
boost::filesystem::path const& _basepath,
|
boost::filesystem::path const& _basepath,
|
||||||
boost::filesystem::path const& _path,
|
boost::filesystem::path const& _path,
|
||||||
|
std::string const& _ipcPath,
|
||||||
TestCase::TestCaseCreator _testCaseCreator
|
TestCase::TestCaseCreator _testCaseCreator
|
||||||
)
|
)
|
||||||
{
|
{
|
||||||
int numTestsAdded = 0;
|
int numTestsAdded = 0;
|
||||||
fs::path fullpath = _basepath / _path;
|
fs::path fullpath = _basepath / _path;
|
||||||
|
TestCase::Config config{fullpath.string(), _ipcPath};
|
||||||
if (fs::is_directory(fullpath))
|
if (fs::is_directory(fullpath))
|
||||||
{
|
{
|
||||||
test_suite* sub_suite = BOOST_TEST_SUITE(_path.filename().string());
|
test_suite* sub_suite = BOOST_TEST_SUITE(_path.filename().string());
|
||||||
@ -87,7 +89,7 @@ int registerTests(
|
|||||||
fs::directory_iterator()
|
fs::directory_iterator()
|
||||||
))
|
))
|
||||||
if (fs::is_directory(entry.path()) || TestCase::isTestFilename(entry.path().filename()))
|
if (fs::is_directory(entry.path()) || TestCase::isTestFilename(entry.path().filename()))
|
||||||
numTestsAdded += registerTests(*sub_suite, _basepath, _path / entry.path().filename(), _testCaseCreator);
|
numTestsAdded += registerTests(*sub_suite, _basepath, _path / entry.path().filename(), _ipcPath, _testCaseCreator);
|
||||||
_suite.add(sub_suite);
|
_suite.add(sub_suite);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
@ -96,13 +98,13 @@ int registerTests(
|
|||||||
|
|
||||||
filenames.emplace_back(new string(_path.string()));
|
filenames.emplace_back(new string(_path.string()));
|
||||||
_suite.add(make_test_case(
|
_suite.add(make_test_case(
|
||||||
[fullpath, _testCaseCreator]
|
[config, _testCaseCreator]
|
||||||
{
|
{
|
||||||
BOOST_REQUIRE_NO_THROW({
|
BOOST_REQUIRE_NO_THROW({
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
stringstream errorStream;
|
stringstream errorStream;
|
||||||
if (!_testCaseCreator(fullpath.string())->run(errorStream))
|
if (!_testCaseCreator(config)->run(errorStream))
|
||||||
BOOST_ERROR("Test expectation mismatch.\n" + errorStream.str());
|
BOOST_ERROR("Test expectation mismatch.\n" + errorStream.str());
|
||||||
}
|
}
|
||||||
catch (boost::exception const& _e)
|
catch (boost::exception const& _e)
|
||||||
@ -142,6 +144,7 @@ test_suite* init_unit_test_suite( int /*argc*/, char* /*argv*/[] )
|
|||||||
master,
|
master,
|
||||||
options.testPath / ts.path,
|
options.testPath / ts.path,
|
||||||
ts.subpath,
|
ts.subpath,
|
||||||
|
options.ipcPath,
|
||||||
ts.testCaseCreator
|
ts.testCaseCreator
|
||||||
) > 0, std::string("no ") + ts.title + " tests found");
|
) > 0, std::string("no ") + ts.title + " tests found");
|
||||||
}
|
}
|
||||||
|
@ -28,30 +28,33 @@
|
|||||||
using namespace dev;
|
using namespace dev;
|
||||||
using namespace solidity;
|
using namespace solidity;
|
||||||
using namespace dev::solidity::test;
|
using namespace dev::solidity::test;
|
||||||
using namespace dev::solidity::test::formatting;
|
using namespace dev::formatting;
|
||||||
using namespace std;
|
using namespace std;
|
||||||
namespace fs = boost::filesystem;
|
|
||||||
using namespace boost;
|
using namespace boost;
|
||||||
using namespace boost::algorithm;
|
using namespace boost::algorithm;
|
||||||
using namespace boost::unit_test;
|
using namespace boost::unit_test;
|
||||||
|
namespace fs = boost::filesystem;
|
||||||
|
|
||||||
namespace
|
namespace
|
||||||
{
|
{
|
||||||
using ParamList = dev::solidity::test::ParameterList;
|
using FunctionCallTest = SemanticTest::FunctionCallTest;
|
||||||
using FunctionCallTest = dev::solidity::test::SemanticTest::FunctionCallTest;
|
|
||||||
using FunctionCall = dev::solidity::test::FunctionCall;
|
using FunctionCall = dev::solidity::test::FunctionCall;
|
||||||
|
using ParamList = dev::solidity::test::ParameterList;
|
||||||
|
|
||||||
string formatBytes(bytes const& _bytes, ParamList const& _params, bool const _formatInvalid = false)
|
|
||||||
|
string formatBytes(bytes const& _bytes, ParamList const& _params)
|
||||||
{
|
{
|
||||||
stringstream resultStream;
|
stringstream resultStream;
|
||||||
if (_bytes.empty())
|
if (_bytes.empty())
|
||||||
resultStream.str();
|
return {};
|
||||||
auto it = _bytes.begin();
|
auto it = _bytes.begin();
|
||||||
for (auto const& param: _params)
|
for (auto const& param: _params)
|
||||||
{
|
{
|
||||||
bytes byteRange{it, it + param.abiType.size};
|
long offset = static_cast<long>(param.abiType.size);
|
||||||
// FIXME Check range
|
auto offsetIter = it + offset;
|
||||||
// TODO Check range
|
soltestAssert(offsetIter <= _bytes.end(), "Byte range can not be extended past the end of given bytes.");
|
||||||
|
|
||||||
|
bytes byteRange{it, offsetIter};
|
||||||
switch (param.abiType.type)
|
switch (param.abiType.type)
|
||||||
{
|
{
|
||||||
case ABIType::SignedDec:
|
case ABIType::SignedDec:
|
||||||
@ -71,22 +74,29 @@ namespace
|
|||||||
resultStream << fromBigEndian<u256>(byteRange);
|
resultStream << fromBigEndian<u256>(byteRange);
|
||||||
break;
|
break;
|
||||||
case ABIType::Failure:
|
case ABIType::Failure:
|
||||||
// If expectations are empty, the encoding type is invalid.
|
|
||||||
// In order to still print the actual result even if
|
|
||||||
// empty expectations were detected, it must be forced.
|
|
||||||
if (_formatInvalid)
|
|
||||||
resultStream << fromBigEndian<u256>(byteRange);
|
|
||||||
break;
|
break;
|
||||||
case ABIType::None:
|
case ABIType::None:
|
||||||
// If expectations are empty, the encoding type is NONE.
|
|
||||||
if (_formatInvalid)
|
|
||||||
resultStream << fromBigEndian<u256>(byteRange);
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
it += param.abiType.size;
|
it += offset;
|
||||||
if (it != _bytes.end() && !(param.abiType.type == ABIType::None))
|
if (it != _bytes.end() && !(param.abiType.type == ABIType::None))
|
||||||
resultStream << ", ";
|
resultStream << ", ";
|
||||||
}
|
}
|
||||||
|
soltestAssert(it == _bytes.end(), "Parameter encoding too short for the given byte range.");
|
||||||
|
return resultStream.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
string formatRawArguments(ParamList const& _params, string const& _linePrefix = "")
|
||||||
|
{
|
||||||
|
stringstream resultStream;
|
||||||
|
for (auto const& param: _params)
|
||||||
|
{
|
||||||
|
if (param.format.newline)
|
||||||
|
resultStream << endl << _linePrefix << "//";
|
||||||
|
resultStream << " " << param.rawString;
|
||||||
|
if (¶m != &_params.back())
|
||||||
|
resultStream << ",";
|
||||||
|
}
|
||||||
return resultStream.str();
|
return resultStream.str();
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -94,41 +104,86 @@ namespace
|
|||||||
FunctionCallTest const& _test,
|
FunctionCallTest const& _test,
|
||||||
string const& _linePrefix = "",
|
string const& _linePrefix = "",
|
||||||
bool const _renderResult = false,
|
bool const _renderResult = false,
|
||||||
bool const _higlight = false
|
bool const _highlight = false
|
||||||
)
|
)
|
||||||
{
|
{
|
||||||
|
using namespace soltest;
|
||||||
|
using Token = soltest::Token;
|
||||||
|
|
||||||
stringstream _stream;
|
stringstream _stream;
|
||||||
FunctionCall call = _test.call;
|
FunctionCall call = _test.call;
|
||||||
bool hightlight = !_test.matchesExpectation() && _higlight;
|
bool highlight = !_test.matchesExpectation() && _highlight;
|
||||||
|
|
||||||
auto formatOutput = [&](bool const _singleLine)
|
auto formatOutput = [&](bool const _singleLine)
|
||||||
{
|
{
|
||||||
_stream << _linePrefix << "// " << call.signature;
|
string ws = " ";
|
||||||
|
string arrow = formatToken(Token::Arrow);
|
||||||
|
string colon = formatToken(Token::Colon);
|
||||||
|
string comma = formatToken(Token::Comma);
|
||||||
|
string comment = formatToken(Token::Comment);
|
||||||
|
string ether = formatToken(Token::Ether);
|
||||||
|
string newline = formatToken(Token::Newline);
|
||||||
|
string failure = formatToken(Token::Failure);
|
||||||
|
|
||||||
|
/// Prints the function signature. This is the same independent from the display-mode.
|
||||||
|
_stream << _linePrefix << newline << ws << call.signature;
|
||||||
if (call.value > u256(0))
|
if (call.value > u256(0))
|
||||||
_stream << TestFileParser::formatToken(SoltToken::Comma)
|
_stream << comma << ws << call.value << ws << ether;
|
||||||
<< call.value << " "
|
|
||||||
<< TestFileParser::formatToken(SoltToken::Ether);
|
|
||||||
if (!call.arguments.rawBytes().empty())
|
if (!call.arguments.rawBytes().empty())
|
||||||
_stream << ": "
|
{
|
||||||
<< formatBytes(call.arguments.rawBytes(), call.arguments.parameters);
|
string output = formatRawArguments(call.arguments.parameters, _linePrefix);
|
||||||
if (!_singleLine)
|
_stream << colon << output;
|
||||||
_stream << endl << _linePrefix << "// ";
|
}
|
||||||
|
|
||||||
|
/// Prints comments on the function parameters and the arrow taking
|
||||||
|
/// the display-mode into account.
|
||||||
if (_singleLine)
|
if (_singleLine)
|
||||||
_stream << " ";
|
{
|
||||||
_stream << "-> ";
|
if (!call.arguments.comment.empty())
|
||||||
if (!_singleLine)
|
_stream << ws << comment << call.arguments.comment << comment;
|
||||||
_stream << endl << _linePrefix << "// ";
|
_stream << ws << arrow << ws;
|
||||||
if (hightlight)
|
}
|
||||||
_stream << formatting::RED_BACKGROUND;
|
|
||||||
bytes output;
|
|
||||||
if (_renderResult)
|
|
||||||
output = call.expectations.rawBytes();
|
|
||||||
else
|
else
|
||||||
output = _test.rawBytes;
|
{
|
||||||
if (!output.empty())
|
_stream << endl << _linePrefix << newline << ws;
|
||||||
_stream << formatBytes(output, call.expectations.result);
|
if (!call.arguments.comment.empty())
|
||||||
if (hightlight)
|
{
|
||||||
_stream << formatting::RESET;
|
_stream << comment << call.arguments.comment << comment;
|
||||||
|
_stream << endl << _linePrefix << newline << ws;
|
||||||
|
}
|
||||||
|
_stream << arrow << ws;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Print either the expected output or the actual result output
|
||||||
|
string result;
|
||||||
|
if (!_renderResult)
|
||||||
|
{
|
||||||
|
bytes output = call.expectations.rawBytes();
|
||||||
|
bool const isFailure = call.expectations.failure;
|
||||||
|
result = isFailure ? failure : formatBytes(output, call.expectations.result);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
bytes output = _test.rawBytes;
|
||||||
|
bool const isFailure = _test.failure;
|
||||||
|
result = isFailure ? failure : formatBytes(output, call.expectations.result);
|
||||||
|
}
|
||||||
|
AnsiColorized(_stream, highlight, {RED_BACKGROUND}) << result;
|
||||||
|
|
||||||
|
/// Print comments on expectations taking the display-mode into account.
|
||||||
|
if (_singleLine)
|
||||||
|
{
|
||||||
|
if (!call.expectations.comment.empty())
|
||||||
|
_stream << ws << comment << call.expectations.comment << comment;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (!call.expectations.comment.empty())
|
||||||
|
{
|
||||||
|
_stream << endl << _linePrefix << newline << ws;
|
||||||
|
_stream << comment << call.expectations.comment << comment;
|
||||||
|
}
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
if (call.displayMode == FunctionCall::DisplayMode::SingleLine)
|
if (call.displayMode == FunctionCall::DisplayMode::SingleLine)
|
||||||
@ -145,8 +200,7 @@ SemanticTest::SemanticTest(string const& _filename, string const& _ipcPath):
|
|||||||
SolidityExecutionFramework(_ipcPath)
|
SolidityExecutionFramework(_ipcPath)
|
||||||
{
|
{
|
||||||
ifstream file(_filename);
|
ifstream file(_filename);
|
||||||
if (!file)
|
soltestAssert(file, "Cannot open test contract: \"" + _filename + "\".");
|
||||||
BOOST_THROW_EXCEPTION(runtime_error("Cannot open test contract: \"" + _filename + "\"."));
|
|
||||||
file.exceptions(ios::badbit);
|
file.exceptions(ios::badbit);
|
||||||
|
|
||||||
m_source = parseSource(file);
|
m_source = parseSource(file);
|
||||||
@ -155,8 +209,7 @@ SemanticTest::SemanticTest(string const& _filename, string const& _ipcPath):
|
|||||||
|
|
||||||
bool SemanticTest::run(ostream& _stream, string const& _linePrefix, bool const _formatted)
|
bool SemanticTest::run(ostream& _stream, string const& _linePrefix, bool const _formatted)
|
||||||
{
|
{
|
||||||
if (!deploy("", 0, bytes()))
|
soltestAssert(deploy("", 0, bytes()), "Failed to deploy contract.");
|
||||||
BOOST_THROW_EXCEPTION(runtime_error("Failed to deploy contract."));
|
|
||||||
|
|
||||||
bool success = true;
|
bool success = true;
|
||||||
for (auto& test: m_tests)
|
for (auto& test: m_tests)
|
||||||
@ -179,15 +232,15 @@ bool SemanticTest::run(ostream& _stream, string const& _linePrefix, bool const _
|
|||||||
|
|
||||||
if (!success)
|
if (!success)
|
||||||
{
|
{
|
||||||
FormattedScope(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Expected result:" << endl;
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Expected result:" << endl;
|
||||||
for (auto const& test: m_tests)
|
for (auto const& test: m_tests)
|
||||||
_stream << formatFunctionCallTest(test, _linePrefix, false, true);
|
_stream << formatFunctionCallTest(test, _linePrefix, false, true & _formatted);
|
||||||
|
|
||||||
FormattedScope(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Obtained result:" << endl;
|
AnsiColorized(_stream, _formatted, {BOLD, CYAN}) << _linePrefix << "Obtained result:" << endl;
|
||||||
for (auto const& test: m_tests)
|
for (auto const& test: m_tests)
|
||||||
_stream << formatFunctionCallTest(test, _linePrefix, true, true);
|
_stream << formatFunctionCallTest(test, _linePrefix, true, true & _formatted);
|
||||||
|
|
||||||
FormattedScope(_stream, _formatted, {BOLD, RED}) << _linePrefix
|
AnsiColorized(_stream, _formatted, {BOLD, RED}) << _linePrefix
|
||||||
<< "Attention: Updates on the test will apply the detected format displayed." << endl;
|
<< "Attention: Updates on the test will apply the detected format displayed." << endl;
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@ -202,10 +255,10 @@ void SemanticTest::printSource(ostream& _stream, string const& _linePrefix, bool
|
|||||||
_stream << _linePrefix << line << endl;
|
_stream << _linePrefix << line << endl;
|
||||||
}
|
}
|
||||||
|
|
||||||
void SemanticTest::printUpdatedExpectations(ostream& _stream, string const& _linePrefix) const
|
void SemanticTest::printUpdatedExpectations(ostream& _stream, string const&) const
|
||||||
{
|
{
|
||||||
for (auto const& test: m_tests)
|
for (auto const& test: m_tests)
|
||||||
_stream << formatFunctionCallTest(test, _linePrefix, false, false);
|
_stream << formatFunctionCallTest(test, "", true, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
void SemanticTest::parseExpectations(istream& _stream)
|
void SemanticTest::parseExpectations(istream& _stream)
|
||||||
|
@ -15,11 +15,11 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include <test/libsolidity/util/TestFileParser.h>
|
#include <test/libsolidity/util/TestFileParser.h>
|
||||||
#include <test/libsolidity/FormattedScope.h>
|
|
||||||
#include <test/libsolidity/SolidityExecutionFramework.h>
|
#include <test/libsolidity/SolidityExecutionFramework.h>
|
||||||
#include <test/libsolidity/AnalysisFramework.h>
|
#include <test/libsolidity/AnalysisFramework.h>
|
||||||
#include <test/TestCase.h>
|
#include <test/TestCase.h>
|
||||||
#include <liblangutil/Exceptions.h>
|
#include <liblangutil/Exceptions.h>
|
||||||
|
#include <libdevcore/AnsiColorized.h>
|
||||||
|
|
||||||
#include <iosfwd>
|
#include <iosfwd>
|
||||||
#include <string>
|
#include <string>
|
||||||
|
17
test/libsolidity/semanticTests/smoke_test.sol
Normal file
17
test/libsolidity/semanticTests/smoke_test.sol
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
contract C {
|
||||||
|
function f() public returns (uint) {
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
function g(uint x, uint y) public returns (uint) {
|
||||||
|
return x - y;
|
||||||
|
}
|
||||||
|
function h() public payable returns (uint) {
|
||||||
|
return f();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ----
|
||||||
|
// f() -> 1
|
||||||
|
// g(uint256,uint256): 1, -2 -> 3
|
||||||
|
// h(), 1 ether -> 1
|
||||||
|
// j() -> FAILURE
|
||||||
|
// i() # Does not exist. # -> FAILURE # Reverts. #
|
11
test/libsolidity/semanticTests/smoke_test_multiline.sol
Normal file
11
test/libsolidity/semanticTests/smoke_test_multiline.sol
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
contract C {
|
||||||
|
function f(uint a, uint b, uint c, uint d, uint e) public returns (uint) {
|
||||||
|
return a + b + c + d + e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ----
|
||||||
|
// f(uint256,uint256,uint256,uint256,uint256): 1, 1, 1, 1, 1
|
||||||
|
// -> 5
|
||||||
|
// g()
|
||||||
|
// # g() does not exist #
|
||||||
|
// -> FAILURE
|
@ -0,0 +1,17 @@
|
|||||||
|
contract C {
|
||||||
|
function f(uint a, uint b, uint c, uint d, uint e) public returns (uint) {
|
||||||
|
return a + b + c + d + e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ----
|
||||||
|
// f(uint256,uint256,uint256,uint256,uint256): 1, 1, 1, 1, 1
|
||||||
|
// # A comment on the function parameters. #
|
||||||
|
// -> 5
|
||||||
|
// f(uint256,uint256,uint256,uint256,uint256):
|
||||||
|
// 1,
|
||||||
|
// 1,
|
||||||
|
// 1,
|
||||||
|
// 1,
|
||||||
|
// 1
|
||||||
|
// -> 5
|
||||||
|
// # Should return sum of all parameters. #
|
@ -85,6 +85,8 @@ vector<dev::solidity::test::FunctionCall> TestFileParser::parseFunctionCalls()
|
|||||||
|
|
||||||
expect(Token::Arrow);
|
expect(Token::Arrow);
|
||||||
call.expectations = parseFunctionCallExpectations();
|
call.expectations = parseFunctionCallExpectations();
|
||||||
|
|
||||||
|
accept(Token::Newline, true);
|
||||||
call.expectations.comment = parseComment();
|
call.expectations.comment = parseComment();
|
||||||
|
|
||||||
calls.emplace_back(std::move(call));
|
calls.emplace_back(std::move(call));
|
||||||
@ -194,38 +196,45 @@ Parameter TestFileParser::parseParameter()
|
|||||||
if (accept(Token::Newline, true))
|
if (accept(Token::Newline, true))
|
||||||
parameter.format.newline = true;
|
parameter.format.newline = true;
|
||||||
auto literal = parseABITypeLiteral();
|
auto literal = parseABITypeLiteral();
|
||||||
parameter.rawBytes = literal.first;
|
parameter.rawBytes = get<0>(literal);
|
||||||
parameter.abiType = literal.second;
|
parameter.abiType = get<1>(literal);
|
||||||
|
parameter.rawString = get<2>(literal);
|
||||||
return parameter;
|
return parameter;
|
||||||
}
|
}
|
||||||
|
|
||||||
pair<bytes, ABIType> TestFileParser::parseABITypeLiteral()
|
tuple<bytes, ABIType, string> TestFileParser::parseABITypeLiteral()
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
u256 number{0};
|
u256 number{0};
|
||||||
ABIType abiType{ABIType::None, 0};
|
ABIType abiType{ABIType::None, 0};
|
||||||
|
string rawString;
|
||||||
|
|
||||||
if (accept(Token::Sub))
|
if (accept(Token::Sub))
|
||||||
{
|
{
|
||||||
abiType = ABIType{ABIType::SignedDec, 32};
|
abiType = ABIType{ABIType::SignedDec, 32};
|
||||||
expect(Token::Sub);
|
expect(Token::Sub);
|
||||||
number = convertNumber(parseNumber()) * -1;
|
rawString += formatToken(Token::Sub);
|
||||||
|
string parsed = parseNumber();
|
||||||
|
rawString += parsed;
|
||||||
|
number = convertNumber(parsed) * -1;
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
if (accept(Token::Number))
|
if (accept(Token::Number))
|
||||||
{
|
{
|
||||||
abiType = ABIType{ABIType::UnsignedDec, 32};
|
abiType = ABIType{ABIType::UnsignedDec, 32};
|
||||||
number = convertNumber(parseNumber());
|
string parsed = parseNumber();
|
||||||
|
rawString += parsed;
|
||||||
|
number = convertNumber(parsed);
|
||||||
}
|
}
|
||||||
else if (accept(Token::Failure, true))
|
else if (accept(Token::Failure, true))
|
||||||
{
|
{
|
||||||
abiType = ABIType{ABIType::Failure, 0};
|
abiType = ABIType{ABIType::Failure, 0};
|
||||||
return make_pair(bytes{}, abiType);
|
return make_tuple(bytes{}, abiType, rawString);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return make_pair(toBigEndian(number), abiType);
|
return make_tuple(toBigEndian(number), abiType, rawString);
|
||||||
}
|
}
|
||||||
catch (std::exception const&)
|
catch (std::exception const&)
|
||||||
{
|
{
|
||||||
|
@ -114,7 +114,7 @@ struct ABIType
|
|||||||
*/
|
*/
|
||||||
struct FormatInfo
|
struct FormatInfo
|
||||||
{
|
{
|
||||||
bool newline;
|
bool newline = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -132,6 +132,9 @@ struct Parameter
|
|||||||
/// compared to the actual result of a function call
|
/// compared to the actual result of a function call
|
||||||
/// and used for validating it.
|
/// and used for validating it.
|
||||||
bytes rawBytes;
|
bytes rawBytes;
|
||||||
|
/// Stores the raw string representation of this parameter.
|
||||||
|
/// Used to print the unformatted arguments of a function call.
|
||||||
|
std::string rawString;
|
||||||
/// Types that were used to encode `rawBytes`. Expectations
|
/// Types that were used to encode `rawBytes`. Expectations
|
||||||
/// are usually comma separated literals. Their type is auto-
|
/// are usually comma separated literals. Their type is auto-
|
||||||
/// detected and retained in order to format them later on.
|
/// detected and retained in order to format them later on.
|
||||||
@ -327,13 +330,15 @@ private:
|
|||||||
Parameter parseParameter();
|
Parameter parseParameter();
|
||||||
|
|
||||||
/// Parses and converts the current literal to its byte representation and
|
/// Parses and converts the current literal to its byte representation and
|
||||||
/// preserves the chosen ABI type. Based on that type information, the driver of
|
/// preserves the chosen ABI type, as well as a raw, unformatted string representation
|
||||||
/// this parser can format arguments, expectations and results. Supported types:
|
/// of this literal.
|
||||||
|
/// Based on the type information retrieved, the driver of this parser may format arguments,
|
||||||
|
/// expectations and results. Supported types:
|
||||||
/// - unsigned and signed decimal number literals.
|
/// - unsigned and signed decimal number literals.
|
||||||
/// Returns invalid ABI type for empty literal. This is needed in order
|
/// Returns invalid ABI type for empty literal. This is needed in order
|
||||||
/// to detect empty expectations. Throws a ParserError if data is encoded incorrectly or
|
/// to detect empty expectations. Throws a ParserError if data is encoded incorrectly or
|
||||||
/// if data type is not supported.
|
/// if data type is not supported.
|
||||||
std::pair<bytes, ABIType> parseABITypeLiteral();
|
std::tuple<bytes, ABIType, std::string> parseABITypeLiteral();
|
||||||
|
|
||||||
/// Recursively parses an identifier or a tuple definition that contains identifiers
|
/// Recursively parses an identifier or a tuple definition that contains identifiers
|
||||||
/// and / or parentheses like `((uint, uint), (uint, (uint, uint)), uint)`.
|
/// and / or parentheses like `((uint, uint), (uint, (uint, uint)), uint)`.
|
||||||
|
@ -56,7 +56,8 @@ void testFunctionCall(
|
|||||||
bytes _expectations = bytes{},
|
bytes _expectations = bytes{},
|
||||||
u256 _value = 0,
|
u256 _value = 0,
|
||||||
string _argumentComment = "",
|
string _argumentComment = "",
|
||||||
string _expectationComment = ""
|
string _expectationComment = "",
|
||||||
|
vector<string> _rawArguments = vector<string>{}
|
||||||
)
|
)
|
||||||
{
|
{
|
||||||
BOOST_REQUIRE_EQUAL(_call.expectations.failure, _failure);
|
BOOST_REQUIRE_EQUAL(_call.expectations.failure, _failure);
|
||||||
@ -67,6 +68,17 @@ void testFunctionCall(
|
|||||||
BOOST_REQUIRE_EQUAL(_call.value, _value);
|
BOOST_REQUIRE_EQUAL(_call.value, _value);
|
||||||
BOOST_REQUIRE_EQUAL(_call.arguments.comment, _argumentComment);
|
BOOST_REQUIRE_EQUAL(_call.arguments.comment, _argumentComment);
|
||||||
BOOST_REQUIRE_EQUAL(_call.expectations.comment, _expectationComment);
|
BOOST_REQUIRE_EQUAL(_call.expectations.comment, _expectationComment);
|
||||||
|
|
||||||
|
if (!_rawArguments.empty())
|
||||||
|
{
|
||||||
|
BOOST_REQUIRE_EQUAL(_call.arguments.parameters.size(), _rawArguments.size());
|
||||||
|
size_t index = 0;
|
||||||
|
for (Parameter const& param: _call.arguments.parameters)
|
||||||
|
{
|
||||||
|
BOOST_REQUIRE_EQUAL(param.rawString, _rawArguments[index]);
|
||||||
|
++index;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
BOOST_AUTO_TEST_SUITE(TestFileParserTest)
|
BOOST_AUTO_TEST_SUITE(TestFileParserTest)
|
||||||
@ -112,11 +124,16 @@ BOOST_AUTO_TEST_CASE(call_arguments_comments_success)
|
|||||||
{
|
{
|
||||||
char const* source = R"(
|
char const* source = R"(
|
||||||
// f(uint256, uint256): 1, 1
|
// f(uint256, uint256): 1, 1
|
||||||
|
// # Comment on the parameters. #
|
||||||
// ->
|
// ->
|
||||||
// # This call should not return a value, but still succeed. #
|
// # This call should not return a value, but still succeed. #
|
||||||
|
// f()
|
||||||
|
// # Comment on no parameters. #
|
||||||
|
// -> 1
|
||||||
|
// # This comment should be parsed. #
|
||||||
)";
|
)";
|
||||||
auto const calls = parse(source);
|
auto const calls = parse(source);
|
||||||
BOOST_REQUIRE_EQUAL(calls.size(), 1);
|
BOOST_REQUIRE_EQUAL(calls.size(), 2);
|
||||||
testFunctionCall(
|
testFunctionCall(
|
||||||
calls.at(0),
|
calls.at(0),
|
||||||
Mode::MultiLine,
|
Mode::MultiLine,
|
||||||
@ -125,9 +142,20 @@ BOOST_AUTO_TEST_CASE(call_arguments_comments_success)
|
|||||||
fmt::encodeArgs(1, 1),
|
fmt::encodeArgs(1, 1),
|
||||||
fmt::encodeArgs(),
|
fmt::encodeArgs(),
|
||||||
0,
|
0,
|
||||||
"",
|
" Comment on the parameters. ",
|
||||||
" This call should not return a value, but still succeed. "
|
" This call should not return a value, but still succeed. "
|
||||||
);
|
);
|
||||||
|
testFunctionCall(
|
||||||
|
calls.at(1),
|
||||||
|
Mode::MultiLine,
|
||||||
|
"f()",
|
||||||
|
false,
|
||||||
|
fmt::encodeArgs(),
|
||||||
|
fmt::encodeArgs(1),
|
||||||
|
0,
|
||||||
|
" Comment on no parameters. ",
|
||||||
|
" This comment should be parsed. "
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
BOOST_AUTO_TEST_CASE(simple_single_line_call_comment_success)
|
BOOST_AUTO_TEST_CASE(simple_single_line_call_comment_success)
|
||||||
@ -383,7 +411,7 @@ BOOST_AUTO_TEST_CASE(call_multiple_arguments_mixed_format)
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
BOOST_AUTO_TEST_CASE(call_signature)
|
BOOST_AUTO_TEST_CASE(call_signature_valid)
|
||||||
{
|
{
|
||||||
char const* source = R"(
|
char const* source = R"(
|
||||||
// f(uint256, uint8, string) -> FAILURE
|
// f(uint256, uint8, string) -> FAILURE
|
||||||
@ -395,6 +423,27 @@ BOOST_AUTO_TEST_CASE(call_signature)
|
|||||||
testFunctionCall(calls.at(1), Mode::SingleLine, "f(invalid,xyz,foo)", true);
|
testFunctionCall(calls.at(1), Mode::SingleLine, "f(invalid,xyz,foo)", true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
BOOST_AUTO_TEST_CASE(call_raw_arguments)
|
||||||
|
{
|
||||||
|
char const* source = R"(
|
||||||
|
// f(): 1, -2, -3 ->
|
||||||
|
)";
|
||||||
|
auto const calls = parse(source);
|
||||||
|
BOOST_REQUIRE_EQUAL(calls.size(), 1);
|
||||||
|
testFunctionCall(
|
||||||
|
calls.at(0),
|
||||||
|
Mode::SingleLine,
|
||||||
|
"f()",
|
||||||
|
false,
|
||||||
|
fmt::encodeArgs(1, -2, -3),
|
||||||
|
fmt::encodeArgs(),
|
||||||
|
0,
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
{"1", "-2", "-3"}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
BOOST_AUTO_TEST_CASE(call_newline_invalid)
|
BOOST_AUTO_TEST_CASE(call_newline_invalid)
|
||||||
{
|
{
|
||||||
char const* source = R"(
|
char const* source = R"(
|
||||||
|
@ -64,8 +64,9 @@ public:
|
|||||||
TestCase::TestCaseCreator _testCaseCreator,
|
TestCase::TestCaseCreator _testCaseCreator,
|
||||||
string const& _name,
|
string const& _name,
|
||||||
fs::path const& _path,
|
fs::path const& _path,
|
||||||
|
string const& _ipcPath,
|
||||||
bool _formatted
|
bool _formatted
|
||||||
): m_testCaseCreator(_testCaseCreator), m_formatted(_formatted), m_name(_name), m_path(_path)
|
): m_testCaseCreator(_testCaseCreator), m_name(_name), m_path(_path), m_ipcPath(_ipcPath), m_formatted(_formatted)
|
||||||
{}
|
{}
|
||||||
|
|
||||||
enum class Result
|
enum class Result
|
||||||
@ -81,6 +82,7 @@ public:
|
|||||||
TestCase::TestCaseCreator _testCaseCreator,
|
TestCase::TestCaseCreator _testCaseCreator,
|
||||||
fs::path const& _basepath,
|
fs::path const& _basepath,
|
||||||
fs::path const& _path,
|
fs::path const& _path,
|
||||||
|
string const& _ipcPath,
|
||||||
bool const _formatted
|
bool const _formatted
|
||||||
);
|
);
|
||||||
|
|
||||||
@ -96,9 +98,10 @@ private:
|
|||||||
Request handleResponse(bool const _exception);
|
Request handleResponse(bool const _exception);
|
||||||
|
|
||||||
TestCase::TestCaseCreator m_testCaseCreator;
|
TestCase::TestCaseCreator m_testCaseCreator;
|
||||||
bool const m_formatted = false;
|
|
||||||
string const m_name;
|
string const m_name;
|
||||||
fs::path const m_path;
|
fs::path const m_path;
|
||||||
|
string m_ipcPath;
|
||||||
|
bool const m_formatted = false;
|
||||||
unique_ptr<TestCase> m_test;
|
unique_ptr<TestCase> m_test;
|
||||||
static bool m_exitRequested;
|
static bool m_exitRequested;
|
||||||
};
|
};
|
||||||
@ -115,25 +118,25 @@ TestTool::Result TestTool::process()
|
|||||||
|
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
m_test = m_testCaseCreator(m_path.string());
|
m_test = m_testCaseCreator(TestCase::Config{m_path.string(), m_ipcPath});
|
||||||
success = m_test->run(outputMessages, " ", m_formatted);
|
success = m_test->run(outputMessages, " ", m_formatted);
|
||||||
}
|
}
|
||||||
catch(boost::exception const& _e)
|
catch(boost::exception const& _e)
|
||||||
{
|
{
|
||||||
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
||||||
"Exception during syntax test: " << boost::diagnostic_information(_e) << endl;
|
"Exception during test: " << boost::diagnostic_information(_e) << endl;
|
||||||
return Result::Exception;
|
return Result::Exception;
|
||||||
}
|
}
|
||||||
catch (std::exception const& _e)
|
catch (std::exception const& _e)
|
||||||
{
|
{
|
||||||
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
||||||
"Exception during syntax test: " << _e.what() << endl;
|
"Exception during test: " << _e.what() << endl;
|
||||||
return Result::Exception;
|
return Result::Exception;
|
||||||
}
|
}
|
||||||
catch (...)
|
catch (...)
|
||||||
{
|
{
|
||||||
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
AnsiColorized(cout, m_formatted, {BOLD, RED}) <<
|
||||||
"Unknown exception during syntax test." << endl;
|
"Unknown exception during test." << endl;
|
||||||
return Result::Exception;
|
return Result::Exception;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -199,6 +202,7 @@ TestStats TestTool::processPath(
|
|||||||
TestCase::TestCaseCreator _testCaseCreator,
|
TestCase::TestCaseCreator _testCaseCreator,
|
||||||
fs::path const& _basepath,
|
fs::path const& _basepath,
|
||||||
fs::path const& _path,
|
fs::path const& _path,
|
||||||
|
string const& _ipcPath,
|
||||||
bool const _formatted
|
bool const _formatted
|
||||||
)
|
)
|
||||||
{
|
{
|
||||||
@ -230,7 +234,7 @@ TestStats TestTool::processPath(
|
|||||||
else
|
else
|
||||||
{
|
{
|
||||||
++testCount;
|
++testCount;
|
||||||
TestTool testTool(_testCaseCreator, currentPath.string(), fullpath, _formatted);
|
TestTool testTool(_testCaseCreator, currentPath.string(), fullpath, _ipcPath, _formatted);
|
||||||
auto result = testTool.process();
|
auto result = testTool.process();
|
||||||
|
|
||||||
switch(result)
|
switch(result)
|
||||||
@ -291,6 +295,7 @@ boost::optional<TestStats> runTestSuite(
|
|||||||
string const& _name,
|
string const& _name,
|
||||||
fs::path const& _basePath,
|
fs::path const& _basePath,
|
||||||
fs::path const& _subdirectory,
|
fs::path const& _subdirectory,
|
||||||
|
string const& _ipcPath,
|
||||||
TestCase::TestCaseCreator _testCaseCreator,
|
TestCase::TestCaseCreator _testCaseCreator,
|
||||||
bool _formatted
|
bool _formatted
|
||||||
)
|
)
|
||||||
@ -303,7 +308,7 @@ boost::optional<TestStats> runTestSuite(
|
|||||||
return {};
|
return {};
|
||||||
}
|
}
|
||||||
|
|
||||||
TestStats stats = TestTool::processPath(_testCaseCreator, _basePath, _subdirectory, _formatted);
|
TestStats stats = TestTool::processPath(_testCaseCreator, _basePath, _subdirectory, _ipcPath, _formatted);
|
||||||
|
|
||||||
cout << endl << _name << " Test Summary: ";
|
cout << endl << _name << " Test Summary: ";
|
||||||
AnsiColorized(cout, _formatted, {BOLD, stats ? GREEN : RED}) <<
|
AnsiColorized(cout, _formatted, {BOLD, stats ? GREEN : RED}) <<
|
||||||
@ -327,11 +332,13 @@ int main(int argc, char *argv[])
|
|||||||
TestTool::editor = "/usr/bin/editor";
|
TestTool::editor = "/usr/bin/editor";
|
||||||
|
|
||||||
fs::path testPath;
|
fs::path testPath;
|
||||||
|
string ipcPath;
|
||||||
|
bool disableIPC = false;
|
||||||
bool disableSMT = false;
|
bool disableSMT = false;
|
||||||
bool formatted = true;
|
bool formatted = true;
|
||||||
po::options_description options(
|
po::options_description options(
|
||||||
R"(isoltest, tool for interactively managing test contracts.
|
R"(isoltest, tool for interactively managing test contracts.
|
||||||
Usage: isoltest [Options] --testpath path
|
Usage: isoltest [Options] --ipcpath ipcpath
|
||||||
Interactively validates test contracts.
|
Interactively validates test contracts.
|
||||||
|
|
||||||
Allowed options)",
|
Allowed options)",
|
||||||
@ -340,6 +347,8 @@ Allowed options)",
|
|||||||
options.add_options()
|
options.add_options()
|
||||||
("help", "Show this help screen.")
|
("help", "Show this help screen.")
|
||||||
("testpath", po::value<fs::path>(&testPath), "path to test files")
|
("testpath", po::value<fs::path>(&testPath), "path to test files")
|
||||||
|
("ipcpath", po::value<string>(&ipcPath), "path to ipc socket")
|
||||||
|
("no-ipc", "disable semantic tests")
|
||||||
("no-smt", "disable SMT checker")
|
("no-smt", "disable SMT checker")
|
||||||
("no-color", "don't use colors")
|
("no-color", "don't use colors")
|
||||||
("editor", po::value<string>(&TestTool::editor), "editor for opening contracts");
|
("editor", po::value<string>(&TestTool::editor), "editor for opening contracts");
|
||||||
@ -362,8 +371,23 @@ Allowed options)",
|
|||||||
|
|
||||||
po::notify(arguments);
|
po::notify(arguments);
|
||||||
|
|
||||||
|
if (arguments.count("no-ipc"))
|
||||||
|
disableIPC = true;
|
||||||
|
else
|
||||||
|
{
|
||||||
|
solAssert(
|
||||||
|
!ipcPath.empty(),
|
||||||
|
"No ipc path specified. The --ipcpath argument is required, unless --no-ipc is used."
|
||||||
|
);
|
||||||
|
solAssert(
|
||||||
|
fs::exists(ipcPath),
|
||||||
|
"Invalid ipc path specified."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
if (arguments.count("no-smt"))
|
if (arguments.count("no-smt"))
|
||||||
disableSMT = true;
|
disableSMT = true;
|
||||||
|
|
||||||
}
|
}
|
||||||
catch (std::exception const& _exception)
|
catch (std::exception const& _exception)
|
||||||
{
|
{
|
||||||
@ -380,10 +404,13 @@ Allowed options)",
|
|||||||
// Interactive tests are added in InteractiveTests.h
|
// Interactive tests are added in InteractiveTests.h
|
||||||
for (auto const& ts: g_interactiveTestsuites)
|
for (auto const& ts: g_interactiveTestsuites)
|
||||||
{
|
{
|
||||||
|
if (ts.ipc && disableIPC)
|
||||||
|
continue;
|
||||||
|
|
||||||
if (ts.smt && disableSMT)
|
if (ts.smt && disableSMT)
|
||||||
continue;
|
continue;
|
||||||
|
|
||||||
if (auto stats = runTestSuite(ts.title, testPath / ts.path, ts.subpath, ts.testCaseCreator, formatted))
|
if (auto stats = runTestSuite(ts.title, testPath / ts.path, ts.subpath, ipcPath, ts.testCaseCreator, formatted))
|
||||||
global_stats += *stats;
|
global_stats += *stats;
|
||||||
else
|
else
|
||||||
return 1;
|
return 1;
|
||||||
|
Loading…
Reference in New Issue
Block a user