cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Unify isoltest and soltest options code

Browse Source 
Also provide a default value for ipc-path, which is the same one as aleth uses.
This commit is contained in:
Mathias Baumann 2019-02-19 17:34:59 +01:00
parent 8b342cbe6a
commit 1672902abb
10 changed files with 229 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
test/Common.cpp
View File

@ -17,16 +17,25 @@
#include <test/Common.h>
#include <libdevcore/Assertions.h>
#include <boost/filesystem.hpp>
#include <boost/program_options.hpp>
namespace fs = boost::filesystem;
namespace po = boost::program_options;
namespace dev
{
namespace test
{
boost::filesystem::path getTestPath()
/// If non-empty returns the value of the env. variable ETH_TEST_PATH, otherwise
/// it tries to find a path that contains the directories "libsolidity/syntaxTests"
/// and returns it if found.
/// The routine searches in the current directory, and inside the "test" directory
/// starting from the current directory and up to three levels up.
/// @returns the path of the first match or an empty path if not found.
boost::filesystem::path testPath()
{
if (auto path = getenv("ETH_TEST_PATH"))
return path;
@ -48,6 +57,70 @@ boost::filesystem::path getTestPath()
return {};
}
std::string IPCEnvOrDefaultPath()
{
if (auto path = getenv("ETH_TEST_IPC"))
return path;
if (auto home = getenv("HOME"))
return std::string(home) + "/.ethereum/geth.ipc";
return std::string{};
}
CommonOptions::CommonOptions(std::string _caption):
options(_caption,
po::options_description::m_default_line_length,
po::options_description::m_default_line_length - 23
)
{
options.add_options()
("testpath", po::value<fs::path>(&this->testPath)->default_value(dev::test::testPath()), "path to test files")
("ipcpath", po::value<fs::path>(&ipcPath)->default_value(IPCEnvOrDefaultPath()), "path to ipc socket")
("no-ipc", po::bool_switch(&disableIPC), "disable semantic tests")
("no-smt", po::bool_switch(&disableSMT), "disable SMT checker");
}
void CommonOptions::validate() const
{
assertThrow(
!testPath.empty(),
ConfigException,
"No test path specified. The --testpath argument must not be empty when given."
);
assertThrow(
fs::exists(testPath),
ConfigException,
"Invalid test path specified."
);
if (!disableIPC)
{
assertThrow(
!ipcPath.empty(),
ConfigException,
"No ipc path specified. The --ipcpath argument must not be empty when given."
);
assertThrow(
fs::exists(ipcPath),
ConfigException,
"Invalid ipc path specified."
);
}
}
bool CommonOptions::parse(int argc, char const* const* argv)
{
po::variables_map arguments;
po::command_line_parser cmdLineParser(argc, argv);
cmdLineParser.options(options);
po::store(cmdLineParser.run(), arguments);
po::notify(arguments);
return true;
}
}
}

31
test/Common.h
View File

@ -17,20 +17,37 @@
#pragma once
#include <libdevcore/Exceptions.h>
#include <boost/filesystem/path.hpp>
#include <boost/program_options.hpp>
#include <boost/noncopyable.hpp>
namespace dev
{
namespace test
{
/// First checks the environment variable ETH_TEST_PATH. If empty,
/// tries to find a path that contains the directories "libsolidity/syntaxTests"
/// and returns it if found.
/// The routine searches in the current directory, and inside the "test" directory
/// starting from the current directory and up to three levels up.
/// @returns the path of the first match or an empty path if not found.
boost::filesystem::path getTestPath();
struct ConfigException : public Exception {};
struct CommonOptions: boost::noncopyable
{
boost::filesystem::path ipcPath;
boost::filesystem::path testPath;
bool optimize = false;
bool disableIPC = false;
bool disableSMT = false;
virtual bool parse(int argc, char const* const* argv);
// Throws a ConfigException on error
virtual void validate() const;
protected:
CommonOptions(std::string caption = "");
boost::program_options::options_description options;
};
}
}

2
test/ExecutionFramework.cpp
View File

