/* 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 2018 * Unit tests for the Yul object parser. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace ranges; using namespace std; using namespace solidity::frontend; using namespace solidity::langutil; namespace solidity::yul::test { namespace { pair parse(string const& _source) { try { AssemblyStack asmStack( solidity::test::CommonOptions::get().evmVersion(), AssemblyStack::Language::StrictAssembly, solidity::frontend::OptimiserSettings::none() ); bool success = asmStack.parseAndAnalyze("source", _source); return {success, asmStack.errors()}; } catch (FatalError const&) { BOOST_FAIL("Fatal error leaked."); } return {false, {}}; } optional parseAndReturnFirstError(string const& _source, bool _allowWarnings = true) { bool success; ErrorList errors; tie(success, errors) = parse(_source); if (!success) { BOOST_REQUIRE_EQUAL(errors.size(), 1); return *errors.front(); } else { // If success is true, there might still be an error in the assembly stage. if (_allowWarnings && Error::containsOnlyWarnings(errors)) return {}; else if (!errors.empty()) { if (!_allowWarnings) BOOST_CHECK_EQUAL(errors.size(), 1); return *errors.front(); } } return {}; } bool successParse(string const& _source, bool _allowWarnings = true) { return !parseAndReturnFirstError(_source, _allowWarnings); } Error expectError(string const& _source, bool _allowWarnings = false) { auto error = parseAndReturnFirstError(_source, _allowWarnings); BOOST_REQUIRE(error); return *error; } tuple, ErrorList> tryGetSourceLocationMapping(string _source) { vector lines; boost::split(lines, _source, boost::is_any_of("\n")); string source = util::joinHumanReadablePrefixed(lines, "\n///") + "\n{}\n"; ErrorList errors; ErrorReporter reporter(errors); Dialect const& dialect = yul::EVMDialect::strictAssemblyForEVM(EVMVersion::berlin()); ObjectParser objectParser{reporter, dialect}; CharStream stream(move(source), ""); objectParser.parse(make_shared(stream), false); return {objectParser.sourceNameMapping(), std::move(errors)}; } } #define CHECK_ERROR(text, typ, substring) \ do \ { \ Error err = expectError((text), false); \ BOOST_CHECK(err.type() == (Error::Type::typ)); \ BOOST_CHECK(::solidity::frontend::test::searchErrorMessage(err, (substring))); \ } while(0) BOOST_AUTO_TEST_SUITE(YulObjectParser) BOOST_AUTO_TEST_CASE(empty_code) { BOOST_CHECK(successParse("{ }")); } BOOST_AUTO_TEST_CASE(recursion_depth) { string input; for (size_t i = 0; i < 20000; i++) input += "object \"a" + to_string(i) + "\" { code {} "; for (size_t i = 0; i < 20000; i++) input += "}"; CHECK_ERROR(input, ParserError, "recursion"); } BOOST_AUTO_TEST_CASE(to_string) { string code = R"( object "O" { code { let x := mload(0) if x { sstore(0, 1) } } object "i" { code {} data "j" "def" } data "j" "abc" data "k" hex"010203" } )"; string expectation = R"(object "O" { code { let x := mload(0) if x { sstore(0, 1) } } object "i" { code { } data "j" hex"646566" } data "j" hex"616263" data "k" hex"010203" } )"; expectation = boost::replace_all_copy(expectation, "\t", " "); AssemblyStack asmStack( solidity::test::CommonOptions::get().evmVersion(), AssemblyStack::Language::StrictAssembly, solidity::frontend::OptimiserSettings::none() ); BOOST_REQUIRE(asmStack.parseAndAnalyze("source", code)); BOOST_CHECK_EQUAL(asmStack.print(), expectation); } BOOST_AUTO_TEST_CASE(use_src_empty) { auto const [mapping, _] = tryGetSourceLocationMapping(""); BOOST_REQUIRE(!mapping); } BOOST_AUTO_TEST_CASE(use_src_simple) { auto const [mapping, _] = tryGetSourceLocationMapping(R"(@use-src 0:"contract.sol")"); BOOST_REQUIRE(mapping.has_value()); BOOST_REQUIRE_EQUAL(mapping->size(), 1); BOOST_REQUIRE_EQUAL(*mapping->at(0), "contract.sol"); } BOOST_AUTO_TEST_CASE(use_src_multiple) { auto const [mapping, _] = tryGetSourceLocationMapping(R"(@use-src 0:"contract.sol", 1:"misc.yul")"); BOOST_REQUIRE(mapping); BOOST_REQUIRE_EQUAL(mapping->size(), 2); BOOST_REQUIRE_EQUAL(*mapping->at(0), "contract.sol"); BOOST_REQUIRE_EQUAL(*mapping->at(1), "misc.yul"); } BOOST_AUTO_TEST_CASE(use_src_escaped_filenames) { auto const [mapping, _] = tryGetSourceLocationMapping( R"(@use-src 42:"con\"tract@\".sol")" ); BOOST_REQUIRE(mapping); BOOST_REQUIRE_EQUAL(mapping->size(), 1); BOOST_REQUIRE(mapping->count(42)); BOOST_REQUIRE_EQUAL(*mapping->at(42), "con\"tract@\".sol"); } BOOST_AUTO_TEST_CASE(use_src_invalid_syntax_malformed_param_1) { // open quote arg, missing closing quote auto const [mapping, errors] = tryGetSourceLocationMapping(R"(@use-src 42_"con")"); BOOST_REQUIRE_EQUAL(errors.size(), 1); BOOST_CHECK_EQUAL(errors.front()->errorId().error, 9804); } BOOST_AUTO_TEST_CASE(use_src_invalid_syntax_malformed_param_2) { // open quote arg, missing closing quote auto const [mapping, errors] = tryGetSourceLocationMapping(R"(@use-src 42:"con)"); BOOST_REQUIRE_EQUAL(errors.size(), 1); BOOST_CHECK_EQUAL(errors.front()->errorId().error, 9804); } BOOST_AUTO_TEST_CASE(use_src_error_unexpected_trailing_tokens) { auto const [mapping, errors] = tryGetSourceLocationMapping( R"(@use-src 1:"file.sol" @use-src 2:"foo.sol")" ); BOOST_REQUIRE_EQUAL(errors.size(), 1); BOOST_CHECK_EQUAL(errors.front()->errorId().error, 9804); } BOOST_AUTO_TEST_CASE(use_src_multiline) { auto const [mapping, _] = tryGetSourceLocationMapping( " @use-src \n 0:\"contract.sol\" \n , \n 1:\"misc.yul\"" ); BOOST_REQUIRE(mapping); BOOST_REQUIRE_EQUAL(mapping->size(), 2); BOOST_REQUIRE_EQUAL(*mapping->at(0), "contract.sol"); BOOST_REQUIRE_EQUAL(*mapping->at(1), "misc.yul"); } BOOST_AUTO_TEST_CASE(use_src_empty_body) { auto const [mapping, _] = tryGetSourceLocationMapping("@use-src"); BOOST_REQUIRE(mapping); BOOST_REQUIRE_EQUAL(mapping->size(), 0); } BOOST_AUTO_TEST_CASE(use_src_leading_text) { auto const [mapping, _] = tryGetSourceLocationMapping( "@something else @use-src 0:\"contract.sol\", 1:\"misc.sol\""s ); BOOST_REQUIRE(mapping); BOOST_REQUIRE_EQUAL(mapping->size(), 2); BOOST_REQUIRE(mapping->find(0) != mapping->end()); BOOST_REQUIRE_EQUAL(*mapping->at(0), "contract.sol"); BOOST_REQUIRE_EQUAL(*mapping->at(1), "misc.sol"); } BOOST_AUTO_TEST_SUITE_END() }