/* 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 . */ /** * @author Christian * @date 2014 * Unit tests for the solidity parser. */ #if ETH_SOLIDITY #include #include #include #include #include #include #include "../TestHelper.h" using namespace std; namespace dev { namespace solidity { namespace test { namespace { ASTPointer parseText(std::string const& _source) { Parser parser; ASTPointer sourceUnit = parser.parse(std::make_shared(CharStream(_source))); for (ASTPointer const& node: sourceUnit->getNodes()) if (ASTPointer contract = dynamic_pointer_cast(node)) return contract; BOOST_FAIL("No contract found in source."); return ASTPointer(); } static void checkFunctionNatspec(ASTPointer _function, std::string const& _expectedDoc) { auto doc = _function->getDocumentation(); BOOST_CHECK_MESSAGE(doc != nullptr, "Function does not have Natspec Doc as expected"); BOOST_CHECK_EQUAL(*doc, _expectedDoc); } } BOOST_AUTO_TEST_SUITE(SolidityParser) BOOST_AUTO_TEST_CASE(smoke_test) { char const* text = "contract test {\n" " uint256 stateVariable1;\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed."); } BOOST_AUTO_TEST_CASE(missing_variable_name_in_declaration) { char const* text = "contract test {\n" " uint256 ;\n" "}\n"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(empty_function) { char const* text = "contract test {\n" " uint256 stateVar;\n" " function functionName(bytes20 arg1, address addr) constant\n" " returns (int id)\n" " { }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed."); } BOOST_AUTO_TEST_CASE(no_function_params) { char const* text = "contract test {\n" " uint256 stateVar;\n" " function functionName() {}\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed."); } BOOST_AUTO_TEST_CASE(single_function_param) { char const* text = "contract test {\n" " uint256 stateVar;\n" " function functionName(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed."); } BOOST_AUTO_TEST_CASE(function_no_body) { char const* text = "contract test {\n" " function functionName(bytes32 input) returns (bytes32 out);\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed."); } BOOST_AUTO_TEST_CASE(missing_parameter_name_in_named_args) { char const* text = "contract test {\n" " function a(uint a, uint b, uint c) returns (uint r) { r = a * 100 + b * 10 + c * 1; }\n" " function b() returns (uint r) { r = a({: 1, : 2, : 3}); }\n" "}\n"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(missing_argument_in_named_args) { char const* text = "contract test {\n" " function a(uint a, uint b, uint c) returns (uint r) { r = a * 100 + b * 10 + c * 1; }\n" " function b() returns (uint r) { r = a({a: , b: , c: }); }\n" "}\n"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(function_natspec_documentation) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " /// This is a test function\n" " function functionName(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); checkFunctionNatspec(function, "This is a test function"); } BOOST_AUTO_TEST_CASE(function_normal_comments) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " // We won't see this comment\n" " function functionName(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); BOOST_CHECK_MESSAGE(function->getDocumentation() == nullptr, "Should not have gotten a Natspecc comment for this function"); } BOOST_AUTO_TEST_CASE(multiple_functions_natspec_documentation) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " /// This is test function 1\n" " function functionName1(bytes32 input) returns (bytes32 out) {}\n" " /// This is test function 2\n" " function functionName2(bytes32 input) returns (bytes32 out) {}\n" " // nothing to see here\n" " function functionName3(bytes32 input) returns (bytes32 out) {}\n" " /// This is test function 4\n" " function functionName4(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); checkFunctionNatspec(function, "This is test function 1"); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(1), "Failed to retrieve function"); checkFunctionNatspec(function, "This is test function 2"); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(2), "Failed to retrieve function"); BOOST_CHECK_MESSAGE(function->getDocumentation() == nullptr, "Should not have gotten natspec comment for functionName3()"); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(3), "Failed to retrieve function"); checkFunctionNatspec(function, "This is test function 4"); } BOOST_AUTO_TEST_CASE(multiline_function_documentation) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " /// This is a test function\n" " /// and it has 2 lines\n" " function functionName1(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); checkFunctionNatspec(function, "This is a test function\n" " and it has 2 lines"); } BOOST_AUTO_TEST_CASE(natspec_comment_in_function_body) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " /// fun1 description\n" " function fun1(uint256 a) {\n" " var b;\n" " /// I should not interfere with actual natspec comments\n" " uint256 c;\n" " mapping(address=>bytes32) d;\n" " bytes7 name = \"Solidity\";" " }\n" " /// This is a test function\n" " /// and it has 2 lines\n" " function fun(bytes32 input) returns (bytes32 out) {}\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); checkFunctionNatspec(function, "fun1 description"); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(1), "Failed to retrieve function"); checkFunctionNatspec(function, "This is a test function\n" " and it has 2 lines"); } BOOST_AUTO_TEST_CASE(natspec_docstring_between_keyword_and_signature) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " function ///I am in the wrong place \n" " fun1(uint256 a) {\n" " var b;\n" " /// I should not interfere with actual natspec comments\n" " uint256 c;\n" " mapping(address=>bytes32) d;\n" " bytes7 name = \"Solidity\";" " }\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); BOOST_CHECK_MESSAGE(!function->getDocumentation(), "Shouldn't get natspec docstring for this function"); } BOOST_AUTO_TEST_CASE(natspec_docstring_after_signature) { ASTPointer contract; ASTPointer function; char const* text = "contract test {\n" " uint256 stateVar;\n" " function fun1(uint256 a) {\n" " /// I should have been above the function signature\n" " var b;\n" " /// I should not interfere with actual natspec comments\n" " uint256 c;\n" " mapping(address=>bytes32) d;\n" " bytes7 name = \"Solidity\";" " }\n" "}\n"; ETH_TEST_REQUIRE_NO_THROW(contract = parseText(text), "Parsing failed"); auto functions = contract->getDefinedFunctions(); ETH_TEST_REQUIRE_NO_THROW(function = functions.at(0), "Failed to retrieve function"); BOOST_CHECK_MESSAGE(!function->getDocumentation(), "Shouldn't get natspec docstring for this function"); } BOOST_AUTO_TEST_CASE(struct_definition) { char const* text = "contract test {\n" " uint256 stateVar;\n" " struct MyStructName {\n" " address addr;\n" " uint256 count;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(mapping) { char const* text = "contract test {\n" " mapping(address => bytes32) names;\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(mapping_in_struct) { char const* text = "contract test {\n" " struct test_struct {\n" " address addr;\n" " uint256 count;\n" " mapping(bytes32 => test_struct) self_reference;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(mapping_to_mapping_in_struct) { char const* text = "contract test {\n" " struct test_struct {\n" " address addr;\n" " mapping (uint64 => mapping (bytes32 => uint)) complex_mapping;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(variable_definition) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " var b;\n" " uint256 c;\n" " mapping(address=>bytes32) d;\n" " customtype varname;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(variable_definition_with_initialization) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " var b = 2;\n" " uint256 c = 0x87;\n" " mapping(address=>bytes32) d;\n" " bytes7 name = \"Solidity\";" " customtype varname;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(variable_definition_in_function_parameter) { char const* text = R"( contract test { function fun(var a) {} } )"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(variable_definition_in_mapping) { char const* text = R"( contract test { function fun() { mapping(var=>bytes32) d; } } )"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(variable_definition_in_function_return) { char const* text = R"( contract test { function fun() returns(var d) { return 1; } } )"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(operator_expression) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " uint256 x = (1 + 4) || false && (1 - 12) + -9;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(complex_expression) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " uint256 x = (1 + 4).member(++67)[a/=9] || true;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(exp_expression) { char const* text = R"( contract test { function fun(uint256 a) { uint256 x = 3 ** a; } })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(while_loop) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " while (true) { uint256 x = 1; break; continue; } x = 9;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(for_loop_vardef_initexpr) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " for (uint256 i = 0; i < 10; i++)\n" " { uint256 x = i; break; continue; }\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(for_loop_simple_initexpr) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " uint256 i =0;\n" " for (i = 0; i < 10; i++)\n" " { uint256 x = i; break; continue; }\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(for_loop_simple_noexpr) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " uint256 i =0;\n" " for (;;)\n" " { uint256 x = i; break; continue; }\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(for_loop_single_stmt_body) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " uint256 i =0;\n" " for (i = 0; i < 10; i++)\n" " continue;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(if_statement) { char const* text = "contract test {\n" " function fun(uint256 a) {\n" " if (a >= 8) return 2; else { var b = 7; }\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(else_if_statement) { char const* text = "contract test {\n" " function fun(uint256 a) returns (address b) {\n" " if (a < 0) b = 0x67; else if (a == 0) b = 0x12; else b = 0x78;\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(statement_starting_with_type_conversion) { char const* text = "contract test {\n" " function fun() {\n" " uint64(2);\n" " uint64[7](3);\n" " uint64[](3);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(type_conversion_to_dynamic_array) { char const* text = "contract test {\n" " function fun() {\n" " var x = uint64[](3);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(import_directive) { char const* text = "import \"abc\";\n" "contract test {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(multiple_contracts) { char const* text = "contract test {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "contract test2 {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(multiple_contracts_and_imports) { char const* text = "import \"abc\";\n" "contract test {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "import \"def\";\n" "contract test2 {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "import \"ghi\";\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(contract_inheritance) { char const* text = "contract base {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "contract derived is base {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(contract_multiple_inheritance) { char const* text = "contract base {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "contract derived is base, nonExisting {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(contract_multiple_inheritance_with_arguments) { char const* text = "contract base {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n" "contract derived is base(2), nonExisting(\"abc\", \"def\", base.fun()) {\n" " function fun() {\n" " uint64(2);\n" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(placeholder_in_function_context) { char const* text = "contract c {\n" " function fun() returns (uint r) {\n" " var _ = 8;\n" " return _ + 1;" " }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(modifier) { char const* text = "contract c {\n" " modifier mod { if (msg.sender == 0) _ }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(modifier_arguments) { char const* text = "contract c {\n" " modifier mod(uint a) { if (msg.sender == a) _ }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(modifier_invocation) { char const* text = "contract c {\n" " modifier mod1(uint a) { if (msg.sender == a) _ }\n" " modifier mod2 { if (msg.sender == 2) _ }\n" " function f() mod1(7) mod2 { }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(fallback_function) { char const* text = "contract c {\n" " function() { }\n" "}\n"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(event) { char const* text = R"( contract c { event e(); })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(event_arguments) { char const* text = R"( contract c { event e(uint a, bytes32 s); })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(event_arguments_indexed) { char const* text = R"( contract c { event e(uint a, bytes32 indexed s, bool indexed b); })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(visibility_specifiers) { char const* text = R"( contract c { uint private a; uint internal b; uint public c; uint d; function f() {} function f_priv() private {} function f_public() public {} function f_internal() internal {} })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(multiple_visibility_specifiers) { char const* text = R"( contract c { uint private internal a; })"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(literal_constants_with_ether_subdenominations) { char const* text = R"( contract c { function c () { a = 1 wei; b = 2 szabo; c = 3 finney; b = 4 ether; } uint256 a; uint256 b; uint256 c; uint256 d; })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(literal_constants_with_ether_subdenominations_in_expressions) { char const* text = R"( contract c { function c () { a = 1 wei * 100 wei + 7 szabo - 3; } uint256 a; })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(enum_valid_declaration) { char const* text = R"( contract c { enum validEnum { Value1, Value2, Value3, Value4 } function c () { a = foo.Value3; } uint256 a; })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(empty_enum_declaration) { char const* text = R"( contract c { enum foo { } })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(malformed_enum_declaration) { char const* text = R"( contract c { enum foo { WARNING,} })"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(external_function) { char const* text = R"( contract c { function x() external {} })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(external_variable) { char const* text = R"( contract c { uint external x; })"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(arrays_in_storage) { char const* text = R"( contract c { uint[10] a; uint[] a2; struct x { uint[2**20] b; y[0] c; } struct y { uint d; mapping(uint=>x)[] e; } })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(arrays_in_events) { char const* text = R"( contract c { event e(uint[10] a, bytes7[8] indexed b, c[3] x); })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(arrays_in_expressions) { char const* text = R"( contract c { function f() { c[10] a = 7; uint8[10 * 2] x; } })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(multi_arrays) { char const* text = R"( contract c { mapping(uint => mapping(uint => int8)[8][][9])[] x; })"; ETH_TEST_CHECK_NO_THROW(parseText(text), "Parsing failed"); } BOOST_AUTO_TEST_CASE(constant_is_keyword) { char const* text = R"( contract Foo { uint constant = 4; })"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_CASE(var_array) { char const* text = R"( contract Foo { function f() { var[] a; } })"; BOOST_CHECK_THROW(parseText(text), ParserError); } BOOST_AUTO_TEST_SUITE_END() } } } // end namespaces #endif