@ -40,7 +40,7 @@ h256 const EmptyTrie("0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5
string getIPCSocketPath()
{
string ipcPath = dev::test::Options::get().ipcPath;
string ipcPath = dev::test::Options::get().ipcPath.string();
if (ipcPath.empty())
BOOST_FAIL("ERROR: ipcPath not set! (use --ipcpath <path> or the environment variable ETH_TEST_IPC)");

42
test/Options.cpp
View File

@ -35,12 +35,14 @@ using namespace dev::test;
namespace fs = boost::filesystem;
namespace po = boost::program_options;
Options const& Options::get()
{
static Options instance;
return instance;
}
Options::Options()
{
auto const& suite = boost::unit_test::framework::master_test_suite();
@ -48,51 +50,13 @@ Options::Options()
if (suite.argc == 0)
return;
po::options_description options("",
po::options_description::m_default_line_length,
po::options_description::m_default_line_length - 23);
options.add_options()
("testpath", po::value<fs::path>(&testPath)->default_value(getTestPath()), "path to test files")
("ipcpath", po::value<string>(&ipcPath)->default_value(getenv("ETH_TEST_IPC")), "path to ipc socket")
("no-ipc", po::bool_switch(&disableIPC), "disable semantic tests")
("no-smt", po::bool_switch(&disableSMT), "disable SMT checker")
("optimize", po::bool_switch(&optimize), "enables optimization")
("abiencoderv2", po::bool_switch(&useABIEncoderV2), "enables abi encoder v2")
("evm-version", po::value(&evmVersionString), "which evm version to use")
("show-messages", po::bool_switch(&showMessages), "enables message output");
po::variables_map arguments;
po::command_line_parser cmdLineParser(suite.argc, suite.argv);
cmdLineParser.options(options);
po::store(cmdLineParser.run(), arguments);
po::notify(arguments);
if (!disableIPC)
{
solAssert(
!ipcPath.empty(),
"No ipc path specified. The --ipcpath argument is required, unless --no-ipc is used."
);
solAssert(
fs::exists(ipcPath),
"Invalid ipc path specified."
);
}
}
void Options::validate() const
{
solAssert(
!dev::test::Options::get().testPath.empty(),
"No test path specified. The --testpath argument is required."
);
if (!disableIPC)
solAssert(
!dev::test::Options::get().ipcPath.empty(),
"No ipc path specified. The --ipcpath argument is required, unless --no-ipc is used."
);
parse(suite.argc, suite.argv);
}
dev::solidity::EVMVersion Options::evmVersion() const

13
test/Options.h
View File

@ -14,17 +14,16 @@
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file TestHelper.h
*/
#pragma once
#include <liblangutil/EVMVersion.h>
#include <test/Common.h>
#include <boost/test/unit_test.hpp>
#include <boost/filesystem.hpp>
#include <boost/program_options.hpp>
#include <boost/version.hpp>
#include <boost/noncopyable.hpp>
#include <functional>
@ -33,17 +32,11 @@ namespace dev
namespace test
{
struct Options: boost::noncopyable
struct Options: CommonOptions
{
std::string ipcPath;
boost::filesystem::path testPath;
bool showMessages = false;
bool optimize = false;
bool disableIPC = false;
bool disableSMT = false;
bool useABIEncoderV2 = false;
void validate() const;
solidity::EVMVersion evmVersion() const;
static Options const& get();

2
test/boostTest.cpp
View File

@ -144,7 +144,7 @@ test_suite* init_unit_test_suite( int /*argc*/, char* /*argv*/[] )
master,
options.testPath / ts.path,
ts.subpath,
options.ipcPath,
options.ipcPath.string(),
ts.testCaseCreator
) > 0, std::string("no ") + ts.title + " tests found");
}

1
test/tools/CMakeLists.txt
View File

@ -10,6 +10,7 @@ target_link_libraries(yulopti PRIVATE solidity ${Boost_PROGRAM_OPTIONS_LIBRARIES
add_executable(isoltest
isoltest.cpp
IsolTestOptions.cpp
../Options.cpp
../Common.cpp
../TestCase.cpp

74
test/tools/IsolTestOptions.cpp Normal file
View File

@ -0,0 +1,74 @@
/*
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/>.
*/
/** @file IsolTestOptions.cpp
* @date 2019
*/
#include <test/tools/IsolTestOptions.h>
#include <boost/filesystem.hpp>
#include <string>
#include <iostream>
namespace fs = boost::filesystem;
namespace po = boost::program_options;
namespace dev
{
namespace test
{
auto const description = R"(isoltest, tool for interactively managing test contracts.
Usage: isoltest [Options] --ipcpath ipcpath
Interactively validates test contracts.
Allowed options)";
std::string editorPath()
{
if (getenv("EDITOR"))
return getenv("EDITOR");
else if (fs::exists("/usr/bin/editor"))
return "/usr/bin/editor";
return std::string{};
}
IsolTestOptions::IsolTestOptions(std::string* _editor):
CommonOptions(description)
{
options.add_options()
("help", po::bool_switch(&showHelp), "Show this help screen.")
("no-color", po::bool_switch(&formatted), "don't use colors")
("editor", po::value<std::string>(_editor)->default_value(editorPath()), "editor for opening test files");
}
bool IsolTestOptions::parse(int _argc, char const* const* _argv)
{
bool const res = CommonOptions::parse(_argc, _argv);
if (showHelp || !res)
{
std::cout << options << std::endl;
return false;
}
return res;
}
}
}

38
test/tools/IsolTestOptions.h Normal file
View File

@ -0,0 +1,38 @@
/*
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/>.
*/
/** @file IsolTestOptions.h
*/
#pragma once
#include <test/Common.h>
namespace dev
{
namespace test
{
struct IsolTestOptions: CommonOptions
{
bool formatted = true;
bool showHelp = false;
IsolTestOptions(std::string* _editor);
bool parse(int _argc, char const* const* _argv) override;
};
}
}

78
test/tools/isoltest.cpp
View File

@ -19,6 +19,7 @@
#include <libdevcore/AnsiColorized.h>
#include <test/Common.h>
#include <test/tools/IsolTestOptions.h>
#include <test/libsolidity/AnalysisFramework.h>
#include <test/InteractiveTests.h>
@ -322,74 +323,18 @@ boost::optional<TestStats> runTestSuite(
}
int main(int argc, char *argv[])
int main(int argc, char const *argv[])
{
setupTerminal();
if (getenv("EDITOR"))
TestTool::editor = getenv("EDITOR");
else if (fs::exists("/usr/bin/editor"))
TestTool::editor = "/usr/bin/editor";
dev::test::IsolTestOptions options(&TestTool::editor);
fs::path testPath;
string ipcPath;
bool disableIPC = false;
bool disableSMT = false;
bool formatted = true;
po::options_description options(
R"(isoltest, tool for interactively managing test contracts.
Usage: isoltest [Options] --ipcpath ipcpath
Interactively validates test contracts.
Allowed options)",
po::options_description::m_default_line_length,
po::options_description::m_default_line_length - 23);
options.add_options()
("help", "Show this help screen.")
("testpath", po::value<fs::path>(&testPath), "path to test files")
("ipcpath", po::value<string>(&ipcPath), "path to ipc socket")
("no-ipc", "disable semantic tests")
("no-smt", "disable SMT checker")
("no-color", "don't use colors")
("editor", po::value<string>(&TestTool::editor), "editor for opening contracts");
po::variables_map arguments;
try
{
po::command_line_parser cmdLineParser(argc, argv);
cmdLineParser.options(options);
po::store(cmdLineParser.run(), arguments);
if (arguments.count("help"))
{
cout << options << endl;
return 0;
}
if (arguments.count("no-color"))
formatted = false;
po::notify(arguments);
if (arguments.count("no-ipc"))
disableIPC = true;
if (options.parse(argc, argv))
options.validate();
else
{
solAssert(
!ipcPath.empty(),
"No ipc path specified. The --ipcpath argument is required, unless --no-ipc is used."
);
solAssert(
fs::exists(ipcPath),
"Invalid ipc path specified."
);
}
if (arguments.count("no-smt"))
disableSMT = true;
return 1;
}
catch (std::exception const& _exception)
{
@ -397,29 +342,26 @@ Allowed options)",
return 1;
}
if (testPath.empty())
testPath = dev::test::getTestPath();
TestStats global_stats{0, 0};
// Actually run the tests.
// Interactive tests are added in InteractiveTests.h
for (auto const& ts: g_interactiveTestsuites)
{
if (ts.ipc && disableIPC)
if (ts.ipc && options.disableIPC)
continue;
if (ts.smt && disableSMT)
if (ts.smt && options.disableSMT)
continue;
if (auto stats = runTestSuite(ts.title, testPath / ts.path, ts.subpath, ipcPath, ts.testCaseCreator, formatted))
if (auto stats = runTestSuite(ts.title, options.testPath / ts.path, ts.subpath, options.ipcPath.string(), ts.testCaseCreator, options.formatted))
global_stats += *stats;
else
return 1;
}
cout << endl << "Summary: ";
AnsiColorized(cout, formatted, {BOLD, global_stats ? GREEN : RED}) <<
AnsiColorized(cout, options.formatted, {BOLD, global_stats ? GREEN : RED}) <<
global_stats.successCount << "/" << global_stats.testCount;
cout << " tests successful." << endl;