Test coverage for existing parsing and formatting functionality of ga…

…s expectations
xtm2005 · Feb 21, 2024 · a9a870d · a9a870d
1 parent f4105a9
commit a9a870d
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 12 deletions.
diff --git a/test/libsolidity/util/TestFileParserTests.cpp b/test/libsolidity/util/TestFileParserTests.cpp
@@ -49,18 +49,18 @@ std::vector<FunctionCall> parse(std::string const& _source, std::map<std::string
 }
 
 void testFunctionCall(
-		FunctionCall const& _call,
-		FunctionCall::DisplayMode _mode,
-		std::string _signature = "",
-		bool _failure = true,
-		bytes _arguments = bytes{},
-		bytes _expectations = bytes{},
-		FunctionValue _value = { 0 },
-		std::string _argumentComment = "",
-		std::string _expectationComment = "",
-		std::vector<std::string> _rawArguments = std::vector<std::string>{},
-		bool _isConstructor = false,
-		bool _isLibrary = false
+	FunctionCall const& _call,
+	FunctionCall::DisplayMode _mode,
+	std::string _signature = "",
+	bool _failure = true,
+	bytes _arguments = bytes{},
+	bytes _expectations = bytes{},
+	FunctionValue _value = { 0 },
+	std::string _argumentComment = "",
+	std::string _expectationComment = "",
+	std::vector<std::string> _rawArguments = std::vector<std::string>{},
+	bool _isConstructor = false,
+	bool _isLibrary = false
 )
 {
 	BOOST_REQUIRE_EQUAL(_call.expectations.failure, _failure);
@@ -1063,6 +1063,52 @@ BOOST_AUTO_TEST_CASE(call_effects)
 	BOOST_CHECK_THROW(parse(source, builtins), std::exception);
 }
 
+BOOST_AUTO_TEST_CASE(gas)
+{
+	char const* source = R"(
+		// f() ->
+		// gas ir: 3245
+		// gas legacy: 5000
+		// gas legacyOptimized: 0
+	)";
+	auto const calls = parse(source);
+	BOOST_REQUIRE_EQUAL(calls.size(), 1);
+	BOOST_REQUIRE_EQUAL(calls[0].expectations.failure, false);
+	BOOST_TEST(calls[0].expectations.gasUsed == (std::map<std::string, u256>{
+		{"ir", 3245},
+		{"legacy", 5000},
+		{"legacyOptimized", 0},
+	}));
+}
+
+BOOST_AUTO_TEST_CASE(gas_before_call)
+{
+	char const* source = R"(
+		// gas ir: 3245
+		// f() ->
+	)";
+	BOOST_REQUIRE_THROW(parse(source), TestParserError);
+}
+
+BOOST_AUTO_TEST_CASE(gas_invalid_run_type)
+{
+	char const* source = R"(
+		// f() ->
+		// gas ir: 3245
+		// gas experimental: 5000
+	)";
+	BOOST_REQUIRE_THROW(parse(source), TestParserError);
+}
+
+BOOST_AUTO_TEST_CASE(gas_duplicate_run_type)
+{
+	char const* source = R"(
+		// f() ->
+		// gas ir: 3245
+		// gas ir: 3245
+	)";
+	BOOST_REQUIRE_THROW(parse(source), TestParserError);
+}
 BOOST_AUTO_TEST_SUITE_END()
 
 }
diff --git a/test/libsolidity/util/TestFunctionCallTests.cpp b/test/libsolidity/util/TestFunctionCallTests.cpp
@@ -250,6 +250,34 @@ BOOST_AUTO_TEST_CASE(format_failure_singleline)
 	BOOST_REQUIRE_EQUAL(test.format(), "// f(uint8): 1 -> FAILURE");
 }
 
+BOOST_AUTO_TEST_CASE(format_gas)
+{
+	FunctionCall call{
+		"f()",
+		FunctionValue{0},
+		FunctionCallArgs{},
+		FunctionCallExpectations{
+			std::vector<Parameter>{},
+			false, // failure
+			"some comment",
+			{
+				{"ir", 3245},
+				{"legacy", 5000},
+				{"legacy optimized", 0},
+			},
+		}
+	};
+	call.omitsArrow = false;
+
+	BOOST_REQUIRE_EQUAL(
+		TestFunctionCall(call).format(),
+		"// f() -> #some comment#\n"
+		"// gas ir: 3245\n"
+		"// gas legacy: 5000\n"
+		"// gas legacy optimized: 0"
+	);
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 
 }