#include #include #include #include #include #include #include #include #include #include #include #include #include #include /** Tests launcher for ClickHouse. * The tool walks through given or default folder in order to find files with * tests' description and launches it. */ namespace DB { namespace ErrorCodes { extern const int POCO_EXCEPTION; extern const int STD_EXCEPTION; extern const int UNKNOWN_EXCEPTION; } class PerformanceTest { public: PerformanceTest( const unsigned concurrency_, const String & host_, const UInt16 port_, const String & default_database_, const String & user_, const String & password_, const std::vector & input_files, const std::vector & tags, const std::vector & without_tags, const std::vector & names, const std::vector & without_names, const std::vector & names_regexp, const std::vector & without_names_regexp ): concurrency(concurrency_), connections(concurrency, host_, port_, default_database_, user_, password_), pool(concurrency), testsConfigurations(input_files.size()) { if (input_files.size() < 1) { throw Poco::Exception("No tests were specified", 1); } // std::cerr << std::fixed << std::setprecision(3); readTestsConfiguration(input_files); } private: unsigned concurrency; ConnectionPool connections; ThreadPool pool; using XMLConfiguration = Poco::Util::XMLConfiguration; using AbstractConfig = Poco::AutoPtr; using Config = Poco::AutoPtr; using Paths = std::vector; using StringToVector = std::map< std::string, std::vector >; std::vector testsConfigurations; void readTestsConfiguration(const Paths & input_files) { testsConfigurations.resize(input_files.size()); for (size_t i = 0; i != input_files.size(); ++i) { const std::string path = input_files[i]; testsConfigurations[i] = Config(new XMLConfiguration(path)); } // TODO: here will be tests filter on tags, names, regexp matching, etc. // { ... } // for now let's launch one test only if (testsConfigurations.size()) { for (auto & testConfig : testsConfigurations) { runTest(testConfig); } } } void runTest(Config & testConfig) { std::cout << "Running: " << testConfig->getString("name") << "\n"; Settings settingsPerTest; using Keys = std::vector; if (testConfig->has("settings")) { Keys settings; testConfig->keys("settings", settings); /// This macro goes through all settings in the Settings.h /// and, if found any settings in test's xml configuration /// with the same name, sets its value to settingsPerTest std::vector::iterator it; #define EXTRACT_SETTING(TYPE, NAME, DEFAULT) \ it = std::find(settings.begin(), settings.end(), #NAME); \ if (it != settings.end()) \ settingsPerTest.set( \ #NAME, testConfig->getString("settings."#NAME) \ ); APPLY_FOR_SETTINGS(EXTRACT_SETTING) APPLY_FOR_LIMITS(EXTRACT_SETTING) #undef EXTRACT_SETTING if (std::find(settings.begin(), settings.end(), "profile") != settings.end()) { // proceed profile settings in a proper way } } std::string query; if (testConfig->has("query")) { query = testConfig->getString("query"); if (query.empty()) { throw Poco::Exception("The query is empty", 1); } } if (testConfig->has("substitutions")) { /// Make "subconfig" of inner xml block AbstractConfig substitutionsView(testConfig ->createView("substitutions")); StringToVector substitutions; constructSubstitutions(substitutionsView, substitutions); std::vector queries = formatQueries(query, substitutions); } } void constructSubstitutions(AbstractConfig & substitutionsView, StringToVector & substitutions) { using Keys = std::vector; Keys xml_substitutions; substitutionsView->keys(xml_substitutions); for (size_t i = 0; i != xml_substitutions.size(); ++i) { const AbstractConfig xml_substitution( substitutionsView->createView("substitution[" + std::to_string(i) + "]") ); /// Property values for substitution will be stored in a vector /// accessible by property name std::vector xml_values; xml_substitution->keys("values", xml_values); std::string name = xml_substitution->getString("name"); for (size_t j = 0; j != xml_values.size(); ++j) { substitutions[name].push_back( xml_substitution->getString("values.value[" + std::to_string(j) + "]") ); } } } std::vector formatQueries(const std::string & query, StringToVector substitutions) const { std::vector queries; StringToVector::iterator substitutions_first = substitutions.begin(); StringToVector::iterator substitutions_last = substitutions.end(); --substitutions_last; runThroughAllOptionsAndPush( substitutions_first, substitutions_last, query, queries ); return queries; } /// Recursive method which goes through all substitution blocks in xml /// and replaces property {names} by their values void runThroughAllOptionsAndPush( StringToVector::iterator substitutions_left, StringToVector::iterator substitutions_right, const std::string & template_query, std::vector & queries ) const { std::string name = substitutions_left->first; std::vector values = substitutions_left->second; for (auto value = values.begin(); value != values.end(); ++value) { /// Copy query string for each unique permutation std::string query = template_query; size_t substrPos = 0; while (substrPos != std::string::npos) { substrPos = query.find("{" + name + "}"); if (substrPos != std::string::npos) { query.replace( substrPos, 1 + name.length() + 1, *value ); } } /// If we've reached the end of substitution chain if (substitutions_left == substitutions_right) { queries.push_back(query); } else { StringToVector::iterator next_it = substitutions_left; ++next_it; runThroughAllOptionsAndPush( next_it, substitutions_right, query, queries ); } } } }; } int mainEntryClickhousePerformanceTest(int argc, char ** argv) { using namespace DB; try { using boost::program_options::value; using Strings = std::vector; boost::program_options::options_description desc("Allowed options"); desc.add_options() ("help", "produce help message") ("concurrency,c", value()->default_value(1), "number of parallel queries") ("host,h", value()->default_value("localhost"), "") ("port", value()->default_value(9000), "") ("user", value()->default_value("default"), "") ("password", value()->default_value(""), "") ("database", value()->default_value("default"), "") ("tag", value(), "Run only tests with tag") ("without-tag", value(), "Do not run tests with tag") ("name", value(), "Run tests with specific name") ("without-name", value(), "Do not run tests with name") ("name-regexp", value(), "Run tests with names matching regexp") ("without-name-regexp", value(), "Do not run tests with names matching regexp") ; /// These options will not be displayed in --help boost::program_options::options_description hidden("Hidden options"); hidden.add_options() ("input-files", value< std::vector >(), "") ; /// But they will be legit, though. And they must be given without name boost::program_options::positional_options_description positional; positional.add("input-files", -1); boost::program_options::options_description cmdline_options; cmdline_options.add(desc).add(hidden); boost::program_options::variables_map options; boost::program_options::store( boost::program_options::command_line_parser(argc, argv) .options(cmdline_options) .positional(positional) .run(), options ); boost::program_options::notify(options); if (options.count("help")) { std::cout << "Usage: " << argv[0] << " [options] [test_file ...] [tests_folder]\n"; std::cout << desc << "\n"; return 1; } if (! options.count("input-files")) { std::cerr << "No tests files were specified. See --help" << "\n"; return 1; } Strings tests_tags; Strings skip_tags; Strings tests_names; Strings skip_names; Strings name_regexp; Strings skip_matching_regexp; if (options.count("tag")) { tests_tags = options["tag"].as(); } if (options.count("without-tag")) { skip_tags = options["without-tag"].as(); } if (options.count("name")) { tests_names = options["name"].as(); } if (options.count("without-name")) { skip_names = options["without-name"].as(); } if (options.count("name-regexp")) { name_regexp = options["name-regexp"].as(); } if (options.count("without-name-regexp")) { skip_matching_regexp = options["without-name-regexp"].as(); } PerformanceTest performanceTest( options["concurrency"].as(), options["host" ].as(), options["port" ].as(), options["database" ].as(), options["user" ].as(), options["password" ].as(), options["input-files"].as(), tests_tags, skip_tags, tests_names, skip_names, name_regexp, skip_matching_regexp ); } catch (const Exception & e) { std::string text = e.displayText(); std::cerr << "Code: " << e.code() << ". " << text << "\n\n"; /// Если есть стек-трейс на сервере, то не будем писать стек-трейс на клиенте. if (std::string::npos == text.find("Stack trace")) std::cerr << "Stack trace:\n" << e.getStackTrace().toString(); return e.code(); } catch (const Poco::Exception & e) { std::cerr << "Poco::Exception: " << e.displayText() << "\n"; return ErrorCodes::POCO_EXCEPTION; } catch (const std::exception & e) { std::cerr << "std::exception: " << e.what() << "\n"; return ErrorCodes::STD_EXCEPTION; } catch (...) { std::cerr << "Unknown exception\n"; return ErrorCodes::UNKNOWN_EXCEPTION; } return 0; }