/* 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 . */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if defined(_WIN32) #include #endif using namespace dev; using namespace dev::solidity; using namespace dev::solidity::test; using namespace dev::formatting; using namespace std; namespace po = boost::program_options; namespace fs = boost::filesystem; struct TestStats { int successCount = 0; int testCount = 0; int skippedCount = 0; operator bool() const noexcept { return successCount + skippedCount == testCount; } TestStats& operator+=(TestStats const& _other) noexcept { successCount += _other.successCount; testCount += _other.testCount; skippedCount += _other.skippedCount; return *this; } }; class TestTool { public: TestTool( TestCase::TestCaseCreator _testCaseCreator, string const& _name, fs::path const& _path, string const& _ipcPath, bool _formatted, langutil::EVMVersion _evmVersion ): m_testCaseCreator(_testCaseCreator), m_name(_name), m_path(_path), m_ipcPath(_ipcPath), m_formatted(_formatted), m_evmVersion(_evmVersion) {} enum class Result { Success, Failure, Exception, Skipped }; Result process(); static TestStats processPath( TestCase::TestCaseCreator _testCaseCreator, fs::path const& _basepath, fs::path const& _path, string const& _ipcPath, bool _formatted, langutil::EVMVersion _evmVersion ); static string editor; private: enum class Request { Skip, Rerun, Quit }; Request handleResponse(bool _exception); TestCase::TestCaseCreator m_testCaseCreator; string const m_name; fs::path const m_path; string m_ipcPath; bool const m_formatted = false; langutil::EVMVersion const m_evmVersion; unique_ptr m_test; static bool m_exitRequested; }; string TestTool::editor; bool TestTool::m_exitRequested = false; TestTool::Result TestTool::process() { bool success; std::stringstream outputMessages; (AnsiColorized(cout, m_formatted, {BOLD}) << m_name << ": ").flush(); try { m_test = m_testCaseCreator(TestCase::Config{m_path.string(), m_ipcPath, m_evmVersion}); if (m_test->supportedForEVMVersion(m_evmVersion)) success = m_test->run(outputMessages, " ", m_formatted); else { AnsiColorized(cout, m_formatted, {BOLD, YELLOW}) << "NOT RUN" << endl; return Result::Skipped; } } catch(boost::exception const& _e) { AnsiColorized(cout, m_formatted, {BOLD, RED}) << "Exception during test: " << boost::diagnostic_information(_e) << endl; return Result::Exception; } catch (std::exception const& _e) { AnsiColorized(cout, m_formatted, {BOLD, RED}) << "Exception during test: " << _e.what() << endl; return Result::Exception; } catch (...) { AnsiColorized(cout, m_formatted, {BOLD, RED}) << "Unknown exception during test." << endl; return Result::Exception; } if (success) { AnsiColorized(cout, m_formatted, {BOLD, GREEN}) << "OK" << endl; return Result::Success; } else { AnsiColorized(cout, m_formatted, {BOLD, RED}) << "FAIL" << endl; AnsiColorized(cout, m_formatted, {BOLD, CYAN}) << " Contract:" << endl; m_test->printSource(cout, " ", m_formatted); cout << endl << outputMessages.str() << endl; return Result::Failure; } } TestTool::Request TestTool::handleResponse(bool _exception) { if (_exception) cout << "(e)dit/(s)kip/(q)uit? "; else cout << "(e)dit/(u)pdate expectations/(s)kip/(q)uit? "; cout.flush(); while (true) { switch(readStandardInputChar()) { case 's': cout << endl; return Request::Skip; case 'u': if (_exception) break; else { cout << endl; ofstream file(m_path.string(), ios::trunc); m_test->printSource(file); file << "// ----" << endl; m_test->printUpdatedExpectations(file, "// "); return Request::Rerun; } case 'e': cout << endl << endl; if (system((TestTool::editor + " \"" + m_path.string() + "\"").c_str())) cerr << "Error running editor command." << endl << endl; return Request::Rerun; case 'q': cout << endl; return Request::Quit; default: break; } } } TestStats TestTool::processPath( TestCase::TestCaseCreator _testCaseCreator, fs::path const& _basepath, fs::path const& _path, string const& _ipcPath, bool _formatted, langutil::EVMVersion _evmVersion ) { std::queue paths; paths.push(_path); int successCount = 0; int testCount = 0; int skippedCount = 0; while (!paths.empty()) { auto currentPath = paths.front(); fs::path fullpath = _basepath / currentPath; if (fs::is_directory(fullpath)) { paths.pop(); for (auto const& entry: boost::iterator_range( fs::directory_iterator(fullpath), fs::directory_iterator() )) if (fs::is_directory(entry.path()) || TestCase::isTestFilename(entry.path().filename())) paths.push(currentPath / entry.path().filename()); } else if (m_exitRequested) { ++testCount; paths.pop(); } else { ++testCount; TestTool testTool(_testCaseCreator, currentPath.string(), fullpath, _ipcPath, _formatted, _evmVersion); auto result = testTool.process(); switch(result) { case Result::Failure: case Result::Exception: switch(testTool.handleResponse(result == Result::Exception)) { case Request::Quit: paths.pop(); m_exitRequested = true; break; case Request::Rerun: cout << "Re-running test case..." << endl; --testCount; break; case Request::Skip: paths.pop(); ++skippedCount; break; } break; case Result::Success: paths.pop(); ++successCount; break; case Result::Skipped: paths.pop(); ++skippedCount; break; } } } return { successCount, testCount, skippedCount }; } namespace { void setupTerminal() { #if defined(_WIN32) && defined(ENABLE_VIRTUAL_TERMINAL_PROCESSING) // Set output mode to handle virtual terminal (ANSI escape sequences) // ignore any error, as this is just a "nice-to-have" // only windows needs to be taken care of, as other platforms (Linux/OSX) support them natively. HANDLE hOut = GetStdHandle(STD_OUTPUT_HANDLE); if (hOut == INVALID_HANDLE_VALUE) return; DWORD dwMode = 0; if (!GetConsoleMode(hOut, &dwMode)) return; dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING; if (!SetConsoleMode(hOut, dwMode)) return; #endif } boost::optional runTestSuite( string const& _name, fs::path const& _basePath, fs::path const& _subdirectory, string const& _ipcPath, TestCase::TestCaseCreator _testCaseCreator, bool _formatted, langutil::EVMVersion _evmVersion ) { fs::path testPath = _basePath / _subdirectory; if (!fs::exists(testPath) || !fs::is_directory(testPath)) { cerr << _name << " tests not found. Use the --testpath argument." << endl; return {}; } TestStats stats = TestTool::processPath(_testCaseCreator, _basePath, _subdirectory, _ipcPath, _formatted, _evmVersion); cout << endl << _name << " Test Summary: "; AnsiColorized(cout, _formatted, {BOLD, stats ? GREEN : RED}) << stats.successCount << "/" << stats.testCount; cout << " tests successful"; if (stats.skippedCount > 0) { cout << " ("; AnsiColorized(cout, _formatted, {BOLD, YELLOW}) << stats.skippedCount; cout<< " tests skipped)"; } cout << "." << endl << endl; return stats; } } int main(int argc, char const *argv[]) { setupTerminal(); dev::test::IsolTestOptions options(&TestTool::editor); try { if (options.parse(argc, argv)) options.validate(); else return 1; } catch (std::exception const& _exception) { cerr << _exception.what() << endl; return 1; } 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 && options.disableIPC) continue; if (ts.smt && options.disableSMT) continue; if (auto stats = runTestSuite(ts.title, options.testPath / ts.path, ts.subpath, options.ipcPath.string(), ts.testCaseCreator, !options.noColor, options.evmVersion())) global_stats += *stats; else return 1; } cout << endl << "Summary: "; AnsiColorized(cout, !options.noColor, {BOLD, global_stats ? GREEN : RED}) << global_stats.successCount << "/" << global_stats.testCount; cout << " tests successful"; if (global_stats.skippedCount > 0) { cout << " ("; AnsiColorized(cout, !options.noColor, {BOLD, YELLOW}) << global_stats.skippedCount; cout << " tests skipped)"; } cout << "." << endl; return global_stats ? 0 : 1; }