solidity/test/boostTest.cpp

/*
	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
/** @file boostTest.cpp
 * @author Marko Simovic <markobarko@gmail.com>
 * @date 2014
 * Stub for generating main boost.test module.
 * Original code taken from boost sources.
 */

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"

#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable:4535) // calling _set_se_translator requires /EHa
#endif
#include <boost/test/unit_test.hpp>
#if defined(_MSC_VER)
#pragma warning(pop)
#endif

#pragma GCC diagnostic pop

#include <test/InteractiveTests.h>
#include <test/Common.h>
#include <test/EVMHost.h>

#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/filesystem.hpp>
#include <string>

using namespace boost::unit_test;
using namespace solidity::frontend::test;
namespace fs = boost::filesystem;
using namespace std;

namespace
{
void removeTestSuite(std::string const& _name)
{
	master_test_suite_t& master = framework::master_test_suite();
	auto id = master.get(_name);
	assert(id != INV_TEST_UNIT_ID);
	master.remove(id);
}

int registerTests(
	boost::unit_test::test_suite& _suite,
	boost::filesystem::path const& _basepath,
	boost::filesystem::path const& _path,
	bool _enforceViaYul,
	vector<string> const& _labels,
	TestCase::TestCaseCreator _testCaseCreator
)
{
	int numTestsAdded = 0;
	fs::path fullpath = _basepath / _path;
	TestCase::Config config{
		fullpath.string(),
		solidity::test::CommonOptions::get().evmVersion(),
		solidity::test::CommonOptions::get().vmPaths,
		_enforceViaYul,
		solidity::test::CommonOptions::get().enforceGasTest,
		solidity::test::CommonOptions::get().enforceGasTestMinValue
	};
	if (fs::is_directory(fullpath))
	{
		test_suite* sub_suite = BOOST_TEST_SUITE(_path.filename().string());
		for (auto const& entry: boost::iterator_range<fs::directory_iterator>(
			fs::directory_iterator(fullpath),
			fs::directory_iterator()
		))
			if (fs::is_directory(entry.path()) || TestCase::isTestFilename(entry.path().filename()))
				numTestsAdded += registerTests(
					*sub_suite,
					_basepath, _path / entry.path().filename(),
					_enforceViaYul,
					_labels,
					_testCaseCreator
				);
		_suite.add(sub_suite);
	}
	else
	{
		// This must be a vector of unique_ptrs because Boost.Test keeps the equivalent of a string_view to the filename
		// that is passed in. If the strings were stored directly in the vector, pointers/references to them would be
		// invalidated on reallocation.
		static vector<unique_ptr<string const>> filenames;

		filenames.emplace_back(make_unique<string>(_path.string()));
		auto test_case = make_test_case(
			[config, _testCaseCreator]
			{
				BOOST_REQUIRE_NO_THROW({
					try
					{
						stringstream errorStream;
						auto testCase = _testCaseCreator(config);
						if (testCase->shouldRun())
							switch (testCase->run(errorStream))
							{
								case TestCase::TestResult::Success:
									break;
								case TestCase::TestResult::Failure:
									BOOST_ERROR("Test expectation mismatch.\n" + errorStream.str());
									break;
								case TestCase::TestResult::FatalError:
									BOOST_ERROR("Fatal error during test.\n" + errorStream.str());
									break;
							}
					}
					catch (boost::exception const& _e)
					{
						BOOST_ERROR("Exception during extracted test: " << boost::diagnostic_information(_e));
					}
			   });
			},
			_path.stem().string(),
			*filenames.back(),
			0
		);
		for (auto const& _label: _labels)
			test_case->add_label(_label);
		_suite.add(test_case);
		numTestsAdded = 1;
	}
	return numTestsAdded;
}

void initializeOptions()
{
	auto const& suite = boost::unit_test::framework::master_test_suite();

	auto options = std::make_unique<solidity::test::CommonOptions>();
	solAssert(options->parse(suite.argc, suite.argv), "Failed to parse options!");
	options->validate();

	solidity::test::CommonOptions::setSingleton(std::move(options));
}
}

// TODO: Prototype -- why isn't this declared in the boost headers?
// TODO: replace this with a (global) fixture.
test_suite* init_unit_test_suite( int /*argc*/, char* /*argv*/[] );

test_suite* init_unit_test_suite( int /*argc*/, char* /*argv*/[] )
{
	master_test_suite_t& master = framework::master_test_suite();
	master.p_name.value = "SolidityTests";

	initializeOptions();

	bool disableSemantics = true;
	try
	{
		disableSemantics = !solidity::test::EVMHost::checkVmPaths(solidity::test::CommonOptions::get().vmPaths);
	}
	catch (std::runtime_error const& _exception)
	{
		cerr << "Error: " << _exception.what() << endl;
		exit(1);
	}
	if (disableSemantics)
		cout << endl << "--- SKIPPING ALL SEMANTICS TESTS ---" << endl << endl;

	// Include the interactive tests in the automatic tests as well
	for (auto const& ts: g_interactiveTestsuites)
	{
		auto const& options = solidity::test::CommonOptions::get();

		if (ts.smt && options.disableSMT)
			continue;

		if (ts.needsVM && disableSemantics)
			continue;

		solAssert(registerTests(
			master,
			options.testPath / ts.path,
			ts.subpath,
			options.enforceViaYul,
			ts.labels,
			ts.testCaseCreator
		) > 0, std::string("no ") + ts.title + " tests found");
	}

	if (disableSemantics)
	{
		for (auto suite: {
			"ABIDecoderTest",
			"ABIEncoderTest",
			"SolidityAuctionRegistrar",
			"SolidityFixedFeeRegistrar",
			"SolidityWallet",
			"GasMeterTests",
			"GasCostTests",
			"SolidityEndToEndTest",
			"SolidityOptimizer"
		})
			removeTestSuite(suite);
	}

	return nullptr;
}

// BOOST_TEST_DYN_LINK should be defined if user want to link against shared boost test library
#ifdef BOOST_TEST_DYN_LINK

// Because we want to have customized initialization function and support shared boost libraries at the same time,
// we are forced to customize the entry point.
// see: https://www.boost.org/doc/libs/1_67_0/libs/test/doc/html/boost_test/adv_scenarios/shared_lib_customizations/init_func.html

int main(int argc, char* argv[])
{
	auto init_unit_test = []() -> bool { init_unit_test_suite(0, nullptr); return true; };
	return boost::unit_test::unit_test_main(init_unit_test, argc, argv);
}

#endif