From c4315521a340aeef8f02d138752267e3489633ac Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Tue, 2 May 2017 22:49:01 +0100 Subject: [PATCH 1/3] Add basic test for jsonCompiler --- test/CMakeLists.txt | 2 +- test/libsolidity/JSONCompiler.cpp | 143 ++++++++++++++++++++++++++++++ 2 files changed, 144 insertions(+), 1 deletion(-) create mode 100644 test/libsolidity/JSONCompiler.cpp diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index 2fc5c77e5..ddec205e9 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -19,7 +19,7 @@ eth_simple_add_executable(${EXECUTABLE} ${SRC_LIST} ${HEADERS}) eth_use(${EXECUTABLE} REQUIRED Solidity::solidity Solidity::lll) include_directories(BEFORE ..) -target_link_libraries(${EXECUTABLE} ${Boost_UNIT_TEST_FRAMEWORK_LIBRARIES}) +target_link_libraries(${EXECUTABLE} soljson ${Boost_UNIT_TEST_FRAMEWORK_LIBRARIES}) add_executable(solfuzzer fuzzer.cpp) target_link_libraries(solfuzzer soljson ${Boost_PROGRAM_OPTIONS_LIBRARIES}) diff --git a/test/libsolidity/JSONCompiler.cpp b/test/libsolidity/JSONCompiler.cpp new file mode 100644 index 000000000..90d1ff592 --- /dev/null +++ b/test/libsolidity/JSONCompiler.cpp @@ -0,0 +1,143 @@ +/* + 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 . +*/ +/** + * @date 2017 + * Unit tests for solc/jsonCompiler.cpp. + */ + +#include +#include +#include +#include +#include + +using namespace std; + +extern "C" +{ +extern char const* compileJSONMulti(char const* _input, bool _optimize); +} + +namespace dev +{ +namespace solidity +{ +namespace test +{ + +namespace +{ + +string bytecodeSansMetadata(string const& _bytecode) +{ + /// The metadata hash takes up 43 bytes (or 86 characters in hex) + /// /a165627a7a72305820([0-9a-f]{64})0029$/ + + if (_bytecode.size() < 88) + return _bytecode; + + if (_bytecode.substr(_bytecode.size() - 4, 4) != "0029") + return _bytecode; + + if (_bytecode.substr(_bytecode.size() - 86, 18) != "a165627a7a72305820") + return _bytecode; + + return _bytecode.substr(0, _bytecode.size() - 86); +} + +bool isValidMetadata(string const& _metadata) +{ + Json::Value metadata; + if (!Json::Reader().parse(_metadata, metadata, false)) + return false; + + if ( + !metadata.isObject() || + !metadata.isMember("version") || + !metadata.isMember("language") || + !metadata.isMember("compiler") || + !metadata.isMember("settings") || + !metadata.isMember("sources") || + !metadata.isMember("output") + ) + return false; + + if (!metadata["version"].isNumeric() || metadata["version"] != 1) + return false; + + if (!metadata["language"].isString() || metadata["language"].asString() != "Solidity") + return false; + + /// @TODO add more strict checks + + return true; +} + +Json::Value compile(string const& _input) +{ + string output(compileJSONMulti(_input.c_str(), false)); + Json::Value ret; + BOOST_REQUIRE(Json::Reader().parse(output, ret, false)); + return ret; +} + +} // end anonymous namespace + +BOOST_AUTO_TEST_SUITE(JSONCompiler) + +BOOST_AUTO_TEST_CASE(basic_compilation) +{ + char const* input = R"( + { + "sources": { + "fileA": "contract A { }" + } + } + )"; + Json::Value result = compile(input); + BOOST_CHECK(result.isObject()); + BOOST_CHECK(result["contracts"].isObject()); + BOOST_CHECK(result["contracts"]["fileA:A"].isObject()); + Json::Value contract = result["contracts"]["fileA:A"]; + BOOST_CHECK(contract.isObject()); + BOOST_CHECK(contract["interface"].isString()); + BOOST_CHECK(contract["interface"].asString() == "[]"); + BOOST_CHECK(contract["bytecode"].isString()); + BOOST_CHECK(bytecodeSansMetadata(contract["bytecode"].asString()) == + "60606040523415600b57fe5b5b60338060196000396000f30060606040525bfe00"); + BOOST_CHECK(contract["runtimeBytecode"].isString()); + BOOST_CHECK(bytecodeSansMetadata(contract["runtimeBytecode"].asString()) == + "60606040525bfe00"); + BOOST_CHECK(contract["functionHashes"].isObject()); + BOOST_CHECK(contract["gasEstimates"].isObject()); + BOOST_CHECK(dev::jsonCompactPrint(contract["gasEstimates"]) == + "{\"creation\":[62,10200],\"external\":{},\"internal\":{}}"); + BOOST_CHECK(contract["metadata"].isString()); + BOOST_CHECK(isValidMetadata(contract["metadata"].asString())); + BOOST_CHECK(result["sources"].isObject()); + BOOST_CHECK(result["sources"]["fileA"].isObject()); + BOOST_CHECK(result["sources"]["fileA"]["AST"].isObject()); + BOOST_CHECK(dev::jsonCompactPrint(result["sources"]["fileA"]["AST"]) == + "{\"children\":[{\"attributes\":{\"fullyImplemented\":true,\"isLibrary\":false,\"linearizedBaseContracts\":[1]," + "\"name\":\"A\"},\"children\":[],\"id\":1,\"name\":\"ContractDefinition\",\"src\":\"0:14:0\"}],\"name\":\"SourceUnit\"}"); +} + +BOOST_AUTO_TEST_SUITE_END() + +} +} +} // end namespaces From 31bd4acf66f212bf6e0c1327fa2ef227ba45100b Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Tue, 2 May 2017 23:34:12 +0100 Subject: [PATCH 2/3] Split out common metadata validation code --- test/Metadata.cpp | 80 +++++++++++++++++++++++++++ test/Metadata.h | 37 +++++++++++++ test/libsolidity/JSONCompiler.cpp | 53 ++---------------- test/libsolidity/StandardCompiler.cpp | 53 +----------------- 4 files changed, 125 insertions(+), 98 deletions(-) create mode 100644 test/Metadata.cpp create mode 100644 test/Metadata.h diff --git a/test/Metadata.cpp b/test/Metadata.cpp new file mode 100644 index 000000000..03f905b1b --- /dev/null +++ b/test/Metadata.cpp @@ -0,0 +1,80 @@ +/* + 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 . +*/ +/** + * @date 2017 + * Metadata processing helpers. + */ + +#include +#include +#include +#include + +using namespace std; + +namespace dev +{ +namespace test +{ + +string bytecodeSansMetadata(string const& _bytecode) +{ + /// The metadata hash takes up 43 bytes (or 86 characters in hex) + /// /a165627a7a72305820([0-9a-f]{64})0029$/ + + if (_bytecode.size() < 88) + return _bytecode; + + if (_bytecode.substr(_bytecode.size() - 4, 4) != "0029") + return _bytecode; + + if (_bytecode.substr(_bytecode.size() - 86, 18) != "a165627a7a72305820") + return _bytecode; + + return _bytecode.substr(0, _bytecode.size() - 86); +} + +bool isValidMetadata(string const& _metadata) +{ + Json::Value metadata; + if (!Json::Reader().parse(_metadata, metadata, false)) + return false; + + if ( + !metadata.isObject() || + !metadata.isMember("version") || + !metadata.isMember("language") || + !metadata.isMember("compiler") || + !metadata.isMember("settings") || + !metadata.isMember("sources") || + !metadata.isMember("output") + ) + return false; + + if (!metadata["version"].isNumeric() || metadata["version"] != 1) + return false; + + if (!metadata["language"].isString() || metadata["language"].asString() != "Solidity") + return false; + + /// @TODO add more strict checks + + return true; +} + +} +} // end namespaces diff --git a/test/Metadata.h b/test/Metadata.h new file mode 100644 index 000000000..cd92ecd80 --- /dev/null +++ b/test/Metadata.h @@ -0,0 +1,37 @@ +/* + 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 . +*/ +/** + * @date 2017 + * Metadata processing helpers. + */ + +#include + +namespace dev +{ +namespace test +{ + +/// Returns the bytecode with the metadata hash stripped out. +std::string bytecodeSansMetadata(std::string const& _bytecode); + +/// Expects a serialised metadata JSON and returns true if the +/// content is valid metadata. +bool isValidMetadata(std::string const& _metadata); + +} +} // end namespaces diff --git a/test/libsolidity/JSONCompiler.cpp b/test/libsolidity/JSONCompiler.cpp index 90d1ff592..b93aa0939 100644 --- a/test/libsolidity/JSONCompiler.cpp +++ b/test/libsolidity/JSONCompiler.cpp @@ -25,6 +25,8 @@ #include #include +#include "../Metadata.h" + using namespace std; extern "C" @@ -42,51 +44,6 @@ namespace test namespace { -string bytecodeSansMetadata(string const& _bytecode) -{ - /// The metadata hash takes up 43 bytes (or 86 characters in hex) - /// /a165627a7a72305820([0-9a-f]{64})0029$/ - - if (_bytecode.size() < 88) - return _bytecode; - - if (_bytecode.substr(_bytecode.size() - 4, 4) != "0029") - return _bytecode; - - if (_bytecode.substr(_bytecode.size() - 86, 18) != "a165627a7a72305820") - return _bytecode; - - return _bytecode.substr(0, _bytecode.size() - 86); -} - -bool isValidMetadata(string const& _metadata) -{ - Json::Value metadata; - if (!Json::Reader().parse(_metadata, metadata, false)) - return false; - - if ( - !metadata.isObject() || - !metadata.isMember("version") || - !metadata.isMember("language") || - !metadata.isMember("compiler") || - !metadata.isMember("settings") || - !metadata.isMember("sources") || - !metadata.isMember("output") - ) - return false; - - if (!metadata["version"].isNumeric() || metadata["version"] != 1) - return false; - - if (!metadata["language"].isString() || metadata["language"].asString() != "Solidity") - return false; - - /// @TODO add more strict checks - - return true; -} - Json::Value compile(string const& _input) { string output(compileJSONMulti(_input.c_str(), false)); @@ -117,17 +74,17 @@ BOOST_AUTO_TEST_CASE(basic_compilation) BOOST_CHECK(contract["interface"].isString()); BOOST_CHECK(contract["interface"].asString() == "[]"); BOOST_CHECK(contract["bytecode"].isString()); - BOOST_CHECK(bytecodeSansMetadata(contract["bytecode"].asString()) == + BOOST_CHECK(dev::test::bytecodeSansMetadata(contract["bytecode"].asString()) == "60606040523415600b57fe5b5b60338060196000396000f30060606040525bfe00"); BOOST_CHECK(contract["runtimeBytecode"].isString()); - BOOST_CHECK(bytecodeSansMetadata(contract["runtimeBytecode"].asString()) == + BOOST_CHECK(dev::test::bytecodeSansMetadata(contract["runtimeBytecode"].asString()) == "60606040525bfe00"); BOOST_CHECK(contract["functionHashes"].isObject()); BOOST_CHECK(contract["gasEstimates"].isObject()); BOOST_CHECK(dev::jsonCompactPrint(contract["gasEstimates"]) == "{\"creation\":[62,10200],\"external\":{},\"internal\":{}}"); BOOST_CHECK(contract["metadata"].isString()); - BOOST_CHECK(isValidMetadata(contract["metadata"].asString())); + BOOST_CHECK(dev::test::isValidMetadata(contract["metadata"].asString())); BOOST_CHECK(result["sources"].isObject()); BOOST_CHECK(result["sources"]["fileA"].isObject()); BOOST_CHECK(result["sources"]["fileA"]["AST"].isObject()); diff --git a/test/libsolidity/StandardCompiler.cpp b/test/libsolidity/StandardCompiler.cpp index ffb0e2c6e..ec2f69d92 100644 --- a/test/libsolidity/StandardCompiler.cpp +++ b/test/libsolidity/StandardCompiler.cpp @@ -26,6 +26,7 @@ #include #include +#include "../Metadata.h" using namespace std; using namespace dev::eth; @@ -68,60 +69,12 @@ bool containsAtMostWarnings(Json::Value const& _compilerResult) BOOST_REQUIRE(error.isObject()); BOOST_REQUIRE(error["severity"].isString()); if (error["severity"].asString() != "warning") - { - cout << error << std::endl; return false; - } } return true; } -string bytecodeSansMetadata(string const& _bytecode) -{ - /// The metadata hash takes up 43 bytes (or 86 characters in hex) - /// /a165627a7a72305820([0-9a-f]{64})0029$/ - - if (_bytecode.size() < 88) - return _bytecode; - - if (_bytecode.substr(_bytecode.size() - 4, 4) != "0029") - return _bytecode; - - if (_bytecode.substr(_bytecode.size() - 86, 18) != "a165627a7a72305820") - return _bytecode; - - return _bytecode.substr(0, _bytecode.size() - 86); -} - -bool isValidMetadata(string const& _metadata) -{ - Json::Value metadata; - if (!Json::Reader().parse(_metadata, metadata, false)) - return false; - - if ( - !metadata.isObject() || - !metadata.isMember("version") || - !metadata.isMember("language") || - !metadata.isMember("compiler") || - !metadata.isMember("settings") || - !metadata.isMember("sources") || - !metadata.isMember("output") - ) - return false; - - if (!metadata["version"].isNumeric() || metadata["version"] != 1) - return false; - - if (!metadata["language"].isString() || metadata["language"].asString() != "Solidity") - return false; - - /// @TODO add more strict checks - - return true; -} - Json::Value getContractResult(Json::Value const& _compilerResult, string const& _file, string const& _name) { if ( @@ -245,7 +198,7 @@ BOOST_AUTO_TEST_CASE(basic_compilation) /// @TODO check evm.methodIdentifiers, legacyAssembly, bytecode, deployedBytecode BOOST_CHECK(contract["evm"]["bytecode"].isObject()); BOOST_CHECK(contract["evm"]["bytecode"]["object"].isString()); - BOOST_CHECK(bytecodeSansMetadata(contract["evm"]["bytecode"]["object"].asString()) == + BOOST_CHECK(dev::test::bytecodeSansMetadata(contract["evm"]["bytecode"]["object"].asString()) == "60606040523415600b57fe5b5b60338060196000396000f30060606040525bfe00"); BOOST_CHECK(contract["evm"]["assembly"].isString()); BOOST_CHECK(contract["evm"]["assembly"].asString() == @@ -257,7 +210,7 @@ BOOST_AUTO_TEST_CASE(basic_compilation) BOOST_CHECK(dev::jsonCompactPrint(contract["evm"]["gasEstimates"]) == "{\"creation\":{\"codeDepositCost\":\"10200\",\"executionCost\":\"62\",\"totalCost\":\"10262\"}}"); BOOST_CHECK(contract["metadata"].isString()); - BOOST_CHECK(isValidMetadata(contract["metadata"].asString())); + BOOST_CHECK(dev::test::isValidMetadata(contract["metadata"].asString())); BOOST_CHECK(result["sources"].isObject()); BOOST_CHECK(result["sources"]["fileA"].isObject()); BOOST_CHECK(result["sources"]["fileA"]["legacyAST"].isObject()); From 41b5361b3f9ef267fa2e5bbbc44b46a315e9b01a Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 6 May 2017 10:48:02 +0100 Subject: [PATCH 3/3] Run in optimizer mode when requested --- test/libsolidity/JSONCompiler.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/libsolidity/JSONCompiler.cpp b/test/libsolidity/JSONCompiler.cpp index b93aa0939..46c718d7a 100644 --- a/test/libsolidity/JSONCompiler.cpp +++ b/test/libsolidity/JSONCompiler.cpp @@ -26,6 +26,7 @@ #include #include "../Metadata.h" +#include "../TestHelper.h" using namespace std; @@ -46,7 +47,7 @@ namespace Json::Value compile(string const& _input) { - string output(compileJSONMulti(_input.c_str(), false)); + string output(compileJSONMulti(_input.c_str(), dev::test::Options::get().optimize)); Json::Value ret; BOOST_REQUIRE(Json::Reader().parse(output, ret, false)); return ret;