solidity/test/libsolidity/SolidityExecutionFramework.h

309 lines
9.6 KiB
C
Raw Normal View History

2014-12-11 15:37:17 +00:00
/*
This file is part of cpp-ethereum.
cpp-ethereum 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.
cpp-ethereum 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 cpp-ethereum. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Framework for executing Solidity contracts and testing them against C++ implementation.
*/
#pragma once
Make the Solidity repository standalone. This commit is the culmination of several months of work to decouple Solidity from the webthree-umbrella so that it can be developed in parallel with cpp-ethereum (the Ethereum C++ runtime) and so that even for the Solidity unit-tests there is no hard-dependency onto the C++ runtime. The Tests-over-IPC refactoring was a major step in the same process which was already committed. This commit contains the following changes: - A subset of the CMake functionality in webthree-helpers was extracted and tailored for Solidity into ./cmake. Further cleanup is certainly possible. - A subset of the libdevcore functionality in libweb3core was extracted and tailored for Solidity into ./libdevcore. Further cleanup is certainly possible - The gas price constants in EVMSchedule were orphaned into libevmasm. - Some other refactorings and cleanups were made to sever unnecessary EVM dependencies in the Solidity unit-tests. - TravisCI and Appveyor support was added, covering builds and running of the unit-tests (Linux and macOS only for now) - A bug-fix was made to get the Tests-over-IPC running on macOS. - There are still reliability issues in the unit-tests, which need immediate attention. The Travis build has been flipped to run the unit-tests 5 times, to try to flush these out. - The Emscripten automation which was previously in webthree-umbrella was merged into the TravisCI automation here. - The development ZIP deployment step has been commented out, but we will want to read that ONLY for release branch. Further iteration on these changes will definitely be needed, but I feel these have got to sufficient maturity than holding them back further isn't winning us anything. It is go time :-)
2016-08-01 05:25:37 +00:00
#include <functional>
2015-04-20 20:48:53 +00:00
#include "../TestHelper.h"
#include "../RPCSession.h"
Make the Solidity repository standalone. This commit is the culmination of several months of work to decouple Solidity from the webthree-umbrella so that it can be developed in parallel with cpp-ethereum (the Ethereum C++ runtime) and so that even for the Solidity unit-tests there is no hard-dependency onto the C++ runtime. The Tests-over-IPC refactoring was a major step in the same process which was already committed. This commit contains the following changes: - A subset of the CMake functionality in webthree-helpers was extracted and tailored for Solidity into ./cmake. Further cleanup is certainly possible. - A subset of the libdevcore functionality in libweb3core was extracted and tailored for Solidity into ./libdevcore. Further cleanup is certainly possible - The gas price constants in EVMSchedule were orphaned into libevmasm. - Some other refactorings and cleanups were made to sever unnecessary EVM dependencies in the Solidity unit-tests. - TravisCI and Appveyor support was added, covering builds and running of the unit-tests (Linux and macOS only for now) - A bug-fix was made to get the Tests-over-IPC running on macOS. - There are still reliability issues in the unit-tests, which need immediate attention. The Travis build has been flipped to run the unit-tests 5 times, to try to flush these out. - The Emscripten automation which was previously in webthree-umbrella was merged into the TravisCI automation here. - The development ZIP deployment step has been commented out, but we will want to read that ONLY for release branch. Further iteration on these changes will definitely be needed, but I feel these have got to sufficient maturity than holding them back further isn't winning us anything. It is go time :-)
2016-08-01 05:25:37 +00:00
#include <libdevcore/ABI.h>
#include <libdevcore/FixedHash.h>
#include <libevmasm/Instruction.h>
2015-10-20 22:21:52 +00:00
#include <libsolidity/interface/CompilerStack.h>
#include <libsolidity/interface/Exceptions.h>
2016-08-06 11:27:29 +00:00
#include <libsolidity/interface/SourceReferenceFormatter.h>
2014-12-11 15:37:17 +00:00
namespace dev
{
namespace solidity
{
Make the Solidity repository standalone. This commit is the culmination of several months of work to decouple Solidity from the webthree-umbrella so that it can be developed in parallel with cpp-ethereum (the Ethereum C++ runtime) and so that even for the Solidity unit-tests there is no hard-dependency onto the C++ runtime. The Tests-over-IPC refactoring was a major step in the same process which was already committed. This commit contains the following changes: - A subset of the CMake functionality in webthree-helpers was extracted and tailored for Solidity into ./cmake. Further cleanup is certainly possible. - A subset of the libdevcore functionality in libweb3core was extracted and tailored for Solidity into ./libdevcore. Further cleanup is certainly possible - The gas price constants in EVMSchedule were orphaned into libevmasm. - Some other refactorings and cleanups were made to sever unnecessary EVM dependencies in the Solidity unit-tests. - TravisCI and Appveyor support was added, covering builds and running of the unit-tests (Linux and macOS only for now) - A bug-fix was made to get the Tests-over-IPC running on macOS. - There are still reliability issues in the unit-tests, which need immediate attention. The Travis build has been flipped to run the unit-tests 5 times, to try to flush these out. - The Emscripten automation which was previously in webthree-umbrella was merged into the TravisCI automation here. - The development ZIP deployment step has been commented out, but we will want to read that ONLY for release branch. Further iteration on these changes will definitely be needed, but I feel these have got to sufficient maturity than holding them back further isn't winning us anything. It is go time :-)
2016-08-01 05:25:37 +00:00
/// An Ethereum address: 20 bytes.
/// @NOTE This is not endian-specific; it's just a bunch of bytes.
using Address = h160;
// The various denominations; here for ease of use where needed within code.
static const u256 ether = exp10<18>();
static const u256 finney = exp10<15>();
static const u256 szabo = exp10<12>();
static const u256 shannon = exp10<9>();
static const u256 wei = exp10<0>();
2014-12-11 15:37:17 +00:00
namespace test
{
class ExecutionFramework
{
2014-12-11 15:37:17 +00:00
public:
2016-06-09 16:54:29 +00:00
ExecutionFramework();
2014-12-11 15:37:17 +00:00
bytes const& compileAndRunWithoutCheck(
std::string const& _sourceCode,
u256 const& _value = 0,
std::string const& _contractName = "",
2015-09-10 17:40:07 +00:00
bytes const& _arguments = bytes(),
std::map<std::string, Address> const& _libraryAddresses = std::map<std::string, Address>()
)
2014-12-11 15:37:17 +00:00
{
2016-08-19 17:57:21 +00:00
// Silence compiler version warning
2016-08-24 10:15:35 +00:00
std::string sourceCode = "pragma solidity >=0.0;\n" + _sourceCode;
2016-08-15 14:58:01 +00:00
m_compiler.reset(false);
2016-08-19 17:57:21 +00:00
m_compiler.addSource("", sourceCode);
2016-08-06 11:27:29 +00:00
if (!m_compiler.compile(m_optimize, m_optimizeRuns))
{
for (auto const& error: m_compiler.errors())
SourceReferenceFormatter::printExceptionInformation(
std::cerr,
*error,
(error->type() == Error::Type::Warning) ? "Warning" : "Error",
[&](std::string const& _sourceName) -> solidity::Scanner const& { return m_compiler.scanner(_sourceName); }
);
BOOST_ERROR("Compiling contract failed");
}
2015-09-10 17:40:07 +00:00
eth::LinkerObject obj = m_compiler.object(_contractName);
obj.link(_libraryAddresses);
BOOST_REQUIRE(obj.linkReferences.empty());
sendMessage(obj.bytecode + _arguments, true, _value);
return m_output;
}
bytes const& compileAndRun(
std::string const& _sourceCode,
u256 const& _value = 0,
std::string const& _contractName = "",
2015-09-10 17:40:07 +00:00
bytes const& _arguments = bytes(),
std::map<std::string, Address> const& _libraryAddresses = std::map<std::string, Address>()
)
{
2015-09-10 17:40:07 +00:00
compileAndRunWithoutCheck(_sourceCode, _value, _contractName, _arguments, _libraryAddresses);
2014-12-11 15:37:17 +00:00
BOOST_REQUIRE(!m_output.empty());
return m_output;
}
2015-01-08 23:58:32 +00:00
template <class... Args>
bytes const& callContractFunctionWithValue(std::string _sig, u256 const& _value, Args const&... _arguments)
2014-12-11 15:37:17 +00:00
{
FixedHash<4> hash(dev::sha3(_sig));
2015-01-08 23:58:32 +00:00
sendMessage(hash.asBytes() + encodeArgs(_arguments...), false, _value);
2014-12-11 15:37:17 +00:00
return m_output;
}
template <class... Args>
bytes const& callContractFunction(std::string _sig, Args const&... _arguments)
2014-12-11 15:37:17 +00:00
{
2015-01-08 23:58:32 +00:00
return callContractFunctionWithValue(_sig, 0, _arguments...);
2014-12-11 15:37:17 +00:00
}
template <class CppFunction, class... Args>
void testSolidityAgainstCpp(std::string _sig, CppFunction const& _cppFunction, Args const&... _arguments)
2014-12-11 15:37:17 +00:00
{
bytes solidityResult = callContractFunction(_sig, _arguments...);
2014-12-11 15:37:17 +00:00
bytes cppResult = callCppAndEncodeResult(_cppFunction, _arguments...);
BOOST_CHECK_MESSAGE(
solidityResult == cppResult,
"Computed values do not match.\nSolidity: " +
toHex(solidityResult) +
"\nC++: " +
2016-06-09 12:57:16 +00:00
toHex(cppResult)
);
2014-12-11 15:37:17 +00:00
}
template <class CppFunction, class... Args>
void testSolidityAgainstCppOnRange(std::string _sig, CppFunction const& _cppFunction, u256 const& _rangeStart, u256 const& _rangeEnd)
2014-12-11 15:37:17 +00:00
{
for (u256 argument = _rangeStart; argument < _rangeEnd; ++argument)
{
bytes solidityResult = callContractFunction(_sig, argument);
2014-12-11 15:37:17 +00:00
bytes cppResult = callCppAndEncodeResult(_cppFunction, argument);
BOOST_CHECK_MESSAGE(
solidityResult == cppResult,
"Computed values do not match.\nSolidity: " +
toHex(solidityResult) +
"\nC++: " +
toHex(cppResult) +
"\nArgument: " +
toHex(encode(argument))
);
2014-12-11 15:37:17 +00:00
}
}
2015-01-08 23:58:32 +00:00
static bytes encode(bool _value) { return encode(byte(_value)); }
static bytes encode(int _value) { return encode(u256(_value)); }
2015-07-29 17:31:25 +00:00
static bytes encode(size_t _value) { return encode(u256(_value)); }
2015-01-08 23:58:32 +00:00
static bytes encode(char const* _value) { return encode(std::string(_value)); }
static bytes encode(byte _value) { return bytes(31, 0) + bytes{_value}; }
static bytes encode(u256 const& _value) { return toBigEndian(_value); }
static bytes encode(h256 const& _value) { return _value.asBytes(); }
2015-01-08 23:58:32 +00:00
static bytes encode(bytes const& _value, bool _padLeft = true)
2014-12-11 15:37:17 +00:00
{
2015-01-08 23:58:32 +00:00
bytes padding = bytes((32 - _value.size() % 32) % 32, 0);
return _padLeft ? padding + _value : _value + padding;
2014-12-11 15:37:17 +00:00
}
2015-01-08 23:58:32 +00:00
static bytes encode(std::string const& _value) { return encode(asBytes(_value), false); }
2015-06-23 12:55:33 +00:00
template <class _T>
static bytes encode(std::vector<_T> const& _value)
{
bytes ret;
for (auto const& v: _value)
ret += encode(v);
return ret;
}
2014-12-11 15:37:17 +00:00
2015-01-08 23:58:32 +00:00
template <class FirstArg, class... Args>
static bytes encodeArgs(FirstArg const& _firstArg, Args const&... _followingArgs)
{
return encode(_firstArg) + encodeArgs(_followingArgs...);
}
static bytes encodeArgs()
{
return bytes();
}
//@todo might be extended in the future
template <class Arg>
static bytes encodeDyn(Arg const& _arg)
{
return encodeArgs(u256(0x20), u256(_arg.size()), _arg);
}
2014-12-11 15:37:17 +00:00
2015-08-04 14:31:27 +00:00
class ContractInterface
{
public:
ContractInterface(ExecutionFramework& _framework): m_framework(_framework) {}
2015-08-06 09:01:59 +00:00
void setNextValue(u256 const& _value) { m_nextValue = _value; }
2015-08-04 14:31:27 +00:00
protected:
template <class... Args>
bytes const& call(std::string const& _sig, Args const&... _arguments)
{
auto const& ret = m_framework.callContractFunctionWithValue(_sig, m_nextValue, _arguments...);
m_nextValue = 0;
return ret;
}
void callString(std::string const& _name, std::string const& _arg)
{
BOOST_CHECK(call(_name + "(string)", u256(0x20), _arg.length(), _arg).empty());
}
void callStringAddress(std::string const& _name, std::string const& _arg1, u160 const& _arg2)
{
BOOST_CHECK(call(_name + "(string,address)", u256(0x40), _arg2, _arg1.length(), _arg1).empty());
}
void callStringAddressBool(std::string const& _name, std::string const& _arg1, u160 const& _arg2, bool _arg3)
{
BOOST_CHECK(call(_name + "(string,address,bool)", u256(0x60), _arg2, _arg3, _arg1.length(), _arg1).empty());
}
void callStringBytes32(std::string const& _name, std::string const& _arg1, h256 const& _arg2)
{
BOOST_CHECK(call(_name + "(string,bytes32)", u256(0x40), _arg2, _arg1.length(), _arg1).empty());
}
u160 callStringReturnsAddress(std::string const& _name, std::string const& _arg)
{
bytes const& ret = call(_name + "(string)", u256(0x20), _arg.length(), _arg);
BOOST_REQUIRE(ret.size() == 0x20);
BOOST_CHECK(std::count(ret.begin(), ret.begin() + 12, 0) == 12);
return eth::abiOut<u160>(ret);
}
std::string callAddressReturnsString(std::string const& _name, u160 const& _arg)
{
2015-08-06 09:01:59 +00:00
bytesConstRef ret = ref(call(_name + "(address)", _arg));
2015-08-04 14:31:27 +00:00
BOOST_REQUIRE(ret.size() >= 0x20);
2015-08-06 09:01:59 +00:00
u256 offset = eth::abiOut<u256>(ret);
BOOST_REQUIRE_EQUAL(offset, 0x20);
2015-08-04 14:31:27 +00:00
u256 len = eth::abiOut<u256>(ret);
2015-08-06 09:01:59 +00:00
BOOST_REQUIRE_EQUAL(ret.size(), ((len + 0x1f) / 0x20) * 0x20);
return ret.cropped(0, size_t(len)).toString();
2015-08-04 14:31:27 +00:00
}
h256 callStringReturnsBytes32(std::string const& _name, std::string const& _arg)
{
bytes const& ret = call(_name + "(string)", u256(0x20), _arg.length(), _arg);
BOOST_REQUIRE(ret.size() == 0x20);
return eth::abiOut<h256>(ret);
}
private:
u256 m_nextValue;
ExecutionFramework& m_framework;
};
2015-01-08 23:58:32 +00:00
private:
2014-12-11 15:37:17 +00:00
template <class CppFunction, class... Args>
auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
-> typename std::enable_if<std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
{
_cppFunction(_arguments...);
return bytes();
}
template <class CppFunction, class... Args>
auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
-> typename std::enable_if<!std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
{
2015-01-08 23:58:32 +00:00
return encode(_cppFunction(_arguments...));
2014-12-11 15:37:17 +00:00
}
2015-02-11 13:32:46 +00:00
protected:
2016-06-09 16:54:29 +00:00
void sendMessage(bytes const& _data, bool _isCreation, u256 const& _value = 0);
2016-06-18 00:08:20 +00:00
void sendEther(Address const& _to, u256 const& _value);
size_t currentTimestamp();
/// @returns the (potentially newly created) _ith address.
Address account(size_t _i);
2014-12-11 15:37:17 +00:00
2016-06-13 22:12:13 +00:00
u256 balanceAt(Address const& _addr);
bool storageEmpty(Address const& _addr);
bool addressHasCode(Address const& _addr);
2016-06-13 22:12:13 +00:00
2016-06-09 16:54:29 +00:00
RPCSession& m_rpc;
2016-05-30 13:01:37 +00:00
2016-06-13 15:10:58 +00:00
struct LogEntry
{
Address address;
std::vector<h256> topics;
bytes data;
};
2015-06-01 10:32:59 +00:00
size_t m_optimizeRuns = 200;
2014-12-11 15:37:17 +00:00
bool m_optimize = false;
dev::solidity::CompilerStack m_compiler;
2014-12-11 15:37:17 +00:00
Address m_sender;
Address m_contractAddress;
Make the Solidity repository standalone. This commit is the culmination of several months of work to decouple Solidity from the webthree-umbrella so that it can be developed in parallel with cpp-ethereum (the Ethereum C++ runtime) and so that even for the Solidity unit-tests there is no hard-dependency onto the C++ runtime. The Tests-over-IPC refactoring was a major step in the same process which was already committed. This commit contains the following changes: - A subset of the CMake functionality in webthree-helpers was extracted and tailored for Solidity into ./cmake. Further cleanup is certainly possible. - A subset of the libdevcore functionality in libweb3core was extracted and tailored for Solidity into ./libdevcore. Further cleanup is certainly possible - The gas price constants in EVMSchedule were orphaned into libevmasm. - Some other refactorings and cleanups were made to sever unnecessary EVM dependencies in the Solidity unit-tests. - TravisCI and Appveyor support was added, covering builds and running of the unit-tests (Linux and macOS only for now) - A bug-fix was made to get the Tests-over-IPC running on macOS. - There are still reliability issues in the unit-tests, which need immediate attention. The Travis build has been flipped to run the unit-tests 5 times, to try to flush these out. - The Emscripten automation which was previously in webthree-umbrella was merged into the TravisCI automation here. - The development ZIP deployment step has been commented out, but we will want to read that ONLY for release branch. Further iteration on these changes will definitely be needed, but I feel these have got to sufficient maturity than holding them back further isn't winning us anything. It is go time :-)
2016-08-01 05:25:37 +00:00
u256 const m_gasPrice = 100 * szabo;
2015-03-05 17:22:17 +00:00
u256 const m_gas = 100000000;
2014-12-11 15:37:17 +00:00
bytes m_output;
2016-06-13 15:10:58 +00:00
std::vector<LogEntry> m_logs;
u256 m_gasUsed;
2014-12-11 15:37:17 +00:00
};
}
}
} // end namespaces