Unify preamble handling between test cases based on AnalysisFramework

ethereum · Aug 8, 2023 · 633cb41 · 633cb41
1 parent 9c059a3
commit 633cb41
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 27 deletions.
diff --git a/test/libsolidity/AnalysisFramework.cpp b/test/libsolidity/AnalysisFramework.cpp
@@ -51,13 +51,7 @@ AnalysisFramework::parseAnalyseAndReturnError(
 )
 {
 	compiler().reset();
-	// Do not insert license if it is already present.
-	bool insertLicense = _insertLicenseAndVersionPragma && _source.find("SPDX-License-Identifier:") == string::npos;
-	compiler().setSources({{"",
-		string{_insertLicenseAndVersionPragma ? "pragma solidity >=0.0;\n" : ""} +
-		string{insertLicense ? "// SPDX-License-Identifier: GPL-3.0\n" : ""} +
-		_source
-	}});
+	compiler().setSources({{"", _insertLicenseAndVersionPragma ? withPreamble(_source) : _source}});
 	compiler().setEVMVersion(solidity::test::CommonOptions::get().evmVersion());
 	compiler().setParserErrorRecovery(_allowRecoveryErrors);
 	_allowMultipleErrors = _allowMultipleErrors || _allowRecoveryErrors;
@@ -191,3 +185,24 @@ FunctionTypePointer AnalysisFramework::retrieveFunctionBySignature(
 {
 	return _contract.interfaceFunctions()[util::selectorFromSignatureH32(_signature)];
 }
+
+string AnalysisFramework::withPreamble(string const& _sourceCode)
+{
+	static string const version = "pragma solidity >=0.0;\n";
+	static string const license = "// SPDX-License-Identifier: GPL-3.0\n";
+
+	// NOTE: this check is intentionally loose to match weird cases.
+	// We can manually adjust a test case where this causes problem.
+	if (_sourceCode.find("SPDX-License-Identifier:") != string::npos)
+		return version + _sourceCode;
+
+	return version + license + _sourceCode;
+}
+
+StringMap AnalysisFramework::withPreamble(StringMap _sources)
+{
+	for (auto&& [sourceName, source]: _sources)
+		source = withPreamble(source);
+
+	return _sources;
+}
diff --git a/test/libsolidity/AnalysisFramework.h b/test/libsolidity/AnalysisFramework.h
@@ -104,6 +104,11 @@ class AnalysisFramework
 	/// custom constructor arguments.
 	virtual std::unique_ptr<CompilerStack> createStack() const;
 
+	/// @returns @p _sourceCode prefixed with the version pragma and the SPDX license identifier.
+	static std::string withPreamble(std::string const& _sourceCode);
+	/// @returns a copy of @p _sources with preamble prepended to all sources.
+	static StringMap withPreamble(StringMap _sources);
+
 private:
 	mutable std::unique_ptr<solidity::frontend::CompilerStack> m_compiler;
 };

diff --git a/test/libsolidity/GasTest.cpp b/test/libsolidity/GasTest.cpp
@@ -100,7 +100,6 @@ void GasTest::printUpdatedExpectations(ostream& _stream, string const& _linePref
 
 TestCase::TestResult GasTest::run(ostream& _stream, string const& _linePrefix, bool _formatted)
 {
-	string const preamble = "pragma solidity >=0.0;\n// SPDX-License-Identifier: GPL-3.0\n";
 	compiler().reset();
 	// Prerelease CBOR metadata varies in size due to changing version numbers and build dates.
 	// This leads to volatile creation cost estimates. Therefore we force the compiler to
@@ -114,7 +113,7 @@ TestCase::TestResult GasTest::run(ostream& _stream, string const& _linePrefix, b
 	}
 	settings.expectedExecutionsPerDeployment = m_optimiseRuns;
 	compiler().setOptimiserSettings(settings);
-	compiler().setSources({{"", preamble + m_source}});
+	compiler().setSources({{"", withPreamble(m_source)}});
 
 	if (!compiler().parseAndAnalyze() || !compiler().compile())
 	{

diff --git a/test/libsolidity/SyntaxTest.cpp b/test/libsolidity/SyntaxTest.cpp
@@ -43,24 +43,10 @@ SyntaxTest::SyntaxTest(string const& _filename, langutil::EVMVersion _evmVersion
 	m_parserErrorRecovery = _parserErrorRecovery;
 }
 
-string SyntaxTest::addPreamble(string const& _sourceCode)
-{
-	// Silence compiler version warning
-	string preamble = "pragma solidity >=0.0;\n";
-	// NOTE: this check is intentionally loose to match weird cases.
-	// We can manually adjust a test case where this causes problem.
-	if (_sourceCode.find("SPDX-License-Identifier:") == string::npos)
-		preamble += "// SPDX-License-Identifier: GPL-3.0\n";
-	return preamble + _sourceCode;
-}
-
 void SyntaxTest::setupCompiler()
 {
 	compiler().reset();
-	auto sourcesWithPragma = m_sources.sources;
-	for (auto& source: sourcesWithPragma)
-		source.second = addPreamble(source.second);
-	compiler().setSources(sourcesWithPragma);
+	compiler().setSources(withPreamble(m_sources.sources));
 	compiler().setEVMVersion(m_evmVersion);
 	compiler().setParserErrorRecovery(m_parserErrorRecovery);
 	compiler().setOptimiserSettings(

diff --git a/test/libsolidity/SyntaxTest.h b/test/libsolidity/SyntaxTest.h
@@ -48,9 +48,6 @@ class SyntaxTest: public AnalysisFramework, public solidity::test::CommonSyntaxT
 	SyntaxTest(std::string const& _filename, langutil::EVMVersion _evmVersion, bool _parserErrorRecovery = false);
 
 protected:
-	/// Returns @param _sourceCode prefixed with the version pragma and the SPDX license identifier.
-	static std::string addPreamble(std::string const& _sourceCode);
-
 	virtual void setupCompiler();
 	void parseAndAnalyze() override;
 	virtual void filterObtainedErrors();