Migrate ethdebug CLI tests to isolest

Author: nikola-matic

test/CMakeLists.txt

@@ -79,6 +79,8 @@ set(libsolidity_sources
     libsolidity/ASTJSONTest.h
     libsolidity/ErrorCheck.cpp
     libsolidity/ErrorCheck.h
+    libsolidity/EthdebugTest.cpp
+    libsolidity/EthdebugTest.h
     libsolidity/FunctionDependencyGraphTest.cpp
     libsolidity/FunctionDependencyGraphTest.h
     libsolidity/GasCosts.cpp
@@ -87,6 +89,8 @@ set(libsolidity_sources
     libsolidity/GasTest.h
     libsolidity/Imports.cpp
     libsolidity/InlineAssembly.cpp
+    libsolidity/JSONExpectationTest.cpp
+    libsolidity/JSONExpectationTest.h
     libsolidity/LibSolc.cpp
     libsolidity/Metadata.cpp
     libsolidity/MemoryGuardTest.cpp

test/InteractiveTests.h

@@ -22,6 +22,7 @@
 #include <test/libsolidity/ABIJsonTest.h>
 #include <test/libsolidity/ASTJSONTest.h>
 #include <test/libsolidity/ASTPropertyTest.h>
+#include <test/libsolidity/EthdebugTest.h>
 #include <libsolidity/FunctionDependencyGraphTest.h>
 #include <test/libsolidity/GasTest.h>
 #include <test/libsolidity/MemoryGuardTest.h>
@@ -93,6 +94,7 @@ Testsuite const g_interactiveTestsuites[] = {
 	{"JSON ABI",                    "libsolidity", "ABIJson",                       false, false, &ABIJsonTest::create},
 	{"JSON Natspec",                "libsolidity", "natspecJSON",                   false, false, &NatspecJSONTest::create},
 	{"SMT Checker",                 "libsolidity", "smtCheckerTests",               true,  false, &SMTCheckerTest::create},
+	{"Ethdebug",                    "libsolidity", "ethdebugTests",                 false, false, &EthdebugTest::create},
 	{"Gas Estimates",               "libsolidity", "gasTests",                      false, false, &GasTest::create},
 	{"Memory Guard",                "libsolidity", "memoryGuardTests",              false, false, &MemoryGuardTest::create},
 	{"AST Properties",              "libsolidity", "astPropertyTests",              false, false, &ASTPropertyTest::create},

test/libsolidity/EthdebugTest.cpp

@@ -0,0 +1,162 @@
+/*
+	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/>.
+*/
+// SPDX-License-Identifier: GPL-3.0
+
+#include <test/libsolidity/EthdebugTest.h>
+#include <test/Common.h>
+
+#include <liblangutil/DebugInfoSelection.h>
+
+#include <libsolidity/interface/OptimiserSettings.h>
+
+#include <boost/throw_exception.hpp>
+
+#include <algorithm>
+#include <stdexcept>
+
+using namespace solidity;
+using namespace solidity::frontend;
+using namespace solidity::frontend::test;
+using namespace solidity::langutil;
+using namespace std::string_literals;
+
+EthdebugTest::EthdebugTest(std::string const& _filename):
+	JSONExpectationTest(_filename)
+{
+	m_optimise = m_reader.boolSetting("optimize", false);
+	m_optimiseYul = m_reader.boolSetting("optimize-yul", false);
+	m_useSSACFG = m_reader.boolSetting("compileViaSSACFG", false);
+
+	auto const revertStrings = revertStringsFromString(m_reader.stringSetting("revertStrings", "default"));
+	if (!revertStrings)
+		BOOST_THROW_EXCEPTION(std::runtime_error("Invalid revertStrings setting."));
+	m_revertStrings = *revertStrings;
+}
+
+void EthdebugTest::setupCompiler(CompilerStack& _compiler)
+{
+	AnalysisFramework::setupCompiler(_compiler);
+
+	_compiler.setViaIR(true);
+	_compiler.setExperimental(true);
+	if (m_useSSACFG)
+		_compiler.setViaSSACFG(true);
+
+	DebugInfoSelection selection = DebugInfoSelection::Default();
+	selection.enable("ethdebug");
+	_compiler.selectDebugInfo(selection);
+
+	_compiler.setMetadataFormat(CompilerStack::MetadataFormat::NoMetadata);
+	_compiler.setRevertStringBehaviour(m_revertStrings);
+
+	OptimiserSettings settings = m_optimise ? OptimiserSettings::standard() : OptimiserSettings::minimal();
+	if (m_optimiseYul)
+		settings.runYulOptimiser = true;
+	_compiler.setOptimiserSettings(settings);
+}
+
+JSONExpectationTest::PathParts EthdebugTest::splitPath(std::string_view _path) const
+{
+	if (_path.empty())
+		BOOST_THROW_EXCEPTION(std::runtime_error("Empty path in expectation"));
+	if (_path[0] == ' ' || _path[0] == '\t')
+		BOOST_THROW_EXCEPTION(std::runtime_error(
+			"Path must not have leading whitespace: "s.append(_path)
+		));
+
+	if (_path[0] == '(')
+		return JSONExpectationTest::splitPath(_path);
+
+	if (_path[0] == '.')
+	{
+		auto const secondDot = _path.find('.', 1);
+		if (secondDot == std::string_view::npos)
+			return {std::string_view{}, _path.substr(1), std::string_view{}};
+		return {
+			std::string_view{},
+			_path.substr(1, secondDot - 1),
+			_path.substr(secondDot + 1)
+		};
+	}
+
+	auto const colonPos = _path.find(':');
+	size_t const searchStart = colonPos == std::string_view::npos ? 0 : colonPos + 1;
+
+	auto const outputDot = _path.find('.', searchStart);
+	if (outputDot == std::string_view::npos)
+		return {_path, std::string_view{}, std::string_view{}};
+
+	auto const pathDot = _path.find('.', outputDot + 1);
+	if (pathDot == std::string_view::npos)
+		return {
+			_path.substr(0, outputDot),
+			_path.substr(outputDot + 1),
+			std::string_view{}
+		};
+	return {
+		_path.substr(0, outputDot),
+		_path.substr(outputDot + 1, pathDot - outputDot - 1),
+		_path.substr(pathDot + 1)
+	};
+}
+
+std::optional<Json> EthdebugTest::fetchOutput(
+	std::string_view _qualifiedContract,
+	std::string_view _outputName
+) const
+{
+	if (compiler().state() < CompilerStack::State::CompilationSuccessful)
+		return std::nullopt;
+
+	if (_qualifiedContract.empty())
+	{
+		if (_outputName == "compilation")
+			return compiler().ethdebugCompilation();
+		if (_outputName == "resources")
+			return compiler().ethdebug();
+		return std::nullopt;
+	}
+
+	if (auto const resolved = resolveContractName(_qualifiedContract))
+	{
+		if (_outputName == "creation")
+			return compiler().ethdebug(*resolved);
+		if (_outputName == "runtime")
+			return compiler().ethdebugRuntime(*resolved);
+		if (_outputName == "contract")
+		{
+			Json const creation = compiler().ethdebug(*resolved);
+			if (creation.is_null() || !creation.contains("contract"))
+				return std::nullopt;
+			return creation["contract"];
+		}
+	}
+	return std::nullopt;
+}
+
+std::optional<std::string> EthdebugTest::resolveContractName(std::string_view _name) const
+{
+	auto const& contractNames = compiler().contractNames();
+
+	auto const isMatch = [&](std::string const& contractName) {
+		return contractName == _name || compiler().contractDefinition(contractName).name() == _name;
+	};
+
+	if (std::ranges::count_if(contractNames, isMatch) != 1)
+		return std::nullopt;
+	return *std::ranges::find_if(contractNames, isMatch);
+}

test/libsolidity/EthdebugTest.h

@@ -0,0 +1,72 @@
+/*
+	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/>.
+*/
+// SPDX-License-Identifier: GPL-3.0
+
+#pragma once
+
+#include <test/libsolidity/JSONExpectationTest.h>
+
+#include <libsolidity/interface/DebugSettings.h>
+
+namespace solidity::frontend::test
+{
+/// Isoltest test case for asserting against the compiler's ethdebug JSON output.
+///
+/// Settings (in the `// ====` block):
+///   - `EVMVersion: <constraint>`        — gates whether the test runs (inherited).
+///   - `optimize: <bool>`                — enable optimizer (default: false).
+///   - `optimize-yul: <bool>`            — additionally run the Yul optimizer (default: false).
+///   - `compileViaSSACFG: <bool>`        — route codegen through the SSA-CFG (default: false).
+///   - `revertStrings: default|strip|debug|verboseDebug`
+///                                       — revert string behavior (default: default).
+///
+/// Compilation is always performed with `viaIR=true`, `experimental=true`, ethdebug
+/// debug info enabled, and metadata stripped, so the output is stable across builds.
+///
+/// Scope keys exposed to expectations:
+///   - Globals: `.resources`, `.compilation`.
+///   - Per contract: `Contract.creation`, `Contract.runtime`, `Contract.contract`.
+///   - Source-qualified per contract (when needed to disambiguate same-named
+///     contracts in different sources): `source.sol:Contract.creation`, etc.
+class EthdebugTest: public JSONExpectationTest
+{
+public:
+	static std::unique_ptr<TestCase> create(Config const& _config)
+	{
+		return std::make_unique<EthdebugTest>(_config.filename);
+	}
+
+	EthdebugTest(std::string const& _filename);
+
+protected:
+	void setupCompiler(CompilerStack& _compiler) override;
+	PathParts splitPath(std::string_view _path) const override;
+	std::optional<Json> fetchOutput(
+		std::string_view _qualifiedContract,
+		std::string_view _outputName
+	) const override;
+
+private:
+	std::optional<std::string> resolveContractName(std::string_view _name) const;
+
+	bool m_optimise = false;
+	bool m_optimiseYul = false;
+	bool m_useSSACFG = false;
+	RevertStrings m_revertStrings = RevertStrings::Default;
+};
+
+}