cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Split out common metadata validation code

Browse Source
This commit is contained in:
Alex Beregszaszi 2017-05-02 23:34:12 +01:00
parent c4315521a3
commit 31bd4acf66
4 changed files with 125 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
test/Metadata.cpp Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
*/
/**
* @date 2017
* Metadata processing helpers.
*/
#include <string>
#include <iostream>
#include <regex>
#include <libdevcore/JSON.h>
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

37
test/Metadata.h Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
*/
/**
* @date 2017
* Metadata processing helpers.
*/
#include <string>
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

53
test/libsolidity/JSONCompiler.cpp
View File

@ -25,6 +25,8 @@
#include <boost/test/unit_test.hpp>
#include <libdevcore/JSON.h>
#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());

53
test/libsolidity/StandardCompiler.cpp
View File

@ -26,6 +26,7 @@
#include <libsolidity/interface/StandardCompiler.h>
#include <libdevcore/JSON.h>
#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());