2017-08-29 13:32:20 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* Unit tests for the view and pure checker.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <test/libsolidity/AnalysisFramework.h>
|
|
|
|
|
2018-02-23 18:29:20 +00:00
|
|
|
#include <test/TestHelper.h>
|
|
|
|
|
2017-08-29 13:32:20 +00:00
|
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
|
|
|
|
#include <string>
|
|
|
|
|
|
|
|
using namespace std;
|
|
|
|
|
|
|
|
namespace dev
|
|
|
|
{
|
|
|
|
namespace solidity
|
|
|
|
{
|
|
|
|
namespace test
|
|
|
|
{
|
|
|
|
|
|
|
|
BOOST_FIXTURE_TEST_SUITE(ViewPureChecker, AnalysisFramework)
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(smoke_test)
|
|
|
|
{
|
|
|
|
char const* text = R"(
|
|
|
|
contract C {
|
|
|
|
uint x;
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() pure public {}
|
|
|
|
function f() view public returns (uint) { return now; }
|
|
|
|
function h() public { x = 2; }
|
|
|
|
function i() payable public { x = 2; }
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(call_internal_functions_success)
|
|
|
|
{
|
|
|
|
char const* text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() pure public { g(); }
|
|
|
|
function f() view public returns (uint) { f(); g(); }
|
|
|
|
function h() public { h(); g(); f(); }
|
|
|
|
function i() payable public { i(); h(); g(); f(); }
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(suggest_pure)
|
|
|
|
{
|
|
|
|
char const* text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() view public { }
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_WARNING(text, "can be restricted to pure");
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(suggest_view)
|
|
|
|
{
|
|
|
|
char const* text = R"(
|
|
|
|
contract C {
|
|
|
|
uint x;
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() public returns (uint) { return x; }
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_WARNING(text, "can be restricted to view");
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(call_internal_functions_fail)
|
|
|
|
{
|
|
|
|
CHECK_ERROR(
|
2017-09-14 15:30:00 +00:00
|
|
|
"contract C{ function f() pure public { g(); } function g() view public {} }",
|
2017-08-29 13:32:20 +00:00
|
|
|
TypeError,
|
2017-08-31 14:14:54 +00:00
|
|
|
"Function declared as pure, but this expression (potentially) reads from the environment or state and thus requires \"view\""
|
2017-08-29 13:32:20 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(write_storage_fail)
|
|
|
|
{
|
|
|
|
CHECK_WARNING(
|
2017-09-14 15:30:00 +00:00
|
|
|
"contract C{ uint x; function f() view public { x = 2; } }",
|
2017-08-31 14:14:54 +00:00
|
|
|
"Function declared as view, but this expression (potentially) modifies the state and thus requires non-payable (the default) or payable."
|
2017-08-29 13:32:20 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(environment_access)
|
|
|
|
{
|
|
|
|
vector<string> view{
|
|
|
|
"block.coinbase",
|
|
|
|
"block.timestamp",
|
|
|
|
"block.blockhash(7)",
|
|
|
|
"block.difficulty",
|
|
|
|
"block.number",
|
|
|
|
"block.gaslimit",
|
2018-03-02 16:58:27 +00:00
|
|
|
"gasleft()",
|
2017-08-29 13:32:20 +00:00
|
|
|
"msg.gas",
|
|
|
|
"msg.value",
|
|
|
|
"msg.sender",
|
|
|
|
"tx.origin",
|
|
|
|
"tx.gasprice",
|
|
|
|
"this",
|
|
|
|
"address(1).balance"
|
|
|
|
};
|
|
|
|
vector<string> pure{
|
|
|
|
"msg.data",
|
|
|
|
"msg.data[0]",
|
|
|
|
"msg.sig",
|
|
|
|
"block.blockhash", // Not evaluating the function
|
|
|
|
"msg",
|
|
|
|
"block",
|
|
|
|
"tx"
|
|
|
|
};
|
|
|
|
for (string const& x: view)
|
|
|
|
{
|
|
|
|
CHECK_ERROR(
|
2017-09-14 15:30:00 +00:00
|
|
|
"contract C { function f() pure public { var x = " + x + "; x; } }",
|
2017-08-29 13:32:20 +00:00
|
|
|
TypeError,
|
2017-08-31 14:14:54 +00:00
|
|
|
"Function declared as pure, but this expression (potentially) reads from the environment or state and thus requires \"view\""
|
2017-08-29 13:32:20 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
for (string const& x: pure)
|
|
|
|
{
|
2018-02-12 22:26:13 +00:00
|
|
|
CHECK_WARNING_ALLOW_MULTI(
|
2017-09-14 15:30:00 +00:00
|
|
|
"contract C { function f() view public { var x = " + x + "; x; } }",
|
2018-02-12 22:26:13 +00:00
|
|
|
(std::vector<std::string>{
|
|
|
|
"Function state mutability can be restricted to pure",
|
|
|
|
"Use of the \"var\" keyword is deprecated."
|
|
|
|
}));
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-09-14 15:53:43 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(view_error_for_050)
|
|
|
|
{
|
|
|
|
CHECK_ERROR(
|
2018-02-27 14:21:23 +00:00
|
|
|
"pragma experimental \"v0.5.0\"; contract C { uint x; function f() view public { x = 2; } }",
|
2017-09-14 15:53:43 +00:00
|
|
|
TypeError,
|
|
|
|
"Function declared as view, but this expression (potentially) modifies the state and thus requires non-payable (the default) or payable."
|
|
|
|
);
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2017-08-29 13:32:20 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(modifiers)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract D {
|
|
|
|
uint x;
|
|
|
|
modifier purem(uint) { _; }
|
|
|
|
modifier viewm(uint) { uint a = x; _; a; }
|
|
|
|
modifier nonpayablem(uint) { x = 2; _; }
|
|
|
|
}
|
|
|
|
contract C is D {
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() purem(0) pure public {}
|
|
|
|
function g() viewm(0) view public {}
|
|
|
|
function h() nonpayablem(0) public {}
|
|
|
|
function i() purem(x) view public {}
|
|
|
|
function j() viewm(x) view public {}
|
|
|
|
function k() nonpayablem(x) public {}
|
|
|
|
function l() purem(x = 2) public {}
|
|
|
|
function m() viewm(x = 2) public {}
|
|
|
|
function n() nonpayablem(x = 2) public {}
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(interface)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
interface D {
|
2018-01-31 16:42:46 +00:00
|
|
|
function f() view external;
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
contract C is D {
|
2018-01-31 16:42:46 +00:00
|
|
|
function f() view external {}
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(overriding)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract D {
|
|
|
|
uint x;
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() public { x = 2; }
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
contract C is D {
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() public {}
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(returning_structs)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
struct S { uint x; }
|
|
|
|
S s;
|
|
|
|
function f() view internal returns (S storage) {
|
|
|
|
return s;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() public {
|
2017-08-29 13:32:20 +00:00
|
|
|
f().x = 2;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function h() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
f();
|
|
|
|
f().x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(mappings)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
mapping(uint => uint) a;
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
a;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
a[2];
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function h() public {
|
2017-08-29 13:32:20 +00:00
|
|
|
a[2] = 3;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(local_storage_variables)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
struct S { uint a; }
|
|
|
|
S s;
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
S storage x = s;
|
|
|
|
x;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
S storage x = s;
|
|
|
|
x = s;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function i() public {
|
2017-08-29 13:32:20 +00:00
|
|
|
s.a = 2;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function h() public {
|
2017-08-29 13:32:20 +00:00
|
|
|
S storage x = s;
|
|
|
|
x.a = 2;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(builtin_functions)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() public {
|
2017-09-20 13:54:41 +00:00
|
|
|
address(this).transfer(1);
|
|
|
|
require(address(this).send(2));
|
|
|
|
selfdestruct(address(this));
|
|
|
|
require(address(this).delegatecall());
|
|
|
|
require(address(this).call());
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() pure public {
|
2018-02-12 22:09:14 +00:00
|
|
|
bytes32 x = keccak256("abc");
|
|
|
|
bytes32 y = sha256("abc");
|
|
|
|
address z = ecrecover(1, 2, 3, 4);
|
2017-08-29 13:32:20 +00:00
|
|
|
require(true);
|
|
|
|
assert(true);
|
|
|
|
x; y; z;
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function() payable public {}
|
2017-08-29 13:32:20 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(function_types)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() pure public {
|
2017-08-29 13:32:20 +00:00
|
|
|
function () external nonpayFun;
|
|
|
|
function () external view viewFun;
|
|
|
|
function () external pure pureFun;
|
|
|
|
|
|
|
|
nonpayFun;
|
|
|
|
viewFun;
|
|
|
|
pureFun;
|
|
|
|
pureFun();
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() view public {
|
2017-08-29 13:32:20 +00:00
|
|
|
function () external view viewFun;
|
|
|
|
|
|
|
|
viewFun();
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function h() public {
|
2017-08-29 13:32:20 +00:00
|
|
|
function () external nonpayFun;
|
|
|
|
|
|
|
|
nonpayFun();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
2018-02-13 08:49:50 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(selector)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
2018-02-13 11:03:02 +00:00
|
|
|
uint public x;
|
2018-02-13 08:49:50 +00:00
|
|
|
function f() payable public {
|
|
|
|
}
|
|
|
|
function g() pure public returns (bytes4) {
|
2018-02-13 11:03:02 +00:00
|
|
|
return this.f.selector ^ this.x.selector;
|
2018-02-13 08:49:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(selector_complex)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
function f(C c) pure public returns (C) {
|
|
|
|
return c;
|
|
|
|
}
|
|
|
|
function g() pure public returns (bytes4) {
|
|
|
|
// By passing `this`, we read from the state, even if f itself is pure.
|
|
|
|
return f(this).f.selector;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_ERROR(text, TypeError, "reads from the environment or state and thus requires \"view\"");
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(selector_complex2)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
function f() payable public returns (C) {
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
function g() pure public returns (bytes4) {
|
|
|
|
C x = C(0x123);
|
|
|
|
return x.f.selector;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
2017-08-31 11:13:35 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(creation)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract D {}
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() public { new D(); }
|
2017-08-31 11:13:35 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(assembly)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
struct S { uint x; }
|
|
|
|
S s;
|
2017-09-14 15:30:00 +00:00
|
|
|
function e() pure public {
|
2017-08-31 11:13:35 +00:00
|
|
|
assembly { mstore(keccak256(0, 20), mul(s_slot, 2)) }
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function f() pure public {
|
2017-08-31 11:13:35 +00:00
|
|
|
uint x;
|
|
|
|
assembly { x := 7 }
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function g() view public {
|
2017-10-16 11:28:44 +00:00
|
|
|
assembly { for {} 1 { pop(sload(0)) } { } pop(gas) }
|
2017-08-31 11:13:35 +00:00
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function h() view public {
|
2017-08-31 11:13:35 +00:00
|
|
|
assembly { function g() { pop(blockhash(20)) } }
|
|
|
|
}
|
2017-09-14 15:30:00 +00:00
|
|
|
function j() public {
|
2017-08-31 11:13:35 +00:00
|
|
|
assembly { pop(call(0, 1, 2, 3, 4, 5, 6)) }
|
|
|
|
}
|
2017-10-16 11:28:44 +00:00
|
|
|
function k() public {
|
|
|
|
assembly { pop(call(gas, 1, 2, 3, 4, 5, 6)) }
|
|
|
|
}
|
2017-08-31 11:13:35 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(assembly_staticcall)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function i() view public {
|
2017-10-16 11:28:44 +00:00
|
|
|
assembly { pop(staticcall(gas, 1, 2, 3, 4, 5)) }
|
2017-08-31 11:13:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
2018-02-26 18:53:38 +00:00
|
|
|
if (!dev::test::Options::get().evmVersion().hasStaticCall())
|
2018-02-23 18:29:42 +00:00
|
|
|
CHECK_WARNING(text, "\"staticcall\" instruction is only available for Byzantium-compatible");
|
|
|
|
else
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
2017-08-31 11:13:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(assembly_jump)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
2017-09-14 15:30:00 +00:00
|
|
|
function k() public {
|
2017-08-31 11:13:35 +00:00
|
|
|
assembly { jump(2) }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_WARNING(text, "low-level EVM features");
|
|
|
|
}
|
|
|
|
|
2017-09-05 16:33:52 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(constant)
|
|
|
|
{
|
|
|
|
string text = R"(
|
|
|
|
contract C {
|
|
|
|
uint constant x = 2;
|
2017-09-14 15:30:00 +00:00
|
|
|
function k() pure public returns (uint) {
|
2017-09-05 16:33:52 +00:00
|
|
|
return x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
CHECK_SUCCESS_NO_WARNINGS(text);
|
|
|
|
}
|
|
|
|
|
2017-08-29 13:32:20 +00:00
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|