Unify preamble handling between test cases based on AnalysisFramework

test/libsolidity/util/Common.cpp

@@ -0,0 +1,46 @@
+/*
+	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/util/Common.h>
+
+using namespace std;
+using namespace solidity;
+using namespace solidity::frontend;
+
+string test::withPreamble(string const& _sourceCode)
+{
+	static string const versionPragma = "pragma solidity >=0.0;\n";
+	static string const licenseComment = "// 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.
+	bool licenseMissing = _sourceCode.find("SPDX-License-Identifier:") == string::npos;
+
+	return
+		versionPragma +
+		(licenseMissing ? licenseComment : "") +
+		_sourceCode;
+}
+
+StringMap test::withPreamble(StringMap _sources)
+{
+	for (auto&& [sourceName, source]: _sources)
+		source = withPreamble(source);
+
+	return _sources;
+}

test/libsolidity/util/Common.h

@@ -0,0 +1,34 @@
+/*
+	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
+
+/// Utilities shared by multiple libsolidity tests.
+
+#include <libsolidity/interface/CompilerStack.h>
+
+#include <string>
+
+namespace solidity::frontend::test
+{
+
+/// @returns @p _sourceCode prefixed with the version pragma and the SPDX license identifier.
+std::string withPreamble(std::string const& _sourceCode);
+
+/// @returns a copy of @p _sources with preamble prepended to all sources.
+StringMap withPreamble(StringMap _sources);
+
+} // namespace solidity::frontend::test