From 63b556b2063acfe84f16973bd5b0429d70f7fb93 Mon Sep 17 00:00:00 2001 From: chriseth Date: Thu, 10 Aug 2017 18:27:57 +0200 Subject: Test both encoders. --- test/libsolidity/ABIEncoderTests.cpp | 214 ++++++++++++++++++++++------------- 1 file changed, 137 insertions(+), 77 deletions(-) (limited to 'test/libsolidity/ABIEncoderTests.cpp') diff --git a/test/libsolidity/ABIEncoderTests.cpp b/test/libsolidity/ABIEncoderTests.cpp index 24205069..297c4ef0 100644 --- a/test/libsolidity/ABIEncoderTests.cpp +++ b/test/libsolidity/ABIEncoderTests.cpp @@ -42,11 +42,36 @@ namespace test BOOST_CHECK_EQUAL(toHex(m_logs[0].data), toHex(DATA)); \ } while (false) +static string const NewEncoderPragma = "pragma experimental ABIEncoderV2;\n"; + +#define NEW_ENCODER(CODE) \ +{ \ + sourceCode = NewEncoderPragma + sourceCode; \ + { CODE } \ +} + +#define BOTH_ENCODERS(CODE) \ +{ \ + { CODE } \ + NEW_ENCODER(CODE) \ +} + BOOST_FIXTURE_TEST_SUITE(ABIEncoderTest, SolidityExecutionFramework) +BOOST_AUTO_TEST_CASE(both_encoders_macro) +{ + // This tests that the "both encoders macro" at least runs twice and + // modifies the source. + string sourceCode; + int runs = 0; + BOTH_ENCODERS(runs++;) + BOOST_CHECK(sourceCode == NewEncoderPragma); + BOOST_CHECK_EQUAL(runs, 2); +} + BOOST_AUTO_TEST_CASE(value_types) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(uint a, uint16 b, uint24 c, int24 d, bytes3 x, bool, C); function f() { @@ -59,16 +84,18 @@ BOOST_AUTO_TEST_CASE(value_types) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - 10, u256(65534), u256(0x121212), u256(-1), string("\x1b\xab\xab"), true, u160(u256(-5)) - )); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + 10, u256(65534), u256(0x121212), u256(-1), string("\x1b\xab\xab"), true, u160(u256(-5)) + )); + ) } BOOST_AUTO_TEST_CASE(string_literal) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(string, bytes20, string); function f() { @@ -76,19 +103,21 @@ BOOST_AUTO_TEST_CASE(string_literal) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - 0x60, string("abcde"), 0xa0, - 6, string("abcdef"), - 0x8b, string("abcdefabcdefgehabcabcasdfjklabcdefabcedefghabcabcasdfjklabcdefabcdefghabcabcasdfjklabcdeefabcdefghabcabcasdefjklabcdefabcdefghabcabcasdfjkl") - )); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + 0x60, string("abcde"), 0xa0, + 6, string("abcdef"), + 0x8b, string("abcdefabcdefgehabcabcasdfjklabcdefabcedefghabcabcasdfjklabcdefabcdefghabcabcasdfjklabcdeefabcdefghabcabcasdefjklabcdefabcdefghabcabcasdfjkl") + )); + ) } BOOST_AUTO_TEST_CASE(enum_type_cleanup) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { enum E { A, B } function f(uint x) returns (E en) { @@ -96,15 +125,17 @@ BOOST_AUTO_TEST_CASE(enum_type_cleanup) } } )"; - compileAndRun(sourceCode); - BOOST_CHECK(callContractFunction("f(uint256)", 0) == encodeArgs(0)); - BOOST_CHECK(callContractFunction("f(uint256)", 1) == encodeArgs(1)); - BOOST_CHECK(callContractFunction("f(uint256)", 2) == encodeArgs()); + BOTH_ENCODERS( + compileAndRun(sourceCode); + BOOST_CHECK(callContractFunction("f(uint256)", 0) == encodeArgs(0)); + BOOST_CHECK(callContractFunction("f(uint256)", 1) == encodeArgs(1)); + BOOST_CHECK(callContractFunction("f(uint256)", 2) == encodeArgs()); + ) } BOOST_AUTO_TEST_CASE(conversion) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(bytes4, bytes4, uint16, uint8, int16, int8); function f() { @@ -118,17 +149,19 @@ BOOST_AUTO_TEST_CASE(conversion) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - string(3, 0) + string("\x0a"), string("\xf1\xf2"), - 0xff, 0xff, u256(-1), u256(1) - )); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + string(3, 0) + string("\x0a"), string("\xf1\xf2"), + 0xff, 0xff, u256(-1), u256(1) + )); + ) } BOOST_AUTO_TEST_CASE(memory_array_one_dim) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(uint a, int16[] b, uint c); function f() { @@ -142,14 +175,20 @@ BOOST_AUTO_TEST_CASE(memory_array_one_dim) } } )"; + compileAndRun(sourceCode); callContractFunction("f()"); + // The old encoder does not clean array elements. + REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 3, u256("0xfffffffe"), u256("0xffffffff"), u256("0x100000000"))); + + compileAndRun(NewEncoderPragma + sourceCode); + callContractFunction("f()"); REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 3, u256(-2), u256(-1), u256(0))); } BOOST_AUTO_TEST_CASE(memory_array_two_dim) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(uint a, int16[][2] b, uint c); function f() { @@ -165,14 +204,16 @@ BOOST_AUTO_TEST_CASE(memory_array_two_dim) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 0x40, 0xc0, 3, 7, 0x0506, u256(-1), 2, 4, 5)); + NEW_ENCODER( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 0x40, 0xc0, 3, 7, 0x0506, u256(-1), 2, 4, 5)); + ) } BOOST_AUTO_TEST_CASE(memory_byte_array) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(uint a, bytes[] b, uint c); function f() { @@ -183,19 +224,21 @@ BOOST_AUTO_TEST_CASE(memory_byte_array) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - 10, 0x60, 11, - 2, 0x40, 0xc0, - 66, string("abcabcdefghjklmnopqrsuvwabcdefgijklmnopqrstuwabcdefgijklmnoprstuvw"), - 63, string("abcdefghijklmnopqrtuvwabcfghijklmnopqstuvwabcdeghijklmopqrstuvw") - )); + NEW_ENCODER( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + 10, 0x60, 11, + 2, 0x40, 0xc0, + 66, string("abcabcdefghjklmnopqrsuvwabcdefgijklmnopqrstuwabcdefgijklmnoprstuvw"), + 63, string("abcdefghijklmnopqrtuvwabcfghijklmnopqstuvwabcdeghijklmopqrstuvw") + )); + ) } BOOST_AUTO_TEST_CASE(storage_byte_array) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { bytes short; bytes long; @@ -207,18 +250,20 @@ BOOST_AUTO_TEST_CASE(storage_byte_array) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - 0x40, 0x80, - 31, string("123456789012345678901234567890a"), - 75, string("ffff123456789012345678901234567890afffffffff123456789012345678901234567890a") - )); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + 0x40, 0x80, + 31, string("123456789012345678901234567890a"), + 75, string("ffff123456789012345678901234567890afffffffff123456789012345678901234567890a") + )); + ) } BOOST_AUTO_TEST_CASE(storage_array) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { address[3] addr; event E(address[3] a); @@ -232,14 +277,16 @@ BOOST_AUTO_TEST_CASE(storage_array) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs(u160(-1), u160(-2), u160(-3))); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs(u160(-1), u160(-2), u160(-3))); + ) } BOOST_AUTO_TEST_CASE(storage_array_dyn) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { address[] addr; event E(address[] a); @@ -251,14 +298,16 @@ BOOST_AUTO_TEST_CASE(storage_array_dyn) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs(0x20, 3, u160(1), u160(2), u160(3))); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs(0x20, 3, u160(1), u160(2), u160(3))); + ) } BOOST_AUTO_TEST_CASE(storage_array_compact) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { int72[] x; event E(int72[]); @@ -275,16 +324,18 @@ BOOST_AUTO_TEST_CASE(storage_array_compact) } } )"; - compileAndRun(sourceCode); - callContractFunction("f()"); - REQUIRE_LOG_DATA(encodeArgs( - 0x20, 8, u256(-1), 2, u256(-3), 4, u256(-5), 6, u256(-7), 8 - )); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f()"); + REQUIRE_LOG_DATA(encodeArgs( + 0x20, 8, u256(-1), 2, u256(-3), 4, u256(-5), 6, u256(-7), 8 + )); + ) } BOOST_AUTO_TEST_CASE(external_function) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(function(uint) external returns (uint), function(uint) external returns (uint)); function(uint) external returns (uint) g; @@ -294,15 +345,17 @@ BOOST_AUTO_TEST_CASE(external_function) } } )"; - compileAndRun(sourceCode); - callContractFunction("f(uint256)"); - string functionIdF = asString(m_contractAddress.ref()) + asString(FixedHash<4>(dev::keccak256("f(uint256)")).ref()); - REQUIRE_LOG_DATA(encodeArgs(functionIdF, functionIdF)); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f(uint256)"); + string functionIdF = asString(m_contractAddress.ref()) + asString(FixedHash<4>(dev::keccak256("f(uint256)")).ref()); + REQUIRE_LOG_DATA(encodeArgs(functionIdF, functionIdF)); + ) } BOOST_AUTO_TEST_CASE(external_function_cleanup) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(function(uint) external returns (uint), function(uint) external returns (uint)); // This test relies on the fact that g is stored in slot zero. @@ -314,14 +367,16 @@ BOOST_AUTO_TEST_CASE(external_function_cleanup) } } )"; - compileAndRun(sourceCode); - callContractFunction("f(uint256)"); - REQUIRE_LOG_DATA(encodeArgs(string(24, char(-1)), string(24, char(-1)))); + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f(uint256)"); + REQUIRE_LOG_DATA(encodeArgs(string(24, char(-1)), string(24, char(-1)))); + ) } BOOST_AUTO_TEST_CASE(calldata) { - char const* sourceCode = R"( + string sourceCode = R"( contract C { event E(bytes); function f(bytes a) external { @@ -329,13 +384,18 @@ BOOST_AUTO_TEST_CASE(calldata) } } )"; - compileAndRun(sourceCode); string s("abcdef"); string t("abcdefgggggggggggggggggggggggggggggggggggggggghhheeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeggg"); - callContractFunction("f(bytes)", 0x20, s.size(), s); - REQUIRE_LOG_DATA(encodeArgs(0x20, s.size(), s)); - callContractFunction("f(bytes)", 0x20, t.size(), t); - REQUIRE_LOG_DATA(encodeArgs(0x20, t.size(), t)); + bool newEncoder = false; + BOTH_ENCODERS( + compileAndRun(sourceCode); + callContractFunction("f(bytes)", 0x20, s.size(), s); + // The old encoder did not pad to multiples of 32 bytes + REQUIRE_LOG_DATA(encodeArgs(0x20, s.size()) + (newEncoder ? encodeArgs(s) : asBytes(s))); + callContractFunction("f(bytes)", 0x20, t.size(), t); + REQUIRE_LOG_DATA(encodeArgs(0x20, t.size()) + (newEncoder ? encodeArgs(t) : asBytes(t))); + newEncoder = true; + ) } BOOST_AUTO_TEST_SUITE_END() -- cgit