1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
#include "sqllogic_test_logger.hpp"
#include "duckdb/parser/parser.hpp"
#include "termcolor.hpp"
#include "result_helper.hpp"
#include "sqllogic_test_runner.hpp"
#include "test_helpers.hpp"
#include "duckdb/common/box_renderer.hpp"
namespace duckdb {
SQLLogicTestLogger::SQLLogicTestLogger(ExecuteContext &context, const Command &command)
: connection(command.CommandConnection(context)), log_lock(command.runner.log_lock), file_name(command.file_name),
query_line(command.query_line), sql_query(context.sql_query) {
}
SQLLogicTestLogger::~SQLLogicTestLogger() {
}
void SQLLogicTestLogger::Log(const string &annotation, const string &str) {
std::cerr << annotation << str;
AppendFailure(str);
}
void SQLLogicTestLogger::AppendFailure(const string &log_message) {
FailureSummary::Log(log_message);
}
void SQLLogicTestLogger::LogFailure(const string &log_message) {
Log("", log_message);
}
void SQLLogicTestLogger::LogFailureAnnotation(const string &log_message) {
const char *ci = std::getenv("CI");
// check the value is "true" otherwise you'll see the prefix in local run outputs
auto prefix = (ci && string(ci) == "true") ? "\n::error::" : "";
Log(prefix, log_message);
}
void SQLLogicTestLogger::PrintSummaryHeader(const std::string &file_name, idx_t query_line) {
auto failures_count = to_string(FailureSummary::GetSummaryCounter());
if (std::getenv("NO_DUPLICATING_HEADERS") == 0) {
LogFailure("\n" + failures_count + ". " + file_name + ":" + to_string(query_line) + "\n");
PrintLineSep();
}
}
void SQLLogicTestLogger::PrintExpectedResult(const vector<string> &values, idx_t columns, bool row_wise) {
if (row_wise) {
for (idx_t r = 0; r < values.size(); r++) {
LogFailure("\n" + values[r]);
}
} else {
idx_t c = 0;
for (idx_t r = 0; r < values.size(); r++) {
if (c != 0) {
LogFailure("\t");
}
LogFailure(values[r]);
c++;
if (c >= columns) {
LogFailure("\n");
c = 0;
}
}
}
LogFailure("\n");
}
void SQLLogicTestLogger::PrintLineSep() {
string line_sep = string(80, '=');
std::ostringstream oss;
oss << termcolor::color<128, 128, 128> << line_sep << termcolor::reset << std::endl;
LogFailure(oss.str());
}
void SQLLogicTestLogger::PrintHeader(string header) {
std::ostringstream oss;
oss << termcolor::bold << header << termcolor::reset << std::endl;
LogFailure(oss.str());
}
void SQLLogicTestLogger::PrintFileHeader() {
PrintHeader("File " + file_name + ":" + to_string(query_line) + ")");
}
void SQLLogicTestLogger::PrintSQL() {
string query = sql_query;
if (StringUtil::EndsWith(sql_query, "\n")) {
// ends with a newline: don't add one
if (!StringUtil::EndsWith(sql_query, ";\n")) {
// no semicolon though
query[query.size() - 1] = ';';
}
} else {
if (!StringUtil::EndsWith(sql_query, ";")) {
query += ";";
}
}
Log("", query + "\n");
}
void SQLLogicTestLogger::PrintSQLFormatted() {
std::cerr << termcolor::bold << "SQL Query" << termcolor::reset << std::endl;
auto tokens = Parser::Tokenize(sql_query);
for (idx_t i = 0; i < tokens.size(); i++) {
auto &token = tokens[i];
idx_t next = i + 1 < tokens.size() ? tokens[i + 1].start : sql_query.size();
// adjust the highlighting based on the type
switch (token.type) {
case SimplifiedTokenType::SIMPLIFIED_TOKEN_IDENTIFIER:
case SimplifiedTokenType::SIMPLIFIED_TOKEN_ERROR:
case SimplifiedTokenType::SIMPLIFIED_TOKEN_ERROR_EMPHASIS:
case SimplifiedTokenType::SIMPLIFIED_TOKEN_ERROR_SUGGESTION:
break;
case SimplifiedTokenType::SIMPLIFIED_TOKEN_NUMERIC_CONSTANT:
case SimplifiedTokenType::SIMPLIFIED_TOKEN_STRING_CONSTANT:
std::cerr << termcolor::yellow;
break;
case SimplifiedTokenType::SIMPLIFIED_TOKEN_OPERATOR:
break;
case SimplifiedTokenType::SIMPLIFIED_TOKEN_KEYWORD:
std::cerr << termcolor::green << termcolor::bold;
break;
case SimplifiedTokenType::SIMPLIFIED_TOKEN_COMMENT:
std::cerr << termcolor::grey;
break;
}
// print the current token
std::cerr << sql_query.substr(token.start, next - token.start);
// reset and move to the next token
std::cerr << termcolor::reset;
}
std::cerr << std::endl;
}
void SQLLogicTestLogger::PrintErrorHeader(const string &file_name, idx_t query_line, const string &description) {
std::ostringstream oss;
PrintSummaryHeader(file_name, query_line);
oss << termcolor::red << termcolor::bold << description << " " << termcolor::reset;
if (!file_name.empty()) {
oss << termcolor::bold << "(" << file_name << ":" << query_line << ")!" << termcolor::reset;
}
LogFailureAnnotation(oss.str() + "\n");
}
void SQLLogicTestLogger::PrintErrorHeader(const string &description) {
PrintErrorHeader(file_name, query_line, description);
}
void SQLLogicTestLogger::PrintResultError(const vector<string> &result_values, const vector<string> &values,
idx_t expected_column_count, bool row_wise) {
PrintHeader("Expected result:");
PrintLineSep();
PrintExpectedResult(values, expected_column_count, row_wise);
PrintLineSep();
PrintHeader("Actual result:");
PrintLineSep();
PrintExpectedResult(result_values, expected_column_count, false);
}
string SQLLogicTestLogger::ResultToString(MaterializedQueryResult &result) {
if (result.RowCount() < 100) {
return result.ToString();
}
BoxRendererConfig config;
config.max_rows = 100;
config.max_width = -1;
return result.ToBox(*connection.context, config);
}
void SQLLogicTestLogger::PrintResultString(MaterializedQueryResult &result) {
LogFailure(ResultToString(result));
}
void SQLLogicTestLogger::PrintResultError(MaterializedQueryResult &result, const vector<string> &values,
idx_t expected_column_count, bool row_wise) {
PrintHeader("Expected result:");
PrintLineSep();
PrintExpectedResult(values, expected_column_count, row_wise);
PrintLineSep();
PrintHeader("Actual result:");
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::UnexpectedFailure(MaterializedQueryResult &result) {
std::ostringstream oss;
PrintErrorHeader("Query unexpectedly failed (" + file_name + ":" + to_string(query_line) + ")\n");
LogFailure(oss.str());
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintHeader("Actual result:");
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::OutputResult(MaterializedQueryResult &result, const vector<string> &result_values_string) {
// names
for (idx_t c = 0; c < result.ColumnCount(); c++) {
if (c != 0) {
LogFailure("\t");
}
LogFailure(result.names[c]);
}
LogFailure("\n");
// types
for (idx_t c = 0; c < result.ColumnCount(); c++) {
if (c != 0) {
LogFailure("\t");
}
LogFailure(result.types[c].ToString());
}
LogFailure("\n");
PrintLineSep();
for (idx_t r = 0; r < result.RowCount(); r++) {
for (idx_t c = 0; c < result.ColumnCount(); c++) {
if (c != 0) {
LogFailure("\t");
}
LogFailure(result_values_string[r * result.ColumnCount() + c]);
}
LogFailure("\n");
}
}
void SQLLogicTestLogger::OutputHash(const string &hash_value) {
PrintLineSep();
PrintSQL();
PrintLineSep();
LogFailure(hash_value + "\n");
PrintLineSep();
}
void SQLLogicTestLogger::ColumnCountMismatch(MaterializedQueryResult &result,
const vector<string> &result_values_string, idx_t expected_column_count,
bool row_wise) {
std::ostringstream oss;
PrintErrorHeader("Wrong column count in query!");
oss << "Expected " << termcolor::bold << expected_column_count << termcolor::reset << " columns, but got "
<< termcolor::bold << result.ColumnCount() << termcolor::reset << " columns" << std::endl;
LogFailure(oss.str());
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintResultError(result, result_values_string, expected_column_count, row_wise);
}
void SQLLogicTestLogger::NotCleanlyDivisible(idx_t expected_column_count, idx_t actual_column_count) {
PrintLineSep();
PrintErrorHeader("Error in test!");
PrintLineSep();
LogFailure("Expected " + to_string(expected_column_count) + " columns, but " + to_string(actual_column_count) +
" values were supplied\nThis is not cleanly divisible (i.e. the last row does not have enough values)");
}
void SQLLogicTestLogger::WrongRowCount(idx_t expected_rows, MaterializedQueryResult &result,
const vector<string> &comparison_values, idx_t expected_column_count,
bool row_wise) {
std::ostringstream oss;
PrintErrorHeader("Wrong row count in query!");
oss << "Expected " << termcolor::bold << expected_rows << termcolor::reset << " rows, but got " << termcolor::bold
<< result.RowCount() << termcolor::reset << " rows" << std::endl;
LogFailure(oss.str());
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintResultError(result, comparison_values, expected_column_count, row_wise);
}
void SQLLogicTestLogger::ColumnCountMismatchCorrectResult(idx_t original_expected_columns, idx_t expected_column_count,
MaterializedQueryResult &result) {
std::ostringstream oss;
PrintErrorHeader("Wrong column count in query!");
oss << "Expected " << termcolor::bold << original_expected_columns << termcolor::reset << " columns, but got "
<< termcolor::bold << expected_column_count << termcolor::reset << " columns" << std::endl;
LogFailure(oss.str());
oss.str("");
oss.clear();
PrintLineSep();
PrintSQL();
PrintLineSep();
oss << "The expected result " << termcolor::bold << "matched" << termcolor::reset << " the query result."
<< std::endl;
LogFailure(oss.str());
oss.str("");
oss.clear();
oss << termcolor::bold << "Suggested fix: modify header to \"" << termcolor::green << "query "
<< string(result.ColumnCount(), 'I') << termcolor::reset << termcolor::bold << "\"" << termcolor::reset
<< std::endl;
LogFailure(oss.str());
PrintLineSep();
}
void SQLLogicTestLogger::SplitMismatch(idx_t row_number, idx_t expected_column_count, idx_t split_count) {
std::ostringstream oss;
PrintLineSep();
PrintErrorHeader("Error in test! Column count mismatch after splitting on tab on row " + to_string(row_number) +
"!");
oss << "Expected " << termcolor::bold << expected_column_count << termcolor::reset << " columns, but got "
<< termcolor::bold << split_count << termcolor::reset << " columns" << std::endl;
LogFailure(oss.str());
LogFailure("Does the result contain tab values? In that case, place every value on a single row.\n");
PrintLineSep();
PrintSQL();
PrintLineSep();
}
void SQLLogicTestLogger::WrongResultHash(const string &expected_result, MaterializedQueryResult &result,
const string &expected_hash, const string &actual_hash) {
PrintErrorHeader("Wrong result hash!");
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintHeader("Expected result:");
if (!expected_result.empty()) {
LogFailure(expected_result);
} else {
LogFailure("???\n");
}
PrintLineSep();
PrintHeader("Actual result:");
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::UnexpectedStatement(bool expect_ok, MaterializedQueryResult &result) {
PrintErrorHeader(!expect_ok ? "Query unexpectedly succeeded!" : "Query unexpectedly failed!");
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::ExpectedErrorMismatch(const string &expected_error, MaterializedQueryResult &result) {
PrintErrorHeader("Query failed, but error message did not match expected error message: " + expected_error);
PrintLineSep();
PrintSQL();
PrintLineSep();
PrintHeader("Actual result:");
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::InternalException(MaterializedQueryResult &result) {
PrintErrorHeader("Query failed with internal exception!");
PrintLineSep();
PrintSQL();
PrintHeader("Actual result:");
PrintLineSep();
PrintResultString(result);
}
void SQLLogicTestLogger::LoadDatabaseFail(const string &file_name, const string &dbpath, const string &message) {
PrintErrorHeader(file_name, 0, "Failed to load database " + dbpath);
PrintLineSep();
LogFailure("Error message: " + message + "\n");
PrintLineSep();
}
} // namespace duckdb
|